Nektar::SolverUtils Namespace Reference

Classes
class	Advection
	An abstract base class encapsulating the concept of advection of a vector field. More...
class	Advection3DHomogeneous1D
class	AdvectionFR
class	AdvectionNonConservative
class	AdvectionSystem
	A base class for PDEs which include an advection component. More...
class	AdvectionWeakDG
class	Coupling
class	CouplingCwipi
class	CouplingFile
class	Diffusion
class	Diffusion3DHomogeneous1D
class	DiffusionIP
class	DiffusionLDG
class	DiffusionLFR
class	DiffusionLFRNS
class	Driver
	Base class for the development of solvers. More...
class	DriverAdaptive
	Base class for the adaptive polynomial order driver. More...
class	DriverArnoldi
	Base class for the development of solvers. More...
class	DriverArpack
	Base class for the development of solvers. More...
class	DriverModifiedArnoldi
class	DriverParallelInTime
	Base class for the development of parallel-in-time solvers. More...
class	DriverParareal
	Base class for the development of solvers. More...
class	DriverPFASST
	Base class for the development of solvers. More...
class	DriverStandard
	Base class for the development of solvers. More...
class	DriverSteadyState
class	EquationSystem
	A base class for describing how to solve specific equations. More...
class	Filter
class	FilterAeroForces
class	FilterAverageFields
class	FilterBodyFittedVelocity
class	FilterCheckpoint
class	FilterEnergy
class	FilterEnergy1D
	Filter for one-dimensional energy spectrum. More...
class	FilterError
class	FilterFieldConvert
class	FilterHistoryPoints
class	FilterIntegral
class	FilterMaxMinFields
class	FilterMean
class	FilterModalEnergy
class	FilterMovingAverage
class	FilterReynoldsStresses
	Append Reynolds stresses to the average fields. More...
class	FilterThresholdMax
class	FilterThresholdMin
class	FluidInterface
class	Forcing
	Defines a forcing term to be explicitly applied. More...
class	ForcingAbsorption
class	ForcingBody
class	ForcingMovingReferenceFrame
class	ForcingNoise
class	ForcingProgrammatic
class	HomoRSScalar
	Wrapper class for Riemann solver scalars. More...
class	HomoRSVector
	Wrapper class for Riemann solver scalars. More...
class	MMFSystem
	A base class for PDEs which include an advection component. More...
class	RiemannSolver
	The RiemannSolver class provides an abstract interface under which solvers for various Riemann problems can be implemented. More...
class	SessionFunction
class	UnsteadySystem
	Base class for unsteady solvers. More...
class	UpwindSolver
	Upwind scheme Riemann solver. More...

Typedefs
typedef std::shared_ptr< Advection >	AdvectionSharedPtr
	A shared pointer to an Advection object. More...
typedef LibUtilities::NekFactory< std::string, Advection, std::string >	AdvectionFactory
	Datatype of the NekFactory used to instantiate classes derived from the Advection class. More...
typedef std::function< void(const Array< OneD, Array< OneD, NekDouble > > &, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &)>	AdvectionFluxVecCB
typedef std::shared_ptr< AdvectionSystem >	AdvectionSystemSharedPtr
	Shared pointer to an AdvectionSystem class. More...
typedef std::function< void(Array< OneD, Array< OneD, NekDouble > > &interpField, Array< OneD, Array< OneD, NekDouble > > &distCoords)>	SendCallbackType
typedef std::vector< std::pair< std::string, std::string > >	SummaryList
typedef std::shared_ptr< SessionFunction >	SessionFunctionSharedPtr
typedef std::shared_ptr< Diffusion >	DiffusionSharedPtr
	A shared pointer to an EquationSystem object. More...
typedef LibUtilities::NekFactory< std::string, Diffusion, std::string >	DiffusionFactory
	Datatype of the NekFactory used to instantiate classes derived from the Diffusion class. More...
typedef std::function< void(const Array< OneD, Array< OneD, NekDouble > > &, const TensorOfArray3D< NekDouble > &, TensorOfArray3D< NekDouble > &)>	DiffusionFluxVecCB
typedef std::function< void(const Array< OneD, Array< OneD, NekDouble > > &, TensorOfArray3D< NekDouble > &, TensorOfArray3D< NekDouble > &)>	DiffusionFluxVecCBNS
typedef std::function< void(const Array< OneD, Array< OneD, NekDouble > > &, const Array< OneD, Array< OneD, NekDouble > > &, Array< OneD, Array< OneD, NekDouble > > &)>	DiffusionFluxPenaltyNS
typedef std::function< void(const Array< OneD, const Array< OneD, NekDouble > > &, const Array< OneD, const Array< OneD, Array< OneD, NekDouble > > > &, NekDouble, const Array< OneD, const Array< OneD, NekDouble > > &, const Array< OneD, const Array< OneD, Array< OneD, NekDouble > > > &)>	FunctorDerivBndCond
typedef std::function< void(const int, const Array< OneD, Array< OneD, NekDouble > > &, const TensorOfArray3D< NekDouble > &, TensorOfArray3D< NekDouble > &, Array< OneD, int > &, const Array< OneD, Array< OneD, NekDouble > > &)>	DiffusionFluxCons
typedef std::function< void(const int, const Array< OneD, Array< OneD, NekDouble > > &, const Array< OneD, Array< OneD, NekDouble > > &, TensorOfArray3D< NekDouble > &, Array< OneD, int > &, const Array< OneD, Array< OneD, NekDouble > > &)>	DiffusionSymmFluxCons
typedef std::function< void(Array< OneD, Array< OneD, NekDouble > > &)>	SpecialBndTreat
typedef std::shared_ptr< DiffusionLFRNS >	DiffusionLFRNSSharedPtr
typedef std::shared_ptr< Driver >	DriverSharedPtr
	A shared pointer to a Driver object. More...
