#include <VelocityCorrectionSchemeImplicit.h>

Inheritance diagram for Nektar::VCSImplicit:

Static Public Member Functions
static SolverUtils::EquationSystemSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Creates an instance of this class.

Static Public Member Functions inherited from Nektar::VelocityCorrectionScheme
static SolverUtils::EquationSystemSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Creates an instance of this class.

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

Static Public Attributes inherited from Nektar::VelocityCorrectionScheme
static std::string	className
	Name of class.

Static Public Attributes inherited from Nektar::SolverUtils::UnsteadySystem
static std::string	cmdSetStartTime

static std::string	cmdSetStartChkNum

Protected Member Functions
	VCSImplicit (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)

	~VCSImplicit () override=default

void	v_GenerateSummary (SolverUtils::SummaryList &s) override
	Print a summary of time stepping parameters.

void	v_SetUpPressureForcing (const Array< OneD, const Array< OneD, NekDouble > > &fields, Array< OneD, Array< OneD, NekDouble > > &Forcing, const NekDouble aii_Dt) override

void	v_SetUpViscousForcing (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &Forcing, const NekDouble aii_Dt) override

void	v_SolvePressure (const Array< OneD, NekDouble > &Forcing) override

void	v_SolveViscous (const Array< OneD, const Array< OneD, NekDouble > > &Forcing, const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble aii_Dt) override

void	v_DoInitialise (bool dumpInitialConditions) override
	Sets up initial conditions.

std::string	v_GetExtrapolateStr (void) override

void	v_EvaluateAdvection_SetPressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) override

void	AddImplicitSkewSymAdvection (StdRegions::VarCoeffMap varcoeffs, NekDouble aii_Dt)

void	CheckUnsetGlobalLinSys (Array< OneD, int32_t > &unsetGlobalLinSys)

Protected Member Functions inherited from Nektar::VelocityCorrectionScheme
	VelocityCorrectionScheme (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)

	~VelocityCorrectionScheme () override=default

void	v_InitObject (bool DeclareField=true) override
	Initialisation object for EquationSystem.

void	SetupFlowrate (NekDouble aii_dt)
	Set up the Stokes solution used to impose constant flowrate through a boundary.

NekDouble	MeasureFlowrate (const Array< OneD, Array< OneD, NekDouble > > &inarray)
	Measure the volumetric flow rate through the volumetric flow rate reference surface.

bool	v_PostIntegrate (int step) override

void	v_GenerateSummary (SolverUtils::SummaryList &s) override
	Print a summary of time stepping parameters.

void	v_TransCoeffToPhys (void) override
	Virtual function for transformation to physical space.

void	v_TransPhysToCoeff (void) override
	Virtual function for transformation to coefficient space.

void	v_DoInitialise (bool dumpInitialConditions=true) override
	Sets up initial conditions.

Array< OneD, bool >	v_GetSystemSingularChecks () override

int	v_GetForceDimension () override

virtual void	v_SolveUnsteadyStokesSystem (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time, const NekDouble a_iixDt)

bool	v_RequireFwdTrans () override

virtual std::string	v_GetSubSteppingExtrapolateStr (const std::string &instr)

void	SetUpSVV (void)

void	SetUpExtrapolation (void)

void	SVVVarDiffCoeff (const NekDouble velmag, Array< OneD, NekDouble > &diffcoeff, const Array< OneD, Array< OneD, NekDouble > > &vel=NullNekDoubleArrayOfArray)

void	AppendSVVFactors (StdRegions::ConstFactorMap &factors, MultiRegions::VarFactorsMap &varFactorsMap)

void	ComputeGJPNormalVelocity (const Array< OneD, const Array< OneD, NekDouble > > &inarray, StdRegions::VarCoeffMap &varcoeffs)

Protected Member Functions inherited from Nektar::IncNavierStokes
	IncNavierStokes (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Constructor.

	~IncNavierStokes () override=default

void	v_GetPressure (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &pressure) override

void	v_GetDensity (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &density) override

bool	v_HasConstantDensity () override

void	v_GetVelocity (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &velocity) override

void	v_SetMovingFrameVelocities (const Array< OneD, NekDouble > &vFrameVels, const int step) override

bool	v_GetMovingFrameVelocities (Array< OneD, NekDouble > &vFrameVels, const int step) override

void	v_SetMovingFrameDisp (const Array< OneD, NekDouble > &vFrameDisp, const int step) override

void	v_SetMovingFramePivot (const Array< OneD, NekDouble > &vFramePivot) override

bool	v_GetMovingFrameDisp (Array< OneD, NekDouble > &vFrameDisp, const int step) override

void	v_SetAeroForce (Array< OneD, NekDouble > forces) override

void	v_GetAeroForce (Array< OneD, NekDouble > forces) override

void	EvaluateAdvectionTerms (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)

void	WriteModalEnergy (void)

void	SetBoundaryConditions (NekDouble time)
	time dependent boundary conditions updating

void	SetRadiationBoundaryForcing (int fieldid)
	Set Radiation forcing term.

void	SetZeroNormalVelocity ()
	Set Normal Velocity Component to Zero.

void	SetWomersleyBoundary (const int fldid, const int bndid)
	Set Womersley Profile if specified.

void	SetUpWomersley (const int fldid, const int bndid, std::string womstr)
	Set Up Womersley details.

MultiRegions::ExpListSharedPtr	v_GetPressure () override

Array< OneD, NekDouble >	v_GetMaxStdVelocity (const NekDouble SpeedSoundFactor) override

bool	v_PreIntegrate (int step) override

Protected Member Functions inherited from Nektar::SolverUtils::UnsteadySystem
SOLVER_UTILS_EXPORT	UnsteadySystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Initialises UnsteadySystem class members.

SOLVER_UTILS_EXPORT void	v_DoSolve () override
	Solves an unsteady problem.

virtual SOLVER_UTILS_EXPORT void	v_PrintStatusInformation (const int step, const NekDouble cpuTime)
	Print Status Information.

virtual SOLVER_UTILS_EXPORT void	v_PrintSummaryStatistics (const NekDouble intTime)
	Print Summary Statistics.

virtual SOLVER_UTILS_EXPORT NekDouble	v_GetTimeStep (const Array< OneD, const Array< OneD, NekDouble > > &inarray)
	Return the timestep to be used for the next step in the time-marching loop.

virtual SOLVER_UTILS_EXPORT void	v_SteadyStateResidual (int step, Array< OneD, NekDouble > &L2)

virtual SOLVER_UTILS_EXPORT bool	v_UpdateTimeStepCheck ()

SOLVER_UTILS_EXPORT NekDouble	MaxTimeStepEstimator ()
	Get the maximum timestep estimator for cfl control.

SOLVER_UTILS_EXPORT void	CheckForRestartTime (NekDouble &time, int &nchk)

SOLVER_UTILS_EXPORT void	SVVVarDiffCoeff (const Array< OneD, Array< OneD, NekDouble > > vel, StdRegions::VarCoeffMap &varCoeffMap)
	Evaluate the SVV diffusion coefficient according to Moura's paper where it should proportional to h time velocity.

SOLVER_UTILS_EXPORT void	DoDummyProjection (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
	Perform dummy projection.

Protected Member Functions inherited from Nektar::SolverUtils::EquationSystem
SOLVER_UTILS_EXPORT	EquationSystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Initialises EquationSystem class members.

virtual SOLVER_UTILS_EXPORT NekDouble	v_LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Virtual function for the L_inf error computation between fields and a given exact solution.

virtual SOLVER_UTILS_EXPORT NekDouble	v_L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
	Virtual function for the L_2 error computation between fields and a given exact solution.

virtual SOLVER_UTILS_EXPORT NekDouble	v_H1Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
	Virtual function for the H_1 error computation between fields and a given exact solution.

virtual SOLVER_UTILS_EXPORT void	v_SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)

virtual SOLVER_UTILS_EXPORT void	v_EvaluateExactSolution (unsigned int field, Array< OneD, NekDouble > &outfield, const NekDouble time)

virtual SOLVER_UTILS_EXPORT void	v_Output (void)

virtual SOLVER_UTILS_EXPORT bool	v_NegatedOp (void)
	Virtual function to identify if operator is negated in DoSolve.

virtual SOLVER_UTILS_EXPORT void	v_ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)

