Nektar::ProtocolSingle Class Reference

Protocol base class. More...

#include <ProtocolSingle.h>

Inheritance diagram for Nektar::ProtocolSingle:

Public Member Functions
virtual	~ProtocolSingle ()
void	Initialise ()
	Initialise the protocol storage and set initial conditions. More...
Public Member Functions inherited from Nektar::Protocol
virtual	~Protocol ()
void	Initialise ()
	Initialise the protocol storage and set initial conditions. More...
NekDouble	GetAmplitude (const NekDouble time)
	Returns amplitude of stimulus (1 or 0) at given time. More...
void	GenerateSummary (SolverUtils::SummaryList &s)
	Print a summary of the cell model. More...

Static Public Member Functions
static ProtocolSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of class. More...

Protected Member Functions
virtual NekDouble	v_GetAmplitude (const NekDouble time)
virtual void	v_GenerateSummary (SolverUtils::SummaryList &s)
virtual void	v_SetInitialConditions ()
Protected Member Functions inherited from Nektar::Protocol
	Protocol (const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)

Protected Attributes
NekDouble	m_start
NekDouble	m_dur
Protected Attributes inherited from Nektar::Protocol
LibUtilities::SessionReaderSharedPtr	m_session
	Session. More...

Private Member Functions
	ProtocolSingle (const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)

Friends
class	MemoryManager< ProtocolSingle >

Detailed Description

Protocol base class.

Definition at line 46 of file ProtocolSingle.h.

Constructor & Destructor Documentation

~ProtocolSingle()

virtual Nektar::ProtocolSingle::~ProtocolSingle ( )

inlinevirtual

Definition at line 63 of file ProtocolSingle.h.

References Initialise().

{}

ProtocolSingle()

Nektar::ProtocolSingle::ProtocolSingle ( const LibUtilities::SessionReaderSharedPtr &  pSession, const TiXmlElement *  pXml  )

private

Protocol base class constructor.

Definition at line 60 of file ProtocolSingle.cpp.

References m_dur, Nektar::Protocol::m_session, and m_start.

            : Protocol(pSession, pXml)
    {
        m_session = pSession;

        if (!pXml)
        {
            return;
        }

        const TiXmlElement *pXmlparameter;

        pXmlparameter = pXml->FirstChildElement("START");
        m_start = atof(pXmlparameter->GetText());

        pXmlparameter = pXml->FirstChildElement("DURATION");
        m_dur = atof(pXmlparameter->GetText());
    }

Member Function Documentation

create()

static ProtocolSharedPtr Nektar::ProtocolSingle::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const TiXmlElement *  pXml  )

inlinestatic

Creates an instance of this class.

Definition at line 50 of file ProtocolSingle.h.

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

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

Initialise()

void Nektar::ProtocolSingle::Initialise

(

)

Initialise the protocol storage and set initial conditions.

Initialise the protocol. Allocate workspace and variable storage.

Definition at line 85 of file ProtocolSingle.cpp.

Referenced by ~ProtocolSingle().

    {
    }

v_GenerateSummary()

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

protectedvirtual

Implements Nektar::Protocol.

Definition at line 109 of file ProtocolSingle.cpp.

    {
    }

v_GetAmplitude()

NekDouble Nektar::ProtocolSingle::v_GetAmplitude ( const NekDouble  time )

protectedvirtual

Implements Nektar::Protocol.

Definition at line 93 of file ProtocolSingle.cpp.

References m_dur, and m_start.

    {
        if(time > m_start && time < (m_start+m_dur))
        {
            return 1.0;
        }
        else
        {
            return 0.0;
        }
    }

v_SetInitialConditions()

void Nektar::ProtocolSingle::v_SetInitialConditions ( )

protectedvirtual

Definition at line 117 of file ProtocolSingle.cpp.

    {
    }

Friends And Related Function Documentation

MemoryManager< ProtocolSingle >

friend class MemoryManager< ProtocolSingle >

friend

Definition at line 61 of file ProtocolSingle.h.

Member Data Documentation

className

std::string Nektar::ProtocolSingle::className

static

Initial value:

= GetProtocolFactory().RegisterCreatorFunction(
                            "ProtocolSingle",
                            ProtocolSingle::create,
                            "Single stimulus protocol.")

Name of class.

Definition at line 59 of file ProtocolSingle.h.

m_dur

NekDouble Nektar::ProtocolSingle::m_dur

protected

Definition at line 70 of file ProtocolSingle.h.

Referenced by ProtocolSingle(), and v_GetAmplitude().

m_start

NekDouble Nektar::ProtocolSingle::m_start

protected

Definition at line 69 of file ProtocolSingle.h.

Referenced by ProtocolSingle(), and v_GetAmplitude().