Chaste Release::3.1
Public Member Functions | Private Member Functions | Private Attributes | Friends
ConstBoundaryCondition< SPACE_DIM > Class Template Reference

#include <ConstBoundaryCondition.hpp>

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

List of all members.

Public Member Functions

 ConstBoundaryCondition (const double value)
double GetValue (const ChastePoint< SPACE_DIM > &rX) const

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

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

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().

template<unsigned SPACE_DIM>
template<class Archive >
void ConstBoundaryCondition< SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Archive the member variables.

Parameters:
archive
version

Reimplemented from AbstractBoundaryCondition< SPACE_DIM >.

Definition at line 60 of file ConstBoundaryCondition.hpp.

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractBoundaryCondition< SPACE_DIM >.

Definition at line 52 of file ConstBoundaryCondition.hpp.

Member Data Documentation

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: