Changeset 909 in Sophya for trunk/SophyaLib/SkyT/nupower.cc

Timestamp:

Apr 13, 2000, 4:10:46 PM (25 years ago)

Author:

ansari

Message:

Sophie: adding documentation for Doxygen in the .cc files:wq

File:

• trunk/SophyaLib/SkyT/nupower.cc (modified) (3 diffs)

trunk/SophyaLib/SkyT/nupower.cc

@@ -1 +1 @@
 //--------------------------------------------------------------------------
 // File and Version Information:
-//      $Id: nupower.cc,v 1.5 1999-11-29 16:59:10 ansari Exp $
+//      $Id: nupower.cc,v 1.6 2000-04-13 14:10:44 ansari Exp $
 //
 // Description:
@@ -21 +21 @@
 #include "nupower.h"
 
-//----------------
-// Constructor --
-//----------------
+
+/*! 
+ * \class SOPHYA::PowerLawSpectra <BR>
+ * This class corresponds to a power law radiation spectrum.
+*/
 PowerLawSpectra::PowerLawSpectra()
 {
 }
-
-PowerLawSpectra::PowerLawSpectra(double a, double b, double nu0, double dnu, double numin, double numax)
+/*! Constructor: The arguments corresponds to the Power Law Spectrum
+  equation:
+<a name="psldef"> </a>
+\f[
+\hbox{flux}(\nu) = A ({\nu-\nu_0\over \delta\nu})^B
+\f]
+*/
+PowerLawSpectra::PowerLawSpectra(double A, double B, double nu0, double dnu, double numin, double numax)
   : RadSpectra(numin, numax)
 {
-  _a = a;
-  _b = b;
+  _a = A;
+  _b = B;
   _nu0 = nu0;
   _dnu = (dnu > 1.e-19) ? dnu : 1.;
@@ -41 +49 @@
 {
 }
-
+/*! Flux function according to the <a href="#psldef"> above </a>
+ equation */
 double
 PowerLawSpectra::flux(double nu) const