max/tug
1
0
Fork 0
mirror of https://git.gfz-potsdam.de/naaice/tug.git synced 2025-12-13 17:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

added comments for public methods

Browse Source
This commit is contained in:
Max Luebke 2021-12-13 13:59:08 +01:00
parent 1bde33cd79
commit dcecc2dd72
1 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/BTCSDiffusion.hpp
View File

@ -12,7 +12,20 @@
*/
typedef Eigen::Triplet<double> T;
/*!
* Defines both types of boundary condition as a datatype.
*/
typedef int bctype;
/*!
* A boundary condition consists of two features. A type and the according
* value. Here we can differentiate between:
*
* - Neumann boundary conditon: type BC_NEUMANN with the value defining the
* gradient
* - Dirichlet boundary condition: type BC_DIRICHLET with the actual value of
* the boundary condition
*/
typedef std::vector<std::tuple<bctype, double>> boundary_condition;
/*!
@ -22,7 +35,13 @@ typedef std::vector<std::tuple<bctype, double>> boundary_condition;
class BTCSDiffusion {
public:
/*!
* Defines a Neumann boundary condition.
*/
static const int BC_NEUMANN;
/*!
* Defines a Dirichlet boundary condition.
*/
static const int BC_DIRICHLET;
/*!
@ -55,12 +74,26 @@ public:
* @param c Vector describing the concentration of one solution of the grid as
* continious memory (Row-wise).
* @param alpha Vector of diffusioncoefficients for each grid element.
* @param timestep Time (in seconds ?) to simulate.
*/
void simulate(std::vector<double> &c, std::vector<double> &alpha);
/*!
* Set the timestep of the simulation
*
* @param time_step Time step (in seconds ???)
*/
void setTimestep(double time_step);
/*!
* Set the boundary condition of the given grid. This is done by defining an
* index (exact order still to be determined), the type of the boundary
* condition and the according value.
*
* @param index Index of the boundary condition vector.
* @param val Value of the boundary condition (gradient for Neumann, exact
* value for Dirichlet).
* @param Type of the grid cell.
*/
void setBoundaryCondition(int index, double val, bctype type);
private: