Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ForcingBody.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ForcingBody.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: Body forcing
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
37 #include <MultiRegions/ExpList.h>
38 
39 using namespace std;
40 
41 namespace Nektar
42 {
43 namespace SolverUtils
44 {
45 
46  std::string ForcingBody::classNameBody = GetForcingFactory().
47  RegisterCreatorFunction("Body",
48  ForcingBody::create,
49  "Body Forcing");
50  std::string ForcingBody::classNameField = GetForcingFactory().
51  RegisterCreatorFunction("Field",
52  ForcingBody::create,
53  "Field Forcing");
54 
55  ForcingBody::ForcingBody(
57  : Forcing(pSession),
58  m_hasTimeFcnScaling(false)
59  {
60  }
61 
64  const unsigned int& pNumForcingFields,
65  const TiXmlElement* pForce)
66  {
67  m_NumVariable = pNumForcingFields;
68 
69  const TiXmlElement* funcNameElmt = pForce->FirstChildElement("BODYFORCE");
70  if(!funcNameElmt)
71  {
72  funcNameElmt = pForce->FirstChildElement("FIELDFORCE");
73 
74  ASSERTL0(funcNameElmt, "Requires BODYFORCE or FIELDFORCE tag "
75  "specifying function name which prescribes body force.");
76  }
77 
78  m_funcName = funcNameElmt->GetText();
79  ASSERTL0(m_session->DefinesFunction(m_funcName),
80  "Function '" + m_funcName + "' not defined.");
81 
82  bool singleMode, halfMode;
83  m_session->MatchSolverInfo("ModeType","SingleMode",singleMode,false);
84  m_session->MatchSolverInfo("ModeType","HalfMode", halfMode, false);
85  bool homogeneous = pFields[0]->GetExpType() == MultiRegions::e3DH1D ||
86  pFields[0]->GetExpType() == MultiRegions::e3DH2D;
87  m_transform = (singleMode || halfMode || homogeneous);
88 
89  // Time function is optional
90  funcNameElmt = pForce->FirstChildElement("BODYFORCETIMEFCN");
91  if(!funcNameElmt)
92  {
93  funcNameElmt = pForce->FirstChildElement("FIELDFORCETIMEFCN");
94  }
95 
96  // Load time function if specified
97  if(funcNameElmt)
98  {
99  std::string funcNameTime = funcNameElmt->GetText();
100 
101  ASSERTL0(!funcNameTime.empty(),
102  "Expression must be given in BODYFORCETIMEFCN or "
103  "FIELDFORCETIMEFCN.");
104 
105  m_session->SubstituteExpressions(funcNameTime);
107  ::AllocateSharedPtr(m_session,funcNameTime);
108 
109  m_hasTimeFcnScaling = true;
110  }
111 
113  for (int i = 0; i < m_NumVariable; ++i)
114  {
115  m_Forcing[i] = Array<OneD, NekDouble> (pFields[0]->GetTotPoints(), 0.0);
116  }
117 
118 
119  Update(pFields, 0.0);
120  }
121 
122 
125  const NekDouble &time)
126  {
127  for (int i = 0; i < m_NumVariable; ++i)
128  {
129  std::string s_FieldStr = m_session->GetVariable(i);
130  ASSERTL0(m_session->DefinesFunction(m_funcName, s_FieldStr),
131  "Variable '" + s_FieldStr + "' not defined.");
132  EvaluateFunction(pFields, m_session, s_FieldStr,
133  m_Forcing[i], m_funcName, time);
134  }
135 
136  // If singleMode or halfMode, transform the forcing term to be in
137  // physical space in the plane, but Fourier space in the homogeneous
138  // direction
139  if (m_transform)
140  {
141  for (int i = 0; i < m_NumVariable; ++i)
142  {
143  pFields[0]->HomogeneousFwdTrans(m_Forcing[i], m_Forcing[i]);
144  }
145  }
146  }
147 
148 
151  const Array<OneD, Array<OneD, NekDouble> > &inarray,
152  Array<OneD, Array<OneD, NekDouble> > &outarray,
153  const NekDouble &time)
154  {
156  {
157  Array<OneD, NekDouble> TimeFcn(1);
158 
159  for (int i = 0; i < m_NumVariable; i++)
160  {
161  EvaluateTimeFunction(time, m_timeFcnEqn, TimeFcn);
162 
163  Vmath::Svtvp(outarray[i].num_elements(), TimeFcn[0],
164  m_Forcing[i], 1,
165  outarray[i], 1,
166  outarray[i], 1);
167  }
168  }
169  else
170  {
171  Update(fields, time);
172 
173  for (int i = 0; i < m_NumVariable; i++)
174  {
175  Vmath::Vadd(outarray[i].num_elements(), outarray[i], 1,
176  m_Forcing[i], 1, outarray[i], 1);
177  }
178  }
179  }
180 
181 }
182 }
SOLVER_UTILS_EXPORT void EvaluateTimeFunction(LibUtilities::SessionReaderSharedPtr pSession, std::string pFieldName, Array< OneD, NekDouble > &pArray, const std::string &pFunctionName, NekDouble pTime=NekDouble(0))
Definition: Forcing.cpp:131
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:102
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
void Update(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
void Svtvp(int n, const T alpha, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
svtvp (scalar times vector plus vector): z = alpha*x + y
Definition: Vmath.cpp:485
ForcingFactory & GetForcingFactory()
Declaration of the forcing factory singleton.
Definition: Forcing.cpp:44
STL namespace.
SOLVER_UTILS_EXPORT void EvaluateFunction(Array< OneD, MultiRegions::ExpListSharedPtr > pFields, LibUtilities::SessionReaderSharedPtr pSession, std::string pFieldName, Array< OneD, NekDouble > &pArray, const std::string &pFunctionName, NekDouble pTime=NekDouble(0))
Definition: Forcing.cpp:161
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
double NekDouble
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:100
int m_NumVariable
Number of variables.
Definition: Forcing.h:104
LibUtilities::EquationSharedPtr m_timeFcnEqn
Definition: ForcingBody.h:90
virtual SOLVER_UTILS_EXPORT void v_Apply(const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
virtual SOLVER_UTILS_EXPORT void v_InitObject(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
Definition: ForcingBody.cpp:62
Defines a forcing term to be explicitly applied.
Definition: Forcing.h:70
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.cpp:299