Nektar::CompressibleSolver Class Reference

#include <CompressibleSolver.h>

Inheritance diagram for Nektar::CompressibleSolver:

Protected Types
using	ND = NekDouble

Protected Member Functions
	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 Attributes
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, RSScalarFuncType >	m_scalars
	Map of scalar function types. More...
std::map< std::string, RSVecFuncType >	m_vectors
	Map of vector function types. More...
std::map< std::string, RSParamFuncType >	m_params
	Map of parameter function types. More...
std::map< std::string, RSScalarFuncType >	m_auxScal
	Map of auxiliary scalar function types. More...
std::map< std::string, RSVecFuncType >	m_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...

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)
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

Detailed Description

Definition at line 45 of file CompressibleSolver.h.

Member Typedef Documentation

ND

using Nektar::CompressibleSolver::ND = NekDouble

protected

Definition at line 58 of file CompressibleSolver.h.

Constructor & Destructor Documentation

CompressibleSolver() [1/2]

Nektar::CompressibleSolver::CompressibleSolver ( const LibUtilities::SessionReaderSharedPtr &  pSession )

protected

Session ctor.

Definition at line 40 of file CompressibleSolver.cpp.

    : RiemannSolver(pSession), m_pointSolve(true)
{
    m_requiresRotation = true;
 
    // Create equation of state object
    std::string eosType;
    pSession->LoadSolverInfo("EquationOfState", eosType, "IdealGas");
    m_eos = GetEquationOfStateFactory().CreateInstance(eosType, pSession);
    // Check if using ideal gas
    m_idealGas = boost::iequals(eosType, "IdealGas");
}

References Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::GetEquationOfStateFactory(), m_eos, m_idealGas, and Nektar::SolverUtils::RiemannSolver::m_requiresRotation.

CompressibleSolver() [2/2]

Nektar::CompressibleSolver::CompressibleSolver ( )

protected

Programmatic ctor.

Definition at line 54 of file CompressibleSolver.cpp.

    : RiemannSolver(), m_pointSolve(true), m_idealGas(true)
{
    m_requiresRotation = true;
}

References Nektar::SolverUtils::RiemannSolver::m_requiresRotation.

Member Function Documentation

GetRoeSoundSpeed()

NekDouble Nektar::CompressibleSolver::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

Definition at line 112 of file CompressibleSolver.cpp.

{
    static NekDouble gamma = m_params["gamma"]();
    NekDouble cRoe;
    if (m_idealGas)
    {
        cRoe = sqrt((gamma - 1.0) * (HRoe - 0.5 * URoe2));
    }
    else
    {
        // Calculate static enthalpy of left and right states
        NekDouble hL = eL + pL / rhoL;
        NekDouble hR = eR + pR / rhoR;
 
        // Get partial derivatives of P(rho,e)
        NekDouble dpdeL   = m_eos->GetDPDe_rho(rhoL, eL);
        NekDouble dpdeR   = m_eos->GetDPDe_rho(rhoR, eR);
        NekDouble dpdrhoL = m_eos->GetDPDrho_e(rhoL, eL);
        NekDouble dpdrhoR = m_eos->GetDPDrho_e(rhoR, eR);
 
        // Evaluate chi and kappa parameters
        NekDouble chiL   = dpdrhoL - eL / rhoL * dpdeL;
        NekDouble kappaL = dpdeL / rhoL;
        NekDouble chiR   = dpdrhoR - eR / rhoR * dpdeR;
        NekDouble kappaR = dpdeR / rhoR;
 
        //
        // Calculate interface speed of sound using procedure from
        //    Vinokur, M.; Montagné, J.-L. "Generalized Flux-Vector
        //    Splitting and Roe Average for an Equilibrium Real Gas",
        //    JCP (1990).
        //
 
        // Calculate averages
        NekDouble avgChi    = 0.5 * (chiL + chiR);
        NekDouble avgKappa  = 0.5 * (kappaL + kappaR);
        NekDouble avgKappaH = 0.5 * (kappaL * hL + kappaR * hR);
 
        // Calculate jumps
        NekDouble deltaP    = pR - pL;
        NekDouble deltaRho  = rhoR - rhoL;
        NekDouble deltaRhoe = rhoR * eR - rhoL * eL;
 
        // Evaluate dP: equation (64) from Vinokur-Montagné
        NekDouble dP = deltaP - avgChi * deltaRho - avgKappa * deltaRhoe;
        // s (eq 66)
        NekDouble s = avgChi + avgKappaH;
        // D (eq 65)
        NekDouble D = (s * deltaRho) * (s * deltaRho) + deltaP * deltaP;
        // chiRoe and kappaRoe (eq 66)
        NekDouble chiRoe, kappaRoe;
        NekDouble fac = D - deltaP * deltaRho;
        if (std::abs(fac) > NekConstants::kNekZeroTol)
        {
            chiRoe   = (D * avgChi + s * s * deltaRho * dP) / fac;
            kappaRoe = D * avgKappa / fac;
        }
        else
        {
            chiRoe   = avgChi;
            kappaRoe = avgKappa;
        }
        // Speed of sound (eq 53)
        cRoe = sqrt(chiRoe + kappaRoe * (HRoe - 0.5 * URoe2));
    }
    return cRoe;
}