typedef LibUtilities::NekFactory< std::string, Driver, const LibUtilities::SessionReaderSharedPtr &, const SpatialDomains::MeshGraphSharedPtr & >	DriverFactory
	Datatype of the NekFactory used to instantiate classes derived from the Driver class. More...
typedef std::shared_ptr< EquationSystem >	EquationSystemSharedPtr
	A shared pointer to an EquationSystem object. More...
typedef LibUtilities::NekFactory< std::string, EquationSystem, const LibUtilities::SessionReaderSharedPtr &, const SpatialDomains::MeshGraphSharedPtr & >	EquationSystemFactory
	Datatype of the NekFactory used to instantiate classes derived from the EquationSystem class. More...
typedef std::shared_ptr< Filter >	FilterSharedPtr
	A shared pointer to a Driver object. More...
typedef LibUtilities::NekFactory< std::string, Filter, const LibUtilities::SessionReaderSharedPtr &, const std::weak_ptr< EquationSystem > &, const std::map< std::string, std::string > & >	FilterFactory
	Datatype of the NekFactory used to instantiate classes derived from the Driver class. More...
typedef std::shared_ptr< FilterAeroForces >	FilterAeroForcesSharedPtr
typedef LibUtilities::NekFactory< std::string, Forcing, const LibUtilities::SessionReaderSharedPtr &, const std::weak_ptr< EquationSystem > &, const Array< OneD, MultiRegions::ExpListSharedPtr > &, const unsigned int &, const TiXmlElement * >	ForcingFactory
	Declaration of the forcing factory. More...
typedef std::shared_ptr< MMFSystem >	MMFSystemSharedPtr
typedef std::function< const Array< OneD, const NekDouble > &()>	RSScalarFuncType
typedef std::function< const Array< OneD, const Array< OneD, NekDouble > > &()>	RSVecFuncType
typedef std::function< NekDouble()>	RSParamFuncType
typedef std::shared_ptr< RiemannSolver >	RiemannSolverSharedPtr
	A shared pointer to an EquationSystem object. More...
typedef LibUtilities::NekFactory< std::string, RiemannSolver, const LibUtilities::SessionReaderSharedPtr & >	RiemannSolverFactory
	Datatype of the NekFactory used to instantiate classes derived from the RiemannSolver class. More...

Enumerations
enum	ProblemType { eCompressible , eIncompressible , eOthers }
enum	SurfaceType {   ePlane , eSphere , eTRSphere , eIrregular ,   eNonconvex , eCube , SIZE_SurfaceType }
enum	BoundaryCopyType {   eDirichlet , eNeumann , eFwdEQBwd , eFwdEQNegBwd ,   SIZE_BoundaryCopyType }
enum	UpwindType {   eNotSet , eAverage , eLaxFriedrich , eUpwind ,   eRusanov , eHLL , eHLLC , SIZE_UpwindType }
enum	TestMaxwellType {   eMaxwell1D , eTestMaxwell2DPEC , eTestMaxwell2DPECAVGFLUX , eTestMaxwell2DPMC ,   eMaxwell3D , eScatField1D , eScatField2D , eScatField3D ,   eTotField1D , eTotField2D , eTotField3D , eMaxwellSphere ,   eELF2DSurface , SIZE_TestMaxwellType }
enum	PolType { eTransMagnetic , eTransElectric , SIZE_PolType }
enum	IncType { ePlaneWave , ePlaneWaveImag , eCylindricalWave , SIZE_IncType }
enum	EvolutionOperatorType {   eNonlinear , eDirect , eAdjoint , eTransientGrowth ,   eSkewSymmetric , eAdaptiveSFD }

Functions
AdvectionFactory &	GetAdvectionFactory ()
	Gets the factory for initialising advection objects. More...
CouplingFactory &	GetCouplingFactory ()
	Declaration of the Coupling factory singleton. More...
void	AddSummaryItem (SummaryList &l, const std::string &name, const std::string &value)
	Adds a summary item to the summary info list. More...
void	AddSummaryItem (SummaryList &l, const std::string &name, const int &value)
	Adds a summary item to the summary info list. More...
void	AddSummaryItem (SummaryList &l, const std::string &name, const NekDouble &value)
	Adds a summary item to the summary info list. More...
DiffusionFactory &	GetDiffusionFactory ()
DriverFactory &	GetDriverFactory ()
void	InterpExp1ToExp2 (const Array< OneD, MultiRegions::ExpListSharedPtr > exp1, Array< OneD, MultiRegions::ExpListSharedPtr > &exp2)
	Interpolate from an expansion to an expansion. More...
EquationSystemFactory &	GetEquationSystemFactory ()
FilterFactory &	GetFilterFactory ()
ForcingFactory &	GetForcingFactory ()
	Declaration of the forcing factory singleton. More...
RiemannSolverFactory &	GetRiemannSolverFactory ()
template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value || tinysimd::is_vector_floating_point<T>::value>::type>
void	rotateToNormalKernel (T *in, T *rotMat, T *out)
template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value || tinysimd::is_vector_floating_point<T>::value>::type>
void	rotateFromNormalKernel (T *in, T *rotMat, T *out)

Variables
SOLVER_UTILS_EXPORT typedef std::shared_ptr< Coupling >	CouplingSharedPtr
SOLVER_UTILS_EXPORT typedef LibUtilities::NekFactory< std::string, Coupling, MultiRegions::ExpListSharedPtr >	CouplingFactory
	Declaration of the Coupling factory. More...
SOLVER_UTILS_EXPORT typedef std::shared_ptr< Forcing >	ForcingSharedPtr
	A shared pointer to an EquationSystem object. More...
SOLVER_UTILS_EXPORT typedef std::shared_ptr< ForcingProgrammatic >	ForcingProgrammaticSharedPtr
	A shared pointer to an EquationSystem object. More...
static std::map< std::string, SendCallbackType >	SendCallbackMap
static SessionFunctionSharedPtr	NullSessionFunction
const char *const	SurfaceTypeMap []
const char *const	BoundaryCopyTypeMap []
const char *const	UpwindTypeMap []
const char *const	TestMaxwellTypeMap []
const char *const	PolTypeMap []
const char *const	IncTypeMap []

Typedef Documentation

AdvectionFactory

typedef LibUtilities::NekFactory<std::string, Advection, std::string> Nektar::SolverUtils::AdvectionFactory

Datatype of the NekFactory used to instantiate classes derived from the Advection class.

Definition at line 61 of file Advection.h.

AdvectionFluxVecCB

typedef std::function<void(const Array<OneD, Array<OneD, NekDouble>> &, Array<OneD, Array<OneD, Array<OneD, NekDouble>>> &)> Nektar::SolverUtils::AdvectionFluxVecCB

Defines a callback function type which evaluates the flux vector \( F(u) \) in a conservative advection of the form \( \nabla\cdot F(u) \).

Definition at line 72 of file Advection.h.

AdvectionSharedPtr

typedef std::shared_ptr<Advection> Nektar::SolverUtils::AdvectionSharedPtr

A shared pointer to an Advection object.

Definition at line 56 of file Advection.h.

AdvectionSystemSharedPtr

typedef std::shared_ptr<AdvectionSystem> Nektar::SolverUtils::AdvectionSystemSharedPtr

Shared pointer to an AdvectionSystem class.

Definition at line 96 of file AdvectionSystem.h.

DiffusionFactory

typedef LibUtilities::NekFactory<std::string, Diffusion, std::string> Nektar::SolverUtils::DiffusionFactory

Datatype of the NekFactory used to instantiate classes derived from the Diffusion class.

Definition at line 63 of file Diffusion.h.

DiffusionFluxCons

typedef std::function<void( const int, const Array<OneD, Array<OneD, NekDouble>> &, const TensorOfArray3D<NekDouble> &, TensorOfArray3D<NekDouble> &, Array<OneD, int> &, const Array<OneD, Array<OneD, NekDouble>> &)> Nektar::SolverUtils::DiffusionFluxCons

Parameter list meaning: 1st: nvariables 2nd: nspaceDimension 3rd: field conservative variables 4th: Devrivatives of field conservative varialbes 5th: nonzero flux index array, optional 6th: normal vectors optional

a null pointer need to be passed for optional parameters

Definition at line 113 of file Diffusion.h.

DiffusionFluxPenaltyNS

typedef std::function<void(const Array<OneD, Array<OneD, NekDouble>> &, const Array<OneD, Array<OneD, NekDouble>> &, Array<OneD, Array<OneD, NekDouble>> &)> Nektar::SolverUtils::DiffusionFluxPenaltyNS

Definition at line 79 of file Diffusion.h.

DiffusionFluxVecCB

typedef std::function<void(const Array<OneD, Array<OneD, NekDouble>> &, const TensorOfArray3D<NekDouble> &, TensorOfArray3D<NekDouble> &)> Nektar::SolverUtils::DiffusionFluxVecCB

Definition at line 69 of file Diffusion.h.

DiffusionFluxVecCBNS

typedef std::function<void(const Array<OneD, Array<OneD, NekDouble>> &, TensorOfArray3D<NekDouble> &, TensorOfArray3D<NekDouble> &)> Nektar::SolverUtils::DiffusionFluxVecCBNS

Definition at line 74 of file Diffusion.h.

DiffusionLFRNSSharedPtr

typedef std::shared_ptr<DiffusionLFRNS> Nektar::SolverUtils::DiffusionLFRNSSharedPtr

Definition at line 190 of file DiffusionLFRNS.h.

DiffusionSharedPtr

typedef std::shared_ptr<Diffusion> Nektar::SolverUtils::DiffusionSharedPtr

A shared pointer to an EquationSystem object.

Definition at line 58 of file Diffusion.h.

DiffusionSymmFluxCons

typedef std::function<void( const int, const Array<OneD, Array<OneD, NekDouble>> &, const Array<OneD, Array<OneD, NekDouble>> &, TensorOfArray3D<NekDouble> &, Array<OneD, int> &, const Array<OneD, Array<OneD, NekDouble>> &)> Nektar::SolverUtils::DiffusionSymmFluxCons

Parameter list meaning: 1st: nvariables 2nd: nspaceDimension 3rd: trace conservative variables for Diffusion Flux Jacobian 4th: trace conservative variables( usually the jump of trace value) 5th: trace symmetric flux 6th: nonzero flux index array, optional

a null pointer need to be passed for optional parameters

Definition at line 130 of file Diffusion.h.

DriverFactory

typedef LibUtilities::NekFactory<std::string, Driver, const LibUtilities::SessionReaderSharedPtr &, const SpatialDomains::MeshGraphSharedPtr &> Nektar::SolverUtils::DriverFactory

Datatype of the NekFactory used to instantiate classes derived from the Driver class.

Definition at line 61 of file Driver.h.

DriverSharedPtr

typedef std::shared_ptr<Driver> Nektar::SolverUtils::DriverSharedPtr

A shared pointer to a Driver object.

Definition at line 54 of file Driver.h.

EquationSystemFactory

typedef LibUtilities::NekFactory<std::string, EquationSystem, const LibUtilities::SessionReaderSharedPtr &, const SpatialDomains::MeshGraphSharedPtr &> Nektar::SolverUtils::EquationSystemFactory

Datatype of the NekFactory used to instantiate classes derived from the EquationSystem class.

Definition at line 72 of file EquationSystem.h.

EquationSystemSharedPtr

typedef std::shared_ptr<EquationSystem> Nektar::SolverUtils::EquationSystemSharedPtr

A shared pointer to an EquationSystem object.

Definition at line 66 of file EquationSystem.h.

FilterAeroForcesSharedPtr

typedef std::shared_ptr<FilterAeroForces> Nektar::SolverUtils::FilterAeroForcesSharedPtr

Definition at line 153 of file FilterAeroForces.h.

FilterFactory

typedef LibUtilities::NekFactory<std::string, Filter, const LibUtilities::SessionReaderSharedPtr &, const std::weak_ptr<EquationSystem> &, const std::map<std::string, std::string> &> Nektar::SolverUtils::FilterFactory

Datatype of the NekFactory used to instantiate classes derived from the Driver class.

Definition at line 61 of file Filter.h.

FilterSharedPtr

typedef std::shared_ptr<Filter> Nektar::SolverUtils::FilterSharedPtr

A shared pointer to a Driver object.

Definition at line 53 of file Filter.h.

ForcingFactory

typedef LibUtilities::NekFactory< std::string, Forcing, const LibUtilities::SessionReaderSharedPtr &, const std::weak_ptr<EquationSystem> &, const Array<OneD, MultiRegions::ExpListSharedPtr> &, const unsigned int &, const TiXmlElement *> Nektar::SolverUtils::ForcingFactory

Declaration of the forcing factory.

Definition at line 63 of file Forcing.h.

FunctorDerivBndCond

typedef std::function<void( const Array<OneD, const Array<OneD, NekDouble>> &, const Array<OneD, const Array<OneD, Array<OneD, NekDouble>>> &, NekDouble, const Array<OneD, const Array<OneD, NekDouble>> &, const Array<OneD, const Array<OneD, Array<OneD, NekDouble>>> &)> Nektar::SolverUtils::FunctorDerivBndCond

Parameter list meaning: 1st: field conservative variables 2th: Devrivatives of field conservative varialbes 3rd: the current time for time-dependent boundary 4th: Fwd of field conservative variables optional 5th: Fwd of Devrivatives(2nd) optional

a null pointer need to be passed for optional parameters

Definition at line 96 of file Diffusion.h.

MMFSystemSharedPtr

typedef std::shared_ptr<MMFSystem> Nektar::SolverUtils::MMFSystemSharedPtr

Definition at line 383 of file MMFSystem.h.

RiemannSolverFactory

typedef LibUtilities::NekFactory<std::string, RiemannSolver, const LibUtilities::SessionReaderSharedPtr &> Nektar::SolverUtils::RiemannSolverFactory

Datatype of the NekFactory used to instantiate classes derived from the RiemannSolver class.

Definition at line 200 of file RiemannSolver.h.

RiemannSolverSharedPtr

typedef std::shared_ptr<RiemannSolver> Nektar::SolverUtils::RiemannSolverSharedPtr

A shared pointer to an EquationSystem object.

Definition at line 195 of file RiemannSolver.h.

RSParamFuncType

typedef std::function<NekDouble()> Nektar::SolverUtils::RSParamFuncType

Definition at line 55 of file RiemannSolver.h.

RSScalarFuncType

typedef std::function<const Array<OneD, const NekDouble> &()> Nektar::SolverUtils::RSScalarFuncType

Definition at line 52 of file RiemannSolver.h.

RSVecFuncType

typedef std::function<const Array<OneD, const Array<OneD, NekDouble> > &()> Nektar::SolverUtils::RSVecFuncType

Definition at line 54 of file RiemannSolver.h.

SendCallbackType

typedef std::function<void(Array<OneD, Array<OneD, NekDouble>> &interpField, Array<OneD, Array<OneD, NekDouble>> &distCoords)> Nektar::SolverUtils::SendCallbackType

Definition at line 182 of file CouplingCwipi.h.

SessionFunctionSharedPtr

typedef std::shared_ptr<SessionFunction> Nektar::SolverUtils::SessionFunctionSharedPtr

Definition at line 153 of file SessionFunction.h.

SpecialBndTreat

typedef std::function<void(Array<OneD, Array<OneD, NekDouble>> &)> Nektar::SolverUtils::SpecialBndTreat

Parameter list meaning: 1rd: trace conservative variables

Definition at line 137 of file Diffusion.h.

SummaryList

typedef std::vector<std::pair<std::string, std::string> > Nektar::SolverUtils::SummaryList

Definition at line 48 of file Misc.h.

Enumeration Type Documentation

BoundaryCopyType

enum Nektar::SolverUtils::BoundaryCopyType

Enumerator
eDirichlet
eNeumann
eFwdEQBwd
eFwdEQNegBwd
SIZE_BoundaryCopyType	Length of enum list.

Definition at line 60 of file MMFSystem.h.

{
    eDirichlet,
    eNeumann,
    eFwdEQBwd,
    eFwdEQNegBwd,
    SIZE_BoundaryCopyType ///< Length of enum list
};

EvolutionOperatorType

enum Nektar::SolverUtils::EvolutionOperatorType

Enumerator
eNonlinear
eDirect
eAdjoint
eTransientGrowth
eSkewSymmetric
eAdaptiveSFD

Definition at line 39 of file SolverUtils.hpp.

{
    eNonlinear,
    eDirect,
    eAdjoint,
    eTransientGrowth,
    eSkewSymmetric,
    eAdaptiveSFD
};

IncType

enum Nektar::SolverUtils::IncType

Enumerator
ePlaneWave
ePlaneWaveImag
eCylindricalWave
SIZE_IncType

Definition at line 130 of file MMFSystem.h.

{
    ePlaneWave,
    ePlaneWaveImag,
    eCylindricalWave,
    SIZE_IncType
};

PolType

enum Nektar::SolverUtils::PolType

Enumerator
eTransMagnetic
eTransElectric
SIZE_PolType

Definition at line 118 of file MMFSystem.h.

{
    eTransMagnetic,
    eTransElectric,
    SIZE_PolType
};

ProblemType

enum Nektar::SolverUtils::ProblemType

Enumerator
eCompressible
eIncompressible
eOthers

Definition at line 45 of file FilterMaxMinFields.h.

{
    eCompressible,
    eIncompressible,
    eOthers
};

SurfaceType

enum Nektar::SolverUtils::SurfaceType

Enumerator
ePlane
eSphere
eTRSphere
eIrregular
eNonconvex
eCube
SIZE_SurfaceType

Definition at line 45 of file MMFSystem.h.

{
    ePlane,
    eSphere,
    eTRSphere,
    eIrregular,
    eNonconvex,
    eCube,
    SIZE_SurfaceType
};

TestMaxwellType

enum Nektar::SolverUtils::TestMaxwellType

Enumerator
eMaxwell1D
eTestMaxwell2DPEC
eTestMaxwell2DPECAVGFLUX
eTestMaxwell2DPMC
eMaxwell3D
eScatField1D
eScatField2D
eScatField3D
eTotField1D
eTotField2D
eTotField3D
eMaxwellSphere
eELF2DSurface
SIZE_TestMaxwellType	Length of enum list.

Definition at line 92 of file MMFSystem.h.

{
    eMaxwell1D,
    eTestMaxwell2DPEC,
    eTestMaxwell2DPECAVGFLUX,
    eTestMaxwell2DPMC,
    eMaxwell3D,
    eScatField1D,
    eScatField2D,
    eScatField3D,
    eTotField1D,
    eTotField2D,
    eTotField3D,
    eMaxwellSphere,
    eELF2DSurface,
    SIZE_TestMaxwellType ///< Length of enum list
};

UpwindType

enum Nektar::SolverUtils::UpwindType

Enumerator
eNotSet	flux not defined
eAverage	averaged (or centred) flux
eLaxFriedrich	Lax-Friedrich flux.
eUpwind
eRusanov	Upwind. Rusanov flux
eHLL	Harten-Lax-Leer flux.
eHLLC	Harten-Lax-Leer Contact wave flux.
SIZE_UpwindType	Length of enum list.

Definition at line 76 of file MMFSystem.h.

{
    eNotSet,        ///< flux not defined
    eAverage,       ///< averaged (or centred) flux
    eLaxFriedrich,  ///< Lax-Friedrich flux
    eUpwind,        ///  Upwind
    eRusanov,       ///< Rusanov flux
    eHLL,           ///< Harten-Lax-Leer flux
    eHLLC,          ///< Harten-Lax-Leer Contact wave flux
    SIZE_UpwindType ///< Length of enum list
};

Function Documentation

AddSummaryItem() [1/3]

SOLVER_UTILS_EXPORT void Nektar::SolverUtils::AddSummaryItem	(	SummaryList &	l,
		const std::string &	name,
		const int &	value
	)

Adds a summary item to the summary info list.

Definition at line 56 of file Misc.cpp.

{
    l.push_back(std::make_pair(name, boost::lexical_cast<std::string>(value)));
}

References CellMLToNektar.pycml::name.

AddSummaryItem() [2/3]

SOLVER_UTILS_EXPORT void Nektar::SolverUtils::AddSummaryItem	(	SummaryList &	l,
		const std::string &	name,
		const NekDouble &	value
	)

Adds a summary item to the summary info list.

Definition at line 62 of file Misc.cpp.

{
    l.push_back(std::make_pair(name, str(boost::format("%g") % value)));
}

References CellMLToNektar.pycml::format, and CellMLToNektar.pycml::name.

AddSummaryItem() [3/3]

SOLVER_UTILS_EXPORT void Nektar::SolverUtils::AddSummaryItem	(	SummaryList &	l,
		const std::string &	name,
		const std::string &	value
	)

Adds a summary item to the summary info list.

Adds an item to a SummaryList

Definition at line 49 of file Misc.cpp.

{
    l.push_back(std::make_pair(name, value));
}

References CellMLToNektar.pycml::name.

Referenced by Nektar::SolverUtils::EquationSystem::SessionSummary(), Nektar::Laplace::v_GenerateSummary(), Nektar::MMFAdvection::v_GenerateSummary(), Nektar::Poisson::v_GenerateSummary(), Nektar::Projection::v_GenerateSummary(), Nektar::SteadyAdvectionDiffusion::v_GenerateSummary(), Nektar::UnsteadyAdvection::v_GenerateSummary(), Nektar::UnsteadyAdvectionDiffusion::v_GenerateSummary(), Nektar::UnsteadyViscousBurgers::v_GenerateSummary(), Nektar::CompressibleFlowSystem::v_GenerateSummary(), Nektar::MMFDiffusion::v_GenerateSummary(), Nektar::CoupledLinearNS::v_GenerateSummary(), Nektar::SmoothedProfileMethod::v_GenerateSummary(), Nektar::VelocityCorrectionScheme::v_GenerateSummary(), Nektar::VCSImplicit::v_GenerateSummary(), Nektar::VCSWeakPressure::v_GenerateSummary(), Nektar::LinearElasticSystem::v_GenerateSummary(), Nektar::MMFMaxwell::v_GenerateSummary(), Nektar::LinearSWE::v_GenerateSummary(), Nektar::MMFSWE::v_GenerateSummary(), Nektar::NonlinearPeregrine::v_GenerateSummary(), Nektar::NonlinearSWE::v_GenerateSummary(), Nektar::ShallowWaterSystem::v_GenerateSummary(), Nektar::SolverUtils::MMFSystem::v_GenerateSummary(), Nektar::SolverUtils::UnsteadySystem::v_GenerateSummary(), Nektar::UnsteadyDiffusion::v_GenerateSummary(), Nektar::CellModelAlievPanfilov::v_GenerateSummary(), Nektar::CourtemancheRamirezNattel98::v_GenerateSummary(), Nektar::FentonKarma::v_GenerateSummary(), Nektar::CellModelFitzHughNagumo::v_GenerateSummary(), Nektar::Fox02::v_GenerateSummary(), Nektar::LuoRudy91::v_GenerateSummary(), Nektar::PanditGilesDemir03::v_GenerateSummary(), Nektar::TenTusscher06::v_GenerateSummary(), Nektar::Winslow99::v_GenerateSummary(), and Nektar::Monodomain::v_GenerateSummary().

GetAdvectionFactory()

SOLVER_UTILS_EXPORT AdvectionFactory & Nektar::SolverUtils::GetAdvectionFactory

(

)

Gets the factory for initialising advection objects.

Returns

The advection factory.

Definition at line 47 of file Advection.cpp.

{
    static AdvectionFactory instance;
    return instance;
}

Referenced by Nektar::SolverUtils::Advection3DHomogeneous1D::Advection3DHomogeneous1D(), Nektar::CompressibleFlowSystem::InitAdvection(), Nektar::SolverUtils::EquationSystem::SessionSummary(), Nektar::PulseWavePropagation::v_InitObject(), Nektar::ImageWarpingSystem::v_InitObject(), Nektar::IncNavierStokes::v_InitObject(), Nektar::APE::v_InitObject(), Nektar::LEE::v_InitObject(), Nektar::CFLtester::v_InitObject(), Nektar::EigenValuesAdvection::v_InitObject(), Nektar::MMFAdvection::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurger::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), Nektar::LinearSWE::v_InitObject(), Nektar::NonlinearPeregrine::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

GetCouplingFactory()

SOLVER_UTILS_EXPORT CouplingFactory & Nektar::SolverUtils::GetCouplingFactory

(

)

Declaration of the Coupling factory singleton.

Definition at line 44 of file Coupling.cpp.

{
    static CouplingFactory instance;
    return instance;
}

References CouplingFactory.

Referenced by Nektar::AcousticSystem::v_InitObject(), and Nektar::Dummy::v_InitObject().

GetDiffusionFactory()

SOLVER_UTILS_EXPORT DiffusionFactory & Nektar::SolverUtils::GetDiffusionFactory

(

)

Definition at line 41 of file Diffusion.cpp.

{
    static DiffusionFactory instance;
    return instance;
}

Referenced by Nektar::ArtificialDiffusion::ArtificialDiffusion(), Nektar::SolverUtils::Diffusion3DHomogeneous1D::Diffusion3DHomogeneous1D(), Nektar::NavierStokesCFE::InitObject_Explicit(), Nektar::SolverUtils::EquationSystem::SessionSummary(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyDiffusion::v_InitObject(), and Nektar::UnsteadyViscousBurgers::v_InitObject().

GetDriverFactory()

SOLVER_UTILS_EXPORT DriverFactory & Nektar::SolverUtils::GetDriverFactory

(

)

Definition at line 67 of file Driver.cpp.

{
    static DriverFactory instance;
    return instance;
}

Referenced by Nektar::VortexWaveInteraction::ExecuteStreak(), Nektar::VortexWaveInteraction::ExecuteWave(), and main().

GetEquationSystemFactory()

SOLVER_UTILS_EXPORT EquationSystemFactory & Nektar::SolverUtils::GetEquationSystemFactory

(

)

Definition at line 103 of file EquationSystem.cpp.

{
    static EquationSystemFactory instance;
    return instance;
}

Referenced by Nektar::VortexWaveInteraction::ExecuteRoll(), Nektar::VortexWaveInteraction::ExecuteStreak(), Nektar::SolverUtils::DriverParallelInTime::SetParallelInTimeEquationSystem(), Nektar::SolverUtils::Driver::v_InitObject(), and Nektar::VortexWaveInteraction::VortexWaveInteraction().

GetFilterFactory()

SOLVER_UTILS_EXPORT FilterFactory & Nektar::SolverUtils::GetFilterFactory

(

)

Definition at line 41 of file Filter.cpp.

{
    static FilterFactory instance;
    return instance;
}

Referenced by Nektar::SolverUtils::UnsteadySystem::v_InitObject().

GetForcingFactory()

SOLVER_UTILS_EXPORT ForcingFactory & Nektar::SolverUtils::GetForcingFactory

(

)

Declaration of the forcing factory singleton.

Definition at line 44 of file Forcing.cpp.

{
    static ForcingFactory instance;
    return instance;
}

Referenced by Nektar::VortexWaveInteraction::ExecuteRoll(), and Nektar::SolverUtils::Forcing::Load().

GetRiemannSolverFactory()

SOLVER_UTILS_EXPORT RiemannSolverFactory & Nektar::SolverUtils::GetRiemannSolverFactory

(

)

Retrieves the singleton instance of the Riemann solver factory.

Definition at line 67 of file RiemannSolver.cpp.

{
    static RiemannSolverFactory instance;
    return instance;
}

Referenced by Nektar::CompressibleFlowSystem::InitAdvection(), Nektar::PulseWavePropagation::v_InitObject(), Nektar::ImageWarpingSystem::v_InitObject(), Nektar::APE::v_InitObject(), Nektar::LEE::v_InitObject(), Nektar::CFLtester::v_InitObject(), Nektar::EigenValuesAdvection::v_InitObject(), Nektar::MMFAdvection::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurger::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), Nektar::LinearSWE::v_InitObject(), Nektar::NonlinearPeregrine::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

InterpExp1ToExp2()

void Nektar::SolverUtils::InterpExp1ToExp2	(	const Array< OneD, MultiRegions::ExpListSharedPtr >	exp1,
		Array< OneD, MultiRegions::ExpListSharedPtr > &	exp2
	)

Interpolate from an expansion to an expansion.

Definition at line 904 of file DriverParallelInTime.cpp.

{
 
    // Interpolation from exp1 -> exp2 assuming that exp1 and exp2 are the
    // same explists, but at potentially different polynomial orders.
    if (exp1.size() != exp2.size())
    {
        NEKERROR(ErrorUtil::efatal, "not the same mesh")
    }
 
    for (int n = 0; n < exp1.size(); ++n)
    {
        // Interpolation from exp1 -> exp2 assuming that exp1 and exp2 are the
        // same explists, but at potentially different polynomial orders.
        if (exp1[n]->GetExpSize() != exp2[n]->GetExpSize())
        {
            NEKERROR(ErrorUtil::efatal, "not the same mesh")
        }
 
        // If same polynomial orders, simply copy solution
        if (exp1[n]->GetTotPoints() == exp2[n]->GetTotPoints())
        {
            Vmath::Vcopy(exp1[n]->GetTotPoints(), exp1[n]->GetPhys(), 1,
                         exp2[n]->UpdatePhys(), 1);
        }
        // If different polynomial orders, interpolate solution
        else
        {
            // Transform solution from physical to coefficient space
            exp1[n]->FwdTrans(exp1[n]->GetPhys(), exp1[n]->UpdateCoeffs());
 
            for (int i = 0; i < exp1[n]->GetExpSize(); ++i)
            {
                // Get the elements
                LocalRegions::ExpansionSharedPtr elmt1 = exp1[n]->GetExp(i),
                                                 elmt2 = exp2[n]->GetExp(i);
 
                // Get the offset of elements in the storage arrays.
                int offset1 = exp1[n]->GetCoeff_Offset(i);
                int offset2 = exp2[n]->GetCoeff_Offset(i);
 
                // Get number of modes
                Array<OneD, LibUtilities::BasisSharedPtr> base1 =
                    elmt1->GetBase();
                std::vector<unsigned int> nummodes1(base1.size());
                std::vector<LibUtilities::BasisType> btype1(base1.size());
                for (int j = 0; j < nummodes1.size(); ++j)
                {
                    nummodes1[j] = base1[j]->GetNumModes();
                    btype1[j]    = base1[j]->GetBasisType();
                }
 
                // Extract data from exp1 -> exp2.
                elmt2->ExtractDataToCoeffs(
                    &exp1[n]->GetCoeffs()[offset1], nummodes1, 0,
                    &exp2[n]->UpdateCoeffs()[offset2], btype1);
            }
 
            // Transform solution back to physical space
            exp2[n]->BwdTrans(exp2[n]->GetCoeffs(), exp2[n]->UpdatePhys());
        }
    }
}

References Nektar::ErrorUtil::efatal, NEKERROR, and Vmath::Vcopy().

Referenced by Nektar::SolverUtils::DriverParallelInTime::Interpolator().

rotateFromNormalKernel()

template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value || tinysimd::is_vector_floating_point<T>::value>::type>

void Nektar::SolverUtils::rotateFromNormalKernel ( T *  in, T *  rotMat, T *  out  )

inline

Definition at line 220 of file RiemannSolver.h.

{
 
    // Apply rotation matrices.
    out[0] = in[0] * rotMat[0] + in[1] * rotMat[3] + in[2] * rotMat[6];
 
    out[1] = in[0] * rotMat[1] + in[1] * rotMat[4] + in[2] * rotMat[7];
 
    out[2] = in[0] * rotMat[2] + in[1] * rotMat[5] + in[2] * rotMat[8];
}

Referenced by Nektar::RoeSolverSIMD::v_Solve().

rotateToNormalKernel()

template<class T , typename = typename std::enable_if< std::is_floating_point<T>::value || tinysimd::is_vector_floating_point<T>::value>::type>

