BioDynaMo  v1.05.119-a4ff3934
Public Member Functions | List of all members
bdm::BoundaryCondition Class Referenceabstract

This class implements the boundary conditions. It is integrated into the diffusion grid as a smart pointer. The diffusion grid will call the Evaluate() method of the boundary condition object for Neumann and Dirichlet boundary conditions. More...

#include <diffusion_grid.h>

Inheritance diagram for bdm::BoundaryCondition:
[legend]

Public Member Functions

 BoundaryCondition ()=default
 
 BoundaryCondition (const TRootIOCtor *)
 
virtual ~BoundaryCondition ()=default
 
virtual real_t Evaluate (real_t x, real_t y, real_t z, real_t time) const =0
 Boundary condition for Neumann and Dirichlet boundary conditions. More...
 
 BDM_CLASS_DEF (BoundaryCondition, 1)
 

Detailed Description

This class implements the boundary conditions. It is integrated into the diffusion grid as a smart pointer. The diffusion grid will call the Evaluate() method of the boundary condition object for Neumann and Dirichlet boundary conditions.

Definition at line 49 of file diffusion_grid.h.

Constructor & Destructor Documentation

◆ BoundaryCondition() [1/2]

bdm::BoundaryCondition::BoundaryCondition ( )
default

◆ BoundaryCondition() [2/2]

bdm::BoundaryCondition::BoundaryCondition ( const TRootIOCtor *  )
inlineexplicit

Definition at line 52 of file diffusion_grid.h.

◆ ~BoundaryCondition()

virtual bdm::BoundaryCondition::~BoundaryCondition ( )
virtualdefault

Member Function Documentation

◆ BDM_CLASS_DEF()

bdm::BoundaryCondition::BDM_CLASS_DEF ( BoundaryCondition  ,
 
)

◆ Evaluate()

virtual real_t bdm::BoundaryCondition::Evaluate ( real_t  x,
real_t  y,
real_t  z,
real_t  time 
) const
pure virtual

Boundary condition for Neumann and Dirichlet boundary conditions.

Parameters
xx coordinate
yy coordinate
zz coordinate
timeTime of the simulation (for time-dependent boundary conditions)
Returns
The value of the boundary condition at the given position and time

Implemented in bdm::ConstantBoundaryCondition.


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