Nektar::Protocol Class Reference

Protocol base class. More...

#include <Protocol.h>

Inheritance diagram for Nektar::Protocol:

Public Member Functions
	Protocol (const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
virtual	~Protocol ()
void	Initialise ()
	Initialise the protocol storage and set initial conditions.
NekDouble	GetAmplitude (const NekDouble time)
	Returns amplitude of stimulus (1 or 0) at given time.
void	GenerateSummary (SolverUtils::SummaryList &s)
	Print a summary of the cell model.

Protected Member Functions
virtual NekDouble	v_GetAmplitude (const NekDouble time)=0
virtual void	v_GenerateSummary (SolverUtils::SummaryList &s)=0

Protected Attributes
LibUtilities::SessionReaderSharedPtr	m_session
	Session.

Detailed Description

Protocol base class.

The Stimuli 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 60 of file Protocol.h.

Constructor & Destructor Documentation

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

Protocol base class constructor.

Definition at line 61 of file Protocol.cpp.

References m_session.

    {
        m_session = pSession;
    }

virtual Nektar::Protocol::~Protocol ( )

inlinevirtual

Definition at line 66 of file Protocol.h.

{}

Member Function Documentation

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

inline

Print a summary of the cell model.

Definition at line 78 of file Protocol.h.

References v_GenerateSummary().

        {
            v_GenerateSummary(s);
        }

NekDouble Nektar::Protocol::GetAmplitude ( const NekDouble  time )

inline

Returns amplitude of stimulus (1 or 0) at given time.

Definition at line 72 of file Protocol.h.

References v_GetAmplitude().

        {
            return v_GetAmplitude(time);
        }

void Nektar::Protocol::Initialise

(

)

Initialise the protocol storage and set initial conditions.

Initialise the protocol. Allocate workspace and variable storage.

Reimplemented in Nektar::ProtocolS1, Nektar::ProtocolSingle, and Nektar::ProtocolS1S2.

Definition at line 71 of file Protocol.cpp.

    {
        
        
    }

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

protectedpure virtual

Implemented in Nektar::ProtocolS1S2, Nektar::ProtocolS1, and Nektar::ProtocolSingle.

Referenced by GenerateSummary().

virtual NekDouble Nektar::Protocol::v_GetAmplitude ( const NekDouble  time )

protectedpure virtual

Implemented in Nektar::ProtocolS1S2, Nektar::ProtocolS1, and Nektar::ProtocolSingle.

Referenced by GetAmplitude().

Member Data Documentation

LibUtilities::SessionReaderSharedPtr Nektar::Protocol::m_session

protected

Session.

Definition at line 85 of file Protocol.h.

Referenced by Protocol(), Nektar::ProtocolS1::ProtocolS1(), Nektar::ProtocolS1S2::ProtocolS1S2(), and Nektar::ProtocolSingle::ProtocolSingle().