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

#include <HLLSolver.h>

Inheritance diagram for Nektar::HLLSolver:
[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

 HLLSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
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) override
 HLL Riemann solver. More...
 
 HLLSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
void v_PointSolve (NekDouble hL, NekDouble huL, NekDouble hvL, NekDouble hR, NekDouble huR, NekDouble hvR, NekDouble &hf, NekDouble &huf, NekDouble &hvf) override
 HLL Riemann solver for the Nonlinear Shallow Water Equations. More...
 
- Protected Member Functions inherited from Nektar::CompressibleSolver
 CompressibleSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 Session ctor. More...
 
 CompressibleSolver ()
 Programmatic ctor. More...
 
void v_Solve (const int nDim, const Array< OneD, const Array< OneD, ND > > &Fwd, const Array< OneD, const Array< OneD, ND > > &Bwd, Array< OneD, Array< OneD, ND > > &flux) override
 
virtual void v_ArraySolve (const Array< OneD, const Array< OneD, ND > > &Fwd, const Array< OneD, const Array< OneD, ND > > &Bwd, Array< OneD, Array< OneD, ND > > &flux)
 
virtual void v_PointSolve (ND rhoL, ND rhouL, ND rhovL, ND rhowL, ND EL, ND rhoR, ND rhouR, ND rhovR, ND rhowR, ND ER, ND &rhof, ND &rhouf, ND &rhovf, ND &rhowf, ND &Ef)
 
ND GetRoeSoundSpeed (ND rhoL, ND pL, ND eL, ND HL, ND srL, ND rhoR, ND pR, ND eR, ND HR, ND srR, ND HRoe, ND URoe2, ND srLR)
 
- Protected Member Functions inherited from Nektar::SolverUtils::RiemannSolver
SOLVER_UTILS_EXPORT RiemannSolver ()
 
SOLVER_UTILS_EXPORT RiemannSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
virtual SOLVER_UTILS_EXPORT ~RiemannSolver ()
 
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)=0
 
SOLVER_UTILS_EXPORT 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...
 
virtual SOLVER_UTILS_EXPORT void v_CalcFluxJacobian (const int nDim, const Array< OneD, const Array< OneD, NekDouble > > &Fwd, const Array< OneD, const Array< OneD, NekDouble > > &Bwd, const Array< OneD, const Array< OneD, NekDouble > > &normals, DNekBlkMatSharedPtr &FJac, DNekBlkMatSharedPtr &BJac)
 
- Protected Member Functions inherited from Nektar::NonlinearSWESolver
 NonlinearSWESolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
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) override
 
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_PointSolve (NekDouble hL, NekDouble huL, NekDouble hvL, NekDouble hR, NekDouble huR, NekDouble hvR, NekDouble &hf, NekDouble &huf, NekDouble &hvf)
 

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 SetALEFlag (bool &ALE)
 
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)
 
void SetAuxVec (std::string name, RSVecFuncType fp)
 
std::map< std::string, RSScalarFuncType > & GetScalars ()
 
std::map< std::string, RSVecFuncType > & GetVectors ()
 
std::map< std::string, RSParamFuncType > & GetParams ()
 
SOLVER_UTILS_EXPORT void CalcFluxJacobian (const int nDim, const Array< OneD, const Array< OneD, NekDouble > > &Fwd, const Array< OneD, const Array< OneD, NekDouble > > &Bwd, DNekBlkMatSharedPtr &FJac, DNekBlkMatSharedPtr &BJac)
 Calculate the flux jacobian of Fwd and Bwd. More...
 
- Public Attributes inherited from Nektar::SolverUtils::RiemannSolver
int m_spacedim
 
- Protected Types inherited from Nektar::CompressibleSolver
using ND = NekDouble
 
- Protected Attributes inherited from Nektar::CompressibleSolver
bool m_pointSolve
 
EquationOfStateSharedPtr m_eos
 
bool m_idealGas
 
- 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...
 
bool m_ALESolver = false
 Flag if using the ALE formulation. More...
 
- Protected Attributes inherited from Nektar::NonlinearSWESolver
bool m_pointSolve
 

