Nektar::LibUtilities::TimeIntegrationSchemeGLM Class Reference

Base class for GLM time integration schemes. More...

#include <TimeIntegrationSchemeGLM.h>

Inheritance diagram for Nektar::LibUtilities::TimeIntegrationSchemeGLM:

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

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

Protected Attributes
TimeIntegrationAlgorithmGLMVector	m_integration_phases
TimeIntegrationSolutionGLMSharedPtr	m_solVector

Friends
LUE friend std::ostream &	operator<< (std::ostream &os, const TimeIntegrationSchemeGLM &rhs)
LUE friend std::ostream &	operator<< (std::ostream &os, const TimeIntegrationSchemeGLMSharedPtr &rhs)

Detailed Description

Base class for GLM time integration schemes.

Definition at line 49 of file TimeIntegrationSchemeGLM.h.

Constructor & Destructor Documentation

TimeIntegrationSchemeGLM()

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

inlineprotected

Definition at line 105 of file TimeIntegrationSchemeGLM.h.

        : TimeIntegrationScheme(variant, order, freeParams)
    {
    }

~TimeIntegrationSchemeGLM()

Nektar::LibUtilities::TimeIntegrationSchemeGLM::~TimeIntegrationSchemeGLM ( )

inlineoverrideprotected

Definition at line 111 of file TimeIntegrationSchemeGLM.h.

    {
    }

Member Function Documentation

InitializeSecondaryData()

LUE void Nektar::LibUtilities::TimeIntegrationSchemeGLM::InitializeSecondaryData ( TimeIntegrationAlgorithmGLM *  phase, NekDouble  deltaT  ) const

inline

Definition at line 52 of file TimeIntegrationSchemeGLM.h.

    {
        v_InitializeSecondaryData(phase, deltaT);
    }

References v_InitializeSecondaryData().

Referenced by Nektar::LibUtilities::TimeIntegrationAlgorithmGLM::TimeIntegrate().

v_GetFreeParams()

std::vector< NekDouble > Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_GetFreeParams ( ) const

overrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 57 of file TimeIntegrationSchemeGLM.cpp.

{
    ASSERTL0(!m_integration_phases.empty(), "No scheme")
 
    return m_integration_phases.back()->m_freeParams;
}

References ASSERTL0, and m_integration_phases.

v_GetIntegrationSchemeType()

TimeIntegrationSchemeType Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_GetIntegrationSchemeType ( ) const

overrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 64 of file TimeIntegrationSchemeGLM.cpp.

{
    ASSERTL0(!m_integration_phases.empty(), "No scheme")
 
    return m_integration_phases.back()->m_schemeType;
}

References ASSERTL0, and m_integration_phases.

v_GetNumIntegrationPhases()

size_t Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_GetNumIntegrationPhases ( ) const

overrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 72 of file TimeIntegrationSchemeGLM.cpp.

{
    return m_integration_phases.size();
}

References m_integration_phases.

v_GetOrder()

size_t Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_GetOrder ( ) const

overrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 50 of file TimeIntegrationSchemeGLM.cpp.

{
    ASSERTL0(!m_integration_phases.empty(), "No scheme")
 
    return m_integration_phases.back()->m_order;
}

References ASSERTL0, and m_integration_phases.

v_GetSolutionVector()

LUE const TripleArray & Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_GetSolutionVector ( ) const

inlineoverrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 73 of file TimeIntegrationSchemeGLM.h.

    {
        return m_solVector->GetSolutionVector();
    }

References m_solVector.

v_GetVariant()

std::string Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_GetVariant ( ) const

overrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 43 of file TimeIntegrationSchemeGLM.cpp.

{
    ASSERTL0(!m_integration_phases.empty(), "No scheme")
 
    return m_integration_phases.back()->m_variant;
}

References ASSERTL0, and m_integration_phases.

v_InitializeScheme()

void Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_InitializeScheme ( const NekDouble  deltaT, ConstDoubleArray &  y_0, const NekDouble  time, const TimeIntegrationSchemeOperators &  op  )

overrideprotectedvirtual

Worker method to initialize the integration scheme.

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 80 of file TimeIntegrationSchemeGLM.cpp.

{
    for (int i = 0; i < m_integration_phases.size(); i++)
    {
        m_integration_phases[i]->InitializeScheme(op);
    }
 
    m_solVector =
        m_integration_phases.back()->InitializeData(deltaT, y_0, time);
}

References m_integration_phases, and m_solVector.

v_InitializeSecondaryData()

void Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_InitializeSecondaryData ( TimeIntegrationAlgorithmGLM *  phase, NekDouble  deltaT  ) const

protectedvirtual

Reimplemented in Nektar::LibUtilities::EulerExponentialTimeIntegrationScheme.

Definition at line 107 of file TimeIntegrationSchemeGLM.cpp.

{
    ASSERTL0(false,
             "No InitializeSecondaryData method for scheme " + GetFullName());
}

References ASSERTL0, and Nektar::LibUtilities::TimeIntegrationScheme::GetFullName().

Referenced by InitializeSecondaryData().

v_print()

void Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_print ( std::ostream &  os ) const

overrideprotectedvirtual

Worker method to print details on the integration scheme.

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 118 of file TimeIntegrationSchemeGLM.cpp.

{
    os << "Time Integration Scheme: " << GetFullName() << std::endl
       << "        Has " << m_integration_phases.size() << " phase(s)"
       << std::endl;
 
    for (size_t i = 0; i < m_integration_phases.size(); i++)
    {
        os << "            - " << m_integration_phases[i]->m_name << std::endl;
    }
}

