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

#include <NoSchemeTimeIntegrationScheme.h>

Inheritance diagram for Nektar::LibUtilities::NoSchemeTimeIntegrationScheme:

Public Member Functions
LUE	NoSchemeTimeIntegrationScheme (std::string variant, unsigned int order, std::vector< NekDouble > freeParams)

	~NoSchemeTimeIntegrationScheme () override

LUE std::string	v_GetName () const override

LUE std::string	v_GetVariant () const override

LUE size_t	v_GetOrder () const override

LUE std::vector< NekDouble >	v_GetFreeParams () const override

LUE NekDouble	v_GetTimeStability () const override

LUE TimeIntegrationSchemeType	v_GetIntegrationSchemeType () const override

LUE size_t	v_GetNumIntegrationPhases () const override

const TripleArray &	v_GetSolutionVector () const override

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

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 TripleArray &	v_UpdateSolutionVector () override

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 NoTimeIntegrationSchemeSharedPtr	create (std::string variant, unsigned int order, std::vector< NekDouble > freeParams)

Static Public Attributes
static std::string	className

Protected Attributes
DoubleArray	m_doubleArray

Static Protected Attributes
static std::string	TimeIntegrationMethodLookupId

Additional Inherited Members
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

Detailed Description

Base class for No time integration schemes.

Definition at line 49 of file NoSchemeTimeIntegrationScheme.h.

Constructor & Destructor Documentation

◆ NoSchemeTimeIntegrationScheme()

LUE Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::NoSchemeTimeIntegrationScheme	(	std::string	variant,
		unsigned int	order,
		std::vector< NekDouble >	freeParams
	)

inline

Definition at line 52 of file NoSchemeTimeIntegrationScheme.h.

        : TimeIntegrationScheme(variant, order, freeParams)
    {
    }

◆ ~NoSchemeTimeIntegrationScheme()

Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::~NoSchemeTimeIntegrationScheme ( )

inlineoverride

Definition at line 57 of file NoSchemeTimeIntegrationScheme.h.

58 {

59 }

Member Function Documentation

◆ create()

static NoTimeIntegrationSchemeSharedPtr Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::create	(	std::string	variant,
		unsigned int	order,
		std::vector< NekDouble >	freeParams
	)

inlinestatic

Definition at line 61 of file NoSchemeTimeIntegrationScheme.h.

    {
        NoTimeIntegrationSchemeSharedPtr p =
            MemoryManager<NoSchemeTimeIntegrationScheme>::AllocateSharedPtr(
                variant, order, freeParams);
        return p;
    }

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

◆ v_GetFreeParams()

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

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 59 of file NoSchemeTimeIntegrationScheme.cpp.

{
    return std::vector<NekDouble>(0);
}

◆ v_GetIntegrationSchemeType()

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

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 69 of file NoSchemeTimeIntegrationScheme.cpp.

{
    return eNoTimeIntegrationSchemeType;
}

References Nektar::LibUtilities::eNoTimeIntegrationSchemeType.

◆ v_GetName()

std::string Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::v_GetName ( ) const

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 44 of file NoSchemeTimeIntegrationScheme.cpp.

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

◆ v_GetNumIntegrationPhases()

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

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 75 of file NoSchemeTimeIntegrationScheme.cpp.

{
    return 0;
}

◆ v_GetOrder()

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

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 54 of file NoSchemeTimeIntegrationScheme.cpp.

{
    return 0;
}

◆ v_GetSolutionVector()

const TripleArray & Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::v_GetSolutionVector ( ) const

inlineoverridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 85 of file NoSchemeTimeIntegrationScheme.h.

    {
        return NullNekDoubleTensorOfArray3D;
    }

References Nektar::NullNekDoubleTensorOfArray3D.

◆ v_GetTimeStability()

NekDouble Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::v_GetTimeStability ( ) const

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 64 of file NoSchemeTimeIntegrationScheme.cpp.

{
    return 0.;
}

◆ v_GetVariant()

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

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 49 of file NoSchemeTimeIntegrationScheme.cpp.

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

◆ v_InitializeScheme()

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

overridevirtual

Worker method to initialize the integration scheme.

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 83 of file NoSchemeTimeIntegrationScheme.cpp.

{
    m_doubleArray = y_0;
}

References m_doubleArray.

◆ v_print()

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

overridevirtual

Worker method to print details on the integration scheme.

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 109 of file NoSchemeTimeIntegrationScheme.cpp.

{
    os << "Time Integration Scheme: " << GetFullName() << std::endl;
}

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

◆ v_printFull()

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

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 114 of file NoSchemeTimeIntegrationScheme.cpp.

{
    os << "Time Integration Scheme: " << GetFullName() << std::endl;
}

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

◆ v_SetSolutionVector()

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

inlineoverridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 91 of file NoSchemeTimeIntegrationScheme.h.

94 {

95 }

◆ v_TimeIntegrate()

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

overridevirtual

Worker method that actually does the time integration.

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 94 of file NoSchemeTimeIntegrationScheme.cpp.

{
    return m_doubleArray;
}

References m_doubleArray.

◆ v_UpdateSolutionVector()

TripleArray & Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::v_UpdateSolutionVector ( )

overridevirtual

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 101 of file NoSchemeTimeIntegrationScheme.cpp.

{
    return NullNekDoubleTensorOfArray3D;
}

References Nektar::NullNekDoubleTensorOfArray3D.

Member Data Documentation

◆ className

std::string Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::className

static

Definition at line 109 of file NoSchemeTimeIntegrationScheme.h.

◆ m_doubleArray

DoubleArray Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::m_doubleArray

protected

Definition at line 112 of file NoSchemeTimeIntegrationScheme.h.

Referenced by v_InitializeScheme(), and v_TimeIntegrate().

◆ TimeIntegrationMethodLookupId

std::string Nektar::LibUtilities::NoSchemeTimeIntegrationScheme::TimeIntegrationMethodLookupId

staticprotected

Definition at line 114 of file NoSchemeTimeIntegrationScheme.h.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NoSchemeTimeIntegrationScheme()

◆ ~NoSchemeTimeIntegrationScheme()

Member Function Documentation

◆ create()

◆ v_GetFreeParams()

◆ v_GetIntegrationSchemeType()

◆ v_GetName()

◆ v_GetNumIntegrationPhases()

◆ v_GetOrder()

◆ v_GetSolutionVector()

◆ v_GetTimeStability()

◆ v_GetVariant()

◆ v_InitializeScheme()

◆ v_print()

◆ v_printFull()

◆ v_SetSolutionVector()

◆ v_TimeIntegrate()

◆ v_UpdateSolutionVector()

Member Data Documentation

◆ className

◆ m_doubleArray

◆ TimeIntegrationMethodLookupId