Nektar++
ProtocolS1S2.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File ProtocolS1S2.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Protocol S1S2 stimulus.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_PROTOCOLS1S2
37 #define NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_PROTOCOLS1S2
39 
40 namespace Nektar
41 {
42  // Forward declaration
43  class ProtocolS1S2;
44 
45  /// Protocol base class.
46  class ProtocolS1S2 : public Protocol
47  {
48  public:
49  /// Creates an instance of this class
52  const TiXmlElement* pXml)
53  {
55  ::AllocateSharedPtr(pSession, pXml);
56  }
57 
58  /// Name of class
59  static std::string className;
60 
61  friend class MemoryManager<ProtocolS1S2>;
62 
63  virtual ~ProtocolS1S2() {}
64 
65  /// Initialise the protocol storage and set initial conditions
66  void Initialise();
67 
68  protected:
75 
76  virtual NekDouble v_GetAmplitude(const NekDouble time);
77 
79 
80  virtual void v_SetInitialConditions();
81 
82  private:
84  const TiXmlElement* pXml);
85  };
86 
87 }
88 
89 #endif
virtual ~ProtocolS1S2()
Definition: ProtocolS1S2.h:63
virtual NekDouble v_GetAmplitude(const NekDouble time)
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
NekDouble m_s2cyclelength
Definition: ProtocolS1S2.h:73
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:47
NekDouble m_s1cyclelength
Definition: ProtocolS1S2.h:71
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
boost::shared_ptr< Protocol > ProtocolSharedPtr
A shared pointer to an EquationSystem object.
Definition: Protocol.h:45
static ProtocolSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
Creates an instance of this class.
Definition: ProtocolS1S2.h:50
static std::string className
Name of class.
Definition: ProtocolS1S2.h:59
double NekDouble
Protocol base class.
Definition: Protocol.h:60
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
ProtocolS1S2(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
void Initialise()
Initialise the protocol storage and set initial conditions.
virtual void v_SetInitialConditions()
Protocol base class.
Definition: ProtocolS1S2.h:46