StimulusBoundaryCondition< SPACE_DIM > Class Template Reference

#include <StimulusBoundaryCondition.hpp>

Inheritance diagram for StimulusBoundaryCondition< SPACE_DIM >:

[legend]

Collaboration diagram for StimulusBoundaryCondition< SPACE_DIM >:

[legend]

List of all members.

Public Member Functions
	StimulusBoundaryCondition (AbstractStimulusFunction *pStimulus)
double	GetValue (const ChastePoint< SPACE_DIM > &rX) const
Private Attributes
AbstractStimulusFunction *	mpStimulus

---

Detailed Description

template<unsigned SPACE_DIM>
class StimulusBoundaryCondition< SPACE_DIM >

Boundary condition defined by an AbstractStimlus object.

Definition at line 40 of file StimulusBoundaryCondition.hpp.

---

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

StimulusBoundaryCondition< SPACE_DIM >::StimulusBoundaryCondition

(

AbstractStimulusFunction *

pStimulus

)

[inline]

Create a new boundary condition object.

Parameters:

pStimulus

Stimulus object defining the parameters of the boundary condition

Definition at line 33 of file StimulusBoundaryCondition.cpp.

References StimulusBoundaryCondition< SPACE_DIM >::mpStimulus.

---

Member Function Documentation

template<unsigned SPACE_DIM>

double StimulusBoundaryCondition< 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 39 of file StimulusBoundaryCondition.cpp.

References AbstractStimulusFunction::GetStimulus(), PdeSimulationTime::GetTime(), and StimulusBoundaryCondition< SPACE_DIM >::mpStimulus.

---

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

Referenced by StimulusBoundaryCondition< SPACE_DIM >::GetValue(), and StimulusBoundaryCondition< SPACE_DIM >::StimulusBoundaryCondition().

---

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

• heart/src/stimulus/StimulusBoundaryCondition.hpp
• heart/src/stimulus/StimulusBoundaryCondition.cpp