Nektar::LibUtilities::EulerTimeIntegrationScheme Class Reference

#include <EulerTimeIntegrationSchemes.h>

Inheritance diagram for Nektar::LibUtilities::EulerTimeIntegrationScheme:

Public Member Functions
	EulerTimeIntegrationScheme (std::string variant, size_t order, std::vector< NekDouble > freeParams)
	~EulerTimeIntegrationScheme () override
Public Member Functions inherited from Nektar::LibUtilities::TimeIntegrationSchemeGLM
LUE void	InitializeSecondaryData (TimeIntegrationAlgorithmGLM *phase, NekDouble deltaT) const
Public Member Functions inherited from Nektar::LibUtilities::TimeIntegrationScheme
LUE std::string	GetFullName () const
LUE std::string	GetName () const
LUE std::string	GetVariant () const
LUE size_t	GetOrder () const
LUE std::vector< NekDouble >	GetFreeParams ()
LUE TimeIntegrationSchemeType	GetIntegrationSchemeType ()
LUE NekDouble	GetTimeStability () const
LUE size_t	GetNumIntegrationPhases ()
LUE const TripleArray &	GetSolutionVector () const
	Gets the solution vector of the ODE. More...
LUE TripleArray &	UpdateSolutionVector ()
LUE void	SetSolutionVector (const size_t Offset, const DoubleArray &y)
	Sets the solution vector of the ODE. More...
LUE void	InitializeScheme (const NekDouble deltaT, ConstDoubleArray &y_0, const NekDouble time, const TimeIntegrationSchemeOperators &op)
	Explicit integration of an ODE. More...
LUE ConstDoubleArray &	TimeIntegrate (const size_t timestep, const NekDouble delta_t)
LUE void	print (std::ostream &os) const
LUE void	printFull (std::ostream &os) const

Static Public Member Functions
static TimeIntegrationSchemeSharedPtr	create (std::string variant, size_t order, std::vector< NekDouble > freeParams)
static LUE void	SetupSchemeData (TimeIntegrationAlgorithmGLMSharedPtr &phase, std::string variant)

Static Public Attributes
static std::string	className

Protected Member Functions
LUE std::string	v_GetFullName () const override
LUE std::string	v_GetName () const override
LUE NekDouble	v_GetTimeStability () const override
Protected Member Functions inherited from Nektar::LibUtilities::TimeIntegrationSchemeGLM
LUE std::string	v_GetVariant () const override
LUE size_t	v_GetOrder () const override
LUE std::vector< NekDouble >	v_GetFreeParams () const override
LUE TimeIntegrationSchemeType	v_GetIntegrationSchemeType () const override
LUE size_t	v_GetNumIntegrationPhases () const override
LUE const TripleArray &	v_GetSolutionVector () const override
LUE TripleArray &	v_UpdateSolutionVector () override
LUE void	v_SetSolutionVector (const size_t Offset, const DoubleArray &y) override
LUE void	v_InitializeScheme (const NekDouble deltaT, ConstDoubleArray &y_0, const NekDouble time, const TimeIntegrationSchemeOperators &op) override
	Worker method to initialize the integration scheme. More...
LUE ConstDoubleArray &	v_TimeIntegrate (const size_t timestep, const NekDouble delta_t) override
	Worker method that actually does the time integration. More...
virtual LUE void	v_InitializeSecondaryData (TimeIntegrationAlgorithmGLM *phase, NekDouble deltaT) const
LUE void	v_print (std::ostream &os) const override
	Worker method to print details on the integration scheme. More...
LUE void	v_printFull (std::ostream &os) const override
LUE	TimeIntegrationSchemeGLM (std::string variant, size_t order, std::vector< NekDouble > freeParams)
	~TimeIntegrationSchemeGLM () override
Protected Member Functions inherited from Nektar::LibUtilities::TimeIntegrationScheme
virtual LUE std::string	v_GetFullName () const
virtual LUE std::string	v_GetName () const =0
virtual LUE std::string	v_GetVariant () const =0
virtual LUE size_t	v_GetOrder () const =0
virtual LUE std::vector< NekDouble >	v_GetFreeParams () const =0
virtual LUE TimeIntegrationSchemeType	v_GetIntegrationSchemeType () const =0
virtual LUE NekDouble	v_GetTimeStability () const =0
virtual LUE size_t	v_GetNumIntegrationPhases () const =0
virtual LUE const TripleArray &	v_GetSolutionVector () const =0
virtual LUE TripleArray &	v_UpdateSolutionVector ()=0
virtual LUE void	v_SetSolutionVector (const size_t Offset, const DoubleArray &y)=0
virtual LUE void	v_InitializeScheme (const NekDouble deltaT, ConstDoubleArray &y_0, const NekDouble time, const TimeIntegrationSchemeOperators &op)=0
virtual LUE ConstDoubleArray &	v_TimeIntegrate (const size_t timestep, const NekDouble delta_t)=0
virtual LUE void	v_print (std::ostream &os) const =0
virtual LUE void	v_printFull (std::ostream &os) const =0
LUE	TimeIntegrationScheme (std::string variant, size_t order, std::vector< NekDouble > freeParams)
LUE	TimeIntegrationScheme (const TimeIntegrationScheme &in)=delete
virtual	~TimeIntegrationScheme ()=default

Additional Inherited Members
Protected Attributes inherited from Nektar::LibUtilities::TimeIntegrationSchemeGLM
TimeIntegrationAlgorithmGLMVector	m_integration_phases
TimeIntegrationSolutionGLMSharedPtr	m_solVector

