Nektar++
ShallowWaterSystem.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File ShallowWaterSystem.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: Generic timestepping for shallow water solvers
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_SHALLOWWATERSOLVER_EQUATIONSYSTEMS_SHALLOWWATERSYSTEM_H
37 #define NEKTAR_SOLVERS_SHALLOWWATERSOLVER_EQUATIONSYSTEMS_SHALLOWWATERSYSTEM_H
38 
43 
44 namespace Nektar
45 {
46 
47  /// Base class for unsteady solvers.
49  {
50  public:
52 
53  /// Creates an instance of this class
56  {
58  }
59 
60  /// Name of class
61  static std::string className;
62 
63  /// Destructor
64  virtual ~ShallowWaterSystem();
65 
66  protected:
71 
72  /// Indicates if variables are primitive or conservative
74  /// Indicates if constant depth case
76  /// Acceleration of gravity
78  /// Still water depth
80  // Bottom slopes
82  /// Coriolis force
84  // Location of velocity vector.
86  /// Initialises UnsteadySystem class members.
88 
89  virtual void v_InitObject();
90 
91  /// Print a summary of time stepping parameters.
93 
95  {
97  }
98  virtual void v_PrimitiveToConservative();
99 
101  {
103  }
104  virtual void v_ConservativeToPrimitive();
105 
106 
108  {
109  return m_g;
110  }
111 
113  {
114  return m_vecLocs;
115  }
116 
118  {
119  return m_traceNormals;
120  }
121 
123  {
124  return m_depth;
125  }
126 
128  {
129  return m_constantDepth;
130  }
131 
133 
134 
135  private:
136  ///
137  void EvaluateWaterDepth(void);
138 
139  ///
140  void EvaluateCoriolis(void);
141 
142  };
143 }
144 
145 #endif
SolverUtils::RiemannSolverSharedPtr m_riemannSolverLDG
Array< OneD, NekDouble > m_coriolis
Coriolis force.
bool m_primitive
Indicates if variables are primitive or conservative.
Base class for unsteady solvers.
Array< OneD, NekDouble > m_depth
Still water depth.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:47
boost::shared_ptr< Advection > AdvectionSharedPtr
A shared pointer to an Advection object.
Definition: Advection.h:158
const Array< OneD, const Array< OneD, NekDouble > > & GetVecLocs()
SolverUtils::AdvectionSharedPtr m_advection
boost::shared_ptr< RiemannSolver > RiemannSolverSharedPtr
A shared pointer to an EquationSystem object.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
const Array< OneD, const Array< OneD, NekDouble > > & GetNormals()
const Array< OneD, NekDouble > & GetDepth()
boost::shared_ptr< EquationSystem > EquationSystemSharedPtr
A shared pointer to an EquationSystem object.
Array< OneD, Array< OneD, NekDouble > > m_traceNormals
Array holding trace normals for DG simulations in the forwards direction.
Array< OneD, Array< OneD, NekDouble > > m_bottomSlope
SolverUtils::DiffusionSharedPtr m_diffusion
virtual void v_InitObject()
Init object for UnsteadySystem class.
Base class for unsteady solvers.
SolverUtils::RiemannSolverSharedPtr m_riemannSolver
ShallowWaterSystem(const LibUtilities::SessionReaderSharedPtr &pSession)
Initialises UnsteadySystem class members.
void CopyBoundaryTrace(const Array< OneD, NekDouble > &Fwd, Array< OneD, NekDouble > &Bwd)
boost::shared_ptr< Diffusion > DiffusionSharedPtr
A shared pointer to an EquationSystem object.
Definition: Diffusion.h:164
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
Print a summary of time stepping parameters.
double NekDouble
virtual ~ShallowWaterSystem()
Destructor.
bool m_constantDepth
Indicates if constant depth case.
static SolverUtils::EquationSystemSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession)
Creates an instance of this class.
Array< OneD, Array< OneD, NekDouble > > m_vecLocs
NekDouble m_g
Acceleration of gravity.
static std::string className
Name of class.