Nektar++
Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Nektar::LaxFriedrichsSolver Class Reference

#include <LaxFriedrichsSolver.h>

Inheritance diagram for Nektar::LaxFriedrichsSolver:
[legend]

Static Public Member Functions

static RiemannSolverSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession)
 
static RiemannSolverSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession)
 

Static Public Attributes

static std::string solverName
 

Protected Member Functions

 LaxFriedrichsSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
virtual void v_PointSolve (double rhoL, double rhouL, double rhovL, double rhowL, double EL, double rhoR, double rhouR, double rhovR, double rhowR, double ER, double &rhof, double &rhouf, double &rhovf, double &rhowf, double &Ef)
 Lax-Friedrichs Riemann solver. More...
 
 LaxFriedrichsSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
virtual void v_PointSolve (NekDouble hL, NekDouble huL, NekDouble hvL, NekDouble hR, NekDouble huR, NekDouble hvR, NekDouble &hf, NekDouble &huf, NekDouble &hvf)
 Lax-Friedrichs Riemann solver. More...
 
- Protected Member Functions inherited from Nektar::NonlinearSWESolver
 NonlinearSWESolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
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)
 
virtual void v_ArraySolve (const Array< OneD, const Array< OneD, NekDouble > > &Fwd, const Array< OneD, const Array< OneD, NekDouble > > &Bwd, Array< OneD, Array< OneD, NekDouble > > &flux)
 
- Protected Member Functions inherited from Nektar::SolverUtils::RiemannSolver
SOLVER_UTILS_EXPORT RiemannSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
virtual SOLVER_UTILS_EXPORT ~RiemannSolver ()
 
void GenerateRotationMatrices (const Array< OneD, const Array< OneD, NekDouble > > &normals)
 Generate rotation matrices for 3D expansions. More...
 
void FromToRotation (Array< OneD, const NekDouble > &from, Array< OneD, const NekDouble > &to, NekDouble *mat)
 A function for creating a rotation matrix that rotates a vector from into another vector to. More...
 
SOLVER_UTILS_EXPORT void rotateToNormal (const Array< OneD, const Array< OneD, NekDouble > > &inarray, const Array< OneD, const Array< OneD, NekDouble > > &normals, const Array< OneD, const Array< OneD, NekDouble > > &vecLocs, Array< OneD, Array< OneD, NekDouble > > &outarray)
 Rotate a vector field to trace normal. More...
 
SOLVER_UTILS_EXPORT void rotateFromNormal (const Array< OneD, const Array< OneD, NekDouble > > &inarray, const Array< OneD, const Array< OneD, NekDouble > > &normals, const Array< OneD, const Array< OneD, NekDouble > > &vecLocs, Array< OneD, Array< OneD, NekDouble > > &outarray)
 Rotate a vector field from trace normal. More...
 
SOLVER_UTILS_EXPORT bool CheckScalars (std::string name)
 Determine whether a scalar has been defined in m_scalars. More...
 
SOLVER_UTILS_EXPORT bool CheckVectors (std::string name)
 Determine whether a vector has been defined in m_vectors. More...
 
SOLVER_UTILS_EXPORT bool CheckParams (std::string name)
 Determine whether a parameter has been defined in m_params. More...
 
SOLVER_UTILS_EXPORT bool CheckAuxScal (std::string name)
 Determine whether a scalar has been defined in m_auxScal. More...
 
SOLVER_UTILS_EXPORT bool CheckAuxVec (std::string name)
 Determine whether a vector has been defined in m_auxVec. More...
 
- Protected Member Functions inherited from Nektar::CompressibleSolver
 CompressibleSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
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)
 
virtual void v_ArraySolve (const Array< OneD, const Array< OneD, NekDouble > > &Fwd, const Array< OneD, const Array< OneD, NekDouble > > &Bwd, Array< OneD, Array< OneD, NekDouble > > &flux)
 
virtual void v_PointSolveVisc (NekDouble rhoL, NekDouble rhouL, NekDouble rhovL, NekDouble rhowL, NekDouble EL, NekDouble EpsL, NekDouble rhoR, NekDouble rhouR, NekDouble rhovR, NekDouble rhowR, NekDouble ER, NekDouble EpsR, NekDouble &rhof, NekDouble &rhouf, NekDouble &rhovf, NekDouble &rhowf, NekDouble &Ef, NekDouble &Epsf)
 
