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

#include <RoeSolver.h>

Inheritance diagram for Nektar::RoeSolver:
[legend]

Public Member Functions

 RoeSolver ()
 programmatic ctor More...
 
- 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...
 

Static Public Member Functions

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

Static Public Attributes

static std::string solverName
 

Protected Types

using ND = NekDouble
 
- Protected Types inherited from Nektar::CompressibleSolver
using ND = NekDouble
 

Protected Member Functions

 RoeSolver (const LibUtilities::SessionReaderSharedPtr &pSession)
 
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) final
 Roe Riemann solver. More...
 
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) final
 
- 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)
 

Additional Inherited Members

- Public Attributes inherited from Nektar::SolverUtils::RiemannSolver
int m_spacedim
 
- 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...
 

Detailed Description

Definition at line 43 of file RoeSolver.h.

Member Typedef Documentation

◆ ND

using Nektar::RoeSolver::ND = NekDouble
protected

Definition at line 60 of file RoeSolver.h.

Constructor & Destructor Documentation

◆ RoeSolver() [1/2]

Nektar::RoeSolver::RoeSolver ( )

programmatic ctor

Definition at line 53 of file RoeSolver.cpp.

54{
55 // m_pointSolve = false;
56}
CompressibleSolver()
Programmatic ctor.

Referenced by create().

◆ RoeSolver() [2/2]

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

Definition at line 46 of file RoeSolver.cpp.

47 : CompressibleSolver(pSession)
48{
49 // m_pointSolve = false;
50}

Member Function Documentation

◆ create()

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

Definition at line 46 of file RoeSolver.h.

48 {
49 return RiemannSolverSharedPtr(new RoeSolver(pSession));
50 }
RoeSolver()
programmatic ctor
Definition: RoeSolver.cpp:53
std::shared_ptr< RiemannSolver > RiemannSolverSharedPtr
A shared pointer to an EquationSystem object.

References RoeSolver().

◆ v_ArraySolve()

void Nektar::RoeSolver::v_ArraySolve ( const Array< OneD, const Array< OneD, ND > > &  Fwd,
const Array< OneD, const Array< OneD, ND > > &  Bwd,
Array< OneD, Array< OneD, ND > > &  flux 
)
finalprotectedvirtual

Reimplemented from Nektar::CompressibleSolver.

Definition at line 99 of file RoeSolver.cpp.