Protected Attributes
Array< OneD, Array< OneD, NekDouble > >	m_advection
	2D Array for Advection Velocities [dir][dof]

Array< OneD, Array< OneD, NekDouble > >	m_AdvVel

Array< OneD, Array< OneD, Array< OneD, NekDouble > > >	m_extVel
	3D Array for extrapolated Advection Velocities [dir][time-levle][dof]

bool	m_advectionVelocity
	bool to identify implicit scheme ie advection velocity

bool	m_implicitSkewSymAdvection
	bool to identify advection operator

int	m_intOrder
	integer for advection velocity

std::string	m_convectiveType

Array< OneD, int32_t >	m_unsetGlobalLinSys
	Array checking whether GlobalLinSys needs to be unset.

Protected Attributes inherited from Nektar::VelocityCorrectionScheme
bool	m_useHomo1DSpecVanVisc
	bool to identify if spectral vanishing viscosity is active.

bool	m_useSpecVanVisc
	bool to identify if spectral vanishing viscosity is active.

bool	m_useGJPStabilisation
	bool to identify if GJP semi-implicit is active.

bool	m_useGJPNormalVel
	bool to identify if GJP normal Velocity should be applied in explicit approach

NekDouble	m_GJPJumpScale

NekDouble	m_sVVCutoffRatio
	cutt off ratio from which to start decayhing modes

NekDouble	m_sVVDiffCoeff
	Diffusion coefficient of SVV modes.

NekDouble	m_sVVCutoffRatioHomo1D

NekDouble	m_sVVDiffCoeffHomo1D
	Diffusion coefficient of SVV modes in homogeneous 1D Direction.

Array< OneD, NekDouble >	m_svvVarDiffCoeff
	Array of coefficient if power kernel is used in SVV.

bool	m_IsSVVPowerKernel
	Identifier for Power Kernel otherwise DG kernel.

Array< OneD, NekDouble >	m_diffCoeff
	Diffusion coefficients (will be kinvis for velocities)

StdRegions::VarCoeffMap	m_varCoeffLap
	Variable Coefficient map for the Laplacian which can be activated as part of SVV or otherwise.

NekDouble	m_flowrate
	Desired volumetric flowrate.

NekDouble	m_flowrateArea
	Area of the boundary through which we are measuring the flowrate.

bool	m_homd1DFlowinPlane

NekDouble	m_greenFlux
	Flux of the Stokes function solution.

NekDouble	m_alpha
	Current flowrate correction.

int	m_flowrateBndID
	Boundary ID of the flowrate reference surface.

int	m_planeID
	Plane ID for cases with homogeneous expansion.

MultiRegions::ExpListSharedPtr	m_flowrateBnd
	Flowrate reference surface.

Array< OneD, Array< OneD, NekDouble > >	m_flowrateStokes
	Stokes solution used to impose flowrate.

std::ofstream	m_flowrateStream
	Output stream to record flowrate.

int	m_flowrateSteps
	Interval at which to record flowrate data.

NekDouble	m_flowrateAiidt
	Value of aii_dt used to compute Stokes flowrate solution.

Array< OneD, Array< OneD, NekDouble > >	m_F

Protected Attributes inherited from Nektar::IncNavierStokes
ExtrapolateSharedPtr	m_extrapolation

IncBoundaryConditionsSharedPtr	m_IncNavierStokesBCs

std::ofstream	m_mdlFile
	modal energy file

bool	m_SmoothAdvection
	bool to identify if advection term smoothing is requested

std::vector< SolverUtils::ForcingSharedPtr >	m_forcing
	Forcing terms.

int	m_nConvectiveFields
	Number of fields to be convected;.

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

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

NekDouble	m_kinvis
	Kinematic viscosity.

int	m_energysteps
	dump energy to file at steps time

EquationType	m_equationType
	equation type;

Array< OneD, Array< OneD, int > >	m_fieldsBCToElmtID
	Mapping from BCs to Elmt IDs.

Array< OneD, Array< OneD, int > >	m_fieldsBCToTraceID
	Mapping from BCs to Elmt Edge IDs.

Array< OneD, Array< OneD, NekDouble > >	m_fieldsRadiationFactor
	RHS Factor for Radiation Condition.

int	m_intSteps
	Number of time integration steps AND Order of extrapolation for pressure boundary conditions.

Array< OneD, NekDouble >	m_pivotPoint
	pivot point for moving reference frame

Array< OneD, NekDouble >	m_aeroForces

std::map< int, std::map< int, WomersleyParamsSharedPtr > >	m_womersleyParams
	Womersley parameters if required.

Protected Attributes inherited from Nektar::SolverUtils::AdvectionSystem
SolverUtils::AdvectionSharedPtr	m_advObject
	Advection term.

Protected Attributes inherited from Nektar::SolverUtils::UnsteadySystem
LibUtilities::TimeIntegrationSchemeSharedPtr	m_intScheme
	Wrapper to the time integration scheme.

LibUtilities::TimeIntegrationSchemeOperators	m_ode
	The time integration scheme operators to use.

Array< OneD, Array< OneD, NekDouble > >	m_previousSolution
	Storage for previous solution for steady-state check.

std::vector< int >	m_intVariables

NekDouble	m_cflSafetyFactor
	CFL safety factor (comprise between 0 to 1).

NekDouble	m_CFLGrowth
	CFL growth rate.

NekDouble	m_CFLEnd
	Maximun cfl in cfl growth.

int	m_abortSteps
	Number of steps between checks for abort conditions.

bool	m_explicitDiffusion
	Indicates if explicit or implicit treatment of diffusion is used.

bool	m_explicitAdvection
	Indicates if explicit or implicit treatment of advection is used.

bool	m_explicitReaction
	Indicates if explicit or implicit treatment of reaction is used.

int	m_steadyStateSteps
	Check for steady state at step interval.

NekDouble	m_steadyStateTol
	Tolerance to which steady state should be evaluated at.

int	m_filtersInfosteps
	Number of time steps between outputting filters information.

std::vector< std::pair< std::string, FilterSharedPtr > >	m_filters

bool	m_homoInitialFwd
	Flag to determine if simulation should start in homogeneous forward transformed state.

std::ofstream	m_errFile

NekDouble	m_epsilon
	Diffusion coefficient.

Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
LibUtilities::CommSharedPtr	m_comm
	Communicator.

bool	m_verbose

LibUtilities::SessionReaderSharedPtr	m_session
	The session reader.

std::map< std::string, SolverUtils::SessionFunctionSharedPtr >	m_sessionFunctions
	Map of known SessionFunctions.

LibUtilities::FieldIOSharedPtr	m_fld
	Field input/output.

Array< OneD, MultiRegions::ExpListSharedPtr >	m_fields
	Array holding all dependent variables.

SpatialDomains::BoundaryConditionsSharedPtr	m_boundaryConditions
	Pointer to boundary conditions object.

SpatialDomains::MeshGraphSharedPtr	m_graph
	Pointer to graph defining mesh.

std::string	m_sessionName
	Name of the session.

NekDouble	m_time
	Current time of simulation.

int	m_initialStep
	Number of the step where the simulation should begin.

NekDouble	m_fintime
	Finish time of the simulation.

NekDouble	m_timestep
	Time step size.

NekDouble	m_lambda
	Lambda constant in real system if one required.

NekDouble	m_checktime
	Time between checkpoints.

NekDouble	m_lastCheckTime

NekDouble	m_TimeIncrementFactor

int	m_nchk
	Number of checkpoints written so far.

int	m_steps
	Number of steps to take.

int	m_checksteps
	Number of steps between checkpoints.

int	m_infosteps
	Number of time steps between outputting status information.

int	m_iterPIT = 0
	Number of parallel-in-time time iteration.

int	m_windowPIT = 0
	Index of windows for parallel-in-time time iteration.

int	m_spacedim
	Spatial dimension (>= expansion dim).

int	m_expdim
	Expansion dimension.

bool	m_singleMode
	Flag to determine if single homogeneous mode is used.

bool	m_halfMode
	Flag to determine if half homogeneous mode is used.

bool	m_multipleModes
	Flag to determine if use multiple homogenenous modes are used.

bool	m_useFFT
	Flag to determine if FFT is used for homogeneous transform.

bool	m_homogen_dealiasing
	Flag to determine if dealiasing is used for homogeneous simulations.

