Nektar++
|
#include <StimulusPoint.h>
Public Member Functions | |
virtual | ~StimulusPoint () |
void | Initialise () |
Initialise the stimulus storage and set initial conditions. More... | |
Public Member Functions inherited from Nektar::Stimulus | |
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 StimulusSharedPtr | create (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml) |
Creates an instance of this class. More... | |
Static Public Member Functions inherited from Nektar::Stimulus | |
static std::vector < StimulusSharedPtr > | LoadStimuli (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField) |
Static Public Attributes | |
static std::string | className |
Name of class. More... | |
Protected Member Functions | |
virtual void | v_Update (Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) |
virtual void | v_GenerateSummary (SolverUtils::SummaryList &s) |
Protected Member Functions inherited from Nektar::Stimulus | |
Stimulus (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml) | |
Protected Attributes | |
NekDouble | m_strength |
Protected Attributes inherited from Nektar::Stimulus | |
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... | |
Private Member Functions | |
StimulusPoint (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml) | |
Friends | |
class | MemoryManager< StimulusPoint > |
Protocol 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 50 of file StimulusPoint.h.
|
inlinevirtual |
Definition at line 68 of file StimulusPoint.h.
|
private |
Stimulus base class constructor.
Definition at line 62 of file StimulusPoint.cpp.
References Nektar::Stimulus::m_field, Nektar::Stimulus::m_nq, Nektar::Stimulus::m_session, and m_strength.
|
inlinestatic |
Creates an instance of this class.
Definition at line 54 of file StimulusPoint.h.
References Nektar::MemoryManager< DataType >::AllocateSharedPtr().
void Nektar::StimulusPoint::Initialise | ( | ) |
Initialise the stimulus storage and set initial conditions.
Initialise the stimulus. Allocate workspace and variable storage.
Definition at line 87 of file StimulusPoint.cpp.
|
protectedvirtual |
|
protectedvirtual |
Implements Nektar::Stimulus.
Definition at line 95 of file StimulusPoint.cpp.
References Nektar::Stimulus::m_Protocol, and m_strength.
|
friend |
Definition at line 66 of file StimulusPoint.h.
|
static |
Name of class.
Definition at line 64 of file StimulusPoint.h.
|
protected |
Definition at line 74 of file StimulusPoint.h.
Referenced by StimulusPoint(), and v_Update().