References Nektar::LibUtilities::TimeIntegrationScheme::GetFullName(), and m_integration_phases.

v_printFull()

void Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_printFull ( std::ostream &  os ) const

overrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 130 of file TimeIntegrationSchemeGLM.cpp.

{
    os << "Time Integration Scheme: " << GetFullName() << std::endl
       << "        Has " << m_integration_phases.size() << " phase(s)"
       << std::endl;
 
    for (size_t i = 0; i < m_integration_phases.size(); i++)
    {
        os << "            - " << m_integration_phases[i]->m_name << std::endl;
 
        os << "            - " << m_integration_phases[i] << std::endl;
    }
}

References Nektar::LibUtilities::TimeIntegrationScheme::GetFullName(), and m_integration_phases.

v_SetSolutionVector()

LUE void Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_SetSolutionVector ( const size_t  Offset, const DoubleArray &  y  )

inlineoverrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 84 of file TimeIntegrationSchemeGLM.h.

    {
        m_solVector->SetSolutionVector(Offset, y);
    }

References m_solVector.

v_TimeIntegrate()

ConstDoubleArray & Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_TimeIntegrate ( const size_t  timestep, const NekDouble  delta_t  )

overrideprotectedvirtual

Worker method that actually does the time integration.

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 96 of file TimeIntegrationSchemeGLM.cpp.

{
    size_t nPhases = m_integration_phases.size();
 
    TimeIntegrationAlgorithmGLMSharedPtr &algorithm =
        m_integration_phases[std::min(timestep, nPhases - 1)];
 
    return algorithm->TimeIntegrate(delta_t, m_solVector);
}

References m_integration_phases, and m_solVector.

v_UpdateSolutionVector()

LUE TripleArray & Nektar::LibUtilities::TimeIntegrationSchemeGLM::v_UpdateSolutionVector ( )

inlineoverrideprotectedvirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 78 of file TimeIntegrationSchemeGLM.h.

    {
        return m_solVector->UpdateSolutionVector();
    }

References m_solVector.

Friends And Related Function Documentation

operator<< [1/2]

LUE friend std::ostream & operator<< ( std::ostream &  os, const TimeIntegrationSchemeGLM &  rhs  )

friend

Definition at line 145 of file TimeIntegrationSchemeGLM.cpp.

{
    rhs.print(os);
 
    return os;
}

operator<< [2/2]

LUE friend std::ostream & operator<< ( std::ostream &  os, const TimeIntegrationSchemeGLMSharedPtr &  rhs  )

friend

Definition at line 152 of file TimeIntegrationSchemeGLM.cpp.

{
    os << *rhs.get();
 
    return os;
}

Member Data Documentation

m_integration_phases

TimeIntegrationAlgorithmGLMVector Nektar::LibUtilities::TimeIntegrationSchemeGLM::m_integration_phases

protected

Definition at line 115 of file TimeIntegrationSchemeGLM.h.

Referenced by Nektar::LibUtilities::AdamsBashforthTimeIntegrationScheme::AdamsBashforthTimeIntegrationScheme(), Nektar::LibUtilities::AdamsMoultonTimeIntegrationScheme::AdamsMoultonTimeIntegrationScheme(), Nektar::LibUtilities::BDFImplicitTimeIntegrationScheme::BDFImplicitTimeIntegrationScheme(), Nektar::LibUtilities::CNABTimeIntegrationScheme::CNABTimeIntegrationScheme(), Nektar::LibUtilities::DIRKTimeIntegrationScheme::DIRKTimeIntegrationScheme(), Nektar::LibUtilities::EulerExponentialTimeIntegrationScheme::EulerExponentialTimeIntegrationScheme(), Nektar::LibUtilities::EulerTimeIntegrationScheme::EulerTimeIntegrationScheme(), Nektar::LibUtilities::IMEXdirkTimeIntegrationScheme::IMEXdirkTimeIntegrationScheme(), Nektar::LibUtilities::IMEXGearTimeIntegrationScheme::IMEXGearTimeIntegrationScheme(), Nektar::LibUtilities::IMEXTimeIntegrationScheme::IMEXTimeIntegrationScheme(), Nektar::LibUtilities::MCNABTimeIntegrationScheme::MCNABTimeIntegrationScheme(), Nektar::LibUtilities::RungeKuttaTimeIntegrationScheme::RungeKuttaTimeIntegrationScheme(), Nektar::LibUtilities::EulerExponentialTimeIntegrationScheme::SetExponentialCoefficients(), v_GetFreeParams(), Nektar::LibUtilities::EulerTimeIntegrationScheme::v_GetFullName(), Nektar::LibUtilities::IMEXdirkTimeIntegrationScheme::v_GetFullName(), Nektar::LibUtilities::IMEXTimeIntegrationScheme::v_GetFullName(), v_GetIntegrationSchemeType(), v_GetNumIntegrationPhases(), v_GetOrder(), v_GetVariant(), v_InitializeScheme(), v_print(), v_printFull(), and v_TimeIntegrate().

m_solVector

TimeIntegrationSolutionGLMSharedPtr Nektar::LibUtilities::TimeIntegrationSchemeGLM::m_solVector

protected

Definition at line 117 of file TimeIntegrationSchemeGLM.h.

Referenced by v_GetSolutionVector(), v_InitializeScheme(), v_SetSolutionVector(), v_TimeIntegrate(), and v_UpdateSolutionVector().