void Nektar::SolverUtils::rotateToNormalKernel ( T *  in, T *  rotMat, T *  out  )

inline

Definition at line 206 of file RiemannSolver.h.

{
 
    // Apply rotation matrices.
    out[0] = in[0] * rotMat[0] + in[1] * rotMat[1] + in[2] * rotMat[2];
 
    out[1] = in[0] * rotMat[3] + in[1] * rotMat[4] + in[2] * rotMat[5];
 
    out[2] = in[0] * rotMat[6] + in[1] * rotMat[7] + in[2] * rotMat[8];
}

Referenced by Nektar::RoeSolverSIMD::v_Solve().

Variable Documentation

BoundaryCopyTypeMap

const char* const Nektar::SolverUtils::BoundaryCopyTypeMap[]

Initial value:

= {
    "Dirichlet",
    "Neumann",
    "FwdEQBwd",
    "FwdEQNegBwd",
}

Definition at line 69 of file MMFSystem.h.

CouplingFactory

SOLVER_UTILS_EXPORT typedef LibUtilities::NekFactory< std::string, Coupling, MultiRegions::ExpListSharedPtr> Nektar::SolverUtils::CouplingFactory

Declaration of the Coupling factory.

Definition at line 52 of file Coupling.h.

Referenced by GetCouplingFactory().

CouplingSharedPtr

SOLVER_UTILS_EXPORT typedef std::shared_ptr<Coupling> Nektar::SolverUtils::CouplingSharedPtr

Definition at line 47 of file Coupling.h.

Referenced by Nektar::SolverUtils::CouplingCwipi::create(), and Nektar::SolverUtils::CouplingFile::create().

ForcingProgrammaticSharedPtr

SOLVER_UTILS_EXPORT typedef std::shared_ptr<ForcingProgrammatic> Nektar::SolverUtils::ForcingProgrammaticSharedPtr

A shared pointer to an EquationSystem object.

Definition at line 55 of file ForcingProgrammatic.h.

ForcingSharedPtr

SOLVER_UTILS_EXPORT typedef std::shared_ptr<Forcing> Nektar::SolverUtils::ForcingSharedPtr

A shared pointer to an EquationSystem object.

Definition at line 55 of file Forcing.h.

Referenced by Nektar::SolverUtils::ForcingAbsorption::create(), Nektar::SolverUtils::ForcingBody::create(), Nektar::SolverUtils::ForcingMovingReferenceFrame::create(), Nektar::SolverUtils::ForcingNoise::create(), Nektar::SolverUtils::ForcingProgrammatic::create(), Nektar::ForcingAxiSymmetric::create(), Nektar::ForcingQuasi1D::create(), Nektar::ForcingMovingBody::create(), and Nektar::ForcingStabilityCoupledLNS::create().

IncTypeMap

const char* const Nektar::SolverUtils::IncTypeMap[]

Initial value:

= {
    "PlaneWave",
    "PlaneWaveImag",
    "CylindricalWave",
}

Definition at line 138 of file MMFSystem.h.

Referenced by Nektar::MMFMaxwell::v_GenerateSummary(), and Nektar::MMFMaxwell::v_InitObject().

NullSessionFunction

SessionFunctionSharedPtr Nektar::SolverUtils::NullSessionFunction

static

Definition at line 154 of file SessionFunction.h.

PolTypeMap

const char* const Nektar::SolverUtils::PolTypeMap[]

Initial value:

= {
    "TransMagnetic",
    "TransElectric",
}

Definition at line 125 of file MMFSystem.h.

Referenced by Nektar::MMFMaxwell::v_GenerateSummary(), and Nektar::MMFMaxwell::v_InitObject().

SendCallbackMap

std::map<std::string, SendCallbackType> Nektar::SolverUtils::SendCallbackMap

static

Definition at line 184 of file CouplingCwipi.h.

Referenced by Nektar::SolverUtils::CouplingCwipi::InterpCallback(), and Nektar::SolverUtils::CouplingCwipi::SetupSend().

SurfaceTypeMap

const char* const Nektar::SolverUtils::SurfaceTypeMap[]

Initial value:

= {
    "Plane", "Sphere", "TRSphere", "Irregular", "Nonconvex", "Cube",
}

Definition at line 56 of file MMFSystem.h.

Referenced by Nektar::SolverUtils::MMFSystem::MMFInitObject(), and Nektar::SolverUtils::MMFSystem::v_GenerateSummary().

TestMaxwellTypeMap

const char* const Nektar::SolverUtils::TestMaxwellTypeMap[]

Initial value:

= {
    "Maxwell1D",        "TestMaxwell2DPEC", "TestMaxwell2DPECAVGFLUX",
    "TestMaxwell2DPMC", "Maxwell3D",        "ScatField1D",
    "ScatField2D",      "ScatField3D",      "TotField1D",
    "TotField2D",       "TotField3D",       "MaxwellSphere",
    "ELF2DSurface",
}

Definition at line 110 of file MMFSystem.h.

Referenced by Nektar::MMFMaxwell::v_GenerateSummary(), and Nektar::MMFMaxwell::v_InitObject().

UpwindTypeMap

const char* const Nektar::SolverUtils::UpwindTypeMap[]

Initial value:

= {
    "NoSet", "Average", "LaxFriedrich", "Upwind", "Rusanov", "HLL", "HLLC",
}

Definition at line 88 of file MMFSystem.h.

Referenced by Nektar::SolverUtils::MMFSystem::MMFInitObject().