commentary

This commit is contained in:
philippun 2023-08-03 16:52:16 +02:00
parent fbdeba00a2
commit ad2fdabac9
3 changed files with 9 additions and 10 deletions

View File

@ -66,8 +66,7 @@ class Boundary {
/** /**
* @brief Construct a new Boundary object * @brief Construct a new Boundary object
* *
* @param grid * @param grid
* @param type
*/ */
Boundary(Grid grid); Boundary(Grid grid);

View File

@ -6,10 +6,10 @@ class Grid {
public: public:
/** /**
* @brief Construct a new Grid object * @brief Construct a new 1D Grid object, which represents the fields holding the concentrations.
* *
* @param col * @param col Defines the length of the grid in terms of cells. Input must be an integer > 3.
*/ */
Grid(int col); Grid(int col);
/** /**
@ -33,7 +33,7 @@ class Grid {
/** /**
* @brief Get the Concentrations object * @brief Get the Concentrations object
* *
* @return auto * @return MatrixXd
*/ */
MatrixXd getConcentrations(); MatrixXd getConcentrations();

View File

@ -4,8 +4,8 @@
using namespace std; using namespace std;
enum APPROACH { enum APPROACH {
FTCS_APPROACH, FTCS_APPROACH, // Forward Time-Centered Space
BTCS_APPROACH BTCS_APPROACH // Backward Time-Centered Space
}; };
enum CSV_OUTPUT { enum CSV_OUTPUT {
@ -23,7 +23,7 @@ enum CONSOLE_OUTPUT {
enum TIME_MEASURE { enum TIME_MEASURE {
TIME_MEASURE_OFF, // do not print any time measures TIME_MEASURE_OFF, // do not print any time measures
TIME_MEASURE_ON, // print one time measure after all iterations TIME_MEASURE_ON, // print time measure after last iteration
TIME_MEASURE_VERBOSE // print time measures after each iteration TIME_MEASURE_VERBOSE // print time measures after each iteration
}; };