Nektar++
ProtocolS1S2.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File ProtocolS1S2.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: S1S2 protocol.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #include <tinyxml.h>
38 
39 namespace Nektar
40 { std::string ProtocolS1S2::className
42  "ProtocolS1S2",
44  "S1S2 stimulus protocol.");
45  /**
46  * @class ProtocolS1S2
47  *
48  * The Stimuli class and derived classes implement a range of stimuli.
49  * The stimulus contains input stimuli that can be applied throughout the
50  * domain, on specified regions determined by the derived classes of Stimulus,
51  * at specified frequencies determined by the derived classes of Protocol.
52  *
53  */
54  /**
55  * Protocol base class constructor.
56  */
57  ProtocolS1S2::ProtocolS1S2(const LibUtilities::SessionReaderSharedPtr& pSession,const TiXmlElement* pXml)
58  : Protocol(pSession, pXml)
59  {
60  m_session = pSession;
61 
62  if (!pXml)
63  {
64  return;
65  }
66 
67  const TiXmlElement *pXmlparameter; //Declaring variable called pxml...
68  // See if we have parameters defined. They are optional so we go on if not.
69 
70  //member variables m_* defined in ProtocolS1S2.h
71 
72  pXmlparameter = pXml->FirstChildElement("START");
73  m_start = atof(pXmlparameter->GetText()); //text value within px1, convert to a floating pt and save in m_px1
74 
75  pXmlparameter = pXml->FirstChildElement("DURATION");
76  m_dur = atof(pXmlparameter->GetText());
77 
78  pXmlparameter = pXml->FirstChildElement("S1CYCLELENGTH");
79  m_s1cyclelength = atof(pXmlparameter->GetText());
80 
81  pXmlparameter = pXml->FirstChildElement("NUM_S1");
82  m_num_s1 = atof(pXmlparameter->GetText());
83 
84  pXmlparameter = pXml->FirstChildElement("S2CYCLELENGTH");
85  m_s2cyclelength = atof(pXmlparameter->GetText());
86 
88  }
89 
90 
91 
92  /**
93  * Initialise the protocol. Allocate workspace and variable storage.
94  */
96  {
97 
98  }
99 
100 
102  {
103  // Number of complete S1 intervals
104  NekDouble a = floor((time-m_start)/m_s1cyclelength);
105 
106  // Time since start of most recent S1 interval
107  NekDouble time1 = time - a * m_s1cyclelength - m_start;
108 
109  // S1
110  if( (time1 > 0) && (a < m_num_s1) && (time1 < m_dur))
111  {
112  return 1.0;
113  }
114 
115  // S2
116  if ((time > m_s2start) && (time < m_s2start + m_dur))
117  {
118  return 1.0;
119  }
120 
121  return 0.0;
122  }
123 
125  {
126 
127  }
128 
130  {
131 
132  }
133 
134 }
virtual NekDouble v_GetAmplitude(const NekDouble time)
NekDouble m_s2cyclelength
Definition: ProtocolS1S2.h:73
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:47
NekDouble m_s1cyclelength
Definition: ProtocolS1S2.h:71
ProtocolFactory & GetProtocolFactory()
Definition: Protocol.cpp:40
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
LibUtilities::SessionReaderSharedPtr m_session
Session.
Definition: Protocol.h:82
static ProtocolSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
Creates an instance of this class.
Definition: ProtocolS1S2.h:50
static std::string className
Name of class.
Definition: ProtocolS1S2.h:59
double NekDouble
Protocol base class.
Definition: Protocol.h:60
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
ProtocolS1S2(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
void Initialise()
Initialise the protocol storage and set initial conditions.
virtual void v_SetInitialConditions()
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215