Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Forcing.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: Forcing.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 // 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: Abstract base class for advection.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FORCING
37 #define NEKTAR_SOLVERUTILS_FORCING
38 
39 #include <string>
40 
43 #include <MultiRegions/ExpList.h>
45 
46 namespace Nektar
47 {
48 namespace SolverUtils
49 {
50  // Forward declaration
51  class Forcing;
52 
53  /// A shared pointer to an EquationSystem object
54  SOLVER_UTILS_EXPORT typedef boost::shared_ptr<Forcing> ForcingSharedPtr;
55 
56  /// Declaration of the forcing factory
57  typedef LibUtilities::NekFactory<std::string, Forcing,
60  const unsigned int&,
61  const TiXmlElement*> ForcingFactory;
62 
63  /// Declaration of the forcing factory singleton
64  SOLVER_UTILS_EXPORT ForcingFactory& GetForcingFactory();
65 
66  /**
67  * @class Forcing
68  * @brief Defines a forcing term to be explicitly applied.
69  */
70  class Forcing
71  {
72  public:
74 
75  /// Initialise the forcing object
77  const Array<OneD, MultiRegions::ExpListSharedPtr>& pFields,
78  const unsigned int& pNumForcingFields,
79  const TiXmlElement* pForce);
80 
81  /// Apply the forcing
83  const Array<OneD, MultiRegions::ExpListSharedPtr> &fields,
84  const Array<OneD, Array<OneD, NekDouble> > &inarray,
85  Array<OneD, Array<OneD, NekDouble> > &outarray,
86  const NekDouble &time);
87 
88  SOLVER_UTILS_EXPORT static std::vector<ForcingSharedPtr> Load(
89  const LibUtilities::SessionReaderSharedPtr& pSession,
90  const Array<OneD, MultiRegions::ExpListSharedPtr>& pFields,
91  const unsigned int& pNumForcingFields = 0);
92 
94  &GetForces();
95 
97 
98  protected:
99  /// Session reader
100  LibUtilities::SessionReaderSharedPtr m_session;
101  /// Evaluated forcing function
103  /// Number of variables
105 
106  /// Constructor
108  const LibUtilities::SessionReaderSharedPtr&);
109 
110  SOLVER_UTILS_EXPORT virtual void v_InitObject(
111  const Array<OneD, MultiRegions::ExpListSharedPtr>& pFields,
112  const unsigned int& pNumForcingFields,
113  const TiXmlElement* pForce) = 0;
114 
115  SOLVER_UTILS_EXPORT virtual void v_Apply(
116  const Array<OneD, MultiRegions::ExpListSharedPtr> &fields,
117  const Array<OneD, Array<OneD, NekDouble> > &inarray,
118  Array<OneD, Array<OneD, NekDouble> > &outarray,
119  const NekDouble &time)=0;
120 
122  Array<OneD, MultiRegions::ExpListSharedPtr> pFields,
123  LibUtilities::SessionReaderSharedPtr pSession,
124  std::string pFieldName,
125  Array<OneD, NekDouble>& pArray,
126  const std::string& pFunctionName,
127  NekDouble pTime = NekDouble(0));
128 
130  LibUtilities::SessionReaderSharedPtr pSession,
131  std::string pFieldName,
132  Array<OneD, NekDouble>& pArray,
133  const std::string& pFunctionName,
134  NekDouble pTime = NekDouble(0));
135 
136 
138  const NekDouble pTime,
140  Array<OneD, NekDouble>& pArray);
141  };
142 }
143 }
144 
145 #endif
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
SOLVER_UTILS_EXPORT void InitObject(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
Initialise the forcing object.
Definition: Forcing.cpp:59
SOLVER_UTILS_EXPORT void Apply(const Array< OneD, MultiRegions::ExpListSharedPtr > &fields, const Array< OneD, Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble &time)
Apply the forcing.
Definition: Forcing.cpp:73
SOLVER_UTILS_EXPORT Array< OneD, Array< OneD, NekDouble > > & UpdateForces()
Definition: Forcing.cpp:121
SOLVER_UTILS_EXPORT typedef boost::shared_ptr< Forcing > ForcingSharedPtr
A shared pointer to an EquationSystem object.
Definition: Forcing.h:51
ForcingFactory & GetForcingFactory()
Declaration of the forcing factory singleton.
Definition: Forcing.cpp:44
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
static SOLVER_UTILS_EXPORT std::vector< ForcingSharedPtr > Load(const LibUtilities::SessionReaderSharedPtr &pSession, const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields=0)
Definition: Forcing.cpp:86
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
SOLVER_UTILS_EXPORT const Array< OneD, const Array< OneD, NekDouble > > & GetForces()
Definition: Forcing.cpp:126
LibUtilities::NekFactory< std::string, Forcing, const LibUtilities::SessionReaderSharedPtr &, const Array< OneD, MultiRegions::ExpListSharedPtr > &, const unsigned int &, const TiXmlElement * > ForcingFactory
Declaration of the forcing factory.
Definition: Forcing.h:61
double NekDouble
SOLVER_UTILS_EXPORT Forcing(const LibUtilities::SessionReaderSharedPtr &)
Constructor.
Definition: Forcing.cpp:53
LibUtilities::SessionReaderSharedPtr m_session
Session reader.
Definition: Forcing.h:100
boost::shared_ptr< Equation > EquationSharedPtr
int m_NumVariable
Number of variables.
Definition: Forcing.h:104
virtual SOLVER_UTILS_EXPORT void v_InitObject(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)=0
#define SOLVER_UTILS_EXPORT
virtual SOLVER_UTILS_EXPORT ~Forcing()
Definition: Forcing.h:73
Defines a forcing term to be explicitly applied.
Definition: Forcing.h:70
Provides a generic Factory class.
Definition: NekFactory.hpp:116
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)=0