Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ForcingBody.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ForcingBody.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: Body forcing
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FORCINGBODY
37 #define NEKTAR_SOLVERUTILS_FORCINGBODY
38 
39 #include <string>
40 
43 #include <MultiRegions/ExpList.h>
46 
47 namespace Nektar
48 {
49 namespace SolverUtils
50 {
51  class ForcingBody : public Forcing
52  {
53  public:
54 
55  friend class MemoryManager<ForcingBody>;
56 
57  /// Creates an instance of this class
60  const Array<OneD, MultiRegions::ExpListSharedPtr>& pFields,
61  const unsigned int& pNumForcingFields,
62  const TiXmlElement* pForce)
63  {
65  AllocateSharedPtr(pSession);
66  p->InitObject(pFields, pNumForcingFields, pForce);
67  return p;
68  }
69 
70  ///Name of the class
71  static std::string className;
72 
73  protected:
74  SOLVER_UTILS_EXPORT virtual void v_InitObject(
75  const Array<OneD, MultiRegions::ExpListSharedPtr>& pFields,
76  const unsigned int& pNumForcingFields,
77  const TiXmlElement* pForce);
78 
79  SOLVER_UTILS_EXPORT virtual void v_Apply(
80  const Array<OneD, MultiRegions::ExpListSharedPtr> &fields,
81  const Array<OneD, Array<OneD, NekDouble> > &inarray,
82  Array<OneD, Array<OneD, NekDouble> > &outarray,
83  const NekDouble &time);
84 
85  private:
87 
88  };
89 
90 }
91 }
92 
93 #endif