Nektar++
StimulusPoint.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File StimulusPoint.cpp
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: Rectangular stimulus class
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 #include <iostream>
36 #include <tinyxml.h>
38 
40 
41 namespace Nektar
42 {
43  std::string StimulusPoint::className
45  "StimulusPoint",
47  "Point stimulus.");
48 
49  /**
50  * @class StimulusPoint
51  *
52  * The Stimulus class and derived classes implement a range of stimuli.
53  * The stimulus contains input stimuli that can be applied throughout the
54  * domain, on specified regions determined by the derived classes of
55  * Stimulus, at specified frequencies determined by the derived classes of
56  * Protocol.
57  */
58 
59  /**
60  * Stimulus base class constructor.
61  */
64  const MultiRegions::ExpListSharedPtr& pField,
65  const TiXmlElement* pXml)
66  : Stimulus(pSession, pField, pXml)
67  {
68  m_session = pSession;
69  m_field = pField;
70  m_nq = pField->GetTotPoints();
71 
72  if (!pXml)
73  {
74  return;
75  }
76 
77  const TiXmlElement *pXmlparameter;
78 
79  pXmlparameter = pXml->FirstChildElement("p_strength");
80  m_strength = atof(pXmlparameter->GetText());
81  }
82 
83 
84  /**
85  * Initialise the stimulus. Allocate workspace and variable storage.
86  */
88  {
89  }
90 
91 
92  /**
93  *
94  */
96  Array<OneD, Array<OneD, NekDouble> >&outarray,
97  const NekDouble time)
98  {
99  // Get the protocol amplitude
100  NekDouble v_amp = m_Protocol->GetAmplitude(time) * m_strength;
101 
102  outarray[0][0] += v_amp;
103  }
104 
105 
106  /**
107  *
108  */
110  {
111  }
112 }
void Initialise()
Initialise the stimulus storage and set initial conditions.
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:47
ProtocolSharedPtr m_Protocol
Stimulus protocol to apply.
Definition: Stimulus.h:99
static StimulusSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
Creates an instance of this class.
Definition: StimulusPoint.h:54
LibUtilities::SessionReaderSharedPtr m_session
Session.
Definition: Stimulus.h:93
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
int m_nq
Number of physical points.
Definition: Stimulus.h:97
static std::string className
Name of class.
Definition: StimulusPoint.h:64
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
Definition: ExpList.h:1340
Stimulus base class.
Definition: Stimulus.h:66
double NekDouble
MultiRegions::ExpListSharedPtr m_field
Transmembrane potential field from PDE system.
Definition: Stimulus.h:95
StimulusFactory & GetStimulusFactory()
Definition: Stimulus.cpp:43
StimulusPoint(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField, const TiXmlElement *pXml)
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
virtual void v_Update(Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215