Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Enumerations | Functions | Variables
Nektar::SolverUtils Namespace Reference

Classes

class  Advection
 Defines a callback function which evaluates the flux vector. More...
class  Advection3DHomogeneous1D
class  AdvectionFR
class  AdvectionNonConservative
class  AdvectionWeakDG
class  HomoRSScalar
 Wrapper class for Riemann solver scalars. More...
class  HomoRSVector
 Wrapper class for Riemann solver scalars. More...
class  AdvectionSystem
 A base class for PDEs which include an advection component. More...
class  Diffusion
class  Diffusion3DHomogeneous1D
class  DiffusionLDG
class  DiffusionLDGNS
class  DiffusionLFR
class  DiffusionLFRNS
class  Driver
 Base class for the development of solvers. 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  FilterEnergyBase
class  FilterHistoryPoints
class  FilterModalEnergy
class  FilterThresholdMax
class  FilterThresholdMin
class  Forcing
 Defines a forcing term to be explicitly applied. More...
class  ForcingAbsorption
class  ForcingBody
class  ForcingNoise
class  ForcingProgrammatic
class  RiemannSolver
 The RiemannSolver class provides an abstract interface under which solvers for various Riemann problems can be implemented. More...
class  UpwindLDGSolver
 Upwind scheme Riemann solver for LDG. More...
class  UpwindSolver
 Upwind scheme Riemann solver. More...
class  UnsteadySystem
 Base class for unsteady solvers. More...
class  FilterEnergy

Typedefs

typedef boost::shared_ptr
< Advection
AdvectionSharedPtr
 A shared pointer to an Advection object.
typedef
LibUtilities::NekFactory
< std::string, Advection,
std::string > 
AdvectionFactory
 Datatype of the NekFactory used to instantiate classes derived from the Advection class.
typedef boost::shared_ptr
< AdvectionSystem
AdvectionSystemSharedPtr
 Shared pointer to an AdvectionSystem class.
typedef std::vector< std::pair
< std::string, std::string > > 
SummaryList
typedef boost::function< void(const
int, const int, const Array
< OneD, Array< OneD, NekDouble >
> &, Array< OneD, Array< OneD,
NekDouble > > &, Array< OneD,
Array< OneD, NekDouble > > &)> 
DiffusionFluxVecCB
typedef boost::function< void(const
Array< OneD, Array< OneD,
NekDouble > > &, Array< OneD,
Array< OneD, Array< OneD,
NekDouble > > > &, Array< OneD,
Array< OneD, Array< OneD,
NekDouble > > > &)> 
DiffusionFluxVecCBNS
typedef boost::function< void(const
Array< OneD, Array< OneD,
NekDouble > > &, Array< OneD,
NekDouble > &)> 
DiffusionArtificialDiffusion
typedef boost::shared_ptr
< Diffusion
DiffusionSharedPtr
 A shared pointer to an EquationSystem object.
typedef
LibUtilities::NekFactory
< std::string, Diffusion,
std::string > 
DiffusionFactory
 Datatype of the NekFactory used to instantiate classes derived from the Diffusion class.
typedef boost::shared_ptr
< DiffusionLDGNS
DiffusionLDGNSSharedPtr
typedef boost::shared_ptr
< DiffusionLFRNS
DiffusionLFRNSSharedPtr
typedef boost::shared_ptr< DriverDriverSharedPtr
 A shared pointer to a Driver object.
typedef
LibUtilities::NekFactory
< std::string, Driver, const
LibUtilities::SessionReaderSharedPtr & > 
DriverFactory
 Datatype of the NekFactory used to instantiate classes derived from the Driver class.
typedef boost::shared_ptr
< EquationSystem
EquationSystemSharedPtr
 A shared pointer to an EquationSystem object.
typedef
LibUtilities::NekFactory
< std::string, EquationSystem,
const
LibUtilities::SessionReaderSharedPtr & > 
EquationSystemFactory
 Datatype of the NekFactory used to instantiate classes derived from the EquationSystem class.
typedef boost::shared_ptr< FilterFilterSharedPtr
 A shared pointer to a Driver object.
typedef
LibUtilities::NekFactory
< std::string, Filter, const
LibUtilities::SessionReaderSharedPtr
&, const std::map< std::string,
std::string > & > 
FilterFactory
 Datatype of the NekFactory used to instantiate classes derived from the Driver class.
typedef
LibUtilities::NekFactory
< std::string, Forcing, const
LibUtilities::SessionReaderSharedPtr
&, const Array< OneD,
MultiRegions::ExpListSharedPtr >
&, const unsigned int
&, const TiXmlElement * > 
ForcingFactory
 Declaration of the forcing factory.
typedef boost::function< const
Array< OneD, const NekDouble > &()> 
RSScalarFuncType
typedef boost::function< const
Array< OneD, const Array< OneD,
NekDouble > > &()> 
RSVecFuncType
typedef boost::function
< NekDouble()> 
RSParamFuncType
typedef boost::shared_ptr
< RiemannSolver
RiemannSolverSharedPtr
 A shared pointer to an EquationSystem object.
typedef
LibUtilities::NekFactory
< std::string, RiemannSolver
RiemannSolverFactory
 Datatype of the NekFactory used to instantiate classes derived from the RiemannSolver class.

Enumerations

enum  EvolutionOperatorType {
  eNonlinear, eDirect, eAdjoint, eTransientGrowth,
  eSkewSymmetric, eAdaptiveSFD
}

