Commit 2557dcb8 authored by Steffen Schotthöfer's avatar Steffen Schotthöfer
Browse files

more documentation


Former-commit-id: 89068dc9
parent 3ac7e043
...@@ -27,7 +27,7 @@ class OptionBase; ...@@ -27,7 +27,7 @@ class OptionBase;
class Config class Config
{ {
private: 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; bool _baseConfig;
// int _commRank, _commSize; /*!< @brief MPI rank and size.*/ // Not yet used!! // int _commRank, _commSize; /*!< @brief MPI rank and size.*/ // Not yet used!!
......
/*! /*!
* \file GlobalConstants.h * \file globalconstants.h
* \brief All global defined (physical) constants, enums etc * \brief All global defined (physical) constants, enums etc
* \author <blank> * \author <blank>
* \version 0.0 * \version 0.0
......
...@@ -10,10 +10,10 @@ class Config; ...@@ -10,10 +10,10 @@ class Config;
class Mesh; class Mesh;
/*! @brief Function to export solver Volume output to VTK file. /*! @brief Function to export solver Volume output to VTK file.
* @param filename: Filename of output file * @param fileName Filename of output file
* @param outputFields: numerical output of the solver. Dimensions: (OutputGroupSize, OutputFieldSize, NumberMeshCells) * @param outputFields numerical output of the solver. Dimensions: (OutputGroupSize, OutputFieldSize, NumberMeshCells)
* @param outputFieldNames: names of the outputfields. Dimensions: (OutputGroupSize, OutputFieldSize) * @param outputFieldNames names of the outputfields. Dimensions: (OutputGroupSize, OutputFieldSize)
* @param mesh: Mesh with <NumberMeshCells> cells (the mesh used for the computation) * @param mesh Mesh with cells (the mesh used for the computation)
*/ */
void ExportVTK( const std::string fileName, void ExportVTK( const std::string fileName,
const std::vector<std::vector<std::vector<double>>>& outputFields, const std::vector<std::vector<std::vector<double>>>& outputFields,
......
/*! /*!
* \file OptionStructure.h * \file optionstructure.h
* \brief Classes for different Options in rtsn * \brief Classes for different Options in KiT-RT
* \author S. Schotthoefer
*
* Disclaimer: This class structure was copied and modifed with open source permission from SU2 v7.0.3 https://su2code.github.io/
*/ */
#ifndef OPTION_STRUCTURE_H #ifndef OPTION_STRUCTURE_H
......
...@@ -20,19 +20,19 @@ class NumericalFlux ...@@ -20,19 +20,19 @@ class NumericalFlux
virtual double Flux( const Vector& Omega, double psiL, double psiR, const Vector& n ) const = 0; 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 * resultFlux
* @param AxPlus : Positive part of the flux jacobian in x direction * @param AxPlus Positive part of the flux jacobian in x direction
* @param AxMinus : Negative 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 AyPlus Positive part of the flux jacobian in y direction
* @param AyMinus : Negative 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 AzPlus Positive part of the flux jacobian in z direction
* @param AzMinus : Negative 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 psiL Solution state of left hand side control volume
* @param psiR : Solution state of right 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 n Normal vector at the edge between left and right control volume
* @param resultFlux: Vector with resulting flux. * @param resultFlux Vector with resulting flux.
* @return : void * @return void
*/ */
virtual Vector Flux( const Matrix AxPlus, virtual Vector Flux( const Matrix AxPlus,
const Matrix AxMinus, const Matrix AxMinus,
......
...@@ -23,19 +23,19 @@ class UpwindFlux : public NumericalFlux ...@@ -23,19 +23,19 @@ class UpwindFlux : public NumericalFlux
double Flux( const Vector& Omega, double psiL, double psiR, const Vector& n ) const override; 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 * resultFlux
* @param AxPlus : Positive part of the flux jacobian in x direction * @param AxPlus Positive part of the flux jacobian in x direction
* @param AxMinus : Negative 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 AyPlus Positive part of the flux jacobian in y direction
* @param AyMinus : Negative 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 AzPlus Positive part of the flux jacobian in z direction
* @param AzMinus : Negative 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 psiL Solution state of left hand side control volume
* @param psiR : Solution state of right 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 n Normal vector at the edge between left and right control volume
* @param resultFlux: Vector with resulting flux. * @param resultFlux Vector with resulting flux.
* @return : void * @return void
*/ */
Vector Flux( const Matrix AxPlus, Vector Flux( const Matrix AxPlus,
const Matrix AxMinus, const Matrix AxMinus,
...@@ -48,19 +48,19 @@ class UpwindFlux : public NumericalFlux ...@@ -48,19 +48,19 @@ class UpwindFlux : public NumericalFlux
const Vector n ) const override; 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 * resultFlux
* @param AxPlus : Positive part of the flux jacobian in x direction * @param AxPlus Positive part of the flux jacobian in x direction
* @param AxMinus : Negative 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 AyPlus Positive part of the flux jacobian in y direction
* @param AyMinus : Negative 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 AzPlus Positive part of the flux jacobian in z direction
* @param AzMinus : Negative 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 psiL Solution state of left hand side control volume
* @param psiR : Solution state of right 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 n Normal vector at the edge between left and right control volume
* @param resultFlux: Vector with resulting flux. * @param resultFlux Vector with resulting flux.
* @return : void * @return void
*/ */
void FluxVanLeer( const Matrix& Ax, void FluxVanLeer( const Matrix& Ax,
const Matrix& AxAbs, const Matrix& AxAbs,
......
...@@ -18,10 +18,10 @@ class Checkerboard_SN : public ProblemBase ...@@ -18,10 +18,10 @@ class Checkerboard_SN : public ProblemBase
Checkerboard_SN( Config* settings, Mesh* mesh ); Checkerboard_SN( Config* settings, Mesh* mesh );
virtual ~Checkerboard_SN(); virtual ~Checkerboard_SN();
virtual VectorVector GetScatteringXS( const Vector& energies ); virtual VectorVector GetScatteringXS( const Vector& energies ) override;
virtual VectorVector GetTotalXS( const Vector& energies ); virtual VectorVector GetTotalXS( const Vector& energies ) override;
virtual std::vector<VectorVector> GetExternalSource( const Vector& energies ); virtual std::vector<VectorVector> GetExternalSource( const Vector& energies ) override;
virtual VectorVector SetupIC(); virtual VectorVector SetupIC() override;
}; };
class Checkerboard_PN : public ProblemBase class Checkerboard_PN : public ProblemBase
...@@ -49,10 +49,10 @@ class Checkerboard_PN : public ProblemBase ...@@ -49,10 +49,10 @@ class Checkerboard_PN : public ProblemBase
Checkerboard_PN( Config* settings, Mesh* mesh ); Checkerboard_PN( Config* settings, Mesh* mesh );
virtual ~Checkerboard_PN(); virtual ~Checkerboard_PN();
virtual VectorVector GetScatteringXS( const Vector& energies ); virtual VectorVector GetScatteringXS( const Vector& energies ) override;
virtual VectorVector GetTotalXS( const Vector& energies ); virtual VectorVector GetTotalXS( const Vector& energies ) override;
virtual std::vector<VectorVector> GetExternalSource( const Vector& energies ); virtual std::vector<VectorVector> GetExternalSource( const Vector& energies ) override;
virtual VectorVector SetupIC(); virtual VectorVector SetupIC() override;
}; };
#endif // CHECKERBOARD_H #endif // CHECKERBOARD_H
...@@ -23,5 +23,4 @@ class IsotropicSource2D : public ElectronRT ...@@ -23,5 +23,4 @@ class IsotropicSource2D : public ElectronRT
std::vector<double> GetDensity( const VectorVector& cellMidPoints ); std::vector<double> GetDensity( const VectorVector& cellMidPoints );
}; };
#endif // ISOTROPICSOURCE2D_H #endif // ISOTROPICSOURCE2D_H
...@@ -28,8 +28,8 @@ class CSDSolverTrafoFP : public SNSolver ...@@ -28,8 +28,8 @@ class CSDSolverTrafoFP : public SNSolver
Vector _xi1; Vector _xi1;
Vector _xi2; Vector _xi2;
unsigned _FPMethod; /*!< @brief Encodes different ways of computing coefficients alpha, alpha2 & beta, _FPMethod == 1, 2 ,3 stand for methods with unsigned _FPMethod; /*!< @brief Encodes different ways of computing coefficients alpha, alpha2 & beta, _FPMethod == 1, 2 ,3 stand for methods
increasing accuracy (see Olbrant 2010, Appendix B)*/ with increasing accuracy (see Olbrant 2010, Appendix B)*/
bool _RT; /*!< @brief radiotherapy application (on/off), if true use crosssections + stopping powers from database */ bool _RT; /*!< @brief radiotherapy application (on/off), if true use crosssections + stopping powers from database */
...@@ -40,7 +40,7 @@ class CSDSolverTrafoFP : public SNSolver ...@@ -40,7 +40,7 @@ class CSDSolverTrafoFP : public SNSolver
// Helper variables // Helper variables
Vector _energiesOrig; /*!< @brief original energy levels for CSD, lenght = _nEnergies */ 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: public:
/** /**
......
...@@ -45,7 +45,7 @@ class CSDSolverTrafoFP2D : public SNSolver ...@@ -45,7 +45,7 @@ class CSDSolverTrafoFP2D : public SNSolver
// Helper variables // Helper variables
Vector _energiesOrig; /*!< @brief original energy levels for CSD, lenght = _nEnergies */ 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 */ double _densityMin; /*!< @brief Minimal density of _density vector */
void GenerateEnergyGrid( bool refinement ); void GenerateEnergyGrid( bool refinement );
......
...@@ -60,7 +60,7 @@ class CSDSolverTrafoFPSH2D : public SNSolver ...@@ -60,7 +60,7 @@ class CSDSolverTrafoFPSH2D : public SNSolver
// Helper variables // Helper variables
Vector _energiesOrig; /*!< @brief original energy levels for CSD, lenght = _nEnergies */ 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 */ double _densityMin; /*!< @brief Minimal density of _density vector */
public: public:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment