Doxygen comments for getter functions of the gauss legendre template

kennethassogba · Dec 31, 2024 · b74ca8f · b74ca8f
1 parent 95cce71
commit b74ca8f
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 16 deletions.
diff --git a/src/demeter/globals.hpp b/src/demeter/globals.hpp
@@ -7,7 +7,6 @@ namespace Demeter {
 
 // 1. definir grandeurs utiles pour methode 
 //    puissance iteree et calcul sources
-//
 // 2. voir comment fixer les valeurs a partir
 //    jeu de donnees: a la fin, ce sera les 
 //    donnees rentrees par lutilisateur qui 
@@ -32,24 +31,24 @@ extern size_t nmomsa;   // nber of angular moments
 extern size_t nmomsp;   // nber of spatial moments
 extern size_t nmoms;    // total nber of moments
 
-double keffs;           // keff from solver 
-double keffb;           // keff from balance
-double kinf;            // infinite multiplication factor
+extern double keffs;    // keff from solver 
+extern double keffb;    // keff from balance
+extern double kinf;     // infinite multiplication factor
 
 // flux, moments, sources
 // Multi-group arrays
-extern ArrayXd mg_fiss_src(nbgroup*nbreg*nmoms);     // fission source
-extern ArrayXd mg_osca_src(nbgroup*nbreg*nmoms);     // out-of-group scattering source
-extern ArrayXd mg_wsca_src(nbgroup*nbreg*nmoms);     // within-group scattering source
-extern ArrayXd mg_exte_src(nbgroup*nbreg*nmoms);     // fission and ouf-of-groupe source
-extern ArrayXd mg_moments(nbgroup*nbreg*nmoms);      // moments of the angular flux
+extern ArrayXd mg_fiss_src;     // fission source
+extern ArrayXd mg_osca_src;     // out-of-group scattering source
+extern ArrayXd mg_wsca_src;     // within-group scattering source
+extern ArrayXd mg_exte_src;     // fission and ouf-of-groupe source
+extern ArrayXd mg_moments;      // moments of the angular flux
 
 // Mono-group arrays
-extern ArrayXd fiss_src(nbgroup*nbreg*nmoms);        // fission source
-extern ArrayXd osca_src(nbgroup*nbreg*nmoms);        // out-of-group scattering source
-extern ArrayXd wsca_src(nbgroup*nbreg*nmoms);        // within-group scattering source
-extern ArrayXd exte_src(nbgroup*nbreg*nmoms);        // fission and ouf-of-groupe source
-extern ArrayXd moments(nbgroup*nbreg*nmoms);         // moments of the angular flux
+extern ArrayXd fiss_src;        // fission source
+extern ArrayXd osca_src;        // out-of-group scattering source
+extern ArrayXd wsca_src;        // within-group scattering source
+extern ArrayXd exte_src;        // fission and ouf-of-groupe source
+extern ArrayXd moments;         // moments of the angular flux
 
 
 } // namespace Demeter

diff --git a/src/demeter/quadrature/gauss_legendre.hpp b/src/demeter/quadrature/gauss_legendre.hpp
@@ -35,12 +35,24 @@ class GaussLegendre {
   */
   void initialization();
 
-  // Define getter methods
+  /**
+  * @brief Getter func to return weights.
+  */
   const Eigen::ArrayXd& getweights() const { return weights_; }
+
+  /**
+  * @brief Getter func to return cosines.
+  */
   const Eigen::ArrayXd& getcosteta() const { return costeta_; }
+
+  /**
+  * @brief Getter func to return teta.
+  *  
+  * @note Teta is define starting from the (Oz)
+  * axis as in [Applied Reactor Physics, Hebert]
+  */
   const Eigen::ArrayXd& getteta() const { return teta_; }
 
-
  private:
   static Eigen::ArrayXd weights_;
   static Eigen::ArrayXd costeta_;

diff --git a/src/demeter/solve/solver.hpp b/src/demeter/solve/solver.hpp
@@ -18,6 +18,9 @@ class Solver {
   const auto& getFiss() const { return fiss_; }
   const auto& getPower() const { return power_; }
 
+  auto& updateFissSrc();
+  auto& updateScatSrc();
+
  private:
   const Lattice& geo__;
   AngularMethod& am_;