Detailed Description

Definition at line 54 of file EulerTimeIntegrationSchemes.h.

Constructor & Destructor Documentation

EulerTimeIntegrationScheme()

Nektar::LibUtilities::EulerTimeIntegrationScheme::EulerTimeIntegrationScheme ( std::string  variant, size_t  order, std::vector< NekDouble >  freeParams  )

inline

Definition at line 57 of file EulerTimeIntegrationSchemes.h.

        : TimeIntegrationSchemeGLM(variant, 1, freeParams)
    {
        boost::ignore_unused(variant, order);
 
        ASSERTL1(variant == "Backward" || variant == "Forward",
                 "Euler Time integration scheme unknown variant: " + variant +
                     ". Must be 'Backward' or 'Forward'");
 
        m_integration_phases    = TimeIntegrationAlgorithmGLMVector(1);
        m_integration_phases[0] = TimeIntegrationAlgorithmGLMSharedPtr(
            new TimeIntegrationAlgorithmGLM(this));
 
        EulerTimeIntegrationScheme::SetupSchemeData(m_integration_phases[0],
                                                    variant);
    }

References ASSERTL1, Nektar::LibUtilities::TimeIntegrationSchemeGLM::m_integration_phases, and SetupSchemeData().

~EulerTimeIntegrationScheme()

Nektar::LibUtilities::EulerTimeIntegrationScheme::~EulerTimeIntegrationScheme ( )

inlineoverride

Definition at line 75 of file EulerTimeIntegrationSchemes.h.

    {
    }

Member Function Documentation

create()

static TimeIntegrationSchemeSharedPtr Nektar::LibUtilities::EulerTimeIntegrationScheme::create ( std::string  variant, size_t  order, std::vector< NekDouble >  freeParams  )

inlinestatic

Definition at line 79 of file EulerTimeIntegrationSchemes.h.

    {
        TimeIntegrationSchemeSharedPtr p =
            MemoryManager<EulerTimeIntegrationScheme>::AllocateSharedPtr(
                variant, 1, freeParams);
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

SetupSchemeData()

static LUE void Nektar::LibUtilities::EulerTimeIntegrationScheme::SetupSchemeData ( TimeIntegrationAlgorithmGLMSharedPtr &  phase, std::string  variant  )

inlinestatic

Definition at line 91 of file EulerTimeIntegrationSchemes.h.

    {
        double A = 0;
 
        if (variant == "Backward")
        {
            phase->m_schemeType = eDiagonallyImplicit;
 
            A = 1;
        }
        else if (variant == "Forward")
        {
            phase->m_schemeType = eExplicit;
 
            A = 0;
        }
 
        phase->m_variant = variant;
        phase->m_order   = 1;
        phase->m_name    = variant + std::string("EulerOrder") +
                        std::to_string(phase->m_order);
 
        phase->m_numsteps  = 1;
        phase->m_numstages = 1;
 
        phase->m_A = Array<OneD, Array<TwoD, NekDouble>>(1);
        phase->m_B = Array<OneD, Array<TwoD, NekDouble>>(1);
 
        phase->m_A[0] =
            Array<TwoD, NekDouble>(phase->m_numstages, phase->m_numstages, A);
        phase->m_B[0] =
            Array<TwoD, NekDouble>(phase->m_numsteps, phase->m_numstages, 1.0);
        phase->m_U =
            Array<TwoD, NekDouble>(phase->m_numstages, phase->m_numsteps, 1.0);
        phase->m_V =
            Array<TwoD, NekDouble>(phase->m_numsteps, phase->m_numsteps, 1.0);
 
        phase->m_numMultiStepValues         = 1;
        phase->m_numMultiStepImplicitDerivs = 0;
        phase->m_numMultiStepExplicitDerivs = 0;
        phase->m_timeLevelOffset    = Array<OneD, size_t>(phase->m_numsteps);
        phase->m_timeLevelOffset[0] = 0;
 
        phase->CheckAndVerify();
    }

References Nektar::LibUtilities::eDiagonallyImplicit, and Nektar::LibUtilities::eExplicit.

Referenced by EulerTimeIntegrationScheme().

v_GetFullName()

LUE std::string Nektar::LibUtilities::EulerTimeIntegrationScheme::v_GetFullName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 139 of file EulerTimeIntegrationSchemes.h.

    {
        return m_integration_phases.back()->m_name;
    }

References Nektar::LibUtilities::TimeIntegrationSchemeGLM::m_integration_phases.

v_GetName()

LUE std::string Nektar::LibUtilities::EulerTimeIntegrationScheme::v_GetName ( ) const

inlineoverrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 144 of file EulerTimeIntegrationSchemes.h.

    {
        return std::string("Euler");
    }

v_GetTimeStability()

LUE NekDouble Nektar::LibUtilities::EulerTimeIntegrationScheme::v_GetTimeStability ( ) const

inlineoverrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 149 of file EulerTimeIntegrationSchemes.h.

    {
        if (GetVariant() == "Backward")
        {
            return 1.0;
        }
        else
        {
            return 2.0;
        }
    }

References Nektar::LibUtilities::TimeIntegrationScheme::GetVariant().

Member Data Documentation

className

std::string Nektar::LibUtilities::EulerTimeIntegrationScheme::className

static

Definition at line 89 of file EulerTimeIntegrationSchemes.h.