more documentation

Former-commit-id: 89068dc9

code/include/common/config.h

@@ -27,7 +27,7 @@ class OptionBase;
 class Config
 {
   private:
-    std::string _fileName; /*!< @rief Name of the current file without extension */
+    std::string _fileName; /*!< @brief Name of the current file without extension */
     bool _baseConfig;
 
     // int _commRank, _commSize; /*!< @brief MPI rank and size.*/    // Not yet used!!

code/include/common/globalconstants.h

 /*!
- * \file GlobalConstants.h
+ * \file globalconstants.h
  * \brief All global defined (physical) constants, enums etc
  * \author <blank>
  * \version 0.0

code/include/common/io.h

@@ -10,10 +10,10 @@ class Config;
 class Mesh;
 
 /*! @brief Function to export solver Volume output to VTK file.
- *  @param filename: Filename of output file
- *  @param outputFields: numerical output of the solver. Dimensions: (OutputGroupSize, OutputFieldSize, NumberMeshCells)
- *  @param outputFieldNames: names of the outputfields. Dimensions: (OutputGroupSize, OutputFieldSize)
- *  @param mesh: Mesh with <NumberMeshCells> cells (the mesh used for the computation)
+ *  @param fileName Filename of output file
+ *  @param outputFields numerical output of the solver. Dimensions: (OutputGroupSize, OutputFieldSize, NumberMeshCells)
+ *  @param outputFieldNames names of the outputfields. Dimensions: (OutputGroupSize, OutputFieldSize)
+ *  @param mesh Mesh with cells (the mesh used for the computation)
  */
 void ExportVTK( const std::string fileName,
                 const std::vector<std::vector<std::vector<double>>>& outputFields,

code/include/common/optionstructure.h

 /*!
- * \file OptionStructure.h
- * \brief Classes for different Options in rtsn
- * \author S. Schotthoefer
- *
- * Disclaimer: This class structure was copied and modifed with open source permission from SU2 v7.0.3 https://su2code.github.io/
+ * \file optionstructure.h
+ * \brief Classes for different Options in KiT-RT
  */
 
 #ifndef OPTION_STRUCTURE_H

code/include/fluxes/numericalflux.h

@@ -20,19 +20,19 @@ class NumericalFlux
     virtual double Flux( const Vector& Omega, double psiL, double psiR, const Vector& n ) const = 0;
 
     /**
-     * @brief Flux      : Computes <Steger Warming> upwinding scheme for given flux jacobians of the PN Solver at a given edge and stores it in
+     * @brief Flux       Computes "Steger Warming" upwinding scheme for given flux jacobians of the PN Solver at a given edge and stores it in
      *                   resultFlux
-     * @param AxPlus    : Positive part of the flux jacobian in x direction
-     * @param AxMinus   : Negative part of the flux jacobian in x direction
-     * @param AyPlus    : Positive part of the flux jacobian in y direction
-     * @param AyMinus   : Negative part of the flux jacobian in y direction
-     * @param AzPlus    : Positive part of the flux jacobian in z direction
-     * @param AzMinus   : Negative part of the flux jacobian in z direction
-     * @param psiL      : Solution state of left hand side control volume
-     * @param psiR      : Solution state of right hand side control volume
-     * @param n         : Normal vector at the edge between left and right control volume
-     * @param resultFlux: Vector with resulting flux.
-     * @return          : void
+     * @param AxPlus     Positive part of the flux jacobian in x direction
+     * @param AxMinus    Negative part of the flux jacobian in x direction
+     * @param AyPlus     Positive part of the flux jacobian in y direction
+     * @param AyMinus    Negative part of the flux jacobian in y direction
+     * @param AzPlus     Positive part of the flux jacobian in z direction
+     * @param AzMinus    Negative part of the flux jacobian in z direction
+     * @param psiL       Solution state of left hand side control volume
+     * @param psiR       Solution state of right hand side control volume
+     * @param n          Normal vector at the edge between left and right control volume
+     * @param resultFlux Vector with resulting flux.
+     * @return           void
      */
     virtual Vector Flux( const Matrix AxPlus,
                          const Matrix AxMinus,

code/include/fluxes/upwindflux.h

@@ -23,19 +23,19 @@ class UpwindFlux : public NumericalFlux
     double Flux( const Vector& Omega, double psiL, double psiR, const Vector& n ) const override;
 
     /**
-     * @brief Flux      : Computes <Steger Warming> upwinding scheme for given flux jacobians of the PN Solver at a given edge and stores it in
+     * @brief Flux       Computes "Steger Warming" upwinding scheme for given flux jacobians of the PN Solver at a given edge and stores it in
      *                   resultFlux
-     * @param AxPlus    : Positive part of the flux jacobian in x direction
-     * @param AxMinus   : Negative part of the flux jacobian in x direction
-     * @param AyPlus    : Positive part of the flux jacobian in y direction
-     * @param AyMinus   : Negative part of the flux jacobian in y direction
-     * @param AzPlus    : Positive part of the flux jacobian in z direction
-     * @param AzMinus   : Negative part of the flux jacobian in z direction
-     * @param psiL      : Solution state of left hand side control volume
-     * @param psiR      : Solution state of right hand side control volume
-     * @param n         : Normal vector at the edge between left and right control volume
-     * @param resultFlux: Vector with resulting flux.
-     * @return          : void
+     * @param AxPlus     Positive part of the flux jacobian in x direction
+     * @param AxMinus    Negative part of the flux jacobian in x direction
+     * @param AyPlus     Positive part of the flux jacobian in y direction
+     * @param AyMinus    Negative part of the flux jacobian in y direction
+     * @param AzPlus     Positive part of the flux jacobian in z direction
+     * @param AzMinus    Negative part of the flux jacobian in z direction
+     * @param psiL       Solution state of left hand side control volume
+     * @param psiR       Solution state of right hand side control volume
+     * @param n          Normal vector at the edge between left and right control volume
+     * @param resultFlux Vector with resulting flux.
+     * @return           void
      */
     Vector Flux( const Matrix AxPlus,
                  const Matrix AxMinus,
@@ -48,19 +48,19 @@ class UpwindFlux : public NumericalFlux
                  const Vector n ) const override;
 
     /**
-     * @brief Flux      : Computes <VanLeer> upwinding scheme for given flux jacobians of the PN Solver at a given edge and stores it in
+     * @brief Flux       Computes "VanLeer" upwinding scheme for given flux jacobians of the PN Solver at a given edge and stores it in
      *                   resultFlux
-     * @param AxPlus    : Positive part of the flux jacobian in x direction
-     * @param AxMinus   : Negative part of the flux jacobian in x direction
-     * @param AyPlus    : Positive part of the flux jacobian in y direction
-     * @param AyMinus   : Negative part of the flux jacobian in y direction
-     * @param AzPlus    : Positive part of the flux jacobian in z direction
-     * @param AzMinus   : Negative part of the flux jacobian in z direction
-     * @param psiL      : Solution state of left hand side control volume
-     * @param psiR      : Solution state of right hand side control volume
-     * @param n         : Normal vector at the edge between left and right control volume
-     * @param resultFlux: Vector with resulting flux.
-     * @return          : void
+     * @param AxPlus     Positive part of the flux jacobian in x direction
+     * @param AxMinus    Negative part of the flux jacobian in x direction
+     * @param AyPlus     Positive part of the flux jacobian in y direction
+     * @param AyMinus    Negative part of the flux jacobian in y direction
+     * @param AzPlus     Positive part of the flux jacobian in z direction
+     * @param AzMinus    Negative part of the flux jacobian in z direction
+     * @param psiL       Solution state of left hand side control volume
+     * @param psiR       Solution state of right hand side control volume
+     * @param n          Normal vector at the edge between left and right control volume
+     * @param resultFlux Vector with resulting flux.
+     * @return           void
      */
     void FluxVanLeer( const Matrix& Ax,
                       const Matrix& AxAbs,

code/include/problems/checkerboard.h

@@ -18,10 +18,10 @@ class Checkerboard_SN : public ProblemBase
     Checkerboard_SN( Config* settings, Mesh* mesh );
     virtual ~Checkerboard_SN();
 
-    virtual VectorVector GetScatteringXS( const Vector& energies );
-    virtual VectorVector GetTotalXS( const Vector& energies );
-    virtual std::vector<VectorVector> GetExternalSource( const Vector& energies );
-    virtual VectorVector SetupIC();
+    virtual VectorVector GetScatteringXS( const Vector& energies ) override;
+    virtual VectorVector GetTotalXS( const Vector& energies ) override;
+    virtual std::vector<VectorVector> GetExternalSource( const Vector& energies ) override;
+    virtual VectorVector SetupIC() override;
 };
 
 class Checkerboard_PN : public ProblemBase
@@ -49,10 +49,10 @@ class Checkerboard_PN : public ProblemBase
     Checkerboard_PN( Config* settings, Mesh* mesh );
     virtual ~Checkerboard_PN();
 
-    virtual VectorVector GetScatteringXS( const Vector& energies );
-    virtual VectorVector GetTotalXS( const Vector& energies );
-    virtual std::vector<VectorVector> GetExternalSource( const Vector& energies );
-    virtual VectorVector SetupIC();
+    virtual VectorVector GetScatteringXS( const Vector& energies ) override;
+    virtual VectorVector GetTotalXS( const Vector& energies ) override;
+    virtual std::vector<VectorVector> GetExternalSource( const Vector& energies ) override;
+    virtual VectorVector SetupIC() override;
 };
 
 #endif    // CHECKERBOARD_H

code/include/problems/isotropicsource2d.h

@@ -23,5 +23,4 @@ class IsotropicSource2D : public ElectronRT
     std::vector<double> GetDensity( const VectorVector& cellMidPoints );
 };
 
-
 #endif    // ISOTROPICSOURCE2D_H

code/include/solvers/csdsolvertrafofp.h

@@ -28,8 +28,8 @@ class CSDSolverTrafoFP : public SNSolver
     Vector _xi1;
     Vector _xi2;
 
-    unsigned _FPMethod; /*!<  @brief Encodes different ways of computing coefficients alpha, alpha2 & beta, _FPMethod == 1, 2 ,3 stand for methods with
-                           increasing accuracy (see Olbrant 2010, Appendix B)*/
+    unsigned _FPMethod; /*!<  @brief Encodes different ways of computing coefficients alpha, alpha2 & beta, _FPMethod == 1, 2 ,3 stand for methods
+                           with increasing accuracy (see Olbrant 2010, Appendix B)*/
 
     bool _RT; /*!<  @brief radiotherapy application (on/off), if true use crosssections + stopping powers from database  */
 
@@ -40,7 +40,7 @@ class CSDSolverTrafoFP : public SNSolver
 
     // Helper variables
     Vector _energiesOrig; /*!< @brief original energy levels for CSD, lenght = _nEnergies */
-    Matrix _identity; /*!< @brif: identity matrix for FP scattering. Dim (_nq,_nq)*/
+    Matrix _identity;     /*!< @brief: identity matrix for FP scattering. Dim (_nq,_nq)*/
 
   public:
     /**

code/include/solvers/csdsolvertrafofp2d.h

@@ -45,7 +45,7 @@ class CSDSolverTrafoFP2D : public SNSolver
 
     // Helper variables
     Vector _energiesOrig; /*!< @brief original energy levels for CSD, lenght = _nEnergies */
-    Matrix _identity; /*!< @brif: identity matrix for FP scattering. Dim (_nq,_nq)*/
+    Matrix _identity;     /*!< @brief: identity matrix for FP scattering. Dim (_nq,_nq)*/
     double _densityMin;   /*!< @brief Minimal density of _density vector */
 
     void GenerateEnergyGrid( bool refinement );

code/include/solvers/csdsolvertrafofpsh2d.h

@@ -60,7 +60,7 @@ class CSDSolverTrafoFPSH2D : public SNSolver
 
     // Helper variables
     Vector _energiesOrig; /*!< @brief original energy levels for CSD, lenght = _nEnergies */
-    Matrix _identity; /*!< @brif: identity matrix for FP scattering. Dim (_nq,_nq)*/
+    Matrix _identity;     /*!< @brief: identity matrix for FP scattering. Dim (_nq,_nq)*/
     double _densityMin;   /*!< @brief Minimal density of _density vector */
 
   public: