Nektar++
Protected Member Functions | Protected Attributes | List of all members
Nektar::NonlinearSWESolver Class Reference

#include <NonlinearSWESolver.h>

Inheritance diagram for Nektar::NonlinearSWESolver:
Inheritance graph
[legend]
Collaboration diagram for Nektar::NonlinearSWESolver:
Collaboration graph
[legend]

Protected Member Functions

 NonlinearSWESolver ()
 
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_PointSolve (NekDouble hL, NekDouble huL, NekDouble hvL, NekDouble hR, NekDouble huR, NekDouble hvR, NekDouble &hf, NekDouble &huf, NekDouble &hvf)
 
- Protected Member Functions inherited from Nektar::SolverUtils::RiemannSolver
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 Attributes

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

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
 

Detailed Description

Definition at line 45 of file NonlinearSWESolver.h.

Constructor & Destructor Documentation

Nektar::NonlinearSWESolver::NonlinearSWESolver ( )
protected

Definition at line 40 of file NonlinearSWESolver.cpp.

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

40  : RiemannSolver(),
41  m_pointSolve(true)
42  {
43  m_requiresRotation = true;
44  }
SOLVER_UTILS_EXPORT RiemannSolver()
bool m_requiresRotation
Indicates whether the Riemann solver requires a rotation to be applied to the velocity fields...

Member Function Documentation

virtual void Nektar::NonlinearSWESolver::v_ArraySolve ( const Array< OneD, const Array< OneD, NekDouble > > &  Fwd,
const Array< OneD, const Array< OneD, NekDouble > > &  Bwd,
Array< OneD, Array< OneD, NekDouble > > &  flux 
)
inlineprotectedvirtual

Reimplemented in Nektar::AverageSolver.

Definition at line 58 of file NonlinearSWESolver.h.

References ASSERTL0.

Referenced by v_Solve().

62  {
63  ASSERTL0(false, "This function should be defined by subclasses.");
64  }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:161
virtual void Nektar::NonlinearSWESolver::v_PointSolve ( NekDouble  hL,
NekDouble  huL,
NekDouble  hvL,
NekDouble  hR,
NekDouble  huR,
NekDouble  hvR,
NekDouble hf,
NekDouble huf,
NekDouble hvf 
)
inlineprotectedvirtual

Reimplemented in Nektar::AverageSolver, Nektar::HLLCSolver, Nektar::HLLSolver, and Nektar::LaxFriedrichsSolver.

Definition at line 66 of file NonlinearSWESolver.h.

References ASSERTL0.

Referenced by v_Solve().

70  {
71  ASSERTL0(false, "This function should be defined by subclasses.");
72  }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:161
void Nektar::NonlinearSWESolver::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 
)
protectedvirtual

Implements Nektar::SolverUtils::RiemannSolver.

Definition at line 46 of file NonlinearSWESolver.cpp.

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

51  {
52  if (m_pointSolve)
53  {
54  int expDim = Fwd.num_elements()-1;
55  NekDouble hvf;
56 
57  if (expDim == 1)
58  {
59  for (int i = 0; i < Fwd[0].num_elements(); ++i)
60  {
62  Fwd [0][i], Fwd [1][i], 0.0,
63  Bwd [0][i], Bwd [1][i], 0.0,
64  flux[0][i], flux[1][i], hvf);
65  }
66  }
67  else if (expDim == 2)
68  {
69  for (int i = 0; i < Fwd[0].num_elements(); ++i)
70  {
72  Fwd [0][i], Fwd [1][i], Fwd [2][i],
73  Bwd [0][i], Bwd [1][i], Bwd [2][i],
74  flux[0][i], flux[1][i], flux[2][i]);
75  }
76  }
77  else if (expDim == 3)
78  {
79  ASSERTL0(false, "No 3D Shallow water supported.");
80  }
81  }
82  else
83  {
84  v_ArraySolve(Fwd, Bwd, flux);
85  }
86  }
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)
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:161
virtual void v_PointSolve(NekDouble hL, NekDouble huL, NekDouble hvL, NekDouble hR, NekDouble huR, NekDouble hvR, NekDouble &hf, NekDouble &huf, NekDouble &hvf)
double NekDouble

Member Data Documentation

bool Nektar::NonlinearSWESolver::m_pointSolve
protected

Definition at line 48 of file NonlinearSWESolver.h.

Referenced by v_Solve().