Nektar++
StimulusPoint.h
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: StimulusPoint.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// 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: Rectangular stimulus header file
33//
34///////////////////////////////////////////////////////////////////////////////
35
36#ifndef NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_STIMULUSRECT
37#define NEKTAR_SOLVERS_CARDIACEPSOLVER_STIMULI_STIMULUSRECT
38
44
45namespace Nektar
46{
47
48/// Protocol base class.
49class StimulusPoint : public Stimulus
50{
51public:
52 /// Creates an instance of this class
55 const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
56 {
58 pXml);
59 }
60
61 /// Name of class
62 static std::string className;
63
64 friend class MemoryManager<StimulusPoint>;
65
66 ~StimulusPoint() override
67 {
68 }
69
70 /// Initialise the stimulus storage and set initial conditions
71 void Initialise();
72
73protected:
75
77 const NekDouble time) override;
78
80
81private:
84 const TiXmlElement *pXml);
85};
86} // namespace Nektar
87
88#endif
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
Stimulus base class.
Definition: Stimulus.h:65
Protocol base class.
Definition: StimulusPoint.h:50
void Initialise()
Initialise the stimulus storage and set initial conditions.
static StimulusSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
Creates an instance of this class.
Definition: StimulusPoint.h:53
~StimulusPoint() override
Definition: StimulusPoint.h:66
void v_GenerateSummary(SolverUtils::SummaryList &s) override
StimulusPoint(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
static std::string className
Name of class.
Definition: StimulusPoint.h:62
void v_Update(Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) override
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:46
std::shared_ptr< Stimulus > StimulusSharedPtr
A shared pointer to an EquationSystem object.
Definition: Stimulus.h:52
double NekDouble