Detailed Description

Definition at line 43 of file CompressibleFlowSolver/RiemannSolvers/HLLSolver.h.

Constructor & Destructor Documentation

◆ HLLSolver() [1/2]

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

Definition at line 44 of file CompressibleFlowSolver/RiemannSolvers/HLLSolver.cpp.

45 : CompressibleSolver(pSession)
46{
47}
CompressibleSolver()
Programmatic ctor.

Referenced by create().

◆ HLLSolver() [2/2]

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

Member Function Documentation

◆ create() [1/2]

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

Definition at line 46 of file CompressibleFlowSolver/RiemannSolvers/HLLSolver.h.

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

References HLLSolver().

◆ create() [2/2]

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

Definition at line 46 of file ShallowWaterSolver/RiemannSolvers/HLLSolver.h.

48 {
49 return RiemannSolverSharedPtr(new HLLSolver(pSession));
50 }

References HLLSolver().

◆ v_PointSolve() [1/2]

void Nektar::HLLSolver::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 
)
overrideprotectedvirtual

HLL 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 68 of file CompressibleFlowSolver/RiemannSolvers/HLLSolver.cpp.

73{
74 // Left and Right velocities
75 NekDouble uL = rhouL / rhoL;
76 NekDouble vL = rhovL / rhoL;
77 NekDouble wL = rhowL / rhoL;
78 NekDouble uR = rhouR / rhoR;
79 NekDouble vR = rhovR / rhoR;
80 NekDouble wR = rhowR / rhoR;
81
82 // Internal energy (per unit mass)
83 NekDouble eL = (EL - 0.5 * (rhouL * uL + rhovL * vL + rhowL * wL)) / rhoL;
84 NekDouble eR = (ER - 0.5 * (rhouR * uR + rhovR * vR + rhowR * wR)) / rhoR;
85 // Pressure
86 NekDouble pL = m_eos->GetPressure(rhoL, eL);
87 NekDouble pR = m_eos->GetPressure(rhoR, eR);
88 // Speed of sound
89 NekDouble cL = m_eos->GetSoundSpeed(rhoL, eL);
90 NekDouble cR = m_eos->GetSoundSpeed(rhoR, eR);
91
92 // Left and right total enthalpy
93 NekDouble HL = (EL + pL) / rhoL;
94 NekDouble HR = (ER + pR) / rhoR;
95
96 // Square root of rhoL and rhoR.
97 NekDouble srL = sqrt(rhoL);
98 NekDouble srR = sqrt(rhoR);
99 NekDouble srLR = srL + srR;
100
101 // Roe average state
102 NekDouble uRoe = (srL * uL + srR * uR) / srLR;
103 NekDouble vRoe = (srL * vL + srR * vR) / srLR;
104 NekDouble wRoe = (srL * wL + srR * wR) / srLR;
105 NekDouble URoe2 = uRoe * uRoe + vRoe * vRoe + wRoe * wRoe;
106 NekDouble HRoe = (srL * HL + srR * HR) / srLR;
107 NekDouble cRoe = GetRoeSoundSpeed(rhoL, pL, eL, HL, srL, rhoR, pR, eR, HR,
108 srR, HRoe, URoe2, srLR);
109
110 // Maximum wave speeds
111 NekDouble SL = std::min(uL - cL, uRoe - cRoe);
112 NekDouble SR = std::max(uR + cR, uRoe + cRoe);
113
114 // HLL Riemann fluxes (positive case)
115 if (SL >= 0)
116 {
117 rhof = rhouL;
118 rhouf = rhouL * uL + pL;
119 rhovf = rhouL * vL;
120 rhowf = rhouL * wL;
121 Ef = uL * (EL + pL);
122 }
123 // HLL Riemann fluxes (negative case)
124 else if (SR <= 0)
125 {
126 rhof = rhouR;
127 rhouf = rhouR * uR + pR;
128 rhovf = rhouR * vR;
129 rhowf = rhouR * wR;
130 Ef = uR * (ER + pR);
131 }
132 // HLL Riemann fluxes (general case (SL < 0 | SR > 0)
133 else
134 {
135 NekDouble tmp1 = 1.0 / (SR - SL);
136 NekDouble tmp2 = SR * SL;
137 rhof = (SR * rhouL - SL * rhouR + tmp2 * (rhoR - rhoL)) * tmp1;
138 rhouf = (SR * (rhouL * uL + pL) - SL * (rhouR * uR + pR) +
139 tmp2 * (rhouR - rhouL)) *
140 tmp1;
141 rhovf =
142 (SR * rhouL * vL - SL * rhouR * vR + tmp2 * (rhovR - rhovL)) * tmp1;
143 rhowf =
144 (SR * rhouL * wL - SL * rhouR * wR + tmp2 * (rhowR - rhowL)) * tmp1;
145 Ef = (SR * uL * (EL + pL) - SL * uR * (ER + pR) + tmp2 * (ER - EL)) *
146 tmp1;
147 }
148}
ND GetRoeSoundSpeed(ND rhoL, ND pL, ND eL, ND HL, ND srL, ND rhoR, ND pR, ND eR, ND HR, ND srR, ND HRoe, ND URoe2, ND srLR)
EquationOfStateSharedPtr m_eos
double NekDouble
scalarT< T > sqrt(scalarT< T > in)
Definition: scalar.hpp:285

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

