Nektar++
ForcingProgrammatic.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: ForcingProgrammatic.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: Programmatic forcing
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FORCINGPROGRAMMATIC
37 #define NEKTAR_SOLVERUTILS_FORCINGPROGRAMMATIC
38 
39 #include <string>
40 
43 #include <MultiRegions/ExpList.h>
46 
47 namespace Nektar
48 {
49 namespace SolverUtils
50 {
51  // Forward declaration
53 
54  /// A shared pointer to an EquationSystem object
55  SOLVER_UTILS_EXPORT typedef boost::shared_ptr<ForcingProgrammatic> ForcingProgrammaticSharedPtr;
56 
58  {
59  public:
60 
62 
63  /// Creates an instance of this class
67  const unsigned int& pNumForcingFields,
68  const TiXmlElement* pForce)
69  {
71  AllocateSharedPtr(pSession);
72  p->InitObject(pFields, pNumForcingFields, pForce);
73  return p;
74  }
75 
76  ///Name of the class
77  static std::string className;
78 
80  UpdateForces();
81 
82  protected:
83  SOLVER_UTILS_EXPORT virtual void v_InitObject(
85  const unsigned int& pNumForcingFields,
86  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,
92  const NekDouble &time);
93 
94  private:
96  virtual ~ForcingProgrammatic(void){};
97 
98  };
99 
100 }
101 }
102 
103 #endif
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.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
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)
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
ForcingProgrammatic(const LibUtilities::SessionReaderSharedPtr &pSession)
SOLVER_UTILS_EXPORT typedef boost::shared_ptr< Forcing > ForcingSharedPtr
A shared pointer to an EquationSystem object.
Definition: Forcing.h:51
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
static std::string className
Name of the class.
virtual SOLVER_UTILS_EXPORT void v_InitObject(const Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const unsigned int &pNumForcingFields, const TiXmlElement *pForce)
SOLVER_UTILS_EXPORT typedef boost::shared_ptr< ForcingProgrammatic > ForcingProgrammaticSharedPtr
A shared pointer to an EquationSystem object.
double NekDouble
#define SOLVER_UTILS_EXPORT
SOLVER_UTILS_EXPORT Array< OneD, Array< OneD, NekDouble > > & UpdateForces()
Defines a forcing term to be explicitly applied.
Definition: Forcing.h:70