103{
104 static auto gamma = m_params["gamma"]();
105 static size_t nVars = fwd.size();
106 static size_t spaceDim = nVars - 2;
107
108 using namespace tinysimd;
109 using vec_t = simd<NekDouble>;
110
111 // get limit of vectorizable chunk
112 size_t sizeScalar = fwd[0].size();
113 size_t sizeVec = (sizeScalar / vec_t::width) * vec_t::width;
114
115 // SIMD loop
116 size_t i = 0;
117 for (; i < sizeVec; i += vec_t::width)
118 {
119 vec_t rhoL{}, rhouL{}, rhovL{}, rhowL{}, EL{};
120 vec_t rhoR{}, rhouR{}, rhovR{}, rhowR{}, ER{};
121
122 // load
123 rhoL.load(&(fwd[0][i]), is_not_aligned);
124 rhouL.load(&(fwd[1][i]), is_not_aligned);
125 EL.load(&(fwd[spaceDim + 1][i]), is_not_aligned);
126 rhoR.load(&(bwd[0][i]), is_not_aligned);
127 rhouR.load(&(bwd[1][i]), is_not_aligned);
128 ER.load(&(bwd[spaceDim + 1][i]), is_not_aligned);
129
130 if (spaceDim == 2)
131 {
132 rhovL.load(&(fwd[2][i]), is_not_aligned);
133 rhovR.load(&(bwd[2][i]), is_not_aligned);
134 }
135 else if (spaceDim == 3)
136 {
137 rhovL.load(&(fwd[2][i]), is_not_aligned);
138 rhowL.load(&(fwd[3][i]), is_not_aligned);
139 rhovR.load(&(bwd[2][i]), is_not_aligned);
140 rhowR.load(&(bwd[3][i]), is_not_aligned);
141 }
142
143 vec_t rhof{}, rhouf{}, rhovf{}, rhowf{}, Ef{};
144
145 RoeKernel(rhoL, rhouL, rhovL, rhowL, EL, rhoR, rhouR, rhovR, rhowR, ER,
146 rhof, rhouf, rhovf, rhowf, Ef, gamma);
147
148 // store
149 rhof.store(&(flux[0][i]), is_not_aligned);
150 rhouf.store(&(flux[1][i]), is_not_aligned);
151 Ef.store(&(flux[nVars - 1][i]), is_not_aligned);
152 if (spaceDim == 2)
153 {
154 rhovf.store(&(flux[2][i]), is_not_aligned);
155 }
156 else if (spaceDim == 3)
157 {
158 rhovf.store(&(flux[2][i]), is_not_aligned);
159 rhowf.store(&(flux[3][i]), is_not_aligned);
160 }
161
162 } // avx loop
163
164 // spillover loop
165 for (; i < sizeScalar; ++i)
166 {
167 NekDouble rhoL{}, rhouL{}, rhovL{}, rhowL{}, EL{};
168 NekDouble rhoR{}, rhouR{}, rhovR{}, rhowR{}, ER{};
169
170 // load
171 rhoL = fwd[0][i];
172 rhouL = fwd[1][i];
173 EL = fwd[spaceDim + 1][i];
174 rhoR = bwd[0][i];
175 rhouR = bwd[1][i];
176 ER = bwd[spaceDim + 1][i];
177
178 if (spaceDim == 2)
179 {
180 rhovL = fwd[2][i];
181 rhovR = bwd[2][i];
182 }
183 else if (spaceDim == 3)
184 {
185 rhovL = fwd[2][i];
186 rhowL = fwd[3][i];
187 rhovR = bwd[2][i];
188 rhowR = bwd[3][i];
189 }
190
191 NekDouble rhof{}, rhouf{}, rhovf{}, rhowf{}, Ef{};
192
193 RoeKernel(rhoL, rhouL, rhovL, rhowL, EL, rhoR, rhouR, rhovR, rhowR, ER,
194 rhof, rhouf, rhovf, rhowf, Ef, gamma);
195
196 // store
197 flux[0][i] = rhof;
198 flux[1][i] = rhouf;
199 flux[nVars - 1][i] = Ef;
200 if (spaceDim == 2)
201 {
202 flux[2][i] = rhovf;
203 }
204 else if (spaceDim == 3)
205 {
206 flux[2][i] = rhovf;
207 flux[3][i] = rhowf;
208 }
209
210 } // loop
211}
std::map< std::string, RSParamFuncType > m_params
Map of parameter function types.
void RoeKernel(T &rhoL, T &rhouL, T &rhovL, T &rhowL, T &EL, T &rhoR, T &rhouR, T &rhovR, T &rhowR, T &ER, T &rhof, T &rhouf, T &rhovf, T &rhowf, T &Ef, NekDouble gamma)
Definition: RoeSolver.h:74
tinysimd::simd< NekDouble > vec_t
double NekDouble
static constexpr struct tinysimd::is_not_aligned_t is_not_aligned
typename abi< ScalarType, width >::type simd
Definition: tinysimd.hpp:80

References tinysimd::is_not_aligned, Nektar::SolverUtils::RiemannSolver::m_params, and Nektar::RoeKernel().

◆ v_PointSolve()

void Nektar::RoeSolver::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 
)
finalprotectedvirtual

Roe Riemann solver.

Stated equations numbers are from:

"Riemann Solvers and Numerical Methods for Fluid Dynamics: A Practical Introduction", E. F. Toro (3rd edition, 2009).

We follow the algorithm prescribed following equation 11.70.

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 84 of file RoeSolver.cpp.

89{
90 static NekDouble gamma = m_params["gamma"]();
91
92 RoeKernel(rhoL, rhouL, rhovL, rhowL, EL, rhoR, rhouR, rhovR, rhowR, ER,
93 rhof, rhouf, rhovf, rhowf, Ef, gamma);
94}

References Nektar::SolverUtils::RiemannSolver::m_params, and Nektar::RoeKernel().

Member Data Documentation

◆ solverName

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

Definition at line 52 of file RoeSolver.h.