NekDouble GetRoeSoundSpeed (NekDouble rhoL, NekDouble pL, NekDouble eL, NekDouble HL, NekDouble srL, NekDouble rhoR, NekDouble pR, NekDouble eR, NekDouble HR, NekDouble srR, NekDouble HRoe, NekDouble URoe2, NekDouble srLR)
 

Additional Inherited Members

- Public Member Functions inherited from Nektar::SolverUtils::RiemannSolver
SOLVER_UTILS_EXPORT void 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)
 Perform the Riemann solve given the forwards and backwards spaces. More...
 
template<typename FuncPointerT , typename ObjectPointerT >
void SetScalar (std::string name, FuncPointerT func, ObjectPointerT obj)
 
void SetScalar (std::string name, RSScalarFuncType fp)
 
template<typename FuncPointerT , typename ObjectPointerT >
void SetVector (std::string name, FuncPointerT func, ObjectPointerT obj)
 
void SetVector (std::string name, RSVecFuncType fp)
 
template<typename FuncPointerT , typename ObjectPointerT >
void SetParam (std::string name, FuncPointerT func, ObjectPointerT obj)
 
void SetParam (std::string name, RSParamFuncType fp)
 
template<typename FuncPointerT , typename ObjectPointerT >
void SetAuxScal (std::string name, FuncPointerT func, ObjectPointerT obj)
 
template<typename FuncPointerT , typename ObjectPointerT >
void SetAuxVec (std::string name, FuncPointerT func, ObjectPointerT obj)
 
std::map< std::string, RSScalarFuncType > & GetScalars ()
 
std::map< std::string, RSVecFuncType > & GetVectors ()
 
std::map< std::string, RSParamFuncType > & GetParams ()
 
- Public Attributes inherited from Nektar::SolverUtils::RiemannSolver
int m_spacedim
 
- Protected Attributes inherited from Nektar::NonlinearSWESolver
bool m_pointSolve
 
- Protected Attributes inherited from Nektar::SolverUtils::RiemannSolver
bool m_requiresRotation
 Indicates whether the Riemann solver requires a rotation to be applied to the velocity fields. More...
 
std::map< std::string, RSScalarFuncTypem_scalars
 Map of scalar function types. More...
 
std::map< std::string, RSVecFuncTypem_vectors
 Map of vector function types. More...
 
std::map< std::string, RSParamFuncTypem_params
 Map of parameter function types. More...
 
std::map< std::string, RSScalarFuncTypem_auxScal
 Map of auxiliary scalar function types. More...
 
std::map< std::string, RSVecFuncTypem_auxVec
 Map of auxiliary vector function types. More...
 
Array< OneD, Array< OneD, NekDouble > > m_rotMat
 Rotation matrices for each trace quadrature point. More...
 
Array< OneD, Array< OneD, Array< OneD, NekDouble > > > m_rotStorage
 Rotation storage. More...
 
- Protected Attributes inherited from Nektar::CompressibleSolver
bool m_pointSolve
 
EquationOfStateSharedPtr m_eos
 
bool m_idealGas
 

Detailed Description

Definition at line 42 of file CompressibleFlowSolver/RiemannSolvers/LaxFriedrichsSolver.h.

Constructor & Destructor Documentation

◆ LaxFriedrichsSolver() [1/2]

Nektar::LaxFriedrichsSolver::LaxFriedrichsSolver ( const LibUtilities::SessionReaderSharedPtr pSession)
protected

Definition at line 45 of file CompressibleFlowSolver/RiemannSolvers/LaxFriedrichsSolver.cpp.

Referenced by create().

47  : CompressibleSolver(pSession)
48  {
49 
50  }
CompressibleSolver(const LibUtilities::SessionReaderSharedPtr &pSession)

◆ LaxFriedrichsSolver() [2/2]

Nektar::LaxFriedrichsSolver::LaxFriedrichsSolver ( const LibUtilities::SessionReaderSharedPtr pSession)
protected

Member Function Documentation

◆ create() [1/2]

static RiemannSolverSharedPtr Nektar::LaxFriedrichsSolver::create ( const LibUtilities::SessionReaderSharedPtr pSession)
inlinestatic

Definition at line 45 of file CompressibleFlowSolver/RiemannSolvers/LaxFriedrichsSolver.h.

