#include <StandardExtrapolate.h>

Inheritance diagram for Nektar::StandardExtrapolate:

Public Member Functions
	StandardExtrapolate (const LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields, MultiRegions::ExpListSharedPtr pPressure, const Array< OneD, int > pVel, const SolverUtils::AdvectionSharedPtr advObject)

	~StandardExtrapolate () override

Public Member Functions inherited from Nektar::Extrapolate
	Extrapolate (const LibUtilities::SessionReaderSharedPtr pSession, Array< OneD, MultiRegions::ExpListSharedPtr > pFields, MultiRegions::ExpListSharedPtr pPressure, const Array< OneD, int > pVel, const SolverUtils::AdvectionSharedPtr advObject)

virtual	~Extrapolate ()

void	GenerateHOPBCMap (const LibUtilities::SessionReaderSharedPtr &pSsession)

void	UpdateRobinPrimCoeff (void)

void	SubSteppingTimeIntegration (const LibUtilities::TimeIntegrationSchemeSharedPtr &IntegrationScheme)

void	SubStepSaveFields (const int nstep)

void	SubStepSetPressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, const NekDouble Aii_DT, NekDouble kinvis)

void	SubStepAdvance (const int nstep, NekDouble time)

void	MountHOPBCs (int HBCdata, NekDouble kinvis, Array< OneD, NekDouble > &Q, Array< OneD, const NekDouble > &Advection)

void	EvaluatePressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &fields, const Array< OneD, const Array< OneD, NekDouble > > &N, NekDouble kinvis)

void	SetForcing (const std::vector< SolverUtils::ForcingSharedPtr > &forcing)

void	AddDuDt (void)

void	AddVelBC (void)

void	ExtrapolatePressureHBCs (void)

void	CopyPressureHBCsToPbndExp (void)

Array< OneD, NekDouble >	GetMaxStdVelocity (const Array< OneD, Array< OneD, NekDouble > > inarray)

void	CorrectPressureBCs (const Array< OneD, NekDouble > &pressure)

void	IProductNormVelocityOnHBC (const Array< OneD, const Array< OneD, NekDouble > > &Vel, Array< OneD, NekDouble > &IprodVn)

void	IProductNormVelocityBCOnHBC (Array< OneD, NekDouble > &IprodVn)

std::string	GetSubStepName (void)

void	ExtrapolateArray (Array< OneD, Array< OneD, NekDouble > > &array)

void	EvaluateBDFArray (Array< OneD, Array< OneD, NekDouble > > &array)

void	ExtrapolateArray (Array< OneD, Array< OneD, NekDouble > > &oldarrays, Array< OneD, NekDouble > &newarray, Array< OneD, NekDouble > &outarray)

void	AddNormVelOnOBC (const int nbcoeffs, const int nreg, Array< OneD, Array< OneD, NekDouble > > &u)

void	AddPressureToOutflowBCs (NekDouble kinvis)

void	GenerateBndElmtExpansion (void)

Static Public Member Functions
static ExtrapolateSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, MultiRegions::ExpListSharedPtr &pPressure, const Array< OneD, int > &pVel, const SolverUtils::AdvectionSharedPtr &advObject)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of class. More...

Protected Member Functions
void	v_EvaluatePressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &fields, const Array< OneD, const Array< OneD, NekDouble > > &N, NekDouble kinvis) override

void	v_SubSteppingTimeIntegration (const LibUtilities::TimeIntegrationSchemeSharedPtr &IntegrationScheme) override

void	v_SubStepSaveFields (int nstep) override

void	v_SubStepSetPressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, NekDouble Aii_DT, NekDouble kinvis) override

void	v_SubStepAdvance (int nstep, NekDouble time) override

void	v_MountHOPBCs (int HBCdata, NekDouble kinvis, Array< OneD, NekDouble > &Q, Array< OneD, const NekDouble > &Advection) override

void	v_AccelerationBDF (Array< OneD, Array< OneD, NekDouble > > &array) override

Protected Member Functions inherited from Nektar::Extrapolate
virtual void	v_EvaluatePressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, const Array< OneD, const Array< OneD, NekDouble > > &N, NekDouble kinvis)=0

