Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
StimulusRect.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File StimulusRect.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 //
10 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
11 // Department of Aeronautics, Imperial College London (UK), and Scientific
12 // Computing and Imaging Institute, University of Utah (USA).
13 //
14 // License for the specific language governing rights and limitations under
15 // Permission is hereby granted, free of charge, to any person obtaining a
16 // copy of this software and associated documentation files (the "Software"),
17 // to deal in the Software without restriction, including without limitation
18 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
19 // and/or sell copies of the Software, and to permit persons to whom the
20 // Software is furnished to do so, subject to the following conditions:
21 //
22 // The above copyright notice and this permission notice shall be included
23 // in all copies or substantial portions of the Software.
24 //
25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
26 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
28 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
30 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
31 // DEALINGS IN THE SOFTWARE.
32 //
33 // Description: Rectangular stimulus header file
34 //
35 ///////////////////////////////////////////////////////////////////////////////
36 
37 #ifndef NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_STIMULUSRECT
38 #define NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_STIMULUSRECT
39 
43 #include <MultiRegions/ExpList.h>
45 
46 namespace Nektar
47 {
48 
49  /// Protocol base class.
50  class StimulusRect: public Stimulus
51  {
52  public:
53  /// Creates an instance of this class
56  const MultiRegions::ExpListSharedPtr& pField,
57  const TiXmlElement* pXml)
58  {
60  ::AllocateSharedPtr(pSession, pField, pXml);
61  }
62 
63  /// Name of class
64  static std::string className;
65 
66  friend class MemoryManager<StimulusRect>;
67 
68  virtual ~StimulusRect() {}
69 
70  /// Initialise the stimulus storage and set initial conditions
71  void Initialise();
72 
73  protected:
83 
84  virtual void v_Update(
85  Array<OneD, Array<OneD, NekDouble> >&outarray,
86  const NekDouble time);
87 
89 
90  private:
92  const MultiRegions::ExpListSharedPtr& pField,
93  const TiXmlElement* pXml);
94  };
95 }
96 
97 #endif
Protocol base class.
Definition: StimulusRect.h:50
boost::shared_ptr< Stimulus > StimulusSharedPtr
A shared pointer to an EquationSystem object.
Definition: Stimulus.h:50
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
virtual void v_Update(Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
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
void Initialise()
Initialise the stimulus storage and set initial conditions.
virtual ~StimulusRect()
Definition: StimulusRect.h:68
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
StimulusRect(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
Stimulus base class.
Definition: Stimulus.h:66
double NekDouble
static StimulusSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
Creates an instance of this class.
Definition: StimulusRect.h:54
static std::string className
Name of class.
Definition: StimulusRect.h:64
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
NekDouble m_chiCapMembrane
Definition: StimulusRect.h:82