Nektar++
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
Nektar::StimulusPoint Class Reference

Protocol base class. More...

#include <StimulusPoint.h>

Inheritance diagram for Nektar::StimulusPoint:
Inheritance graph
[legend]
Collaboration diagram for Nektar::StimulusPoint:
Collaboration graph
[legend]

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< StimulusSharedPtrLoadStimuli (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 >
 

Detailed Description

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.

Constructor & Destructor Documentation

virtual Nektar::StimulusPoint::~StimulusPoint ( )
inlinevirtual

Definition at line 68 of file StimulusPoint.h.

68 {}
Nektar::StimulusPoint::StimulusPoint ( const LibUtilities::SessionReaderSharedPtr pSession,
const MultiRegions::ExpListSharedPtr pField,
const TiXmlElement *  pXml 
)
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.

66  : Stimulus(pSession, pField, pXml)
67  {
68  m_session = pSession;
69  m_field = pField;
70  m_nq = pField->GetTotPoints();
71 
72  if (!pXml)
73  {
74  return;
75  }
76 
77  const TiXmlElement *pXmlparameter;
78 
79  pXmlparameter = pXml->FirstChildElement("p_strength");
80  m_strength = atof(pXmlparameter->GetText());
81  }
LibUtilities::SessionReaderSharedPtr m_session
Session.
Definition: Stimulus.h:93
int m_nq
Number of physical points.
Definition: Stimulus.h:97
Stimulus(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
Definition: Stimulus.cpp:65
MultiRegions::ExpListSharedPtr m_field
Transmembrane potential field from PDE system.
Definition: Stimulus.h:95

Member Function Documentation

static StimulusSharedPtr Nektar::StimulusPoint::create ( const LibUtilities::SessionReaderSharedPtr pSession,
const MultiRegions::ExpListSharedPtr pField,
const TiXmlElement *  pXml 
)
inlinestatic

Creates an instance of this class.

Definition at line 54 of file StimulusPoint.h.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

58  {
60  ::AllocateSharedPtr(pSession, pField, pXml);
61  }
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
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.

88  {
89  }
void Nektar::StimulusPoint::v_GenerateSummary ( SolverUtils::SummaryList s)
protectedvirtual

Implements Nektar::Stimulus.

Definition at line 109 of file StimulusPoint.cpp.

110  {
111  }
void Nektar::StimulusPoint::v_Update ( Array< OneD, Array< OneD, NekDouble > > &  outarray,
const NekDouble  time 
)
protectedvirtual

Implements Nektar::Stimulus.

Definition at line 95 of file StimulusPoint.cpp.

References Nektar::Stimulus::m_Protocol, and m_strength.

98  {
99  // Get the protocol amplitude
100  NekDouble v_amp = m_Protocol->GetAmplitude(time) * m_strength;
101 
102  outarray[0][0] += v_amp;
103  }
ProtocolSharedPtr m_Protocol
Stimulus protocol to apply.
Definition: Stimulus.h:99
double NekDouble

Friends And Related Function Documentation

friend class MemoryManager< StimulusPoint >
friend

Definition at line 66 of file StimulusPoint.h.

Member Data Documentation

std::string Nektar::StimulusPoint::className
static
Initial value:
"StimulusPoint",
"Point stimulus.")

Name of class.

Definition at line 64 of file StimulusPoint.h.

NekDouble Nektar::StimulusPoint::m_strength
protected

Definition at line 74 of file StimulusPoint.h.

Referenced by StimulusPoint(), and v_Update().