Nektar::LibUtilities::CNABTimeIntegrationScheme Class Reference

#include <CNABTimeIntegrationScheme.h>

Inheritance diagram for Nektar::LibUtilities::CNABTimeIntegrationScheme:

Public Member Functions
	CNABTimeIntegrationScheme (std::string variant, size_t order, std::vector< NekDouble > freeParams)
	~CNABTimeIntegrationScheme () 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)

Static Public Attributes
static std::string	className

Protected Member Functions
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

Static Protected Attributes
static std::string	TimeIntegrationMethodLookupId

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

Detailed Description

Definition at line 51 of file CNABTimeIntegrationScheme.h.

Constructor & Destructor Documentation

CNABTimeIntegrationScheme()

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

inline

Definition at line 54 of file CNABTimeIntegrationScheme.h.

        : TimeIntegrationSchemeGLM("", 2, freeParams)
    {
        boost::ignore_unused(variant, order);
 
        m_integration_phases    = TimeIntegrationAlgorithmGLMVector(2);
        m_integration_phases[0] = TimeIntegrationAlgorithmGLMSharedPtr(
            new TimeIntegrationAlgorithmGLM(this));
        m_integration_phases[1] = TimeIntegrationAlgorithmGLMSharedPtr(
            new TimeIntegrationAlgorithmGLM(this));
 
        // IMEX dirk 2 2 2
        IMEXdirkTimeIntegrationScheme::SetupSchemeData(m_integration_phases[0],
                                                       2, {2, 2});
        // CNAB
        CNABTimeIntegrationScheme::SetupSchemeData(m_integration_phases[1]);
    }

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

~CNABTimeIntegrationScheme()

Nektar::LibUtilities::CNABTimeIntegrationScheme::~CNABTimeIntegrationScheme ( )

inlineoverride

Definition at line 73 of file CNABTimeIntegrationScheme.h.

    {
    }

Member Function Documentation

create()

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

inlinestatic

Definition at line 77 of file CNABTimeIntegrationScheme.h.

    {
        TimeIntegrationSchemeSharedPtr p =
            MemoryManager<CNABTimeIntegrationScheme>::AllocateSharedPtr(
                "", 2, freeParams);
 
        return p;
    }

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

SetupSchemeData()

static LUE void Nektar::LibUtilities::CNABTimeIntegrationScheme::SetupSchemeData ( TimeIntegrationAlgorithmGLMSharedPtr &  phase )

inlinestatic

Definition at line 90 of file CNABTimeIntegrationScheme.h.

    {
        phase->m_schemeType = eIMEX;
        phase->m_order      = 2;
        phase->m_name =
            std::string("CNABOrder" + std::to_string(phase->m_order));
 
        phase->m_numsteps  = 4;
        phase->m_numstages = 1;
 
        phase->m_A = Array<OneD, Array<TwoD, NekDouble>>(2);
        phase->m_B = Array<OneD, Array<TwoD, NekDouble>>(2);
 
        phase->m_A[0] =
            Array<TwoD, NekDouble>(phase->m_numstages, phase->m_numstages, 0.0);
        phase->m_B[0] =
            Array<TwoD, NekDouble>(phase->m_numsteps, phase->m_numstages, 0.0);
        phase->m_A[1] =
            Array<TwoD, NekDouble>(phase->m_numstages, phase->m_numstages, 0.0);
        phase->m_B[1] =
            Array<TwoD, NekDouble>(phase->m_numsteps, phase->m_numstages, 0.0);
 
        phase->m_U =
            Array<TwoD, NekDouble>(phase->m_numstages, phase->m_numsteps, 0.0);
        phase->m_V =
            Array<TwoD, NekDouble>(phase->m_numsteps, phase->m_numsteps, 0.0);
 
        // Coefficients
        phase->m_A[0][0][0] = 1.0 / 2.0;
        phase->m_B[0][0][0] = 1.0 / 2.0;
        phase->m_B[0][1][0] = 1.0;
 
        phase->m_B[1][2][0] = 1.0;
 
        phase->m_U[0][0] = 2.0 / 2.0;
        phase->m_U[0][1] = 1.0 / 2.0;
        phase->m_U[0][2] = 3.0 / 2.0;
        phase->m_U[0][3] = -1.0 / 2.0;
 
        phase->m_V[0][0] = 2.0 / 2.0;
        phase->m_V[0][1] = 1.0 / 2.0;
        phase->m_V[0][2] = 3.0 / 2.0;
        phase->m_V[0][3] = -1.0 / 2.0;
 
        phase->m_V[3][2] = 1.0;
 
        phase->m_numMultiStepValues         = 1;
        phase->m_numMultiStepImplicitDerivs = 1;
        phase->m_numMultiStepExplicitDerivs = 2;
        phase->m_timeLevelOffset    = Array<OneD, size_t>(phase->m_numsteps);
        phase->m_timeLevelOffset[0] = 0;
        phase->m_timeLevelOffset[1] = 0;
        phase->m_timeLevelOffset[2] = 0;
        phase->m_timeLevelOffset[3] = 1;
 
        phase->CheckAndVerify();
    }

References Nektar::LibUtilities::eIMEX.

Referenced by CNABTimeIntegrationScheme().

v_GetName()

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

inlineoverrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 149 of file CNABTimeIntegrationScheme.h.

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

v_GetTimeStability()

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

inlineoverrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 154 of file CNABTimeIntegrationScheme.h.

    {
        return 1.0;
    }

Member Data Documentation

className

std::string Nektar::LibUtilities::CNABTimeIntegrationScheme::className

static

Definition at line 88 of file CNABTimeIntegrationScheme.h.

TimeIntegrationMethodLookupId

std::string Nektar::LibUtilities::CNABTimeIntegrationScheme::TimeIntegrationMethodLookupId

staticprotected

Definition at line 159 of file CNABTimeIntegrationScheme.h.