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

Interface class for boundary conditions. More...

#include <BoundaryCondition.hpp>

Inherits Base.

Public Member Functions

template<class Impl , Dune::disableCopyMove< BoundaryCondition, Impl > = 0>
 BoundaryCondition (Impl &&impl)
 Constructor. Pass any type supporting the BoundaryConditionInterface.
 
 BoundaryCondition ()=default
 Default Constructor.
 
void init ()
 Initialize the boundary condition. More...
 
void apply (Mat &A, Sol &x, Rhs &b)
 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()

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

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.

◆ init()

void init ( )
inline

Initialize the boundary condition.

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


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