Chaste  Release::2017.1
StimulusBoundaryCondition< SPACE_DIM > Class Template Reference

#include <StimulusBoundaryCondition.hpp>

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

Public Member Functions

 StimulusBoundaryCondition (AbstractStimulusFunction *pStimulus)
 
double GetValue (const ChastePoint< SPACE_DIM > &rX) const
 
- Public Member Functions inherited from AbstractBoundaryCondition< SPACE_DIM >
 AbstractBoundaryCondition ()
 
virtual ~AbstractBoundaryCondition ()
 

Private Attributes

AbstractStimulusFunctionmpStimulus
 

Detailed Description

template<unsigned SPACE_DIM>
class StimulusBoundaryCondition< SPACE_DIM >

Boundary condition defined by an AbstractStimlus object.

Definition at line 47 of file StimulusBoundaryCondition.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>
StimulusBoundaryCondition< SPACE_DIM >::StimulusBoundaryCondition ( AbstractStimulusFunction pStimulus)

Create a new boundary condition object.

Parameters
pStimulusStimulus object defining the parameters of the boundary condition

Definition at line 40 of file StimulusBoundaryCondition.cpp.

Member Function Documentation

template<unsigned SPACE_DIM>
double StimulusBoundaryCondition< 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 46 of file StimulusBoundaryCondition.cpp.

References PdeSimulationTime::GetTime().

Member Data Documentation

template<unsigned SPACE_DIM>
AbstractStimulusFunction* StimulusBoundaryCondition< SPACE_DIM >::mpStimulus
private

A pointer to the stimulus that is to be applied as a boundary condition

Definition at line 51 of file StimulusBoundaryCondition.hpp.


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