Nektar::StimulusCirc Class Reference

Protocol base class. More...

#include <StimulusCircle.h>

Inheritance diagram for Nektar::StimulusCirc:

Public Member Functions
	~StimulusCirc () override
void	Initialise ()
	Initialise the protocol 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
void	v_Update (Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) override
void	v_GenerateSummary (SolverUtils::SummaryList &s) override
Protected Member Functions inherited from Nektar::Stimulus
	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
NekDouble	m_px1
NekDouble	m_py1
NekDouble	m_pz1
NekDouble	m_pr1
NekDouble	m_pis
NekDouble	m_strength
NekDouble	v_amp
NekDouble	m_chiCapMembrane
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
	StimulusCirc (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)

Friends
class	MemoryManager< StimulusCirc >

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 52 of file StimulusCircle.h.

Constructor & Destructor Documentation

~StimulusCirc()

Nektar::StimulusCirc::~StimulusCirc ( )

inlineoverride

Definition at line 69 of file StimulusCircle.h.

    {
    }

StimulusCirc()

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

private

Stimulus base class constructor.

Definition at line 58 of file StimulusCircle.cpp.

    : Stimulus(pSession, pField, pXml)
{
    m_session = pSession;
    m_field   = pField;
    m_nq      = pField->GetTotPoints();
    m_chiCapMembrane =
        m_session->GetParameter("chi") * m_session->GetParameter("Cm");
 
    if (!pXml)
    {
        return;
    }
 
    const TiXmlElement *pXmlparameter;
 
    pXmlparameter = pXml->FirstChildElement("p_x1");
    m_px1         = atof(pXmlparameter->GetText());
 
    pXmlparameter = pXml->FirstChildElement("p_y1");
    m_py1         = atof(pXmlparameter->GetText());
 
    pXmlparameter = pXml->FirstChildElement("p_z1");
    m_pz1         = atof(pXmlparameter->GetText());
 
    pXmlparameter = pXml->FirstChildElement("p_r1");
    m_pr1         = atof(pXmlparameter->GetText());
 
    pXmlparameter = pXml->FirstChildElement("p_is");
    m_pis         = atof(pXmlparameter->GetText());
 
    pXmlparameter = pXml->FirstChildElement("p_strength");
    m_strength    = atof(pXmlparameter->GetText());
}

References m_chiCapMembrane, Nektar::Stimulus::m_field, Nektar::Stimulus::m_nq, m_pis, m_pr1, m_px1, m_py1, m_pz1, Nektar::Stimulus::m_session, and m_strength.

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 56 of file StimulusCircle.h.

    {
        return MemoryManager<StimulusCirc>::AllocateSharedPtr(pSession, pField,
                                                              pXml);
    }

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

Initialise()

void Nektar::StimulusCirc::Initialise

(

)

Initialise the protocol storage and set initial conditions.

Initialise the stimulus. Allocate workspace and variable storage.

Definition at line 98 of file StimulusCircle.cpp.

{
}

v_GenerateSummary()

void Nektar::StimulusCirc::v_GenerateSummary ( SolverUtils::SummaryList &  s )

overrideprotectedvirtual

Implements Nektar::Stimulus.

Definition at line 167 of file StimulusCircle.cpp.

{
}

v_Update()

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

overrideprotectedvirtual

Implements Nektar::Stimulus.

Definition at line 105 of file StimulusCircle.cpp.

{
    // Get the dimension of the expansion
    int dim = m_field->GetCoordim(0);
 
    // Retrieve coodrinates of quadrature points
    int nq = m_field->GetNpoints();
    Array<OneD, NekDouble> x0(nq);
    Array<OneD, NekDouble> x1(nq);
    Array<OneD, NekDouble> x2(nq);
 
    // Get the protocol amplitude
    NekDouble v_amp = m_Protocol->GetAmplitude(time) * m_strength;
 
    // get the coordinates
    m_field->GetCoords(x0, x1, x2);
 
    switch (dim)
    {
        case 1:
            for (int j = 0; j < nq; j++)
            {
                outarray[0][j] +=
                    v_amp * (-tanh((m_pis * x0[j] - m_px1 + m_pr1) *
                                   (m_pis * x0[j] - m_px1 - m_pr1)) /
                                 2.0 +
                             0.5);
            }
            break;
        case 2:
            for (int j = 0; j < nq; j++)
            {
                outarray[0][j] +=
                    v_amp * (-tanh((m_pis * x0[j] - m_px1 + m_pr1) *
                                       (m_pis * x0[j] - m_px1 - m_pr1) +
                                   (m_pis * x1[j] - m_py1 + m_pr1) *
                                       (m_pis * x1[j] - m_py1 - m_pr1)) /
                                 2.0 +
                             0.5);
            }
            break;
        case 3:
            for (int j = 0; j < nq; j++)
            {
                outarray[0][j] +=
                    v_amp * (-tanh((m_pis * x0[j] - m_px1 + m_pr1) *
                                       (m_pis * x0[j] - m_px1 - m_pr1) +
                                   (m_pis * x1[j] - m_py1 + m_pr1) *
                                       (m_pis * x1[j] - m_py1 - m_pr1) +
                                   (m_pis * x2[j] - m_pz1 + m_pr1) *
                                       (m_pis * x2[j] - m_pz1 - m_pr1)) /
                                 2.0 +
                             0.5);
            }
            break;
    }
}

References Nektar::Stimulus::m_field, m_pis, m_pr1, Nektar::Stimulus::m_Protocol, m_px1, m_py1, m_pz1, m_strength, and v_amp.

Friends And Related Function Documentation

MemoryManager< StimulusCirc >

friend class MemoryManager< StimulusCirc >

friend

Definition at line 65 of file StimulusCircle.h.

Member Data Documentation

className

std::string Nektar::StimulusCirc::className

static

Initial value:

=
    GetStimulusFactory().RegisterCreatorFunction(
        "StimulusCirc", StimulusCirc::create, "Circular stimulus.")

Name of class.

Definition at line 65 of file StimulusCircle.h.

m_chiCapMembrane

NekDouble Nektar::StimulusCirc::m_chiCapMembrane

protected

Definition at line 84 of file StimulusCircle.h.

Referenced by StimulusCirc().

m_pis

NekDouble Nektar::StimulusCirc::m_pis

protected

Definition at line 81 of file StimulusCircle.h.

Referenced by StimulusCirc(), and v_Update().

m_pr1

NekDouble Nektar::StimulusCirc::m_pr1

protected

Definition at line 80 of file StimulusCircle.h.

Referenced by StimulusCirc(), and v_Update().

m_px1

NekDouble Nektar::StimulusCirc::m_px1

protected

Definition at line 77 of file StimulusCircle.h.

Referenced by StimulusCirc(), and v_Update().

m_py1

NekDouble Nektar::StimulusCirc::m_py1

protected

Definition at line 78 of file StimulusCircle.h.

Referenced by StimulusCirc(), and v_Update().

m_pz1

NekDouble Nektar::StimulusCirc::m_pz1

protected

Definition at line 79 of file StimulusCircle.h.

Referenced by StimulusCirc(), and v_Update().

m_strength

NekDouble Nektar::StimulusCirc::m_strength

protected

Definition at line 82 of file StimulusCircle.h.

Referenced by StimulusCirc(), and v_Update().

v_amp

NekDouble Nektar::StimulusCirc::v_amp

protected

Definition at line 83 of file StimulusCircle.h.

Referenced by v_Update().