bool	m_specHP_dealiasing
	Flag to determine if dealisising is usde for the Spectral/hp element discretisation.

enum MultiRegions::ProjectionType	m_projectionType
	Type of projection; e.g continuous or discontinuous.

Array< OneD, Array< OneD, NekDouble > >	m_traceNormals
	Array holding trace normals for DG simulations in the forwards direction.

Array< OneD, bool >	m_checkIfSystemSingular
	Flag to indicate if the fields should be checked for singularity.

LibUtilities::FieldMetaDataMap	m_fieldMetaDataMap
	Map to identify relevant solver info to dump in output fields.

Array< OneD, NekDouble >	m_movingFrameData
	Moving reference frame status in the inertial frame X, Y, Z, Theta_x, Theta_y, Theta_z, U, V, W, Omega_x, Omega_y, Omega_z, A_x, A_y, A_z, DOmega_x, DOmega_y, DOmega_z, pivot_x, pivot_y, pivot_z.

std::vector< std::string >	m_strFrameData
	variable name in m_movingFrameData

int	m_NumQuadPointsError
	Number of Quadrature points used to work out the error.

enum HomogeneousType	m_HomogeneousType

NekDouble	m_LhomX
	physical length in X direction (if homogeneous)

NekDouble	m_LhomY
	physical length in Y direction (if homogeneous)

NekDouble	m_LhomZ
	physical length in Z direction (if homogeneous)

int	m_npointsX
	number of points in X direction (if homogeneous)

int	m_npointsY
	number of points in Y direction (if homogeneous)

int	m_npointsZ
	number of points in Z direction (if homogeneous)

int	m_HomoDirec
	number of homogenous directions

Protected Attributes inherited from Nektar::SolverUtils::ALEHelper
Array< OneD, MultiRegions::ExpListSharedPtr >	m_fieldsALE

Array< OneD, Array< OneD, NekDouble > >	m_gridVelocity

Array< OneD, Array< OneD, NekDouble > >	m_gridVelocityTrace

std::vector< ALEBaseShPtr >	m_ALEs

bool	m_ALESolver = false

bool	m_meshDistorted = false

bool	m_implicitALESolver = false

bool	m_updateNormals = false

NekDouble	m_prevStageTime = 0.0

int	m_spaceDim

Static Protected Attributes
static std::string	solverTypeLookupId

Static Protected Attributes inherited from Nektar::VelocityCorrectionScheme
static std::string	solverTypeLookupId

Static Protected Attributes inherited from Nektar::IncNavierStokes
static std::string	eqTypeLookupIds []

Static Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
static std::string	equationSystemTypeLookupIds []

static std::string	projectionTypeLookupIds []

Friends
class	MemoryManager< VCSImplicit >

Additional Inherited Members
Public Member Functions inherited from Nektar::VelocityCorrectionScheme
void	SetUpPressureForcing (const Array< OneD, const Array< OneD, NekDouble > > &fields, Array< OneD, Array< OneD, NekDouble > > &Forcing, const NekDouble aii_Dt)

void	SetUpViscousForcing (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &Forcing, const NekDouble aii_Dt)

void	SolvePressure (const Array< OneD, NekDouble > &Forcing)

void	SolveViscous (const Array< OneD, const Array< OneD, NekDouble > > &Forcing, const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble aii_Dt)

void	SolveUnsteadyStokesSystem (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time, const NekDouble a_iixDt)

void	EvaluateAdvection_SetPressureBCs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)

Public Member Functions inherited from Nektar::IncNavierStokes
int	GetNConvectiveFields (void)

void	AddForcing (const SolverUtils::ForcingSharedPtr &pForce)

bool	DefinedForcing (const std::string &sForce)

Public Member Functions inherited from Nektar::SolverUtils::AdvectionSystem
SOLVER_UTILS_EXPORT	AdvectionSystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)

SOLVER_UTILS_EXPORT	~AdvectionSystem () override=default

SOLVER_UTILS_EXPORT AdvectionSharedPtr	GetAdvObject ()
	Returns the advection object held by this instance.

SOLVER_UTILS_EXPORT Array< OneD, NekDouble >	GetElmtCFLVals (const bool FlagAcousticCFL=true)

SOLVER_UTILS_EXPORT NekDouble	GetCFLEstimate (int &elmtid)

Public Member Functions inherited from Nektar::SolverUtils::UnsteadySystem
SOLVER_UTILS_EXPORT	~UnsteadySystem () override=default
	Destructor.

SOLVER_UTILS_EXPORT NekDouble	GetTimeStep (const Array< OneD, const Array< OneD, NekDouble > > &inarray)
	Calculate the larger time-step mantaining the problem stable.

SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()

SOLVER_UTILS_EXPORT void	SetTimeStep (const NekDouble timestep)

SOLVER_UTILS_EXPORT void	SteadyStateResidual (int step, Array< OneD, NekDouble > &L2)

SOLVER_UTILS_EXPORT LibUtilities::TimeIntegrationSchemeSharedPtr &	GetTimeIntegrationScheme ()
	Returns the time integration scheme.

SOLVER_UTILS_EXPORT LibUtilities::TimeIntegrationSchemeOperators &	GetTimeIntegrationSchemeOperators ()
	Returns the time integration scheme operators.

Public Member Functions inherited from Nektar::SolverUtils::EquationSystem
virtual SOLVER_UTILS_EXPORT	~EquationSystem ()
	Destructor.

SOLVER_UTILS_EXPORT void	InitObject (bool DeclareField=true)
	Initialises the members of this object.

SOLVER_UTILS_EXPORT void	DoInitialise (bool dumpInitialConditions=true)
	Perform any initialisation necessary before solving the problem.

SOLVER_UTILS_EXPORT void	DoSolve ()
	Solve the problem.

SOLVER_UTILS_EXPORT void	TransCoeffToPhys ()
	Transform from coefficient to physical space.

SOLVER_UTILS_EXPORT void	TransPhysToCoeff ()
	Transform from physical to coefficient space.

SOLVER_UTILS_EXPORT void	Output ()
	Perform output operations after solve.

SOLVER_UTILS_EXPORT std::string	GetSessionName ()
	Get Session name.

template<class T >
std::shared_ptr< T >	as ()

SOLVER_UTILS_EXPORT void	ResetSessionName (std::string newname)
	Reset Session name.

SOLVER_UTILS_EXPORT LibUtilities::SessionReaderSharedPtr	GetSession ()
	Get Session name.

SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr	GetPressure ()
	Get pressure field if available.

SOLVER_UTILS_EXPORT void	ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)

SOLVER_UTILS_EXPORT void	PrintSummary (std::ostream &out)
	Print a summary of parameters and solver characteristics.

SOLVER_UTILS_EXPORT void	SetLambda (NekDouble lambda)
	Set parameter m_lambda.

SOLVER_UTILS_EXPORT SessionFunctionSharedPtr	GetFunction (std::string name, const MultiRegions::ExpListSharedPtr &field=MultiRegions::NullExpListSharedPtr, bool cache=false)
	Get a SessionFunction by name.

SOLVER_UTILS_EXPORT void	SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
	Initialise the data in the dependent fields.

SOLVER_UTILS_EXPORT void	EvaluateExactSolution (int field, Array< OneD, NekDouble > &outfield, const NekDouble time)
	Evaluates an exact solution.

SOLVER_UTILS_EXPORT NekDouble	L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
	Compute the L2 error between fields and a given exact solution.

SOLVER_UTILS_EXPORT NekDouble	L2Error (unsigned int field, bool Normalised=false)
	Compute the L2 error of the fields.

SOLVER_UTILS_EXPORT NekDouble	LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Linf error computation.

SOLVER_UTILS_EXPORT NekDouble	H1Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
	Compute the H1 error between fields and a given exact solution.

SOLVER_UTILS_EXPORT Array< OneD, NekDouble >	ErrorExtraPoints (unsigned int field)
	Compute error (L2 and L_inf) over an larger set of quadrature points return [L2 Linf].

SOLVER_UTILS_EXPORT void	Checkpoint_Output (const int n)
	Write checkpoint file of m_fields.

