Nektar++
LinearSWE.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File LinearSWE.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: Linear Shallow water equations in primitive variables
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_SHALLOWWATERSOLVER_EQUATIONSYSTEMS_LINEARSWE_H
37 #define NEKTAR_SOLVERS_SHALLOWWATERSOLVER_EQUATIONSYSTEMS_LINEARSWE_H
38 
40 
41 namespace Nektar
42 {
43 
44 
45  /**
46  *
47  *
48  **/
49 
51  {
52  public:
53  friend class MemoryManager<LinearSWE>;
54 
55  /// Creates an instance of this class
58  {
60  p->InitObject();
61  return p;
62  }
63  /// Name of class
64  static std::string className;
65 
66  virtual ~LinearSWE();
67 
68  protected:
69 
71 
72  virtual void v_InitObject();
73 
74  /// Still water depth traces
77 
78  void DoOdeRhs(const Array<OneD, const Array<OneD, NekDouble> > &inarray,
79  Array<OneD, Array<OneD, NekDouble> > &outarray,
80  const NekDouble time);
81 
82  void DoOdeProjection(const Array<OneD, const Array<OneD, NekDouble> > &inarray,
83  Array<OneD, Array<OneD, NekDouble> > &outarray,
84  const NekDouble time);
85 
86  void GetFluxVector(
87  const Array<OneD, const Array<OneD, NekDouble> > &physfield,
89 
91 
92  virtual void v_PrimitiveToConservative( );
93 
94  virtual void v_ConservativeToPrimitive( );
95 
97  {
98  return m_dFwd;
99  }
101  {
102  return m_dBwd;
103  }
104 
105  private:
106 
107  void NumericalFlux1D(Array<OneD, Array<OneD, NekDouble> > &physfield,
108  Array<OneD, Array<OneD, NekDouble> > &numfluxX);
109 
110  void NumericalFlux2D(Array<OneD, Array<OneD, NekDouble> > &physfield,
111  Array<OneD, Array<OneD, NekDouble> > &numfluxX,
112  Array<OneD, Array<OneD, NekDouble> > &numfluxY);
113 
114 
116 
117  void WallBoundary2D(int bcRegion, int cnt, Array<OneD, Array<OneD, NekDouble> > &physarray);
118  void WallBoundary(int bcRegion, int cnt, Array<OneD, Array<OneD, NekDouble> > &physarray);
119 
120  void AddCoriolis( const Array<OneD, const Array<OneD, NekDouble> > &physarray,
121  Array<OneD, Array<OneD, NekDouble> > &outarray);
122 
123  void ConservativeToPrimitive(const Array<OneD, const Array<OneD, NekDouble> >&physin,
124  Array<OneD, Array<OneD, NekDouble> >&physout);
125  void PrimitiveToConservative(const Array<OneD, const Array<OneD, NekDouble> >&physin,
126  Array<OneD, Array<OneD, NekDouble> >&physout);
127 
128  void GetVelocityVector(
129  const Array<OneD, Array<OneD, NekDouble> > &physfield,
130  Array<OneD, Array<OneD, NekDouble> > &velocity);
131  };
132 
133 }
134 
135 #endif
136 
const Array< OneD, NekDouble > & GetDepthFwd()
Definition: LinearSWE.h:96
void WallBoundary(int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &physarray)
Wall boundary condition.
Definition: LinearSWE.cpp:405
virtual void v_InitObject()
Init object for UnsteadySystem class.
Definition: LinearSWE.cpp:56
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
Print a summary of time stepping parameters.
Definition: LinearSWE.cpp:712
Base class for unsteady solvers.
Array< OneD, NekDouble > m_dFwd
Still water depth traces.
Definition: LinearSWE.h:75
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
void GetFluxVector(const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &flux)
Definition: LinearSWE.cpp:548
void WallBoundary2D(int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &physarray)
Definition: LinearSWE.cpp:474
virtual void v_PrimitiveToConservative()
Definition: LinearSWE.cpp:677
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
void AddCoriolis(const Array< OneD, const Array< OneD, NekDouble > > &physarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
Definition: LinearSWE.cpp:172
static SolverUtils::EquationSystemSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession)
Creates an instance of this class.
Definition: LinearSWE.h:56
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
virtual void v_ConservativeToPrimitive()
Definition: LinearSWE.cpp:621
void NumericalFlux2D(Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &numfluxX, Array< OneD, Array< OneD, NekDouble > > &numfluxY)
boost::shared_ptr< EquationSystem > EquationSystemSharedPtr
A shared pointer to an EquationSystem object.
void SetBoundaryConditions(Array< OneD, Array< OneD, NekDouble > > &physarray, NekDouble time)
Definition: LinearSWE.cpp:371
virtual ~LinearSWE()
Definition: LinearSWE.cpp:166
static std::string className
Name of class.
Definition: LinearSWE.h:64
double NekDouble
Array< OneD, NekDouble > m_dBwd
Definition: LinearSWE.h:76
void NumericalFlux1D(Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &numfluxX)
void DoOdeProjection(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
Definition: LinearSWE.cpp:326
LinearSWE(const LibUtilities::SessionReaderSharedPtr &pSession)
Definition: LinearSWE.cpp:50
void GetVelocityVector(const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &velocity)
Compute the velocity field given the momentum .
Definition: LinearSWE.cpp:699
const Array< OneD, NekDouble > & GetDepthBwd()
Definition: LinearSWE.h:100
void DoOdeRhs(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
Definition: LinearSWE.cpp:223