Nektar++
Classes | Typedefs | Enumerations | Functions | Variables
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  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  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  FilterCheckpoint
 
class  FilterEnergy
 
class  FilterEnergy1D
 Filter for one-dimensional energy spectrum. More...
 
class  FilterFieldConvert
 
class  FilterHistoryPoints
 
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  UpwindLDGSolver
 Upwind scheme Riemann solver for LDG. More...
 
class  UpwindSolver
 Upwind scheme Riemann solver. More...
 

Typedefs

typedef std::function< void(const Array< OneD, Array< OneD, NekDouble > > &, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &)> AdvectionFluxVecCB
 
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::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::function< void(const Array< OneD, Array< OneD, NekDouble > > &, const Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &)> DiffusionFluxVecCB
 
typedef std::function< void(const Array< OneD, Array< OneD, NekDouble > > &, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &, Array< OneD, Array< OneD, Array< OneD, 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, Array< OneD, NekDouble > > &, Array< OneD, NekDouble > &)> DiffusionArtificialDiffusion
 
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::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  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 ()
 
EquationSystemFactory & GetEquationSystemFactory ()
 
FilterFactory & GetFilterFactory ()
 
ForcingFactory & GetForcingFactory ()
 Declaration of the forcing factory singleton. More...
 
RiemannSolverFactory & GetRiemannSolverFactory ()
 

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 175 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 59 of file Advection.h.

◆ AdvectionSharedPtr

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

A shared pointer to an Advection object.

Definition at line 170 of file Advection.h.

◆ AdvectionSystemSharedPtr

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

Shared pointer to an AdvectionSystem class.

Definition at line 90 of file AdvectionSystem.h.

◆ DiffusionArtificialDiffusion

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

Definition at line 75 of file Diffusion.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 187 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 70 of file Diffusion.h.

◆ DiffusionFluxVecCB

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

Definition at line 58 of file Diffusion.h.

◆ DiffusionFluxVecCBNS

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

Definition at line 64 of file Diffusion.h.

◆ DiffusionLFRNSSharedPtr

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

Definition at line 202 of file DiffusionLFRNS.h.

◆ DiffusionSharedPtr

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

A shared pointer to an EquationSystem object.

Definition at line 183 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 51 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 70 of file EquationSystem.h.

◆ EquationSystemSharedPtr

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

A shared pointer to an EquationSystem object.

Definition at line 59 of file EquationSystem.h.

◆ FilterAeroForcesSharedPtr

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

Definition at line 131 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 62 of file Filter.h.

◆ FilterSharedPtr

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

A shared pointer to a Driver object.

Definition at line 50 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.

◆ MMFSystemSharedPtr

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

Definition at line 380 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 57 of file RiemannSolver.h.

◆ RSScalarFuncType

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

Definition at line 53 of file RiemannSolver.h.

◆ RSVecFuncType

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

Definition at line 55 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 190 of file CouplingCwipi.h.

◆ SessionFunctionSharedPtr

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

Definition at line 151 of file SessionFunction.h.

◆ SummaryList

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

Definition at line 46 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 61 of file MMFSystem.h.

62 {
63  eDirichlet,
64  eNeumann,
65  eFwdEQBwd,
66  eFwdEQNegBwd,
67  SIZE_BoundaryCopyType ///< Length of enum list
68 };

◆ EvolutionOperatorType

enum Nektar::SolverUtils::EvolutionOperatorType
Enumerator
eNonlinear 
eDirect 
eAdjoint 
eTransientGrowth 
eSkewSymmetric 
eAdaptiveSFD 

Definition at line 5 of file SolverUtils.hpp.

6  {
7  eNonlinear,
8  eDirect,
9  eAdjoint,
10  eTransientGrowth,
11  eSkewSymmetric,
12  eAdaptiveSFD
13  };

◆ IncType

enum Nektar::SolverUtils::IncType
Enumerator
ePlaneWave 
ePlaneWaveImag 
eCylindricalWave 
SIZE_IncType 

Definition at line 127 of file MMFSystem.h.

128 {
129  ePlaneWave,
130  ePlaneWaveImag,
131  eCylindricalWave,
132  SIZE_IncType
133 };

◆ PolType

enum Nektar::SolverUtils::PolType
Enumerator
eTransMagnetic 
eTransElectric 
SIZE_PolType 

Definition at line 116 of file MMFSystem.h.

117 {
118  eTransMagnetic,
119  eTransElectric,
120  SIZE_PolType
121 };

◆ SurfaceType

enum Nektar::SolverUtils::SurfaceType
Enumerator
ePlane 
eSphere 
eTRSphere 
eIrregular 
eNonconvex 
eCube 
SIZE_SurfaceType 

Definition at line 46 of file MMFSystem.h.

47 {
48  ePlane,
49  eSphere,
50  eTRSphere,
51  eIrregular,
52  eNonconvex,
53  eCube,
54  SIZE_SurfaceType
55 };

◆ 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 90 of file MMFSystem.h.

91 {
92  eMaxwell1D,
93  eTestMaxwell2DPEC,
94  eTestMaxwell2DPECAVGFLUX,
95  eTestMaxwell2DPMC,
96  eMaxwell3D,
97  eScatField1D,
98  eScatField2D,
99  eScatField3D,
100  eTotField1D,
101  eTotField2D,
102  eTotField3D,
103  eMaxwellSphere,
104  eELF2DSurface,
105  SIZE_TestMaxwellType ///< Length of enum list
106 };

◆ 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 74 of file MMFSystem.h.

75 {
76  eNotSet, ///< flux not defined
77  eAverage, ///< averaged (or centred) flux
78  eLaxFriedrich, ///< Lax-Friedrich flux
79  eUpwind, /// Upwind
80  eRusanov, ///< Rusanov flux
81  eHLL, ///< Harten-Lax-Leer flux
82  eHLLC, ///< Harten-Lax-Leer Contact wave flux
83  SIZE_UpwindType ///< Length of enum list
84 };
Nektar::SolverUtils::eAverage
averaged (or centred) flux
Definition: MMFSystem.h:77
Nektar::SolverUtils::eNotSet
flux not defined
Definition: MMFSystem.h:76
Nektar::SolverUtils::eLaxFriedrich
Lax-Friedrich flux.
Definition: MMFSystem.h:78
Nektar::SolverUtils::eHLLC
Harten-Lax-Leer Contact wave flux.
Definition: MMFSystem.h:82
Nektar::SolverUtils::eHLL
Harten-Lax-Leer flux.
Definition: MMFSystem.h:81

Function Documentation

◆ AddSummaryItem() [1/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.

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

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

◆ AddSummaryItem() [2/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 58 of file Misc.cpp.

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

◆ AddSummaryItem() [3/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 67 of file Misc.cpp.

References CellMLToNektar.pycml::format.

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

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

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

48 {
49  static AdvectionFactory instance;
50  return instance;
51 }
Nektar::SolverUtils::AdvectionFactory
LibUtilities::NekFactory< std::string, Advection, std::string > AdvectionFactory
Datatype of the NekFactory used to instantiate classes derived from the Advection class...
Definition: Advection.h:175

◆ GetCouplingFactory()

SOLVER_UTILS_EXPORT CouplingFactory & Nektar::SolverUtils::GetCouplingFactory ( )

Declaration of the Coupling factory singleton.

Definition at line 44 of file Coupling.cpp.

References CouplingFactory.

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

45 {
46  static CouplingFactory instance;
47  return instance;
48 }
Nektar::SolverUtils::CouplingFactory
SOLVER_UTILS_EXPORT typedef LibUtilities::NekFactory< std::string, Coupling, MultiRegions::ExpListSharedPtr > CouplingFactory
Declaration of the Coupling factory.
Definition: Coupling.h:52

◆ GetDiffusionFactory()

SOLVER_UTILS_EXPORT DiffusionFactory & Nektar::SolverUtils::GetDiffusionFactory ( )

Definition at line 41 of file Diffusion.cpp.

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

42  {
43  static DiffusionFactory instance;
44  return instance;
45  }
Nektar::SolverUtils::DiffusionFactory
LibUtilities::NekFactory< std::string, Diffusion, std::string > DiffusionFactory
Datatype of the NekFactory used to instantiate classes derived from the Diffusion class...
Definition: Diffusion.h:187

◆ GetDriverFactory()

SOLVER_UTILS_EXPORT DriverFactory & Nektar::SolverUtils::GetDriverFactory ( )

Definition at line 65 of file Driver.cpp.

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

66 {
67  static DriverFactory instance;
68  return instance;
69 }
Nektar::SolverUtils::DriverFactory
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.
Definition: Driver.h:61

◆ GetEquationSystemFactory()

SOLVER_UTILS_EXPORT EquationSystemFactory & Nektar::SolverUtils::GetEquationSystemFactory ( )

Definition at line 90 of file EquationSystem.cpp.

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

91  {
92  static EquationSystemFactory instance;
93  return instance;
94  }
Nektar::SolverUtils::EquationSystemFactory
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...
Definition: EquationSystem.h:70

◆ GetFilterFactory()

SOLVER_UTILS_EXPORT FilterFactory & Nektar::SolverUtils::GetFilterFactory ( )

Definition at line 41 of file Filter.cpp.

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

42 {
43  static FilterFactory instance;
44  return instance;
45 }
Nektar::SolverUtils::FilterFactory
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.
Definition: Filter.h:62

◆ GetForcingFactory()

SOLVER_UTILS_EXPORT ForcingFactory & Nektar::SolverUtils::GetForcingFactory ( )

Declaration of the forcing factory singleton.

Definition at line 44 of file Forcing.cpp.

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

45  {
46  static ForcingFactory instance;
47  return instance;
48  }
Nektar::SolverUtils::ForcingFactory
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.
Definition: Forcing.h:63

◆ GetRiemannSolverFactory()

SOLVER_UTILS_EXPORT RiemannSolverFactory & Nektar::SolverUtils::GetRiemannSolverFactory ( )

Retrieves the singleton instance of the Riemann solver factory.

Definition at line 63 of file RiemannSolver.cpp.

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

64  {
65  static RiemannSolverFactory instance;
66  return instance;
67  }
Nektar::SolverUtils::RiemannSolverFactory
LibUtilities::NekFactory< std::string, RiemannSolver, const LibUtilities::SessionReaderSharedPtr & > RiemannSolverFactory
Datatype of the NekFactory used to instantiate classes derived from the RiemannSolver class...
Definition: RiemannSolver.h:200

Variable Documentation

◆ BoundaryCopyTypeMap

const char* const Nektar::SolverUtils::BoundaryCopyTypeMap[]
Initial value:
= {
"Dirichlet", "Neumann", "FwdEQBwd", "FwdEQNegBwd",
}

Definition at line 70 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 45 of file Coupling.h.

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

◆ ForcingProgrammaticSharedPtr

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

A shared pointer to an EquationSystem object.

Definition at line 51 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 52 of file Forcing.h.

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

◆ IncTypeMap

const char* const Nektar::SolverUtils::IncTypeMap[]
Initial value:
= {
"PlaneWave", "PlaneWaveImag", "CylindricalWave",
}

Definition at line 135 of file MMFSystem.h.

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

◆ NullSessionFunction

SessionFunctionSharedPtr Nektar::SolverUtils::NullSessionFunction
static

Definition at line 152 of file SessionFunction.h.

◆ PolTypeMap

const char* const Nektar::SolverUtils::PolTypeMap[]
Initial value:
= {
"TransMagnetic", "TransElectric",
}

Definition at line 123 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 192 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 57 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 108 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 86 of file MMFSystem.h.

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

Generated on Wed Jan 20 2021 03:34:11 for Nektar++ by   doxygen 1.8.13