#include <ImplicitTimeIntegrationSchemeSDC.h>

Inheritance diagram for Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC:

Public Member Functions
	ImplicitTimeIntegrationSchemeSDC (std::string variant, size_t order, std::vector< NekDouble > freeParams)

Public Member Functions inherited from Nektar::LibUtilities::TimeIntegrationSchemeSDC
	TimeIntegrationSchemeSDC (std::string variant, size_t order, std::vector< NekDouble > freeParams)

	~TimeIntegrationSchemeSDC () override
	Destructor. More...

LUE void	SetPFASST (bool pfasst)

LUE void	SetTime (double time)

LUE size_t	GetMaxOrder () const

LUE bool	HasFirstQuadrature () const

LUE bool	HasLastQuadrature () const

LUE size_t	GetQuadPtsNumber () const

LUE size_t	GetNpoints () const

LUE size_t	GetNvars () const

LUE const PointsKey &	GetPointsKey () const

LUE const DoubleArray &	GetFirstQuadratureSolutionVector () const

LUE DoubleArray &	UpdateFirstQuadratureSolutionVector ()

LUE const DoubleArray &	GetLastQuadratureSolutionVector () const

LUE DoubleArray &	UpdateLastQuadratureSolutionVector ()

LUE const TripleArray &	GetResidualVector () const

LUE TripleArray &	UpdateResidualVector ()

LUE const TripleArray &	GetIntegratedResidualVector () const

LUE TripleArray &	UpdateIntegratedResidualVector ()

LUE const TripleArray &	GetFAScorrectionVector () const

LUE TripleArray &	UpdateFAScorrectionVector ()

LUE void	ResidualEval (const NekDouble &delta_t, const size_t n)

LUE void	ResidualEval (const NekDouble &delta_t)

LUE void	ComputeInitialGuess (const NekDouble &delta_t)

LUE void	SDCIterationLoop (const NekDouble &delta_t)

LUE void	UpdateFirstQuadrature (void)
	Worker method that update the first quadrature. More...

LUE void	UpdateLastQuadrature (void)
	Worker method that update the last quadrature. More...

LUE void	AddFASCorrectionToSFint (void)
	Worker method that add the FASCorrection. More...

LUE void	UpdateIntegratedResidualSFint (const NekDouble &delta_t)
	Worker method that compute residual integral. More...

LUE void	UpdateIntegratedResidualQFint (const NekDouble &delta_t)

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 Public Member Functions inherited from Nektar::LibUtilities::TimeIntegrationSchemeSDC
static TimeIntegrationSchemeSharedPtr	create (std::string variant, size_t order, std::vector< NekDouble > freeParams)

Public Attributes
DoubleArray	m_tmp

Static Public Attributes
static std::string	className

Static Public Attributes inherited from Nektar::LibUtilities::TimeIntegrationSchemeSDC
static std::string	className

Protected Member Functions
LUE void	v_InitializeScheme (const NekDouble deltaT, ConstDoubleArray &y_0, const NekDouble time, const TimeIntegrationSchemeOperators &op) override
	Array for temporary storage. More...

LUE void	v_ResidualEval (const NekDouble &delta_t, const size_t n) override
	Worker method to compute the residual. More...

LUE void	v_ResidualEval (const NekDouble &delta_t) override

LUE void	v_ComputeInitialGuess (const NekDouble &delta_t) override
	Worker method to compute the initial SDC guess. More...

LUE void	v_SDCIterationLoop (const NekDouble &delta_t) override
	Worker method to compute the SDC iteration. More...

Protected Member Functions inherited from Nektar::LibUtilities::TimeIntegrationSchemeSDC
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 TimeIntegrationSchemeType	v_GetIntegrationSchemeType () const override

LUE NekDouble	v_GetTimeStability () const override

LUE size_t	v_GetNumIntegrationPhases () const override

LUE const TripleArray &	v_GetSolutionVector () const override
	Gets the solution vector of the ODE. More...

LUE TripleArray &	v_UpdateSolutionVector () override

LUE void	v_SetSolutionVector (const size_t Offset, const DoubleArray &y) override
	Sets the solution vector of the ODE. More...

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 performs the time integration. More...

virtual LUE void	v_ResidualEval (const NekDouble &delta_t, const size_t n)

virtual LUE void	v_ResidualEval (const NekDouble &delta_t)

virtual LUE void	v_ComputeInitialGuess (const NekDouble &delta_t)

virtual LUE void	v_SDCIterationLoop (const NekDouble &delta_t)

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

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::TimeIntegrationSchemeSDC
NekDouble	m_time

std::string	m_name

std::string	m_variant

std::vector< NekDouble >	m_freeParams

TimeIntegrationSchemeType	m_schemeType {eNoTimeIntegrationSchemeType}

TimeIntegrationSchemeOperators	m_op

PointsKey	m_pointsKey

SingleArray	m_tau
	Object containing quadrature data. More...

DoubleArray	m_Y_f
	Array containing the quadrature points. More...

TripleArray	m_Y
	Array containing the last stage values. More...

TripleArray	m_F
	Array containing the stage values. More...

TripleArray	m_FAScorr
	Array containing the stage derivatives. More...

TripleArray	m_SFint
	Array containing the FAS correction term. More...

TripleArray	m_QFint
	Array containing the integrated residual term. More...

SingleArray	m_QMat
	Array containing the integrated residual term. More...

SingleArray	m_interp
	Array containing the integration matrix. More...

NekDouble	m_theta {1.0}
	Array containing the interpolation coefficients. More...

size_t	m_ordermin {0}
	SDC parameter. More...

size_t	m_ordermax {0}
	Minimum order of the integration scheme. More...

size_t	m_order {0}
	Maximum order of the integration scheme. More...

size_t	m_nQuadPts {0}
	Order of the integration scheme. More...

size_t	m_nvars {0}
	Number of quadrature points. More...

size_t	m_npoints {0}
	Number of variables in the integration scheme. More...

bool	m_first_quadrature {true}
	Number of points in the integration scheme. More...

bool	m_last_quadrature {true}

bool	m_initialized {false}

bool	m_PFASST {false}

Detailed Description

Definition at line 46 of file ImplicitTimeIntegrationSchemeSDC.h.

Constructor & Destructor Documentation

◆ ImplicitTimeIntegrationSchemeSDC()

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

inline

Definition at line 49 of file ImplicitTimeIntegrationSchemeSDC.h.

        : TimeIntegrationSchemeSDC(variant, order, freeParams)
    {
        ASSERTL0(!m_first_quadrature,
                 "Quadrature type that include the left end point (e.g. "
                 "GaussLobattoLegendre) should not be used for ImplicitSDC");
 
        m_name       = "ImplicitSpectralDeferredCorrection";
        m_schemeType = eImplicit;
    }

References ASSERTL0, Nektar::LibUtilities::eImplicit, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_first_quadrature, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_name, and Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_schemeType.

Member Function Documentation

◆ create()

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

inlinestatic

Definition at line 61 of file ImplicitTimeIntegrationSchemeSDC.h.

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

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

◆ v_ComputeInitialGuess()

void Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_ComputeInitialGuess ( const NekDouble & delta_t )

overrideprotectedvirtual

Worker method to compute the initial SDC guess.

Reimplemented from Nektar::LibUtilities::TimeIntegrationSchemeSDC.

Definition at line 141 of file ImplicitTimeIntegrationSchemeSDC.h.

{
    for (size_t n = 0; n < m_nQuadPts; ++n)
    {
        if (n != 0)
        {
            NekDouble dtn = delta_t * (m_tau[n] - m_tau[n - 1]);
 
            // Update solution
            m_op.DoImplicitSolve(m_Y[n - 1], m_Y[n],
                                 m_time + delta_t * m_tau[n], dtn);
 
            // Compute residual from updated solution
            for (size_t i = 0; i < m_nvars; ++i)
            {
                Vmath::Vsub(m_npoints, m_Y[n][i], 1, m_Y[n - 1][i], 1,
                            m_F[n][i], 1);
                Vmath::Smul(m_npoints, 1.0 / dtn, m_F[n][i], 1, m_F[n][i], 1);
            }
        }
    }
}

◆ v_InitializeScheme()

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

overrideprotectedvirtual

Array for temporary storage.

Worker method to initialize the integration scheme.

Implements Nektar::LibUtilities::TimeIntegrationScheme.

Definition at line 92 of file ImplicitTimeIntegrationSchemeSDC.h.

{
    if (m_initialized)
    {
        m_time = time;
        for (size_t i = 0; i < m_nvars; ++i)
        {
            // Store the initial values as the first previous state.
            Vmath::Vcopy(m_npoints, y_0[i], 1, m_Y[0][i], 1);
        }
    }
    else
    {
        TimeIntegrationSchemeSDC::v_InitializeScheme(deltaT, y_0, time, op);
 
        m_tmp = DoubleArray(m_nvars);
        for (size_t i = 0; i < m_nvars; ++i)
        {
            m_tmp[i] = SingleArray(m_npoints, 0.0);
        }
    }
}

References Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_initialized, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_npoints, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_nvars, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_time, m_tmp, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_Y, Nektar::LibUtilities::TimeIntegrationSchemeSDC::v_InitializeScheme(), and Vmath::Vcopy().

◆ v_ResidualEval() [1/2]

void Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_ResidualEval ( const NekDouble & delta_t )

overrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::TimeIntegrationSchemeSDC.

Definition at line 130 of file ImplicitTimeIntegrationSchemeSDC.h.

{
    for (size_t n = 0; n < m_nQuadPts; ++n)
    {
        v_ResidualEval(delta_t, n);
    }
}

References Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_nQuadPts, and v_ResidualEval().

◆ v_ResidualEval() [2/2]

void Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_ResidualEval	(	const NekDouble &	delta_t,
		const size_t	n
	)

overrideprotectedvirtual

Worker method to compute the residual.

Reimplemented from Nektar::LibUtilities::TimeIntegrationSchemeSDC.

Definition at line 120 of file ImplicitTimeIntegrationSchemeSDC.h.

{
    // Apply time-dependent boundary condition
    m_op.DoProjection(m_Y[n], m_tmp, m_time + delta_t * m_tau[n]);
 
    // Compute residual
    m_op.DoOdeRhs(m_tmp, m_F[n], m_time + delta_t * m_tau[n]);
}

References Nektar::LibUtilities::TimeIntegrationSchemeOperators::DoOdeRhs(), Nektar::LibUtilities::TimeIntegrationSchemeOperators::DoProjection(), Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_F, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_op, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_tau, Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_time, m_tmp, and Nektar::LibUtilities::TimeIntegrationSchemeSDC::m_Y.

Referenced by v_ResidualEval().

◆ v_SDCIterationLoop()

void Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::v_SDCIterationLoop ( const NekDouble & delta_t )

overrideprotectedvirtual

Worker method to compute the SDC iteration.

Reimplemented from Nektar::LibUtilities::TimeIntegrationSchemeSDC.

Definition at line 168 of file ImplicitTimeIntegrationSchemeSDC.h.

{
    // Update integrated residual
    UpdateIntegratedResidualSFint(delta_t);
 
    // Add FAS correction to integrated residual
    AddFASCorrectionToSFint();
 
    // Loop over quadrature points
    for (size_t n = 1; n < m_nQuadPts; ++n)
    {
        NekDouble dtn = delta_t * (m_tau[n] - m_tau[n - 1]);
 
        // Add rhs terms
        for (size_t i = 0; i < m_nvars; ++i)
        {
            // Add SFint contribution
            Vmath::Vadd(m_npoints, m_Y[n - 1][i], 1, m_SFint[n][i], 1, m_tmp[i],
                        1);
 
            // Add implicit contribution
            Vmath::Svtvp(m_npoints, -m_theta * dtn, m_F[n][i], 1, m_tmp[i], 1,
                         m_tmp[i], 1);
        }
 
        // Solve implicit system
        m_op.DoImplicitSolve(m_tmp, m_Y[n], m_time + delta_t * m_tau[n],
                             m_theta * dtn);
 
        // Compute residual from updated solution
        for (size_t i = 0; i < m_nvars; ++i)
        {
            Vmath::Vsub(m_npoints, m_Y[n][i], 1, m_tmp[i], 1, m_F[n][i], 1);
            Vmath::Smul(m_npoints, 1.0 / (m_theta * dtn), m_F[n][i], 1,
                        m_F[n][i], 1);
        }
    }
}

Member Data Documentation

◆ className

std::string Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::className

static

Initial value:

=
    GetTimeIntegrationSchemeFactory().RegisterCreatorFunction(
        "ImplicitSDC", ImplicitTimeIntegrationSchemeSDC::create)

Definition at line 71 of file ImplicitTimeIntegrationSchemeSDC.h.

◆ m_tmp

DoubleArray Nektar::LibUtilities::ImplicitTimeIntegrationSchemeSDC::m_tmp

Definition at line 73 of file ImplicitTimeIntegrationSchemeSDC.h.

Referenced by v_InitializeScheme(), v_ResidualEval(), and v_SDCIterationLoop().

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImplicitTimeIntegrationSchemeSDC()

Member Function Documentation

◆ create()

◆ v_ComputeInitialGuess()

◆ v_InitializeScheme()

◆ v_ResidualEval() [1/2]

◆ v_ResidualEval() [2/2]

◆ v_SDCIterationLoop()

Member Data Documentation

◆ className

◆ m_tmp