virtual void	v_SubSteppingTimeIntegration (const LibUtilities::TimeIntegrationSchemeSharedPtr &IntegrationScheme)=0

virtual void	v_SubStepSaveFields (int nstep)=0

virtual void	v_SubStepSetPressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, NekDouble Aii_DT, NekDouble kinvis)=0

virtual void	v_SubStepAdvance (int nstep, NekDouble time)=0

virtual void	v_MountHOPBCs (int HBCdata, NekDouble kinvis, Array< OneD, NekDouble > &Q, Array< OneD, const NekDouble > &Advection)=0

virtual std::string	v_GetSubStepName (void)

virtual void	v_AccelerationBDF (Array< OneD, Array< OneD, NekDouble > > &array)

void	CalcNeumannPressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &fields, const Array< OneD, const Array< OneD, NekDouble > > &N, NekDouble kinvis)

virtual void	v_CalcNeumannPressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &fields, const Array< OneD, const Array< OneD, NekDouble > > &N, NekDouble kinvis)

virtual void	v_CorrectPressureBCs (const Array< OneD, NekDouble > &pressure)

virtual void	v_AddNormVelOnOBC (const int nbcoeffs, const int nreg, Array< OneD, Array< OneD, NekDouble > > &u)

void	CalcOutflowBCs (const Array< OneD, const Array< OneD, NekDouble > > &fields, NekDouble kinvis)

void	RollOver (Array< OneD, Array< OneD, NekDouble > > &input)

Static Protected Attributes
static NekDouble	DuDt_Coeffs [3][4]

Static Protected Attributes inherited from Nektar::Extrapolate
static NekDouble	StifflyStable_Betaq_Coeffs [3][3]

static NekDouble	StifflyStable_Alpha_Coeffs [3][3]

static NekDouble	StifflyStable_Gamma0_Coeffs [3] = {1.0, 1.5, 11.0 / 6.0}

Additional Inherited Members
Protected Attributes inherited from Nektar::Extrapolate
LibUtilities::SessionReaderSharedPtr	m_session

LibUtilities::CommSharedPtr	m_comm

Array< OneD, HBCType >	m_hbcType
	Array of type of high order BCs for splitting shemes. More...

Array< OneD, MultiRegions::ExpListSharedPtr >	m_fields
	Velocity fields. More...

MultiRegions::ExpListSharedPtr	m_pressure
	Pointer to field holding pressure field. More...

Array< OneD, int >	m_velocity
	int which identifies which components of m_fields contains the velocity (u,v,w); More...

SolverUtils::AdvectionSharedPtr	m_advObject

std::vector< SolverUtils::ForcingSharedPtr >	m_forcing

Array< OneD, Array< OneD, NekDouble > >	m_previousVelFields

int	m_curl_dim
	Curl-curl dimensionality. More...

int	m_bnd_dim
	bounday dimensionality More...

Array< OneD, const SpatialDomains::BoundaryConditionShPtr >	m_PBndConds
	pressure boundary conditions container More...

Array< OneD, MultiRegions::ExpListSharedPtr >	m_PBndExp
	pressure boundary conditions expansion container More...

Array< OneD, MultiRegions::ExpListSharedPtr >	m_bndElmtExps
	Boundary expansions on each domain boundary. More...

int	m_pressureCalls
	number of times the high-order pressure BCs have been called More...

int	m_numHBCDof

int	m_HBCnumber

int	m_intSteps
	Maximum points used in pressure BC evaluation. More...

NekDouble	m_timestep

Array< OneD, Array< OneD, NekDouble > >	m_pressureHBCs
	Storage for current and previous levels of high order pressure boundary conditions. More...

Array< OneD, Array< OneD, NekDouble > >	m_iprodnormvel
	Storage for current and previous levels of the inner product of normal velocity. More...

Array< OneD, Array< OneD, NekDouble > >	m_traceNormals

HighOrderOutflowSharedPtr	m_houtflow

Detailed Description

Definition at line 57 of file StandardExtrapolate.h.

Constructor & Destructor Documentation

◆ StandardExtrapolate()

Nektar::StandardExtrapolate::StandardExtrapolate	(	const LibUtilities::SessionReaderSharedPtr	pSession,
		Array< OneD, MultiRegions::ExpListSharedPtr >	pFields,
		MultiRegions::ExpListSharedPtr	pPressure,
		const Array< OneD, int >	pVel,
		const SolverUtils::AdvectionSharedPtr	advObject
	)

