Nektar::SolverUtils Namespace Reference

Classes
class	Advection
	Defines a callback function which evaluates the flux vector. More...
class	Advection3DHomogeneous1D
class	AdvectionFR
class	AdvectionNonConservative
class	AdvectionSystem
	A base class for PDEs which include an advection component. More...
class	AdvectionWeakDG
class	Diffusion
class	Diffusion3DHomogeneous1D
class	DiffusionLDG
class	DiffusionLDGNS
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	FilterEnergy1D
	Filter for one-dimensional energy spectrum. More...
class	FilterEnergyBase
class	FilterFieldConvert
class	FilterHistoryPoints
class	FilterModalEnergy
class	FilterMovingAverage
class	FilterReynoldsStresses
	Append Reynolds stresses to the average fields. More...
class	FilterThresholdMax
class	FilterThresholdMin
class	Forcing
	Defines a forcing term to be explicitly applied. More...
class	ForcingAbsorption
class	ForcingBody
class	ForcingNoise
class	ForcingProgrammatic
class	HomoRSScalar
	Wrapper class for Riemann solver scalars. More...
class	HomoRSVector
	Wrapper class for Riemann solver scalars. More...
struct	loadedFldField
class	RiemannSolver
	The RiemannSolver class provides an abstract interface under which solvers for various Riemann problems can be implemented. More...
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 boost::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 boost::shared_ptr < AdvectionSystem >	AdvectionSystemSharedPtr
	Shared pointer to an AdvectionSystem class. More...
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. 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 boost::shared_ptr < DiffusionLDGNS >	DiffusionLDGNSSharedPtr
typedef boost::shared_ptr < DiffusionLFRNS >	DiffusionLFRNSSharedPtr
typedef boost::shared_ptr< Driver >	DriverSharedPtr
	A shared pointer to a Driver object. More...
typedef LibUtilities::NekFactory < std::string, Driver, const LibUtilities::SessionReaderSharedPtr & >	DriverFactory
	Datatype of the NekFactory used to instantiate classes derived from the Driver class. More...
typedef boost::shared_ptr < EquationSystem >	EquationSystemSharedPtr
	A shared pointer to an EquationSystem object. More...
typedef LibUtilities::NekFactory < std::string, EquationSystem, const LibUtilities::SessionReaderSharedPtr & >	EquationSystemFactory
	Datatype of the NekFactory used to instantiate classes derived from the EquationSystem class. More...
typedef boost::shared_ptr< Filter >	FilterSharedPtr
	A shared pointer to a Driver object. More...
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. More...
typedef boost::shared_ptr < FilterAeroForces >	FilterAeroForcesSharedPtr
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. More...
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. More...
typedef LibUtilities::NekFactory < std::string, RiemannSolver >	RiemannSolverFactory
	Datatype of the NekFactory used to instantiate classes derived from the RiemannSolver class. More...

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

Functions
AdvectionFactory &	GetAdvectionFactory ()
	Gets the factory for initialising advection objects. 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 boost::shared_ptr< Forcing >	ForcingSharedPtr
	A shared pointer to an EquationSystem object. More...
SOLVER_UTILS_EXPORT typedef boost::shared_ptr < ForcingProgrammatic >	ForcingProgrammaticSharedPtr
	A shared pointer to an EquationSystem object. More...

Typedef Documentation

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

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

A shared pointer to an Advection object.

Definition at line 165 of file Advection.h.

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

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.

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

typedef boost::shared_ptr<DiffusionLDGNS> Nektar::SolverUtils::DiffusionLDGNSSharedPtr

Definition at line 129 of file DiffusionLDGNS.h.

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

Definition at line 203 of file DiffusionLFRNS.h.

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

A shared pointer to an EquationSystem object.

Definition at line 162 of file Diffusion.h.

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

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.

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

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

Definition at line 68 of file EquationSystem.h.

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

A shared pointer to an EquationSystem object.

Definition at line 59 of file EquationSystem.h.

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

Definition at line 131 of file FilterAeroForces.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.

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

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

Definition at line 198 of file RiemannSolver.h.

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

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

enum Nektar::SolverUtils::EvolutionOperatorType

Enumerator
eNonlinear
eDirect
eAdjoint
eTransientGrowth
eSkewSymmetric
eAdaptiveSFD

Definition at line 5 of file SolverUtils.hpp.

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

Function Documentation

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 50 of file Misc.cpp.

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

    {
        l.push_back(std::make_pair(name, 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.

References CellMLToNektar.pycml::format.

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

SOLVER_UTILS_EXPORT AdvectionFactory & Nektar::SolverUtils::GetAdvectionFactory

(

)

Gets the factory for initialising advection objects.

Returns

The advection factory.

Definition at line 46 of file Advection.cpp.

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

{
    typedef Loki::SingletonHolder<AdvectionFactory,
    Loki::CreateUsingNew,
    Loki::NoDestroy,
    Loki::SingleThreaded> Type;
    return Type::Instance();
}

SOLVER_UTILS_EXPORT DiffusionFactory & Nektar::SolverUtils::GetDiffusionFactory

(

)

Definition at line 42 of file Diffusion.cpp.

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

        {
            typedef Loki::SingletonHolder<DiffusionFactory,
            Loki::CreateUsingNew,
            Loki::NoDestroy,
            Loki::SingleThreaded> Type;
            return Type::Instance();
        }

SOLVER_UTILS_EXPORT DriverFactory & Nektar::SolverUtils::GetDriverFactory

(

)

Definition at line 66 of file Driver.cpp.

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

{
    typedef Loki::SingletonHolder<DriverFactory,
    Loki::CreateUsingNew,
    Loki::NoDestroy,
    Loki::SingleThreaded> Type;
    return Type::Instance();
}

SOLVER_UTILS_EXPORT EquationSystemFactory & Nektar::SolverUtils::GetEquationSystemFactory

(

)

Definition at line 83 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,
                                          Loki::ClassLevelLockable> 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,
                                  Loki::SingleThreaded> Type;
    return Type::Instance();
}

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

        {
            typedef Loki::SingletonHolder<ForcingFactory,
                                          Loki::CreateUsingNew,
                                          Loki::NoDestroy,
                                          Loki::SingleThreaded> Type;
            return Type::Instance();
        }

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::NonlinearSWE::v_InitObject(), Nektar::LinearSWE::v_InitObject(), Nektar::NonlinearPeregrine::v_InitObject(), Nektar::APE::v_InitObject(), Nektar::UnsteadyInviscidBurger::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), and Nektar::UnsteadyViscousBurgers::v_InitObject().

        {
            typedef Loki::SingletonHolder<RiemannSolverFactory,
                                          Loki::CreateUsingNew,
                                          Loki::NoDestroy,
                                          Loki::SingleThreaded> Type;
            return Type::Instance();
        }

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

A shared pointer to an EquationSystem object.

Definition at line 51 of file Forcing.h.

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