◆ v_PointSolve() [2/2]

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

HLL Riemann solver for the Nonlinear Shallow Water Equations.

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 62 of file ShallowWaterSolver/RiemannSolvers/HLLSolver.cpp.

65{
66 static NekDouble g = m_params["gravity"]();
67
68 // Left and Right velocities
69 NekDouble uL = huL / hL;
70 NekDouble vL = hvL / hL;
71 NekDouble uR = huR / hR;
72 NekDouble vR = hvR / hR;
73
74 // Left and right wave speeds
75 NekDouble cL = sqrt(g * hL);
76 NekDouble cR = sqrt(g * hR);
77
78 // the two-rarefaction wave assumption
79 NekDouble hstar, fL, fR;
80 hstar = 0.5 * (cL + cR) + 0.25 * (uL - uR);
81 hstar *= hstar;
82 hstar *= (1.0 / g);
83
84 // Compute SL
85 NekDouble SL;
86 if (hstar > hL)
87 {
88 SL = uL - cL * sqrt(0.5 * ((hstar * hstar + hstar * hL) / (hL * hL)));
89 }
90 else
91 {
92 SL = uL - cL;
93 }
94
95 // Compute SR
96 NekDouble SR;
97 if (hstar > hR)
98 {
99 SR = uR + cR * sqrt(0.5 * ((hstar * hstar + hstar * hR) / (hR * hR)));
100 }
101 else
102 {
103 SR = uR + cR;
104 }
105
106 if (SL >= 0)
107 {
108 hf = hL * uL;
109 huf = uL * uL * hL + 0.5 * g * hL * hL;
110 hvf = hL * uL * vL;
111 }
112 else if (SR <= 0)
113 {
114 hf = hR * uR;
115 huf = uR * uR * hR + 0.5 * g * hR * hR;
116 hvf = hR * uR * vR;
117 }
118 else
119 {
120 hf = (SR * hL * uL - SL * hR * uR + SL * SR * (hR - hL)) / (SR - SL);
121 fL = uL * uL * hL + 0.5 * g * hL * hL;
122 fR = uR * uR * hR + 0.5 * g * hR * hR;
123 huf = (SR * fL - SL * fR + SL * SR * (hR * uR - hL * uL)) / (SR - SL);
124 fL = uL * vL * hL;
125 fR = uR * vR * hR;
126 hvf = (SR * fL - SL * fR + SL * SR * (hR * vR - hL * vL)) / (SR - SL);
127 }
128}
std::map< std::string, RSParamFuncType > m_params
Map of parameter function types.

References tinysimd::sqrt().

Member Data Documentation

◆ solverName

static std::string Nektar::HLLSolver::solverName
static
Initial value:
=
"HLL", HLLSolver::create, "HLL Riemann solver")
static RiemannSolverSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession)
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
RiemannSolverFactory & GetRiemannSolverFactory()

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