References tinysimd::abs(), Nektar::NekConstants::kNekZeroTol, m_eos, m_idealGas, Nektar::SolverUtils::RiemannSolver::m_params, and tinysimd::sqrt().

Referenced by Nektar::HLLSolver::v_PointSolve(), Nektar::LaxFriedrichsSolver::v_PointSolve(), and Nektar::HLLCSolver::v_PointSolve().

v_ArraySolve()

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

inlineprotectedvirtual

Reimplemented in Nektar::RoeSolver, and Nektar::AverageSolver.

Definition at line 64 of file CompressibleSolver.h.

    {
        NEKERROR(ErrorUtil::efatal,
                 "This function should be defined by subclasses.");
    }

References Nektar::ErrorUtil::efatal, and NEKERROR.

Referenced by v_Solve().

v_PointSolve()

virtual void Nektar::CompressibleSolver::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  )

inlineprotectedvirtual

Reimplemented in Nektar::AUSM0Solver, Nektar::AUSM1Solver, Nektar::AUSM2Solver, Nektar::AUSM3Solver, Nektar::HLLSolver, Nektar::LaxFriedrichsSolver, Nektar::RoeSolver, Nektar::ExactSolverToro, and Nektar::HLLCSolver.

Definition at line 73 of file CompressibleSolver.h.

    {
        NEKERROR(ErrorUtil::efatal,
                 "This function should be defined by subclasses.");
    }

References Nektar::ErrorUtil::efatal, and NEKERROR.

Referenced by v_Solve().

v_Solve()

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

overrideprotectedvirtual

Implements Nektar::SolverUtils::RiemannSolver.

Reimplemented in Nektar::RoeSolverSIMD.

Definition at line 63 of file CompressibleSolver.cpp.

{
    if (m_pointSolve)
    {
        size_t expDim = nDim;
        NekDouble rhouf{}, rhovf{};
 
        if (expDim == 1)
        {
            for (size_t i = 0; i < Fwd[0].size(); ++i)
            {
                v_PointSolve(Fwd[0][i], Fwd[1][i], 0.0, 0.0, Fwd[2][i],
                             Bwd[0][i], Bwd[1][i], 0.0, 0.0, Bwd[2][i],
                             flux[0][i], flux[1][i], rhouf, rhovf, flux[2][i]);
            }
        }
        else if (expDim == 2)
        {
            for (size_t i = 0; i < Fwd[0].size(); ++i)
            {
                v_PointSolve(Fwd[0][i], Fwd[1][i], Fwd[2][i], 0.0, Fwd[3][i],
                             Bwd[0][i], Bwd[1][i], Bwd[2][i], 0.0, Bwd[3][i],
                             flux[0][i], flux[1][i], flux[2][i], rhovf,
                             flux[3][i]);
            }
        }
        else if (expDim == 3)
        {
            for (size_t i = 0; i < Fwd[0].size(); ++i)
            {
                v_PointSolve(Fwd[0][i], Fwd[1][i], Fwd[2][i], Fwd[3][i],
                             Fwd[4][i], Bwd[0][i], Bwd[1][i], Bwd[2][i],
                             Bwd[3][i], Bwd[4][i], flux[0][i], flux[1][i],
                             flux[2][i], flux[3][i], flux[4][i]);
            }
        }
    }
    else
    {
        v_ArraySolve(Fwd, Bwd, flux);
    }
}

References m_pointSolve, v_ArraySolve(), and v_PointSolve().

Member Data Documentation

m_eos

EquationOfStateSharedPtr Nektar::CompressibleSolver::m_eos

protected

Definition at line 49 of file CompressibleSolver.h.

Referenced by CompressibleSolver(), GetRoeSoundSpeed(), Nektar::AverageSolver::v_ArraySolve(), Nektar::AUSM0Solver::v_PointSolve(), Nektar::AUSM1Solver::v_PointSolve(), Nektar::AUSM2Solver::v_PointSolve(), Nektar::AUSM3Solver::v_PointSolve(), Nektar::HLLSolver::v_PointSolve(), Nektar::LaxFriedrichsSolver::v_PointSolve(), and Nektar::HLLCSolver::v_PointSolve().

m_idealGas

bool Nektar::CompressibleSolver::m_idealGas

protected

Definition at line 50 of file CompressibleSolver.h.

Referenced by CompressibleSolver(), and GetRoeSoundSpeed().

m_pointSolve

bool Nektar::CompressibleSolver::m_pointSolve

protected

Definition at line 48 of file CompressibleSolver.h.

Referenced by Nektar::AverageSolver::AverageSolver(), and v_Solve().