SOLVER_UTILS_EXPORT void	Checkpoint_Output (const int n, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write checkpoint file of custom data fields.

SOLVER_UTILS_EXPORT void	Checkpoint_BaseFlow (const int n)
	Write base flow file of m_fields.

SOLVER_UTILS_EXPORT void	WriteFld (const std::string &outname)
	Write field data to the given filename.

SOLVER_UTILS_EXPORT void	WriteFld (const std::string &outname, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write input fields to the given filename.

SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
	Input field data from the given file.

SOLVER_UTILS_EXPORT void	ImportFldToMultiDomains (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int ndomains)
	Input field data from the given file to multiple domains.

SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, std::vector< std::string > &fieldStr, Array< OneD, Array< OneD, NekDouble > > &coeffs)
	Output a field. Input field data into array from the given file.

SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, MultiRegions::ExpListSharedPtr &pField, std::string &pFieldName)
	Output a field. Input field data into ExpList from the given file.

SOLVER_UTILS_EXPORT void	SessionSummary (SummaryList &vSummary)
	Write out a session summary.

SOLVER_UTILS_EXPORT Array< OneD, MultiRegions::ExpListSharedPtr > &	UpdateFields ()

SOLVER_UTILS_EXPORT LibUtilities::FieldMetaDataMap &	UpdateFieldMetaDataMap ()
	Get hold of FieldInfoMap so it can be updated.

SOLVER_UTILS_EXPORT NekDouble	GetTime ()
	Return final time.

SOLVER_UTILS_EXPORT int	GetNcoeffs ()

SOLVER_UTILS_EXPORT int	GetNcoeffs (const int eid)

SOLVER_UTILS_EXPORT int	GetNumExpModes ()

SOLVER_UTILS_EXPORT const Array< OneD, int >	GetNumExpModesPerExp ()

SOLVER_UTILS_EXPORT int	GetNvariables ()

SOLVER_UTILS_EXPORT const std::string	GetVariable (unsigned int i)

SOLVER_UTILS_EXPORT int	GetTraceTotPoints ()

SOLVER_UTILS_EXPORT int	GetTraceNpoints ()

SOLVER_UTILS_EXPORT int	GetExpSize ()

SOLVER_UTILS_EXPORT int	GetPhys_Offset (int n)

SOLVER_UTILS_EXPORT int	GetCoeff_Offset (int n)

SOLVER_UTILS_EXPORT int	GetTotPoints ()

SOLVER_UTILS_EXPORT int	GetTotPoints (int n)

SOLVER_UTILS_EXPORT int	GetNpoints ()

SOLVER_UTILS_EXPORT int	GetSteps ()

SOLVER_UTILS_EXPORT void	SetSteps (const int steps)

SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()

SOLVER_UTILS_EXPORT void	CopyFromPhysField (const int i, Array< OneD, NekDouble > &output)

SOLVER_UTILS_EXPORT void	CopyToPhysField (const int i, const Array< OneD, const NekDouble > &input)

SOLVER_UTILS_EXPORT Array< OneD, NekDouble > &	UpdatePhysField (const int i)

SOLVER_UTILS_EXPORT void	ZeroPhysFields ()

SOLVER_UTILS_EXPORT void	FwdTransFields ()

SOLVER_UTILS_EXPORT void	SetModifiedBasis (const bool modbasis)

SOLVER_UTILS_EXPORT int	GetCheckpointNumber ()

SOLVER_UTILS_EXPORT void	SetCheckpointNumber (int num)

SOLVER_UTILS_EXPORT int	GetCheckpointSteps ()

SOLVER_UTILS_EXPORT void	SetCheckpointSteps (int num)

SOLVER_UTILS_EXPORT int	GetInfoSteps ()

SOLVER_UTILS_EXPORT void	SetInfoSteps (int num)

SOLVER_UTILS_EXPORT void	SetIterationNumberPIT (int num)

SOLVER_UTILS_EXPORT void	SetWindowNumberPIT (int num)

SOLVER_UTILS_EXPORT Array< OneD, const Array< OneD, NekDouble > >	GetTraceNormals ()

SOLVER_UTILS_EXPORT void	SetTime (const NekDouble time)

SOLVER_UTILS_EXPORT void	SetTimeStep (const NekDouble timestep)

SOLVER_UTILS_EXPORT void	SetInitialStep (const int step)

SOLVER_UTILS_EXPORT void	SetBoundaryConditions (NekDouble time)
	Evaluates the boundary conditions at the given time.

SOLVER_UTILS_EXPORT bool	NegatedOp ()
	Identify if operator is negated in DoSolve.

Public Member Functions inherited from Nektar::SolverUtils::ALEHelper
virtual	~ALEHelper ()=default

virtual SOLVER_UTILS_EXPORT void	v_ALEInitObject (int spaceDim, Array< OneD, MultiRegions::ExpListSharedPtr > &fields)

SOLVER_UTILS_EXPORT void	InitObject (int spaceDim, Array< OneD, MultiRegions::ExpListSharedPtr > &fields)

virtual SOLVER_UTILS_EXPORT void	v_UpdateGridVelocity (const NekDouble &time)

virtual SOLVER_UTILS_EXPORT void	v_ALEPreMultiplyMass (Array< OneD, Array< OneD, NekDouble > > &fields)

SOLVER_UTILS_EXPORT void	ALEDoElmtInvMass (Array< OneD, Array< OneD, NekDouble > > &traceNormals, Array< OneD, Array< OneD, NekDouble > > &fields, NekDouble time)
	Update m_fields with u^n by multiplying by inverse mass matrix. That's then used in e.g. checkpoint output and L^2 error calculation.

SOLVER_UTILS_EXPORT void	ALEDoElmtInvMassBwdTrans (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)

SOLVER_UTILS_EXPORT void	MoveMesh (const NekDouble &time, Array< OneD, Array< OneD, NekDouble > > &traceNormals)

SOLVER_UTILS_EXPORT void	ResetMatricesNormal (Array< OneD, Array< OneD, NekDouble > > &traceNormals)

SOLVER_UTILS_EXPORT void	UpdateNormalsFlag ()

const Array< OneD, const Array< OneD, NekDouble > > &	GetGridVelocity ()

bool &	GetUpdateNormalsFlag ()

SOLVER_UTILS_EXPORT const Array< OneD, const Array< OneD, NekDouble > > &	GetGridVelocityTrace ()

SOLVER_UTILS_EXPORT void	ExtraFldOutputGridVelocity (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)

SOLVER_UTILS_EXPORT void	ExtraFldOutputGrid (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)

Public Member Functions inherited from Nektar::SolverUtils::FluidInterface
virtual	~FluidInterface ()=default

SOLVER_UTILS_EXPORT void	GetVelocity (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &velocity)
	Extract array with velocity from physfield.

SOLVER_UTILS_EXPORT bool	HasConstantDensity ()

SOLVER_UTILS_EXPORT void	GetDensity (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &density)
	Extract array with density from physfield.

SOLVER_UTILS_EXPORT void	GetPressure (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, NekDouble > &pressure)
	Extract array with pressure from physfield.

SOLVER_UTILS_EXPORT void	SetMovingFrameVelocities (const Array< OneD, NekDouble > &vFrameVels, const int step)

SOLVER_UTILS_EXPORT bool	GetMovingFrameVelocities (Array< OneD, NekDouble > &vFrameVels, const int step)

SOLVER_UTILS_EXPORT void	SetMovingFrameDisp (const Array< OneD, NekDouble > &vFrameDisp, const int step)

SOLVER_UTILS_EXPORT void	SetMovingFramePivot (const Array< OneD, NekDouble > &vFramePivot)

SOLVER_UTILS_EXPORT bool	GetMovingFrameDisp (Array< OneD, NekDouble > &vFrameDisp, const int step)

SOLVER_UTILS_EXPORT void	SetAeroForce (Array< OneD, NekDouble > forces)
	Set aerodynamic force and moment.

SOLVER_UTILS_EXPORT void	GetAeroForce (Array< OneD, NekDouble > forces)
	Get aerodynamic force and moment.

Protected Types inherited from Nektar::SolverUtils::EquationSystem
enum	HomogeneousType { eHomogeneous1D , eHomogeneous2D , eHomogeneous3D , eNotHomogeneous }
	Parameter for homogeneous expansions. More...

Detailed Description

Definition at line 42 of file VelocityCorrectionSchemeImplicit.h.

Constructor & Destructor Documentation

◆ VCSImplicit()

Nektar::VCSImplicit::VCSImplicit	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const SpatialDomains::MeshGraphSharedPtr &	pGraph
	)