Functions

AdvectionFactoryGetAdvectionFactory ()
 Gets the factory for initialising advection objects.
void AddSummaryItem (SummaryList &l, const std::string &name, const std::string &value)
 Adds a summary item to the summary info list.
void AddSummaryItem (SummaryList &l, const std::string &name, const int &value)
 Adds a summary item to the summary info list.
void AddSummaryItem (SummaryList &l, const std::string &name, const NekDouble &value)
 Adds a summary item to the summary info list.
DiffusionFactoryGetDiffusionFactory ()
DriverFactoryGetDriverFactory ()
EquationSystemFactoryGetEquationSystemFactory ()
FilterFactoryGetFilterFactory ()
ForcingFactoryGetForcingFactory ()
 Declaration of the forcing factory singleton.
RiemannSolverFactoryGetRiemannSolverFactory ()

Variables

SOLVER_UTILS_EXPORT typedef
boost::shared_ptr< Forcing
ForcingSharedPtr
 A shared pointer to an EquationSystem object.
SOLVER_UTILS_EXPORT typedef
boost::shared_ptr
< ForcingProgrammatic
ForcingProgrammaticSharedPtr
 A shared pointer to an EquationSystem object.

Typedef Documentation

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

Definition at line 163 of file Advection.h.

A shared pointer to an Advection object.

Definition at line 158 of file Advection.h.

Shared pointer to an AdvectionSystem class.

Definition at line 68 of file AdvectionSystem.h.

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

Definition at line 69 of file Diffusion.h.

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

Definition at line 168 of file Diffusion.h.

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

Definition at line 58 of file Diffusion.h.

typedef boost::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.

Definition at line 123 of file DiffusionLDGNS.h.

Definition at line 201 of file DiffusionLFRNS.h.

A shared pointer to an EquationSystem object.

Definition at line 164 of file Diffusion.h.

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

Definition at line 60 of file Driver.h.

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

A shared pointer to a Driver object.

Definition at line 52 of file Driver.h.

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

Definition at line 62 of file EquationSystem.h.

A shared pointer to an EquationSystem object.

Definition at line 53 of file EquationSystem.h.

typedef LibUtilities::NekFactory< std::string, Filter, const LibUtilities::SessionReaderSharedPtr&, 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.

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

A shared pointer to a Driver object.

Definition at line 50 of file Filter.h.

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

Declaration of the forcing factory.

Definition at line 61 of file Forcing.h.

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

Definition at line 198 of file RiemannSolver.h.

A shared pointer to an EquationSystem object.

Definition at line 194 of file RiemannSolver.h.

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

Definition at line 60 of file RiemannSolver.h.

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

Definition at line 56 of file RiemannSolver.h.

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

Definition at line 58 of file RiemannSolver.h.

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

Definition at line 47 of file Misc.h.

Enumeration Type Documentation

Enumerator:
eNonlinear 
eDirect 
eAdjoint 
eTransientGrowth 
eSkewSymmetric 
eAdaptiveSFD 

Definition at line 5 of file SolverUtils.hpp.

Function Documentation

SOLVER_UTILS_EXPORT void Nektar::SolverUtils::AddSummaryItem ( SummaryList &  l,
const std::string &  name,
const std::string &  value 
)
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 59 of file Misc.cpp.

{
l.push_back(std::make_pair(name, boost::lexical_cast<std::string>(value)));
}
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 68 of file Misc.cpp.

{
l.push_back(std::make_pair(
name, str(boost::format("%g") % value)));
}
SOLVER_UTILS_EXPORT AdvectionFactory & Nektar::SolverUtils::GetAdvectionFactory ( )
SOLVER_UTILS_EXPORT DiffusionFactory & Nektar::SolverUtils::GetDiffusionFactory ( )
SOLVER_UTILS_EXPORT DriverFactory & Nektar::SolverUtils::GetDriverFactory ( )

Definition at line 64 of file Driver.cpp.

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

{
typedef Loki::SingletonHolder<DriverFactory,
Loki::CreateUsingNew,
Loki::NoDestroy > Type;
return Type::Instance();
}
SOLVER_UTILS_EXPORT EquationSystemFactory & Nektar::SolverUtils::GetEquationSystemFactory ( )

Definition at line 82 of file EquationSystem.cpp.

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

{
typedef Loki::SingletonHolder<EquationSystemFactory,
Loki::CreateUsingNew,
Loki::NoDestroy > Type;
return Type::Instance();
}
SOLVER_UTILS_EXPORT FilterFactory & Nektar::SolverUtils::GetFilterFactory ( )

Definition at line 42 of file Filter.cpp.

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

{
typedef Loki::SingletonHolder<FilterFactory,
Loki::CreateUsingNew,
Loki::NoDestroy > Type;
return Type::Instance();
}
SOLVER_UTILS_EXPORT ForcingFactory & Nektar::SolverUtils::GetForcingFactory ( )

Declaration of the forcing factory singleton.

Definition at line 42 of file Forcing.cpp.

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

{
typedef Loki::SingletonHolder<ForcingFactory,
Loki::CreateUsingNew,
Loki::NoDestroy > Type;
return Type::Instance();
}
SOLVER_UTILS_EXPORT RiemannSolverFactory & Nektar::SolverUtils::GetRiemannSolverFactory ( )

Variable Documentation

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

A shared pointer to an EquationSystem object.

Definition at line 52 of file ForcingProgrammatic.h.

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