References LaxFriedrichsSolver().

47  {
49  new LaxFriedrichsSolver(pSession));
50  }
std::shared_ptr< RiemannSolver > RiemannSolverSharedPtr
A shared pointer to an EquationSystem object.
LaxFriedrichsSolver(const LibUtilities::SessionReaderSharedPtr &pSession)

◆ create() [2/2]

static RiemannSolverSharedPtr Nektar::LaxFriedrichsSolver::create ( const LibUtilities::SessionReaderSharedPtr pSession)
inlinestatic

Definition at line 45 of file ShallowWaterSolver/RiemannSolvers/LaxFriedrichsSolver.h.

References LaxFriedrichsSolver(), solverName, and v_PointSolve().

47  {
49  new LaxFriedrichsSolver(pSession));
50  }
std::shared_ptr< RiemannSolver > RiemannSolverSharedPtr
A shared pointer to an EquationSystem object.
LaxFriedrichsSolver(const LibUtilities::SessionReaderSharedPtr &pSession)

◆ v_PointSolve() [1/2]

void Nektar::LaxFriedrichsSolver::v_PointSolve ( NekDouble  hL,
NekDouble  huL,
NekDouble  hvL,
NekDouble  hR,
NekDouble  huR,
NekDouble  hvR,
NekDouble hf,
NekDouble huf,
NekDouble hvf 
)
protectedvirtual

Lax-Friedrichs Riemann solver.

Parameters
hLWater depth left state.
hRWater depth right state.
huLx-momentum component left state.
huRx-momentum component right state.
hvLy-momentum component left state.
hvRy-momentum component right state.
hfComputed Riemann flux for density.
hufComputed Riemann flux for x-momentum component
hvfComputed Riemann flux for y-momentum component

Reimplemented from Nektar::NonlinearSWESolver.

Definition at line 65 of file ShallowWaterSolver/RiemannSolvers/LaxFriedrichsSolver.cpp.

References Nektar::SolverUtils::RiemannSolver::m_params, and sign.

69  {
70  static NekDouble g = m_params["gravity"]();
71 
72  // Left and right velocities
73  NekDouble uL = huL / hL;
74  NekDouble vL = hvL / hL;
75  NekDouble uR = huR / hR;
76  NekDouble vR = hvR / hR;
77 
78  // Left and right wave speeds
79  NekDouble cL = sqrt(g * hL);
80  NekDouble cR = sqrt(g * hR);
81 
82  // Square root of hL and hR.
83  NekDouble srL = sqrt(hL);
84  NekDouble srR = sqrt(hR);
85  NekDouble srLR = srL + srR;
86 
87  // Velocity Roe averages
88  NekDouble uRoe = (srL * uL + srR * uR) / srLR;
89  NekDouble cRoe = sqrt(0.5 * (cL * cL + cR * cR));
90 
91  // Minimum and maximum wave speeds
92  NekDouble S = std::max(uRoe+cRoe, std::max(uR+cR, -(uL-cL)));
93  NekDouble sign = 1.0;
94 
95  if(S == -(uL-cL))
96  {
97  sign = -1.0;
98  }
99 
100  // Lax-Friedrichs Riemann h flux
101  hf = 0.5 * ((huL + huR) - sign * S * (hR -hL));
102 
103  // Lax-Friedrichs Riemann hu flux
104  huf = 0.5 * ((hL * uL * uL + 0.5 * g * hL * hL +
105  hR * uR * uR + 0.5 * g * hR * hR) -
106  sign * S * (huR - huL));
107 
108  // Lax-Friedrichs Riemann hv flux
109  hvf = 0.5 * ((hL * uL * vL + hR * uR * vR) -
110  sign * S * (hvR - hvL));
111 
112  }
#define sign(a, b)
return the sign(b)*a
Definition: Polylib.cpp:16
double NekDouble
std::map< std::string, RSParamFuncType > m_params
Map of parameter function types.

◆ v_PointSolve() [2/2]

void Nektar::LaxFriedrichsSolver::v_PointSolve ( double  rhoL,
double  rhouL,
double  rhovL,
double  rhowL,
double  EL,
double  rhoR,
double  rhouR,
double  rhovR,
double  rhowR,
double  ER,
double &  rhof,
double &  rhouf,
double &  rhovf,
double &  rhowf,
double &  Ef 
)
protectedvirtual

