Nektar++
|
#include <Stimulus.h>
Public Member Functions | |
virtual | ~Stimulus () |
void | Initialise () |
Initialise the stimulus storage and set initial conditions. More... | |
void | Update (Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) |
Updates RHS of outarray by adding a stimulus to it. More... | |
void | GenerateSummary (SolverUtils::SummaryList &s) |
Print a summary of the outarray. More... | |
Static Public Member Functions | |
static std::vector < StimulusSharedPtr > | LoadStimuli (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField) |
Protected Member Functions | |
Stimulus (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml) | |
virtual void | v_Update (Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)=0 |
virtual void | v_GenerateSummary (SolverUtils::SummaryList &s)=0 |
Protected Attributes | |
LibUtilities::SessionReaderSharedPtr | m_session |
Session. More... | |
MultiRegions::ExpListSharedPtr | m_field |
Transmembrane potential field from PDE system. More... | |
int | m_nq |
Number of physical points. More... | |
ProtocolSharedPtr | m_Protocol |
Stimulus protocol to apply. More... | |
Stimulus base class.
The Stimulus class and derived classes implement a range of stimuli. The stimulus contains input stimuli that can be applied throughout the domain, on specified regions determined by the derived classes of Stimulus, at specified frequencies determined by the derived classes of Protocol.
Definition at line 66 of file Stimulus.h.
|
inlinevirtual |
Definition at line 69 of file Stimulus.h.
|
protected |
Stimulus base class constructor.
Definition at line 67 of file Stimulus.cpp.
References Nektar::LibUtilities::NekFactory< tKey, tBase, >::CreateInstance(), and Nektar::GetProtocolFactory().
|
inline |
Print a summary of the outarray.
Definition at line 82 of file Stimulus.h.
References v_GenerateSummary().
void Nektar::Stimulus::Initialise | ( | ) |
Initialise the stimulus storage and set initial conditions.
Initialise the stimulus. Allocate workspace and variable storage.
Definition at line 87 of file Stimulus.cpp.
|
static |
Definition at line 95 of file Stimulus.cpp.
References Nektar::GetStimulusFactory().
Referenced by Nektar::BidomainRoth::v_InitObject(), and Nektar::Monodomain::v_InitObject().
|
inline |
Updates RHS of outarray by adding a stimulus to it.
Definition at line 75 of file Stimulus.h.
References v_Update().
|
protectedpure virtual |
Implemented in Nektar::StimulusCirc, Nektar::StimulusRect, and Nektar::StimulusPoint.
Referenced by GenerateSummary().
|
protectedpure virtual |
Implemented in Nektar::StimulusCirc, Nektar::StimulusRect, and Nektar::StimulusPoint.
Referenced by Update().
|
protected |
Transmembrane potential field from PDE system.
Definition at line 95 of file Stimulus.h.
Referenced by Nektar::StimulusCirc::StimulusCirc(), Nektar::StimulusPoint::StimulusPoint(), Nektar::StimulusRect::StimulusRect(), Nektar::StimulusRect::v_Update(), and Nektar::StimulusCirc::v_Update().
|
protected |
Number of physical points.
Definition at line 97 of file Stimulus.h.
Referenced by Nektar::StimulusCirc::StimulusCirc(), Nektar::StimulusPoint::StimulusPoint(), and Nektar::StimulusRect::StimulusRect().
|
protected |
Stimulus protocol to apply.
Definition at line 99 of file Stimulus.h.
Referenced by Nektar::StimulusPoint::v_Update(), Nektar::StimulusRect::v_Update(), and Nektar::StimulusCirc::v_Update().
|
protected |
Session.
Definition at line 93 of file Stimulus.h.
Referenced by Nektar::StimulusCirc::StimulusCirc(), Nektar::StimulusPoint::StimulusPoint(), and Nektar::StimulusRect::StimulusRect().