Nektar++
ShallowWaterSolver/RiemannSolvers/AverageSolver.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: AverageSolver.cpp
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: Simple mean value solver for the Nonlinear Shallow Water
33 // Equations.
34 // Do not use for anything else than testing and comparisons
35 //
36 ///////////////////////////////////////////////////////////////////////////////
37 
39 
40 namespace Nektar
41 {
42  std::string AverageSolver::solverName =
44  "Average",
46  "Average Value Riemann solver");
47 
48  AverageSolver::AverageSolver() : NonlinearSWESolver()
49  {
50 
51  }
52 
53  /**
54  * @brief Average Value Riemann solver for the Nonlinear Shallow
55  * Water Equations
56  *
57  * @param hL Water depth left state.
58  * @param hR Water depth right state.
59  * @param huL x-momentum component left state.
60  * @param huR x-momentum component right state.
61  * @param hvL y-momentum component left state.
62  * @param hvR y-momentum component right state.
63  * @param hf Computed Riemann flux for density.
64  * @param huf Computed Riemann flux for x-momentum component
65  * @param hvf Computed Riemann flux for y-momentum component
66  */
68  double hL, double huL, double hvL,
69  double hR, double huR, double hvR,
70  double &hf, double &huf, double &hvf)
71  {
72  static NekDouble g = m_params["gravity"]();
73 
74  // Left and Right velocities
75  NekDouble uL = huL / hL;
76  NekDouble vL = hvL / hL;
77  NekDouble uR = huR / hR;
78  NekDouble vR = hvR / hR;
79 
80  // Compute fluxes
81  hf = 0.5 * (hL * uL + hR * uR);
82  huf = 0.5 * ((uL * uL * hL + 0.5 * g * hL * hL) +
83  (uR * uR * hR + 0.5 * g * hR * hR));
84  hvf = 0.5 * (hL * uL * vL + hR * uR * vR);
85  }
86 }
virtual void v_PointSolve(double hL, double huL, double hvL, double hR, double huR, double hvR, double &hf, double &huf, double &hvf)
Average Value Riemann solver for the Nonlinear Shallow Water Equations.
RiemannSolverFactory & GetRiemannSolverFactory()
double NekDouble
std::map< std::string, RSParamFuncType > m_params
Map of parameter function types.
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215