Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
ConstBoundaryCondition< SPACE_DIM > Class Template Reference

#include <ConstBoundaryCondition.hpp>

+ Inheritance diagram for ConstBoundaryCondition< SPACE_DIM >:
+ Collaboration diagram for ConstBoundaryCondition< SPACE_DIM >:

Public Member Functions

 ConstBoundaryCondition (const double value)
 
double GetValue (const ChastePoint< SPACE_DIM > &rX) const
 
- Public Member Functions inherited from AbstractBoundaryCondition< SPACE_DIM >
 AbstractBoundaryCondition ()
 
virtual ~AbstractBoundaryCondition ()
 

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)
 

Private Attributes

double mValue
 

Friends

class boost::serialization::access
 

Detailed Description

template<unsigned SPACE_DIM>
class ConstBoundaryCondition< SPACE_DIM >

Boundary condition that takes a constant value wherever it is applied.

Definition at line 47 of file ConstBoundaryCondition.hpp.

Constructor & Destructor Documentation

◆ ConstBoundaryCondition()

template<unsigned SPACE_DIM>
ConstBoundaryCondition< SPACE_DIM >::ConstBoundaryCondition ( const double  value)

Create a new boundary condition object.

Parameters
valueThe value of this boundary condition at all points where it is applied.

Definition at line 39 of file ConstBoundaryCondition.cpp.

Member Function Documentation

◆ GetValue()

template<unsigned SPACE_DIM>
double ConstBoundaryCondition< SPACE_DIM >::GetValue ( const ChastePoint< SPACE_DIM > &  rX) const
virtual
Parameters
rXThe point at which this boundary condition is to be evaluated.
Returns
The constant value given in the constructor.

Implements AbstractBoundaryCondition< SPACE_DIM >.

Definition at line 45 of file ConstBoundaryCondition.cpp.

Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::AddNeumannBoundaryCondition().

◆ serialize()

template<unsigned SPACE_DIM>
template<class Archive >
void ConstBoundaryCondition< SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Archive the member variables.

Parameters
archive
version

Definition at line 60 of file ConstBoundaryCondition.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned SPACE_DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 52 of file ConstBoundaryCondition.hpp.

Member Data Documentation

◆ mValue

template<unsigned SPACE_DIM>
double ConstBoundaryCondition< SPACE_DIM >::mValue
private

The constant value of the boundary condition.

Definition at line 66 of file ConstBoundaryCondition.hpp.


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