Nektar::LibUtilities::TimeIntegrationSchemeOperators Class Reference

Binds a set of functions for use by time integration schemes. More...

#include <TimeIntegrationSchemeOperators.h>

Public Types
typedef const Array< OneD, const Array< OneD, NekDouble > >	InArrayType
typedef Array< OneD, Array< OneD, NekDouble > >	OutArrayType
typedef std::function< void(InArrayType &, OutArrayType &, const NekDouble)>	FunctorType1
typedef std::function< void(InArrayType &, OutArrayType &, const NekDouble, const NekDouble)>	FunctorType2
typedef const FunctorType1 &	ConstFunctorType1Ref
typedef const FunctorType2 &	ConstFunctorType2Ref
typedef Array< OneD, FunctorType1 >	FunctorType1Array
typedef Array< OneD, FunctorType2 >	FunctorType2Array

Public Member Functions
	TimeIntegrationSchemeOperators (void)
template<typename FuncPointerT , typename ObjectPointerT >
void	DefineOdeRhs (FuncPointerT func, ObjectPointerT obj)
template<typename FuncPointerT , typename ObjectPointerT >
void	DefineProjection (FuncPointerT func, ObjectPointerT obj)
template<typename FuncPointerT , typename ObjectPointerT >
void	DefineImplicitSolve (FuncPointerT func, ObjectPointerT obj)
void	DoOdeRhs (InArrayType &inarray, OutArrayType &outarray, const NekDouble time) const
void	DoProjection (InArrayType &inarray, OutArrayType &outarray, const NekDouble time) const
void	DoImplicitSolve (InArrayType &inarray, OutArrayType &outarray, const NekDouble time, const NekDouble lambda) const

Protected Attributes
FunctorType1Array	m_functors1
FunctorType2Array	m_functors2

Detailed Description

Binds a set of functions for use by time integration schemes.

Definition at line 61 of file TimeIntegrationSchemeOperators.h.

Member Typedef Documentation

ConstFunctorType1Ref

typedef const FunctorType1& Nektar::LibUtilities::TimeIntegrationSchemeOperators::ConstFunctorType1Ref

Definition at line 73 of file TimeIntegrationSchemeOperators.h.

ConstFunctorType2Ref

typedef const FunctorType2& Nektar::LibUtilities::TimeIntegrationSchemeOperators::ConstFunctorType2Ref

Definition at line 74 of file TimeIntegrationSchemeOperators.h.

FunctorType1

typedef std::function<void(InArrayType &, OutArrayType &, const NekDouble)> Nektar::LibUtilities::TimeIntegrationSchemeOperators::FunctorType1

Definition at line 68 of file TimeIntegrationSchemeOperators.h.

FunctorType1Array

typedef Array<OneD, FunctorType1> Nektar::LibUtilities::TimeIntegrationSchemeOperators::FunctorType1Array

Definition at line 76 of file TimeIntegrationSchemeOperators.h.

FunctorType2

typedef std::function<void(InArrayType &, OutArrayType &, const NekDouble, const NekDouble)> Nektar::LibUtilities::TimeIntegrationSchemeOperators::FunctorType2

Definition at line 71 of file TimeIntegrationSchemeOperators.h.

FunctorType2Array

typedef Array<OneD, FunctorType2> Nektar::LibUtilities::TimeIntegrationSchemeOperators::FunctorType2Array

Definition at line 77 of file TimeIntegrationSchemeOperators.h.

InArrayType

typedef const Array<OneD, const Array<OneD, NekDouble> > Nektar::LibUtilities::TimeIntegrationSchemeOperators::InArrayType

Definition at line 64 of file TimeIntegrationSchemeOperators.h.

OutArrayType

typedef Array<OneD, Array<OneD, NekDouble> > Nektar::LibUtilities::TimeIntegrationSchemeOperators::OutArrayType

Definition at line 65 of file TimeIntegrationSchemeOperators.h.

Constructor & Destructor Documentation

TimeIntegrationSchemeOperators()

Nektar::LibUtilities::TimeIntegrationSchemeOperators::TimeIntegrationSchemeOperators ( void  )

inline

Definition at line 79 of file TimeIntegrationSchemeOperators.h.

                                         : m_functors1(2), m_functors2(1)
    {
    }

Member Function Documentation

DefineImplicitSolve()

template<typename FuncPointerT , typename ObjectPointerT >

void Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineImplicitSolve ( FuncPointerT  func, ObjectPointerT  obj  )

inline

Definition at line 100 of file TimeIntegrationSchemeOperators.h.

    {
        m_functors2[0] =
            std::bind(func, obj, std::placeholders::_1, std::placeholders::_2,
                      std::placeholders::_3, std::placeholders::_4);
    }

References m_functors2.

Referenced by Nektar::CoupledLinearNS::v_DoInitialise(), Nektar::Bidomain::v_InitObject(), Nektar::BidomainRoth::v_InitObject(), Nektar::Monodomain::v_InitObject(), Nektar::MMFDiffusion::v_InitObject(), Nektar::SmoothedProfileMethod::v_InitObject(), Nektar::VelocityCorrectionScheme::v_InitObject(), Nektar::SolverUtils::FileSolution::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyDiffusion::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), and Nektar::CFSImplicit::v_InitObject().

DefineOdeRhs()

template<typename FuncPointerT , typename ObjectPointerT >

void Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineOdeRhs ( FuncPointerT  func, ObjectPointerT  obj  )

inline

Definition at line 84 of file TimeIntegrationSchemeOperators.h.

    {
        m_functors1[0] =
            std::bind(func, obj, std::placeholders::_1, std::placeholders::_2,
                      std::placeholders::_3);
    }

References m_functors1.

Referenced by Nektar::UnsteadyAdvectionDiffusion::SetUpSubSteppingTimeIntegration(), Nektar::CoupledLinearNS::v_DoInitialise(), Nektar::PulseWavePropagation::v_InitObject(), Nektar::Bidomain::v_InitObject(), Nektar::BidomainRoth::v_InitObject(), Nektar::Monodomain::v_InitObject(), Nektar::MMFDiffusion::v_InitObject(), Nektar::ImageWarpingSystem::v_InitObject(), Nektar::VelocityCorrectionScheme::v_InitObject(), Nektar::SolverUtils::FileSolution::v_InitObject(), Nektar::APE::v_InitObject(), Nektar::LEE::v_InitObject(), Nektar::MMFAdvection::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurgers::v_InitObject(), Nektar::UnsteadyReactionDiffusion::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), Nektar::CompressibleFlowSystem::v_InitObject(), Nektar::CFSImplicit::v_InitObject(), Nektar::Dummy::v_InitObject(), Nektar::MMFMaxwell::v_InitObject(), Nektar::LinearSWE::v_InitObject(), Nektar::MMFSWE::v_InitObject(), Nektar::NonlinearPeregrine::v_InitObject(), Nektar::NonlinearSWE::v_InitObject(), and Nektar::SubSteppingExtrapolate::v_SubSteppingTimeIntegration().

DefineProjection()

template<typename FuncPointerT , typename ObjectPointerT >

void Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineProjection ( FuncPointerT  func, ObjectPointerT  obj  )

inline

Definition at line 92 of file TimeIntegrationSchemeOperators.h.

    {
        m_functors1[1] =
            std::bind(func, obj, std::placeholders::_1, std::placeholders::_2,
                      std::placeholders::_3);
    }

References m_functors1.

Referenced by Nektar::UnsteadyAdvectionDiffusion::SetUpSubSteppingTimeIntegration(), Nektar::PulseWavePropagation::v_InitObject(), Nektar::Bidomain::v_InitObject(), Nektar::BidomainRoth::v_InitObject(), Nektar::Monodomain::v_InitObject(), Nektar::ImageWarpingSystem::v_InitObject(), Nektar::SolverUtils::FileSolution::v_InitObject(), Nektar::APE::v_InitObject(), Nektar::LEE::v_InitObject(), Nektar::MMFAdvection::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurgers::v_InitObject(), Nektar::CompressibleFlowSystem::v_InitObject(), Nektar::Dummy::v_InitObject(), Nektar::MMFMaxwell::v_InitObject(), Nektar::LinearSWE::v_InitObject(), Nektar::MMFSWE::v_InitObject(), Nektar::NonlinearPeregrine::v_InitObject(), Nektar::NonlinearSWE::v_InitObject(), and Nektar::SubSteppingExtrapolate::v_SubSteppingTimeIntegration().

DoImplicitSolve()

void Nektar::LibUtilities::TimeIntegrationSchemeOperators::DoImplicitSolve ( InArrayType &  inarray, OutArrayType &  outarray, const NekDouble  time, const NekDouble  lambda  ) const

inline

