All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Nektar::Protocol Class Referenceabstract

Protocol base class. More...

#include <Protocol.h>

Inheritance diagram for Nektar::Protocol:
Inheritance graph

Public Member Functions

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

Protected Member Functions

 Protocol (const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
virtual NekDouble v_GetAmplitude (const NekDouble time)=0
virtual void v_GenerateSummary (SolverUtils::SummaryList &s)=0

Protected Attributes

LibUtilities::SessionReaderSharedPtr m_session
 Session. More...

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

virtual Nektar::Protocol::~Protocol ( )

Definition at line 63 of file Protocol.h.

63 {}
Nektar::Protocol::Protocol ( const LibUtilities::SessionReaderSharedPtr pSession,
const TiXmlElement *  pXml 

Protocol base class constructor.

Definition at line 61 of file Protocol.cpp.

63  : m_session(pSession)
64  {
65  }
LibUtilities::SessionReaderSharedPtr m_session
Definition: Protocol.h:82

Member Function Documentation

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

Print a summary of the cell model.

Definition at line 75 of file Protocol.h.

References v_GenerateSummary().

76  {
78  }
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)=0
NekDouble Nektar::Protocol::GetAmplitude ( const NekDouble  time)

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

Definition at line 69 of file Protocol.h.

References v_GetAmplitude().

70  {
71  return v_GetAmplitude(time);
72  }
virtual NekDouble v_GetAmplitude(const NekDouble time)=0
void Nektar::Protocol::Initialise ( )

Initialise the protocol storage and set initial conditions.

Initialise the protocol. Allocate workspace and variable storage.

Definition at line 71 of file Protocol.cpp.

72  {
73  }
virtual void Nektar::Protocol::v_GenerateSummary ( SolverUtils::SummaryList s)
protectedpure virtual
virtual NekDouble Nektar::Protocol::v_GetAmplitude ( const NekDouble  time)
protectedpure virtual

Member Data Documentation

LibUtilities::SessionReaderSharedPtr Nektar::Protocol::m_session