protected

Constructor. No special instructions here. v_DoInitialise sets the scheme up.

Parameters

param

Definition at line 63 of file VelocityCorrectionSchemeImplicit.cpp.

    : UnsteadySystem(pSession, pGraph),
      VelocityCorrectionScheme(pSession, pGraph)
{
}

◆ ~VCSImplicit()

Nektar::VCSImplicit::~VCSImplicit ( )

overrideprotecteddefault

Member Function Documentation

◆ AddImplicitSkewSymAdvection()

void Nektar::VCSImplicit::AddImplicitSkewSymAdvection	(	StdRegions::VarCoeffMap	varcoeffs,
		NekDouble	aii_Dt
	)

protected

Definition at line 514 of file VelocityCorrectionSchemeImplicit.cpp.

{
    if (!m_implicitSkewSymAdvection)
    {
        return;
    }
 
    // Setup temporary storages
    int nvel    = m_velocity.size();
    int phystot = m_fields[0]->GetTotPoints();
    Array<OneD, NekDouble> divAdvVel(phystot, 0.0);
    Array<OneD, NekDouble> tmpstore(phystot);
    Array<OneD, NekDouble> ones(phystot, 1.0);
 
    // Compute divergence of advection velocity: 1/\nu \tilde{u}
    m_fields[0]->PhysDeriv(eX, m_AdvVel[0], divAdvVel);
    for (int i = 1; i < nvel; ++i)
    {
        m_fields[i]->PhysDeriv(DirCartesianMap[i], m_AdvVel[i], tmpstore);
        Vmath::Vadd(phystot, divAdvVel, 1, tmpstore, 1, divAdvVel, 1);
    }
    // Smul: 1/(2*lambda) * divAdvVel
    NekDouble lambda = 1.0 / aii_Dt / m_diffCoeff[0];
    Vmath::Smul(phystot, 1.0 / 2.0 / lambda, divAdvVel, 1, divAdvVel, 1);
 
    // Vadd: 1 + 1/(2*lambda) * divAdvVel
    Vmath::Vadd(phystot, ones, 1, divAdvVel, 1, divAdvVel, 1);
 
    // Assign VarcoeffMass
    varcoeffs[StdRegions::eVarCoeffMass] = divAdvVel;
}

References Nektar::MultiRegions::DirCartesianMap, Nektar::StdRegions::eVarCoeffMass, Nektar::MultiRegions::eX, m_AdvVel, Nektar::VelocityCorrectionScheme::m_diffCoeff, Nektar::SolverUtils::EquationSystem::m_fields, m_implicitSkewSymAdvection, Nektar::IncNavierStokes::m_velocity, Vmath::Smul(), and Vmath::Vadd().

Referenced by v_SolveViscous().

◆ CheckUnsetGlobalLinSys()

void Nektar::VCSImplicit::CheckUnsetGlobalLinSys ( Array< OneD, int32_t > & unsetGlobalLinSys )

protected

Definition at line 547 of file VelocityCorrectionSchemeImplicit.cpp.

{
    // Loop over all convected Fields (excludes pressure)
    for (int i = 0; i < m_nConvectiveFields; ++i)
    {
        // Always unset after last solve
        if (i == m_nConvectiveFields - 1)
        {
            unsetGlobalLinSys[i] = 1;
            continue;
        }
 
        auto contField =
            std::dynamic_pointer_cast<MultiRegions::ContField>(m_fields[i]);
        // Check against all solves after this one, whether same
        // Global Linear system is required
        for (int j = i + 1; j < m_nConvectiveFields; ++j)
        {
            // If same BCs (ie GlobalLinSys) in j-solves, save the GlobalLinSys
            // for re-use
            if (std::dynamic_pointer_cast<MultiRegions::ContField>(m_fields[j])
                    ->SameTypeOfBoundaryConditions(*contField))
            {
                unsetGlobalLinSys[i] = 0;
            }
            // If no same BCs (ie GlobalLinSys) in j-solves, UnsetGlobalLinSys()
            // for i-solve
            else
            {
                unsetGlobalLinSys[i] = 1;
            }
        }
    }
}

References Nektar::SolverUtils::EquationSystem::m_fields, and Nektar::IncNavierStokes::m_nConvectiveFields.

Referenced by v_DoInitialise().

◆ create()

static SolverUtils::EquationSystemSharedPtr Nektar::VCSImplicit::create	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const SpatialDomains::MeshGraphSharedPtr &	pGraph
	)

inlinestatic

Creates an instance of this class.