Definition at line 123 of file TimeIntegrationSchemeOperators.h.

    {
        ASSERTL1(m_functors2[0], "ImplicitSolve should be defined for this "
                                 "time integration scheme");
        m_functors2[0](inarray, outarray, time, lambda);
    }

References ASSERTL1, and m_functors2.

Referenced by Nektar::LibUtilities::TimeIntegrationAlgorithmGLM::TimeIntegrate(), Nektar::LibUtilities::IMEXTimeIntegrationSchemeSDC::v_ComputeInitialGuess(), Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_ComputeInitialGuess(), Nektar::LibUtilities::IMEXTimeIntegrationSchemeSDC::v_SDCIterationLoop(), Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_SDCIterationLoop(), and Nektar::LibUtilities::TimeIntegrationSchemeGEM::v_TimeIntegrate().

DoOdeRhs()

void Nektar::LibUtilities::TimeIntegrationSchemeOperators::DoOdeRhs ( InArrayType &  inarray, OutArrayType &  outarray, const NekDouble  time  ) const

inline

Definition at line 107 of file TimeIntegrationSchemeOperators.h.

    {
        ASSERTL1(m_functors1[0], "OdeRhs should be defined for this time "
                                 "integration scheme");
        m_functors1[0](inarray, outarray, time);
    }

References ASSERTL1, and m_functors1.

Referenced by Nektar::LibUtilities::FractionalInTimeIntegrationScheme::finalIncrement(), Nektar::LibUtilities::TimeIntegrationAlgorithmGLM::InitializeData(), Nektar::LibUtilities::FractionalInTimeIntegrationScheme::timeAdvance(), Nektar::LibUtilities::TimeIntegrationAlgorithmGLM::TimeIntegrate(), Nektar::LibUtilities::ExplicitTimeIntegrationSchemeSDC::v_ComputeInitialGuess(), Nektar::LibUtilities::IMEXTimeIntegrationSchemeSDC::v_ComputeInitialGuess(), Nektar::LibUtilities::ExplicitTimeIntegrationSchemeSDC::v_ResidualEval(), Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_ResidualEval(), Nektar::LibUtilities::ExplicitTimeIntegrationSchemeSDC::v_SDCIterationLoop(), Nektar::LibUtilities::IMEXTimeIntegrationSchemeSDC::v_SDCIterationLoop(), and Nektar::LibUtilities::TimeIntegrationSchemeGEM::v_TimeIntegrate().

DoProjection()

void Nektar::LibUtilities::TimeIntegrationSchemeOperators::DoProjection ( InArrayType &  inarray, OutArrayType &  outarray, const NekDouble  time  ) const

inline

Definition at line 115 of file TimeIntegrationSchemeOperators.h.

    {
        ASSERTL1(m_functors1[1], "Projection operation should be defined for "
                                 "this time integration scheme");
        m_functors1[1](inarray, outarray, time);
    }

References ASSERTL1, and m_functors1.

Referenced by Nektar::LibUtilities::TimeIntegrationAlgorithmGLM::InitializeData(), Nektar::LibUtilities::TimeIntegrationAlgorithmGLM::TimeIntegrate(), Nektar::LibUtilities::ExplicitTimeIntegrationSchemeSDC::v_ComputeInitialGuess(), Nektar::LibUtilities::IMEXTimeIntegrationSchemeSDC::v_ComputeInitialGuess(), Nektar::LibUtilities::TimeIntegrationSchemeGEM::v_InitializeScheme(), Nektar::LibUtilities::ExplicitTimeIntegrationSchemeSDC::v_ResidualEval(), Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_ResidualEval(), Nektar::LibUtilities::ExplicitTimeIntegrationSchemeSDC::v_SDCIterationLoop(), and Nektar::LibUtilities::TimeIntegrationSchemeGEM::v_TimeIntegrate().

Member Data Documentation

m_functors1

FunctorType1Array Nektar::LibUtilities::TimeIntegrationSchemeOperators::m_functors1

protected

Definition at line 133 of file TimeIntegrationSchemeOperators.h.

Referenced by DefineOdeRhs(), DefineProjection(), DoOdeRhs(), and DoProjection().

m_functors2

FunctorType2Array Nektar::LibUtilities::TimeIntegrationSchemeOperators::m_functors2

protected

Definition at line 134 of file TimeIntegrationSchemeOperators.h.

Referenced by DefineImplicitSolve(), and DoImplicitSolve().