ConstBoundaryCondition< SPACE_DIM > Class Template Reference

#include <ConstBoundaryCondition.hpp>

Inheritance diagram for ConstBoundaryCondition< SPACE_DIM >:

Inheritance graph
[legend]
Collaboration diagram for ConstBoundaryCondition< SPACE_DIM >:

Collaboration graph
[legend]

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 39 of file ConstBoundaryCondition.hpp.


Constructor & Destructor Documentation

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

Create a new boundary condition object.

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

Definition at line 32 of file ConstBoundaryCondition.cpp.


Member Function Documentation

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 52 of file ConstBoundaryCondition.hpp.

template<unsigned SPACE_DIM>
double ConstBoundaryCondition< SPACE_DIM >::GetValue ( const ChastePoint< SPACE_DIM > &  rX  )  const [inline, virtual]

Parameters:
rX The 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 38 of file ConstBoundaryCondition.cpp.

References ConstBoundaryCondition< SPACE_DIM >::mValue.

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


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 44 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 58 of file ConstBoundaryCondition.hpp.

Referenced by ConstBoundaryCondition< SPACE_DIM >::GetValue().


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

Generated on Mon Nov 1 12:36:26 2010 for Chaste by  doxygen 1.5.5