Definition at line 48 of file VelocityCorrectionSchemeImplicit.h.

    {
        SolverUtils::EquationSystemSharedPtr p =
            MemoryManager<VCSImplicit>::AllocateSharedPtr(pSession, pGraph);
        p->InitObject();
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

◆ v_DoInitialise()

void Nektar::VCSImplicit::v_DoInitialise ( bool dumpInitialConditions )

overrideprotectedvirtual

Sets up initial conditions.

Sets the initial conditions.

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

Definition at line 160 of file VelocityCorrectionSchemeImplicit.cpp.

{
    VelocityCorrectionScheme::v_DoInitialise(dumpInitialConditions);
 
    // Get integration order for extrapolation
    m_intOrder = m_intScheme->GetOrder();
 
    // Initialise Advection velocity
    m_AdvVel = Array<OneD, Array<OneD, NekDouble>>(m_velocity.size());
    for (int i = 0; i < m_velocity.size(); i++)
    {
        m_AdvVel[i] = Array<OneD, NekDouble>(m_fields[i]->GetTotPoints(), 0.0);
    }
 
    // Initialise storage for explicit advection terms
    m_advection = Array<OneD, Array<OneD, NekDouble>>(m_nConvectiveFields);
    for (int i = 0; i < m_nConvectiveFields; i++)
    {
        m_advection[i] =
            Array<OneD, NekDouble>(m_fields[i]->GetTotPoints(), 0.0);
    }
 
    // Check advection velocity: Extrapolated or Updated scheme
    // Default to Extrapolated scheme
    m_session->MatchSolverInfo("AdvectionVelocity", "Extrapolated",
                               m_advectionVelocity, true);
 
    // Extrapolated velocity (for 2nd order scheme)
    // Only initiliase for Extrapolated scheme
    if (m_advectionVelocity)
    {
        m_extVel =
            Array<OneD, Array<OneD, Array<OneD, NekDouble>>>(m_velocity.size());
        for (int i = 0; i < m_velocity.size(); i++)
        {
            m_extVel[i] = Array<OneD, Array<OneD, NekDouble>>(m_intOrder);
            for (int j = 0; j < m_intOrder; j++)
            {
                m_extVel[i][j] =
                    Array<OneD, NekDouble>(m_fields[i]->GetTotPoints(), 0.0);
            }
        }
    }
 
    // Check whether multiple or single GlobalLinSys are
    // required and when to delete them
    // Initialise to always reset GlobalLinSys
    m_unsetGlobalLinSys = Array<OneD, int32_t>(m_velocity.size(), 1);
    CheckUnsetGlobalLinSys(m_unsetGlobalLinSys);
 
    // Check skew-symmetric advection operator
    // Default to Convective operator = false
    m_session->MatchSolverInfo("AdvectionOperator", "SkewSymmetric",
                               m_implicitSkewSymAdvection, false);
}

References CheckUnsetGlobalLinSys(), Nektar::SolverUtils::EquationSystem::GetTotPoints(), m_advection, m_advectionVelocity, m_AdvVel, m_extVel, Nektar::SolverUtils::EquationSystem::m_fields, m_implicitSkewSymAdvection, m_intOrder, Nektar::SolverUtils::UnsteadySystem::m_intScheme, Nektar::IncNavierStokes::m_nConvectiveFields, Nektar::SolverUtils::EquationSystem::m_session, m_unsetGlobalLinSys, Nektar::IncNavierStokes::m_velocity, and Nektar::VelocityCorrectionScheme::v_DoInitialise().

◆ v_EvaluateAdvection_SetPressureBCs()

void Nektar::VCSImplicit::v_EvaluateAdvection_SetPressureBCs	(	const Array< OneD, const Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble	time
	)

overrideprotectedvirtual

Explicit part of the method - HOPBCs based on VCSWeakPressure. For the implicit scheme, we do not extrapolate the advection and rotational diffusion terms, see also S. Dong and J. Shen (2010).

Parameters

inarray	Holds the vector of previous solutions \( [u^n, v^n, \ldots] \).
outarray	In the implicit scheme, currently an empty array. TODO Don't waste memory here.
time	Holds the new time \( t^{n+1} = (n+1) \Delta t \).

Reimplemented from Nektar::VelocityCorrectionScheme.

Definition at line 482 of file VelocityCorrectionSchemeImplicit.cpp.

{
    // Zero RHS derivatives, avoids undefined values
    for (int i = 0; i < m_velocity.size(); ++i)
    {
        Vmath::Zero(outarray[i].size(), outarray[i], 1);
    }
 
    // Calculate High-Order pressure boundary conditions
    LibUtilities::Timer timer;
    timer.Start();
    m_extrapolation->EvaluatePressureBCs(inarray, outarray, m_kinvis);
    timer.Stop();
    timer.AccumulateRegion("Pressure BCs");
 
    // Extrapolate advection velocity with StifflyStableBeta coefficients
    if (m_advectionVelocity)
    {
        for (int i = 0; i < m_velocity.size(); ++i)
        {
            Vmath::Vcopy(inarray[i].size(), inarray[i], 1,
                         m_extVel[i][m_intOrder - 1], 1);
            m_extrapolation->ExtrapolateArray(m_extVel[i]);
        }
    }
 
    // Compute explicit advection terms
    EvaluateAdvectionTerms(inarray, m_advection, time);
}

References Nektar::LibUtilities::Timer::AccumulateRegion(), Nektar::IncNavierStokes::EvaluateAdvectionTerms(), m_advection, m_advectionVelocity, Nektar::IncNavierStokes::m_extrapolation, m_extVel, m_intOrder, Nektar::IncNavierStokes::m_kinvis, Nektar::IncNavierStokes::m_velocity, Nektar::LibUtilities::Timer::Start(), Nektar::LibUtilities::Timer::Stop(), Vmath::Vcopy(), and Vmath::Zero().

◆ v_GenerateSummary()

void Nektar::VCSImplicit::v_GenerateSummary ( SolverUtils::SummaryList & s )

overrideprotectedvirtual

Print a summary of time stepping parameters.

Prints a summary with some information regards the time-stepping.

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

Definition at line 73 of file VelocityCorrectionSchemeImplicit.cpp.

{
    AdvectionSystem::v_GenerateSummary(s);
    SolverUtils::AddSummaryItem(s, "Splitting Scheme",
                                "Implicit velocity correction");
 
    if (m_extrapolation->GetSubStepName().size())
    {
        SolverUtils::AddSummaryItem(s, "Substepping",
                                    m_extrapolation->GetSubStepName());
    }
 
    string dealias = m_homogen_dealiasing ? "Homogeneous1D" : "";
    if (m_specHP_dealiasing)
    {
        dealias += (dealias == "" ? "" : " + ") + string("spectral/hp");
    }
    if (dealias != "")
    {
        SolverUtils::AddSummaryItem(s, "Dealiasing", dealias);
    }
 
    string smoothing = m_useSpecVanVisc ? "spectral/hp" : "";
    if (smoothing != "")
    {
        if (m_svvVarDiffCoeff == NullNekDouble1DArray)
        {
            SolverUtils::AddSummaryItem(
                s, "Smoothing-SpecHP",
                "SVV (" + smoothing + " Exp Kernel(cut-off = " +
                    boost::lexical_cast<string>(m_sVVCutoffRatio) +
                    ", diff coeff = " +
                    boost::lexical_cast<string>(m_sVVDiffCoeff) + "))");
        }
        else
        {
            if (m_IsSVVPowerKernel)
            {
                SolverUtils::AddSummaryItem(
                    s, "Smoothing-SpecHP",
                    "SVV (" + smoothing + " Power Kernel (Power ratio =" +
                        boost::lexical_cast<string>(m_sVVCutoffRatio) +
                        ", diff coeff = " +
                        boost::lexical_cast<string>(m_sVVDiffCoeff) +
                        "*Uh/p))");
            }
            else
            {
                SolverUtils::AddSummaryItem(
                    s, "Smoothing-SpecHP",
                    "SVV (" + smoothing + " DG Kernel (diff coeff = " +
                        boost::lexical_cast<string>(m_sVVDiffCoeff) +
                        "*Uh/p))");
            }
        }
    }
 
    if (m_useHomo1DSpecVanVisc && (m_HomogeneousType == eHomogeneous1D))
    {
        SolverUtils::AddSummaryItem(
            s, "Smoothing-Homo1D",
            "SVV (Homogeneous1D - Exp Kernel(cut-off = " +
                boost::lexical_cast<string>(m_sVVCutoffRatioHomo1D) +
                ", diff coeff = " +
                boost::lexical_cast<string>(m_sVVDiffCoeffHomo1D) + "))");
    }
 
    if (m_useGJPStabilisation)
    {
        SolverUtils::AddSummaryItem(
            s, "GJP Stab. Impl.    ",
            m_session->GetSolverInfo("GJPStabilisation"));
        SolverUtils::AddSummaryItem(s, "GJP Stab. JumpScale", m_GJPJumpScale);
 
        if (boost::iequals(m_session->GetSolverInfo("GJPStabilisation"),
                           "Explicit"))
        {
            SolverUtils::AddSummaryItem(
                s, "GJP Normal Velocity",
                m_session->GetSolverInfo("GJPNormalVelocity"));
        }
    }
}

◆ v_GetExtrapolateStr()

std::string Nektar::VCSImplicit::v_GetExtrapolateStr ( void )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::VelocityCorrectionScheme.

Definition at line 104 of file VelocityCorrectionSchemeImplicit.h.

    {
        return "Implicit"; // Use ImplicitExtrapolate.cpp
    }

◆ v_SetUpPressureForcing()

void Nektar::VCSImplicit::v_SetUpPressureForcing	(	const Array< OneD, const Array< OneD, NekDouble > > &	fields,
		Array< OneD, Array< OneD, NekDouble > > &	Forcing,
		const NekDouble	aii_Dt
	)

overrideprotectedvirtual

Computes the forcing term for the pressure solve in VCSImplicit::v_SolvePressure(). It uses the weak pressure forcing similar to VCSWeakPressure (coefficient space).

Parameters

fields	Holds the BDF formula of previous solutions \(\sum_q \frac{\alpha_q}{\gamma} [u^{n-q}, v^{n-q}, \ldots]\).
Forcing	Array for the forcing term of the pressure solve. May contain temporary values on input. On output, Forcing = \( \int_\Omega \nabla \phi \cdot \left( \frac{1}{\Delta t} \sum_q \alpha_q \mathbf{u}^{n-q} + \mathbf{f}^{n+1} - N(\mathbf{u})^n \right) \).

Reimplemented from Nektar::VelocityCorrectionScheme.

Definition at line 229 of file VelocityCorrectionSchemeImplicit.cpp.

{
    int ncoeffs = m_pressure->GetNcoeffs();
    int phystot = m_fields[0]->GetTotPoints();
    int nvel    = m_velocity.size();
 
    // Add 1/dt \sum_q \alpha_q u^{n-q} - N(u^n)
    for (int i = 0; i < nvel; i++)
    {
        Vmath::Svtvp(phystot, 1.0 / aii_Dt, fields[i], 1, m_advection[i], 1,
                     Forcing[i], 1);
    }
 
    // Add forcing terms
    for (auto &x : m_forcing)
    {
        x->Apply(m_fields, Forcing, Forcing, m_time + m_timestep);
    }
 
    // Do Innerproduct with derivative base
    m_pressure->IProductWRTDerivBase(Forcing, Forcing[0]);
 
    // Negate to reverse negation in HelmSolve
    Vmath::Neg(ncoeffs, Forcing[0], 1);
}

References m_advection, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::IncNavierStokes::m_forcing, Nektar::IncNavierStokes::m_pressure, Nektar::SolverUtils::EquationSystem::m_time, Nektar::SolverUtils::EquationSystem::m_timestep, Nektar::IncNavierStokes::m_velocity, Vmath::Neg(), and Vmath::Svtvp().

◆ v_SetUpViscousForcing()

void Nektar::VCSImplicit::v_SetUpViscousForcing	(	const Array< OneD, const Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	Forcing,
		const NekDouble	aii_Dt
	)

overrideprotectedvirtual

Computes the forcing term and advection velocity for ADR solves.

Parameters

inarray	Holds the BDF formula of previous solutions \(\sum_q \frac{\alpha_q}{\gamma} [u^{n-q}, v^{n-q}, \ldots]\).
Forcing	Shared forcing array m_F. Used in pressure and velocity solve. On input, holds temporary values from pressure solve. On output: Forcing = \( - \frac{1}{\nu} \left( \frac{1}{\Delta t} \sum_q \alpha_q \mathbf{u}^{n-q} - \nabla p^{n+1} + \mathbf{f}^{n+1} \right) \).
aii_Dt	\(\frac{\Delta t}{\gamma}\).

Additionally, the advection velocity \( \tilde{\mathbf{u}}^{n+1} \) is computed and handed to the velocity solve via the array m_AdvVel. It is computed as \( \tilde{\mathbf{u}}^{n+1} = \sum_q \frac{\alpha_q}{\gamma} \mathbf{u}^{n-q} - \frac{\Delta t}{\gamma} \left[ \nabla p^{n+1} - N(\mathbf{u})^n - \nu \nabla \times \omega^n + \mathbf{f}^{n+1} \right] \).

Reimplemented from Nektar::VelocityCorrectionScheme.

Definition at line 276 of file VelocityCorrectionSchemeImplicit.cpp.

{
    int phystot = m_fields[0]->GetTotPoints();
    int nvel    = m_velocity.size();
 
    // Update (PhysSpace) pressure to n+1
    m_pressure->BwdTrans(m_pressure->GetCoeffs(), m_pressure->UpdatePhys());
 
    // Compute gradient \nabla p^{n+1}
    if (nvel == 2)
    {
        m_pressure->PhysDeriv(m_pressure->GetPhys(), Forcing[m_velocity[0]],
                              Forcing[m_velocity[1]]);
    }
    else
    {
        m_pressure->PhysDeriv(m_pressure->GetPhys(), Forcing[m_velocity[0]],
                              Forcing[m_velocity[1]], Forcing[m_velocity[2]]);
    }
 
    // Negate pressure gradient: -1 * \nabla p
    for (int i = 0; i < nvel; ++i)
    {
        Vmath::Neg(phystot, Forcing[i], 1);
    }
 
    // Zero convective fields
    for (int i = nvel; i < m_nConvectiveFields; ++i)
    {
        Vmath::Zero(phystot, Forcing[i], 1);
    }
 
    // Add forcing terms: += f^{n+1}
    for (auto &x : m_forcing)
    {
        x->Apply(m_fields, Forcing, Forcing, m_time + m_timestep);
    }
 
    // Build Advection Velocity
    for (int i = 0; i < nvel; ++i)
    {
        // Extrapolated Advection Velocity = u^*n+1
        if (m_advectionVelocity)
        {
            Vmath::Smul(phystot, 1.0 / m_diffCoeff[i],
                        m_extVel[i][m_intOrder - 1], 1, m_AdvVel[i], 1);
        }
        // Updated Advection Velocity = u^*n+1 - (...)
        else
        {
            // Get velocity fields [u^n, v^n, ..] for curl of vorticity
            Array<OneD, Array<OneD, NekDouble>> velocity(nvel);
            for (int i = 0; i < nvel; i++)
            {
                velocity[i] = Array<OneD, NekDouble>(m_fields[i]->GetPhys());
            }
            // Curl of vorticity \nabla \times \nabla \times [u^n, v^n, ..]
            m_fields[0]->CurlCurl(velocity, velocity);
 
            // \frac{\Delta t}{\gamma}(-\nabla p + f) + inarray
            Vmath::Svtvp(phystot, aii_Dt, Forcing[i], 1, inarray[i], 1,
                         m_AdvVel[i], 1);
            // += \frac{\Delta t}{\gamma} -N(u)
            Vmath::Svtvp(phystot, aii_Dt, m_advection[i], 1, m_AdvVel[i], 1,
                         m_AdvVel[i], 1);
            // += -\frac{\Delta t}{\gamma} CurlCurl(u)
            Vmath::Svtvp(phystot, -aii_Dt * m_diffCoeff[i], velocity[i], 1,
                         m_AdvVel[i], 1, m_AdvVel[i], 1);
            // *= 1/\nu
            Vmath::Smul(phystot, 1.0 / m_diffCoeff[i], m_AdvVel[i], 1,
                        m_AdvVel[i], 1);
        }
    }
 
    // Build Forcing term
    for (int i = 0; i < nvel; ++i)
    {
        // \frac{\gamma}{\Delta t} * inarray - \nabla p + f
        Vmath::Svtvp(phystot, 1.0 / aii_Dt, inarray[i], 1, Forcing[i], 1,
                     Forcing[i], 1);
 
        // *= -1/kinvis
        Vmath::Smul(phystot, -1.0 / m_diffCoeff[i], Forcing[i], 1, Forcing[i],
                    1);
    }
}

References m_advection, m_advectionVelocity, m_AdvVel, Nektar::VelocityCorrectionScheme::m_diffCoeff, m_extVel, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::IncNavierStokes::m_forcing, m_intOrder, Nektar::IncNavierStokes::m_nConvectiveFields, Nektar::IncNavierStokes::m_pressure, Nektar::SolverUtils::EquationSystem::m_time, Nektar::SolverUtils::EquationSystem::m_timestep, Nektar::IncNavierStokes::m_velocity, Vmath::Neg(), Vmath::Smul(), Vmath::Svtvp(), and Vmath::Zero().

◆ v_SolvePressure()

void Nektar::VCSImplicit::v_SolvePressure ( const Array< OneD, NekDouble > & Forcing )

overrideprotectedvirtual

Solve pressure system via a Poisson problem with ContField::HelmSolve(). Uses coefficient space forcing and hence sets the argument PhysSpaceForcing=false in ContFieldHelmSolve().

Parameters

Forcing See output description in VCSImplicit::v_SetUpPressureForcing().

Reimplemented from Nektar::VelocityCorrectionScheme.

Definition at line 374 of file VelocityCorrectionSchemeImplicit.cpp.

{
    StdRegions::ConstFactorMap factors;
    // Setup coefficient for equation, Lambda = 0 ensures Poisson instead of
    // Helmholtz problem
    factors[StdRegions::eFactorLambda] = 0.0;
 
    // Solve Pressure Poisson Equation (with Weak Forcing)
    m_pressure->HelmSolve(Forcing, m_pressure->UpdateCoeffs(), factors,
                          StdRegions::NullVarCoeffMap,
                          MultiRegions::NullVarFactorsMap, NullNekDouble1DArray,
                          false);
 
    // Add presure to outflow bc if using convective like BCs
    m_extrapolation->AddPressureToOutflowBCs(m_kinvis);
}

References Nektar::StdRegions::eFactorLambda, Nektar::IncNavierStokes::m_extrapolation, Nektar::IncNavierStokes::m_kinvis, Nektar::IncNavierStokes::m_pressure, Nektar::NullNekDouble1DArray, Nektar::StdRegions::NullVarCoeffMap, and Nektar::MultiRegions::NullVarFactorsMap.

◆ v_SolveViscous()

void Nektar::VCSImplicit::v_SolveViscous	(	const Array< OneD, const Array< OneD, NekDouble > > &	Forcing,
		const Array< OneD, const Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray,
		const NekDouble	aii_Dt
	)

overrideprotectedvirtual

Solve velocity system via the ContField::LinearAdvectionDiffusionReactionSolve().

Parameters

Forcing	Holds the forcing term for each velocity component. See output description in VCSImplicit::v_SetUpViscousForcing().
inarray	Unused in this routine. Still, holds \(\sum_q \frac{\alpha_q}{\gamma} [u^{n-q}, v^{n-q}, \ldots] \).
outarray	Holds vector of previous solution \( [u^n, v^n, \ldots] \). Overwritten upon output with new solution [u^{n+1}, v^{n+1}, \ldots].

Additionally, the advection velocity \( \tilde{\mathbf{u}}^{n+1} \) is handed to the velocity solve via the array m_AdvVel. It is computed in VCSImplicit::v_SetUpViscousForcing(). It is defined as \( \tilde{\mathbf{u}}^{n+1} = \sum_q \frac{\alpha_q}{\gamma} \mathbf{u}^{n-q} - \frac{\Delta t}{\gamma} \left[ \nabla p^{n+1} - N(\mathbf{u})^n - \nu \nabla \times \omega^n + \mathbf{f}^{n+1} \right] \).

Reimplemented from Nektar::VelocityCorrectionScheme.

Definition at line 410 of file VelocityCorrectionSchemeImplicit.cpp.

{
    StdRegions::ConstFactorMap factors;
    StdRegions::VarCoeffMap varcoeffs;
    MultiRegions::VarFactorsMap varfactors = MultiRegions::NullVarFactorsMap;
 
    AppendSVVFactors(factors, varfactors);
    ComputeGJPNormalVelocity(inarray, varcoeffs);
 
    // Compute mass varcoeff for implicit Skew-symmetric operator
    AddImplicitSkewSymAdvection(varcoeffs, aii_Dt);
 
    // Set advection velocities
    StdRegions::VarCoeffType varcoefftypes[] = {StdRegions::eVarCoeffVelX,
                                                StdRegions::eVarCoeffVelY,
                                                StdRegions::eVarCoeffVelZ};
    for (int i = 0; i < m_velocity.size(); i++)
    {
        varcoeffs[varcoefftypes[i]] = m_AdvVel[i];
    }
 
    // Solve Advection-Diffusion-Reaction system
    for (int i = 0; i < m_nConvectiveFields; ++i)
    {
        // Add diffusion coefficient to GJP matrix operator (Implicit part)
        if (m_useGJPStabilisation)
        {
            factors[StdRegions::eFactorGJP] = m_GJPJumpScale / m_diffCoeff[i];
        }
 
        // \lambda = - /frac{\gamma}{\Delta t \nu}
        factors[StdRegions::eFactorLambda] = -1.0 / aii_Dt / m_diffCoeff[i];
 
        auto gkey = m_fields[i]->LinearAdvectionDiffusionReactionSolve(
            Forcing[i], m_fields[i]->UpdateCoeffs(), factors, varcoeffs,
            varfactors);
 
        // Nuke GlobalLinSys to avoid memory leak
        // The condition nukes, if:
        // - Remove after last velocity solve (w-velocity in 3D,
        // assumes same matrix for each velocity)
        // - Catches Null return from 3DH1D solve by checking matrix type
        // is a LinearADR matrix (variant)
        if (m_unsetGlobalLinSys[i] &&
            (gkey.GetMatrixType() ==
                 StdRegions::eLinearAdvectionDiffusionReaction ||
             gkey.GetMatrixType() ==
                 StdRegions::eLinearAdvectionDiffusionReactionGJP))
        {
            m_fields[i]->UnsetGlobalLinSys(gkey, true);
        }
 
        // Transform solution to PhysSpace
        m_fields[i]->BwdTrans(m_fields[i]->GetCoeffs(), outarray[i]);
    }
}

References AddImplicitSkewSymAdvection(), Nektar::VelocityCorrectionScheme::AppendSVVFactors(), Nektar::VelocityCorrectionScheme::ComputeGJPNormalVelocity(), Nektar::StdRegions::eFactorGJP, Nektar::StdRegions::eFactorLambda, Nektar::StdRegions::eLinearAdvectionDiffusionReaction, Nektar::StdRegions::eLinearAdvectionDiffusionReactionGJP, Nektar::StdRegions::eVarCoeffVelX, Nektar::StdRegions::eVarCoeffVelY, Nektar::StdRegions::eVarCoeffVelZ, m_AdvVel, Nektar::VelocityCorrectionScheme::m_diffCoeff, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::VelocityCorrectionScheme::m_GJPJumpScale, Nektar::IncNavierStokes::m_nConvectiveFields, m_unsetGlobalLinSys, Nektar::VelocityCorrectionScheme::m_useGJPStabilisation, Nektar::IncNavierStokes::m_velocity, and Nektar::MultiRegions::NullVarFactorsMap.

Friends And Related Symbol Documentation

◆ MemoryManager< VCSImplicit >

friend class MemoryManager< VCSImplicit >

friend

Definition at line 126 of file VelocityCorrectionSchemeImplicit.h.

Member Data Documentation

◆ className

string Nektar::VCSImplicit::className

static

Initial value:

=
    SolverUtils::GetEquationSystemFactory().RegisterCreatorFunction(
        "VCSImplicit", VCSImplicit::create)

Name of class.

Definition at line 59 of file VelocityCorrectionSchemeImplicit.h.

◆ m_advection

Array<OneD, Array<OneD, NekDouble> > Nektar::VCSImplicit::m_advection

protected

2D Array for Advection Velocities [dir][dof]

Definition at line 63 of file VelocityCorrectionSchemeImplicit.h.

Referenced by v_DoInitialise(), v_EvaluateAdvection_SetPressureBCs(), v_SetUpPressureForcing(), and v_SetUpViscousForcing().

◆ m_advectionVelocity

bool Nektar::VCSImplicit::m_advectionVelocity

protected

bool to identify implicit scheme ie advection velocity

Definition at line 67 of file VelocityCorrectionSchemeImplicit.h.

Referenced by v_DoInitialise(), v_EvaluateAdvection_SetPressureBCs(), and v_SetUpViscousForcing().

◆ m_AdvVel

Array<OneD, Array<OneD, NekDouble> > Nektar::VCSImplicit::m_AdvVel

protected

Definition at line 63 of file VelocityCorrectionSchemeImplicit.h.

Referenced by AddImplicitSkewSymAdvection(), v_DoInitialise(), v_SetUpViscousForcing(), and v_SolveViscous().

◆ m_convectiveType

std::string Nektar::VCSImplicit::m_convectiveType

protected

Definition at line 72 of file VelocityCorrectionSchemeImplicit.h.

◆ m_extVel

Array<OneD, Array<OneD, Array<OneD, NekDouble> > > Nektar::VCSImplicit::m_extVel

protected

3D Array for extrapolated Advection Velocities [dir][time-levle][dof]

Definition at line 65 of file VelocityCorrectionSchemeImplicit.h.

Referenced by v_DoInitialise(), v_EvaluateAdvection_SetPressureBCs(), and v_SetUpViscousForcing().

◆ m_implicitSkewSymAdvection

bool Nektar::VCSImplicit::m_implicitSkewSymAdvection

protected

bool to identify advection operator

Definition at line 69 of file VelocityCorrectionSchemeImplicit.h.

Referenced by AddImplicitSkewSymAdvection(), and v_DoInitialise().

◆ m_intOrder

int Nektar::VCSImplicit::m_intOrder

protected

integer for advection velocity

Definition at line 71 of file VelocityCorrectionSchemeImplicit.h.

Referenced by v_DoInitialise(), v_EvaluateAdvection_SetPressureBCs(), and v_SetUpViscousForcing().

◆ m_unsetGlobalLinSys

Array<OneD, int32_t> Nektar::VCSImplicit::m_unsetGlobalLinSys

protected

Array checking whether GlobalLinSys needs to be unset.

Definition at line 74 of file VelocityCorrectionSchemeImplicit.h.

Referenced by v_DoInitialise(), and v_SolveViscous().

◆ solverTypeLookupId

string Nektar::VCSImplicit::solverTypeLookupId

staticprotected

Initial value:

=
    LibUtilities::SessionReader::RegisterEnumValue("SolverType", "VCSImplicit",
                                                   eVCSImplicit)

Definition at line 114 of file VelocityCorrectionSchemeImplicit.h.

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VCSImplicit()

◆ ~VCSImplicit()

Member Function Documentation

◆ AddImplicitSkewSymAdvection()

◆ CheckUnsetGlobalLinSys()

◆ create()

◆ v_DoInitialise()

◆ v_EvaluateAdvection_SetPressureBCs()

◆ v_GenerateSummary()

◆ v_GetExtrapolateStr()

◆ v_SetUpPressureForcing()

◆ v_SetUpViscousForcing()

◆ v_SolvePressure()

◆ v_SolveViscous()

Friends And Related Symbol Documentation

◆ MemoryManager< VCSImplicit >

Member Data Documentation

◆ className

◆ m_advection

◆ m_advectionVelocity

◆ m_AdvVel

◆ m_convectiveType

◆ m_extVel

◆ m_implicitSkewSymAdvection

◆ m_intOrder

◆ m_unsetGlobalLinSys

◆ solverTypeLookupId