Lax-Friedrichs Riemann solver.

Parameters
rhoLDensity left state.
rhoRDensity right state.
rhouLx-momentum component left state.
rhouRx-momentum component right state.
rhovLy-momentum component left state.
rhovRy-momentum component right state.
rhowLz-momentum component left state.
rhowRz-momentum component right state.
ELEnergy left state.
EREnergy right state.
rhofComputed Riemann flux for density.
rhoufComputed Riemann flux for x-momentum component
rhovfComputed Riemann flux for y-momentum component
rhowfComputed Riemann flux for z-momentum component
EfComputed Riemann flux for energy.

Reimplemented from Nektar::CompressibleSolver.

Definition at line 71 of file CompressibleFlowSolver/RiemannSolvers/LaxFriedrichsSolver.cpp.

References Nektar::CompressibleSolver::GetRoeSoundSpeed(), and Nektar::CompressibleSolver::m_eos.

Referenced by create().

75  {
76  // Left and right velocities
77  NekDouble uL = rhouL / rhoL;
78  NekDouble vL = rhovL / rhoL;
79  NekDouble wL = rhowL / rhoL;
80  NekDouble uR = rhouR / rhoR;
81  NekDouble vR = rhovR / rhoR;
82  NekDouble wR = rhowR / rhoR;
83 
84  // Internal energy (per unit mass)
85  NekDouble eL =
86  (EL - 0.5 * (rhouL * uL + rhovL * vL + rhowL * wL)) / rhoL;
87  NekDouble eR =
88  (ER - 0.5 * (rhouR * uR + rhovR * vR + rhowR * wR)) / rhoR;
89  // Pressure
90  NekDouble pL = m_eos->GetPressure(rhoL, eL);
91  NekDouble pR = m_eos->GetPressure(rhoR, eR);
92 
93  // Left and right total enthalpy
94  NekDouble HL = (EL + pL) / rhoL;
95  NekDouble HR = (ER + pR) / rhoR;
96 
97  // Square root of rhoL and rhoR.
98  NekDouble srL = sqrt(rhoL);
99  NekDouble srR = sqrt(rhoR);
100  NekDouble srLR = srL + srR;
101 
102  // Roe average state
103  NekDouble uRoe = (srL * uL + srR * uR) / srLR;
104  NekDouble vRoe = (srL * vL + srR * vR) / srLR;
105  NekDouble wRoe = (srL * wL + srR * wR) / srLR;
106  NekDouble URoe2 = uRoe*uRoe + vRoe*vRoe + wRoe*wRoe;
107  NekDouble HRoe = (srL * HL + srR * HR) / srLR;
109  rhoL, pL, eL, HL, srL,
110  rhoR, pR, eR, HR, srR,
111  HRoe, URoe2, srLR);
112 
113  // Maximum eigenvalue
114  NekDouble URoe = fabs(uRoe) + cRoe;
115 
116  // Lax-Friedrichs flux formula
117  rhof = 0.5*(rhouL + rhouR - URoe*(rhoR - rhoL));
118  rhouf = 0.5*(pL + rhouL*uL + pR + rhouR*uR - URoe*(rhouR - rhouL));
119  rhovf = 0.5*(rhouL*vL + rhouR*vR - URoe*(rhovR - rhovL));
120  rhowf = 0.5*(rhouL*wL + rhouR*wR - URoe*(rhowR - rhowL));
121  Ef = 0.5*(uL*(EL + pL) + uR*(ER + pR) - URoe*(ER - EL));
122  }
double NekDouble
NekDouble GetRoeSoundSpeed(NekDouble rhoL, NekDouble pL, NekDouble eL, NekDouble HL, NekDouble srL, NekDouble rhoR, NekDouble pR, NekDouble eR, NekDouble HR, NekDouble srR, NekDouble HRoe, NekDouble URoe2, NekDouble srLR)
EquationOfStateSharedPtr m_eos

Member Data Documentation

◆ solverName

static std::string Nektar::LaxFriedrichsSolver::solverName
static
Initial value:
=
"LaxFriedrichs",
"Lax-Friedrichs Riemann solver")

Definition at line 52 of file CompressibleFlowSolver/RiemannSolvers/LaxFriedrichsSolver.h.

Referenced by create().