Nektar++
ProtocolSingle.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File ProtocolSingle.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: Single impulse protocol.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #include <tinyxml.h>
38 
39 namespace Nektar
40 {
41  std::string ProtocolSingle::className
43  "ProtocolSingle",
45  "Single stimulus protocol.");
46 
47  /**
48  * @class Protocol
49  *
50  * The Stimuli class and derived classes implement a range of stimuli.
51  * The stimulus contains input stimuli that can be applied throughout the
52  * domain, on specified regions determined by the derived classes of
53  * Stimulus, at specified frequencies determined by the derived classes of
54  * Protocol.
55  *
56  */
57 
58  /**
59  * Protocol base class constructor.
60  */
63  const TiXmlElement* pXml)
64  : Protocol(pSession, pXml)
65  {
66  m_session = pSession;
67 
68  if (!pXml)
69  {
70  return;
71  }
72 
73  const TiXmlElement *pXmlparameter;
74 
75  pXmlparameter = pXml->FirstChildElement("START");
76  m_start = atof(pXmlparameter->GetText());
77 
78  pXmlparameter = pXml->FirstChildElement("DURATION");
79  m_dur = atof(pXmlparameter->GetText());
80  }
81 
82 
83  /**
84  * Initialise the protocol. Allocate workspace and variable storage.
85  */
87  {
88  }
89 
90 
91  /**
92  *
93  */
95  {
96  if(time > m_start && time < (m_start+m_dur))
97  {
98  return 1.0;
99  }
100  else
101  {
102  return 0.0;
103  }
104  }
105 
106 
107  /**
108  *
109  */
111  {
112  }
113 
114 
115  /**
116  *
117  */
119  {
120  }
121 
122 }
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:47
ProtocolFactory & GetProtocolFactory()
Definition: Protocol.cpp:40
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
static ProtocolSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
Creates an instance of this class.
virtual NekDouble v_GetAmplitude(const NekDouble time)
LibUtilities::SessionReaderSharedPtr m_session
Session.
Definition: Protocol.h:82
virtual void v_SetInitialConditions()
static std::string className
Name of class.
ProtocolSingle(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
double NekDouble
Protocol base class.
Definition: Protocol.h:60
void Initialise()
Initialise the protocol storage and set initial conditions.
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215