Definition at line 51 of file StandardExtrapolate.cpp.

    : Extrapolate(pSession, pFields, pPressure, pVel, advObject)
{
}

◆ ~StandardExtrapolate()

Nektar::StandardExtrapolate::~StandardExtrapolate ( )

override

Definition at line 60 of file StandardExtrapolate.cpp.

61{

62}

Member Function Documentation

◆ create()

static ExtrapolateSharedPtr Nektar::StandardExtrapolate::create	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		Array< OneD, MultiRegions::ExpListSharedPtr > &	pFields,
		MultiRegions::ExpListSharedPtr &	pPressure,
		const Array< OneD, int > &	pVel,
		const SolverUtils::AdvectionSharedPtr &	advObject
	)

inlinestatic

Creates an instance of this class.

Definition at line 61 of file StandardExtrapolate.h.

    {
        ExtrapolateSharedPtr p =
            MemoryManager<StandardExtrapolate>::AllocateSharedPtr(
                pSession, pFields, pPressure, pVel, advObject);
        return p;
    }

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

◆ v_AccelerationBDF()

void Nektar::StandardExtrapolate::v_AccelerationBDF ( Array< OneD, Array< OneD, NekDouble > > & array )

overrideprotectedvirtual

At the start, the newest value is stored in array[nlevels-1] and the previous values in the first positions At the end, the acceleration from BDF is stored in array[nlevels-1] and the storage has been updated to included the new value

Reimplemented from Nektar::Extrapolate.

Definition at line 155 of file StandardExtrapolate.cpp.

{
    int nlevels = array.size();
    int nPts    = array[0].size();
 
    if (nPts)
    {
        // Update array
        RollOver(array);
 
        // Calculate acceleration using Backward Differentiation Formula
        Array<OneD, NekDouble> accelerationTerm(nPts, 0.0);
        if (m_pressureCalls > 2)
        {
            int acc_order = std::min(m_pressureCalls - 2, m_intSteps);
            Vmath::Smul(nPts, DuDt_Coeffs[acc_order - 1][0], array[0], 1,
                        accelerationTerm, 1);
 
            for (int i = 0; i < acc_order; i++)
            {
                Vmath::Svtvp(nPts, DuDt_Coeffs[acc_order - 1][i + 1],
                             array[i + 1], 1, accelerationTerm, 1,
                             accelerationTerm, 1);
            }
        }
        array[nlevels - 1] = accelerationTerm;
    }
}

References DuDt_Coeffs, Nektar::Extrapolate::m_intSteps, Nektar::Extrapolate::m_pressureCalls, Nektar::Extrapolate::RollOver(), Vmath::Smul(), and Vmath::Svtvp().

◆ v_EvaluatePressureBCs()

void Nektar::StandardExtrapolate::v_EvaluatePressureBCs	(	const Array< OneD, const Array< OneD, NekDouble > > &	fields,
		const Array< OneD, const Array< OneD, NekDouble > > &	N,
		NekDouble	kinvis
	)

overrideprotectedvirtual

Function to extrapolate the new pressure boundary condition. Based on the velocity field and on the advection term. Acceleration term is also computed. This routine is a general one for 2d and 3D application and it can be called directly from velocity correction scheme. Specialisation on dimensionality is redirected to the CalcNeumannPressureBCs method.

Implements Nektar::Extrapolate.

Reimplemented in Nektar::WeakPressureExtrapolate.

Definition at line 72 of file StandardExtrapolate.cpp.

{
    m_pressureCalls++;
    if (m_HBCnumber > 0)
    {
        // Calculate non-linear and viscous BCs at current level
        // and put in m_pressureHBCs[0]
        CalcNeumannPressureBCs(fields, N, kinvis);
 
        // Extrapolate to n+1
        ExtrapolateArray(m_pressureHBCs);
 
        // Add (phi,Du/Dt) term to m_presureHBC
        AddDuDt();
 
        // Copy m_pressureHBCs to m_PbndExp
        CopyPressureHBCsToPbndExp();
    }
 
    CalcOutflowBCs(fields, kinvis);
}

