Nektar++
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 namespace Nektar
40 {
41 namespace SolverUtils
42 {
43 
45  RegisterCreatorFunction("Body",
47  "Body Forcing");
48 
51  : Forcing(pSession)
52  {
53  }
54 
57  const unsigned int& pNumForcingFields,
58  const TiXmlElement* pForce)
59  {
60  m_NumVariable = pNumForcingFields;
61  int nq = pFields[0]->GetTotPoints();
62 
63  const TiXmlElement* funcNameElmt = pForce->FirstChildElement("BODYFORCE");
64  ASSERTL0(funcNameElmt, "Requires BODYFORCE tag specifying function "
65  "name which prescribes body force.");
66 
67  string funcName = funcNameElmt->GetText();
68  ASSERTL0(m_session->DefinesFunction(funcName),
69  "Function '" + funcName + "' not defined.");
70 
71  bool singleMode, halfMode;
72  m_session->MatchSolverInfo("ModeType", "SingleMode", singleMode, false);
73  m_session->MatchSolverInfo("ModeType", "HalfMode", halfMode, false);
74 
76  std::string s_FieldStr;
77  for (int i = 0; i < m_NumVariable; ++i)
78  {
79  m_Forcing[i] = Array<OneD, NekDouble> (nq, 0.0);
80  s_FieldStr = m_session->GetVariable(i);
81  ASSERTL0(m_session->DefinesFunction(funcName, s_FieldStr),
82  "Variable '" + s_FieldStr + "' not defined.");
83  EvaluateFunction(pFields, m_session, s_FieldStr,
84  m_Forcing[i], funcName);
85  }
86 
87  bool homogeneous = pFields[0]->GetExpType() == MultiRegions::e3DH1D;
88 
89  // If singleMode or halfMode, transform the forcing term to be in
90  // physical space in the plane, but Fourier space in the homogeneous
91  // direction
92  if (singleMode || halfMode || homogeneous)
93  {
94  // Temporary array
95  Array<OneD, NekDouble> forcingCoeff(pFields[0]->GetNcoeffs(), 0.0);
96 
97  bool w = pFields[0]->GetWaveSpace();
98  for (int i = 0; i < m_NumVariable; ++i)
99  {
100  // FwdTrans in SEM and Fourier
101  pFields[0]->SetWaveSpace(false);
102  pFields[0]->FwdTrans_IterPerExp(m_Forcing[i], forcingCoeff);
103  // BwdTrans in SEM only
104  pFields[0]->SetWaveSpace(true);
105  pFields[0]->BwdTrans(forcingCoeff, m_Forcing[i]);
106  }
107  pFields[0]->SetWaveSpace(w);
108  }
109 
110  }
111 
114  const Array<OneD, Array<OneD, NekDouble> > &inarray,
115  Array<OneD, Array<OneD, NekDouble> > &outarray,
116  const NekDouble &time)
117  {
118  for (int i = 0; i < m_NumVariable; i++)
119  {
120  Vmath::Vadd(outarray[i].num_elements(), outarray[i], 1,
121  m_Forcing[i], 1, outarray[i], 1);
122  }
123  }
124 
125 }
126 }
Array< OneD, Array< OneD, NekDouble > > m_Forcing
Evaluated forcing function.
Definition: Forcing.h:97
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:161
ForcingFactory & GetForcingFactory()
Declaration of the forcing factory singleton.
Definition: Forcing.cpp:42
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:140
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
static SOLVER_UTILS_EXPORT ForcingSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
Creates an instance of this class.
Definition: ForcingBody.h:59
static std::string className
Name of the class.
Definition: ForcingBody.h:72
ForcingBody(const LibUtilities::SessionReaderSharedPtr &pSession)
Definition: ForcingBody.cpp:49
double NekDouble
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:95
int m_NumVariable
Number of variables.
Definition: Forcing.h:99
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:55
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:285