Nektar++
ForcingMovingReferenceFrame.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ForcingMovingReferenceFrame.h
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 // Permission is hereby granted, free of charge, to any person obtaining a
14 // copy of this software and associated documentation files (the "Software"),
15 // to deal in the Software without restriction, including without limitation
16 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 // and/or sell copies of the Software, and to permit persons to whom the
18 // Software is furnished to do so, subject to the following conditions:
19 //
20 // The above copyright notice and this permission notice shall be included
21 // in all copies or substantial portions of the Software.
22 //
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 // DEALINGS IN THE SOFTWARE.
30 //
31 // Description: Allows for a moving frame of reference, through adding c * du/dx
32 // to the body force, where c is the frame velocity vector
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FORCINGMOVINGREFERENCEFRAME
37 #define NEKTAR_SOLVERUTILS_FORCINGMOVINGREFERENCEFRAME
38 
39 #include <string>
40 
44 #include <MultiRegions/ExpList.h>
48 #include <boost/numeric/ublas/io.hpp>
49 #include <boost/numeric/ublas/matrix.hpp>
50 #include <boost/numeric/ublas/vector.hpp>
51 #include <cmath>
52 
53 namespace Nektar
54 {
55 namespace SolverUtils
56 {
57 
58 namespace bn = boost::numeric;
59 
61 {
62 
63 public:
65 
66  /// Creates an instance of this class
69  const std::weak_ptr<EquationSystem> &pEquation,
71  const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
72  {
75  pSession, pEquation);
76  p->InitObject(pFields, pNumForcingFields, pForce);
77  return p;
78  }
79 
80  /// Name of the class
81  static std::string classNameBody;
82 
83 protected:
84  SOLVER_UTILS_EXPORT virtual void v_InitObject(
86  const unsigned int &pNumForcingFields, const TiXmlElement *pForce);
87 
88  SOLVER_UTILS_EXPORT virtual void v_Apply(
90  const Array<OneD, Array<OneD, NekDouble>> &inarray,
91  Array<OneD, Array<OneD, NekDouble>> &outarray, const NekDouble &time);
92 
93  SOLVER_UTILS_EXPORT virtual void v_PreApply(
95  const Array<OneD, Array<OneD, NekDouble>> &inarray,
96  Array<OneD, Array<OneD, NekDouble>> &outarray, const NekDouble &time);
97 
98 private:
99  // name of the function for linear and angular velocities in the session
100  // file
101  std::string m_funcName;
102  std::string m_velFuncName;
103  std::string m_omegaFuncName;
104 
105  // prescribed functions in the session file
106  std::map<int, LibUtilities::EquationSharedPtr> m_frameFunction;
107  std::map<int, LibUtilities::EquationSharedPtr> m_velFunction;
108  std::map<int, LibUtilities::EquationSharedPtr> m_omegaFunction;
109 
110  // a boolean switch indicating for which direction the velocities are
111  // available. The available velocites could be different from the
112  // precscribed one because of the rotation which result in change of basis
113  // vector of local frame to the inertial frame.
114  std::map<int, bool> m_hasVel;
115  std::map<int, bool> m_hasOmega;
116 
117  // frame linear velocities in inertial frame
118  std::map<int, NekDouble> m_velXYZ;
119 
120  // frame linear velocities in local translating-rotating frame
121  std::map<int, NekDouble> m_velxyz;
122 
123  // frame angular velocities in inertial frame
124  std::map<int, NekDouble> m_omegaXYZ;
125 
126  // frame angular velocities in local translating-rotating frame
127  std::map<int, NekDouble> m_omegaxyz;
128  // coordinate vector
130 
131  // pivot point
133 
134  // rotation angel
136 
137  // Projection matrix for transformation of vectors between inertial and
138  // moving reference frames
139  bn::ublas::matrix<NekDouble> m_ProjMatX;
140  bn::ublas::matrix<NekDouble> m_ProjMatY;
141  bn::ublas::matrix<NekDouble> m_ProjMatZ;
142 
144  bool m_isH1d;
146  bool m_isH2d;
148 
150  const LibUtilities::SessionReaderSharedPtr &pSession,
151  const std::weak_ptr<EquationSystem> &pEquation);
152 
154 
155  void Update(const NekDouble &time);
156  void UpdateTheta(const NekDouble &time);
159  Array<OneD, NekDouble> &theta);
160 
161  void addRotation(int npoints,
162  const Array<OneD, Array<OneD, NekDouble>> &inarray0,
163  NekDouble angVelScale,
164  const Array<OneD, Array<OneD, NekDouble>> &inarray1,
165  Array<OneD, Array<OneD, NekDouble>> &outarray);
166 };
167 
168 } // namespace SolverUtils
169 } // namespace Nektar
170 
171 #endif
#define SOLVER_UTILS_EXPORT
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
Defines a forcing term to be explicitly applied.
Definition: Forcing.h:73
void addRotation(int npoints, const Array< OneD, Array< OneD, NekDouble >> &inarray0, NekDouble angVelScale, const Array< OneD, Array< OneD, NekDouble >> &inarray1, Array< OneD, Array< OneD, NekDouble >> &outarray)
outarray = inarray0 + angVelScale Omega x inarray1
virtual SOLVER_UTILS_EXPORT void v_InitObject(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
Initialise the forcing module.
virtual SOLVER_UTILS_EXPORT void v_PreApply(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_Apply(const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble >> &inarray, Array< OneD, Array< OneD, NekDouble >> &outarray, const NekDouble &time)
Adds the body force, -Omega X u.
std::map< int, LibUtilities::EquationSharedPtr > m_omegaFunction
void CheckForRestartTheta(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, Array< OneD, NekDouble > &theta)
ForcingMovingReferenceFrame(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation)
std::map< int, LibUtilities::EquationSharedPtr > m_velFunction
std::map< int, LibUtilities::EquationSharedPtr > m_frameFunction
static SOLVER_UTILS_EXPORT ForcingSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::weak_ptr< EquationSystem > &pEquation, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
Creates an instance of this class.
void Update(const NekDouble &time)
Updates the forcing array with the current required forcing.
std::shared_ptr< SessionReader > SessionReaderSharedPtr
SOLVER_UTILS_EXPORT typedef std::shared_ptr< Forcing > ForcingSharedPtr
A shared pointer to an EquationSystem object.
Definition: Forcing.h:52
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:1
std::int32_t NekInt
double NekDouble