References Nektar::Extrapolate::AddDuDt(), Nektar::Extrapolate::CalcNeumannPressureBCs(), Nektar::Extrapolate::CalcOutflowBCs(), Nektar::Extrapolate::CopyPressureHBCsToPbndExp(), Nektar::Extrapolate::ExtrapolateArray(), Nektar::Extrapolate::m_HBCnumber, Nektar::Extrapolate::m_pressureCalls, and Nektar::Extrapolate::m_pressureHBCs.

◆ v_MountHOPBCs()

void Nektar::StandardExtrapolate::v_MountHOPBCs	(	int	HBCdata,
		NekDouble	kinvis,
		Array< OneD, NekDouble > &	Q,
		Array< OneD, const NekDouble > &	Advection
	)

overrideprotectedvirtual

Implements Nektar::Extrapolate.

Reimplemented in Nektar::WeakPressureExtrapolate.

Definition at line 142 of file StandardExtrapolate.cpp.

{
    Vmath::Svtvp(HBCdata, -kinvis, Q, 1, Advection, 1, Q, 1);
}

References Vmath::Svtvp().

◆ v_SubStepAdvance()

void Nektar::StandardExtrapolate::v_SubStepAdvance	(	int	nstep,
		NekDouble	time
	)

overrideprotectedvirtual

Implements Nektar::Extrapolate.

Definition at line 127 of file StandardExtrapolate.cpp.

129{

130}

◆ v_SubSteppingTimeIntegration()

void Nektar::StandardExtrapolate::v_SubSteppingTimeIntegration ( const LibUtilities::TimeIntegrationSchemeSharedPtr & IntegrationScheme )

overrideprotectedvirtual

Implements Nektar::Extrapolate.

Definition at line 99 of file StandardExtrapolate.cpp.

{
    if (IntegrationScheme->GetName() == "IMEX" ||
        IntegrationScheme->GetName() == "IMEXGear")
    {
        m_intSteps = IntegrationScheme->GetOrder();
    }
    else
    {
        NEKERROR(ErrorUtil::efatal,
                 "Integration method not suitable: "
                 "Options include IMEXGear or IMEXOrder{1,2,3,4}");
    }
}

References Nektar::ErrorUtil::efatal, Nektar::Extrapolate::m_intSteps, and NEKERROR.

◆ v_SubStepSaveFields()

void Nektar::StandardExtrapolate::v_SubStepSaveFields ( int nstep )

overrideprotectedvirtual

Implements Nektar::Extrapolate.

Definition at line 135 of file StandardExtrapolate.cpp.

136{

137}

◆ v_SubStepSetPressureBCs()

void Nektar::StandardExtrapolate::v_SubStepSetPressureBCs	(	const Array< OneD, const Array< OneD, NekDouble > > &	inarray,
		NekDouble	Aii_DT,
		NekDouble	kinvis
	)

overrideprotectedvirtual

Implements Nektar::Extrapolate.

Definition at line 118 of file StandardExtrapolate.cpp.

121{

122}

Member Data Documentation

◆ className

std::string Nektar::StandardExtrapolate::className

static

Initial value:

=
    GetExtrapolateFactory().RegisterCreatorFunction(
        "Standard", StandardExtrapolate::create, "Standard")

Name of class.

Registers the class with the Factory.

Definition at line 74 of file StandardExtrapolate.h.

◆ DuDt_Coeffs

NekDouble Nektar::StandardExtrapolate::DuDt_Coeffs

staticprotected

Initial value:

= {
    {1.0, -1., 0.0, 0.0},
    {2.5, -4.0, 1.5, 0.0},
    {13. / 3., -9.5, 7.0, -11.0 / 6.0}}

Definition at line 107 of file StandardExtrapolate.h.

Referenced by v_AccelerationBDF().

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StandardExtrapolate()

◆ ~StandardExtrapolate()

Member Function Documentation

◆ create()

◆ v_AccelerationBDF()

◆ v_EvaluatePressureBCs()

◆ v_MountHOPBCs()

◆ v_SubStepAdvance()

◆ v_SubSteppingTimeIntegration()

◆ v_SubStepSaveFields()

◆ v_SubStepSetPressureBCs()

Member Data Documentation

◆ className

◆ DuDt_Coeffs