Nektar::Stimulus Class Reference

Stimulus base class. More...

#include <Stimulus.h>

Inheritance diagram for Nektar::Stimulus:

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...

Detailed Description

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 64 of file Stimulus.h.

Constructor & Destructor Documentation

~Stimulus()

virtual Nektar::Stimulus::~Stimulus ( )

inlinevirtual

Definition at line 67 of file Stimulus.h.

    {
    }

Stimulus()

Nektar::Stimulus::Stimulus ( const LibUtilities::SessionReaderSharedPtr &  pSession, const MultiRegions::ExpListSharedPtr &  pField, const TiXmlElement *  pXml  )

protected

Stimulus base class constructor.

Definition at line 64 of file Stimulus.cpp.

{
    m_session = pSession;
    m_field   = pField;
    m_nq      = pField->GetTotPoints();
 
    const TiXmlElement *vProtocol = pXml->FirstChildElement("PROTOCOL");
    string vTypeP                 = vProtocol->Attribute("TYPE");
 
    m_Protocol =
        GetProtocolFactory().CreateInstance(vTypeP, pSession, vProtocol);
}

References Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::GetProtocolFactory(), m_field, m_nq, m_Protocol, and m_session.

Member Function Documentation

GenerateSummary()

void Nektar::Stimulus::GenerateSummary ( SolverUtils::SummaryList &  s )

inline

Print a summary of the outarray.

Definition at line 82 of file Stimulus.h.

    {
        v_GenerateSummary(s);
    }

References v_GenerateSummary().

Initialise()

void Nektar::Stimulus::Initialise

(

)

Initialise the stimulus storage and set initial conditions.

Initialise the stimulus. Allocate workspace and variable storage.

Definition at line 82 of file Stimulus.cpp.

{
}

LoadStimuli()

vector< StimulusSharedPtr > Nektar::Stimulus::LoadStimuli ( const LibUtilities::SessionReaderSharedPtr &  pSession, const MultiRegions::ExpListSharedPtr &  pField  )

static

Definition at line 89 of file Stimulus.cpp.

{
    vector<StimulusSharedPtr> vStimList;
 
    TiXmlElement *vStimuli = pSession->GetElement("Nektar/Stimuli");
    if (vStimuli)
    {
        TiXmlElement *vStimulus = vStimuli->FirstChildElement("STIMULUS");
        while (vStimulus)
        {
            string vType = vStimulus->Attribute("TYPE");
 
            vStimList.push_back(GetStimulusFactory().CreateInstance(
                vType, pSession, pField, vStimulus));
            vStimulus = vStimulus->NextSiblingElement("STIMULUS");
        }
    }
    return vStimList;
}

References Nektar::GetStimulusFactory().

Referenced by Nektar::BidomainRoth::v_InitObject(), and Nektar::Monodomain::v_InitObject().

Update()

void Nektar::Stimulus::Update ( Array< OneD, Array< OneD, NekDouble > > &  outarray, const NekDouble  time  )

inline

Updates RHS of outarray by adding a stimulus to it.

Definition at line 75 of file Stimulus.h.

    {
        v_Update(outarray, time);
    }

References v_Update().

v_GenerateSummary()

virtual void Nektar::Stimulus::v_GenerateSummary ( SolverUtils::SummaryList &  s )

protectedpure virtual

Implemented in Nektar::StimulusCirc, Nektar::StimulusPoint, and Nektar::StimulusRect.

Referenced by GenerateSummary().

v_Update()

virtual void Nektar::Stimulus::v_Update ( Array< OneD, Array< OneD, NekDouble > > &  outarray, const NekDouble  time  )

protectedpure virtual

Implemented in Nektar::StimulusCirc, Nektar::StimulusPoint, and Nektar::StimulusRect.

Referenced by Update().

Member Data Documentation

m_field

MultiRegions::ExpListSharedPtr Nektar::Stimulus::m_field

protected

Transmembrane potential field from PDE system.

Definition at line 95 of file Stimulus.h.

Referenced by Stimulus(), Nektar::StimulusCirc::StimulusCirc(), Nektar::StimulusPoint::StimulusPoint(), Nektar::StimulusRect::StimulusRect(), Nektar::StimulusCirc::v_Update(), and Nektar::StimulusRect::v_Update().

m_nq

int Nektar::Stimulus::m_nq

protected

Number of physical points.

Definition at line 97 of file Stimulus.h.

Referenced by Stimulus(), Nektar::StimulusCirc::StimulusCirc(), Nektar::StimulusPoint::StimulusPoint(), and Nektar::StimulusRect::StimulusRect().

m_Protocol

ProtocolSharedPtr Nektar::Stimulus::m_Protocol

protected

Stimulus protocol to apply.

Definition at line 99 of file Stimulus.h.

Referenced by Stimulus(), Nektar::StimulusCirc::v_Update(), Nektar::StimulusPoint::v_Update(), and Nektar::StimulusRect::v_Update().

m_session

LibUtilities::SessionReaderSharedPtr Nektar::Stimulus::m_session

protected

Session.

Definition at line 93 of file Stimulus.h.

Referenced by Stimulus(), Nektar::StimulusCirc::StimulusCirc(), Nektar::StimulusPoint::StimulusPoint(), and Nektar::StimulusRect::StimulusRect().