Nektar++
library/SolverUtils/RiemannSolvers/UpwindSolver.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: UpwindSolver.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: Upwind Riemann solver.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
37 
38 namespace Nektar
39 {
40  namespace SolverUtils
41  {
43  RegisterCreatorFunction("Upwind", UpwindSolver::create, "Upwind solver");
44 
45  /**
46  * @class UpwindSolver
47  *
48  * @brief Upwind scheme Riemann solver.
49  *
50  * The upwind solver determines the flux based upon an advection
51  * velocity \f$\mathbf{V}\f$ and trace normal \f$\mathbf{n}\f$. In
52  * particular, the flux for each component of the velocity field is
53  * deterined by:
54  *
55  * \f[ \mathbf{f}(u^+,u^-) = \begin{cases} \mathbf{V}u^+, &
56  * \mathbf{V}\cdot\mathbf{n} \geq 0,\\ \mathbf{V}u^-, &
57  * \mathbf{V}\cdot\mathbf{n} < 0.\end{cases} \f]
58  *
59  * Here the superscript + and - denotes forwards and backwards spaces
60  * respectively.
61  */
62 
63  /**
64  * @brief Default constructor.
65  */
68  {
69  }
70 
71  /**
72  * @brief Implementation of the upwind solver.
73  *
74  * The upwind solver assumes that a scalar field Vn is defined, which
75  * corresponds with the dot product \f$\mathbf{V}\cdot\mathbf{n}\f$,
76  * where \f$\mathbf{V}\f$ is the advection velocity and \f$\mathbf{n}\f$
77  * defines the normal of a vertex, edge or face at each quadrature point
78  * of the trace space.
79  *
80  * @param Fwd Forwards trace space.
81  * @param Bwd Backwards trace space.
82  * @param flux Resulting flux.
83  */
85  const int nDim,
86  const Array<OneD, const Array<OneD, NekDouble> > &Fwd,
87  const Array<OneD, const Array<OneD, NekDouble> > &Bwd,
89  {
90  ASSERTL1(CheckScalars("Vn"), "Vn not defined.");
91  const Array<OneD, NekDouble> &traceVel = m_scalars["Vn"]();
92 
93  for (int j = 0; j < traceVel.num_elements(); ++j)
94  {
96  traceVel[j] >= 0 ? Fwd : Bwd;
97  for (int i = 0; i < Fwd.num_elements(); ++i)
98  {
99  flux[i][j] = traceVel[j]*tmp[i][j];
100  }
101  }
102  }
103  }
104 }
SOLVER_UTILS_EXPORT bool CheckScalars(std::string name)
Determine whether a scalar has been defined in m_scalars.
static SOLVER_UTILS_EXPORT RiemannSolverSharedPtr create()
std::map< std::string, RSScalarFuncType > m_scalars
Map of scalar function types.
virtual void v_Solve(const int nDim, const Array< OneD, const Array< OneD, NekDouble > > &Fwd, const Array< OneD, const Array< OneD, NekDouble > > &Bwd, Array< OneD, Array< OneD, NekDouble > > &flux)
Implementation of the upwind solver.
RiemannSolverFactory & GetRiemannSolverFactory()
The RiemannSolver class provides an abstract interface under which solvers for various Riemann proble...
Definition: RiemannSolver.h:62
#define ASSERTL1(condition, msg)
Assert Level 1 – Debugging which is used whether in FULLDEBUG or DEBUG compilation mode...
Definition: ErrorUtil.hpp:191