AMDiS  0.1
The Adaptive Multi-Dimensional Simulation Toolbox
BoundaryCondition< Mat, Sol, Rhs > Class Template Referenceabstract

Interface class for boundary conditions. More...

#include <BoundaryCondition.hpp>

Inherited by DirichletBC< Mat, Sol, Rhs, RowSubBasis, ColSubBasis, ValueGridFct >, and PeriodicBC< Mat, Sol, Rhs, Basis, TP >.

Public Member Functions

 BoundaryCondition ()=default
 Default constructor.
 
virtual void init ()=0
 Initialize the boundary condition. More...
 
virtual void apply (Mat &A, Sol &x, Rhs &b)=0
 Apply the boundary condition to matrix and vector. More...
 

Detailed Description

template<class Mat, class Sol, class Rhs>
class AMDiS::BoundaryCondition< Mat, Sol, Rhs >

Interface class for boundary conditions.

Stores a boundary subset related to the boundary condition. See BoundarySubset.

Template Parameters
MatMatrix
SolVector of solution
RhsVector of rhs

Member Function Documentation

◆ apply()

virtual void apply ( Mat &  A,
Sol &  x,
Rhs &  b 
)
pure virtual

Apply the boundary condition to matrix and vector.

This is called after the matrix A and rhs b are assembled. Implementations may alter values or change the structure of A, x or b.

Implemented in PeriodicBC< Mat, Sol, Rhs, Basis, TP >, and DirichletBC< Mat, Sol, Rhs, RowSubBasis, ColSubBasis, ValueGridFct >.

◆ init()

virtual void init ( )
pure virtual

Initialize the boundary condition.

This performs setup before starting the matrix and vector assembly independantly of the matrix, rhs or solution.

Implemented in PeriodicBC< Mat, Sol, Rhs, Basis, TP >, and DirichletBC< Mat, Sol, Rhs, RowSubBasis, ColSubBasis, ValueGridFct >.


The documentation for this class was generated from the following file: