Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ProtocolS1.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File ProtocolS1.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 S1 stimulus header.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_PROTOCOLS1
37 #define NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_PROTOCOLS1
38 
40 
41 namespace Nektar
42 {
43  // Forward declaration
44  class ProtocolS1;
45 
46  /// Protocol base class.
47  class ProtocolS1 : public Protocol
48  {
49  public:
50  /// Creates an instance of this class
53  const TiXmlElement* pXml)
54  {
56  ::AllocateSharedPtr(pSession, pXml);
57  }
58 
59  /// Name of class
60  static std::string className;
61 
63  const TiXmlElement* pXml);
64 
65  virtual ~ProtocolS1() {}
66 
67  /// Initialise the protocol storage and set initial conditions
68  void Initialise();
69 
70  protected:
76 
77  virtual NekDouble v_GetAmplitude(const NekDouble time);
78 
80 
81  virtual void v_SetInitialConditions();
82  };
83 
84 }
85 
86 #endif /* ProtocolS1_H_ */