A base class for PDEs which include an advection component. More...

#include <AdvectionSystem.h>

Inheritance diagram for Nektar::SolverUtils::AdvectionSystem:

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

SOLVER_UTILS_EXPORT	~AdvectionSystem () override

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

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

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

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

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

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

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

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

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

SOLVER_UTILS_EXPORT void	DoSolve ()
	Solve the problem. More...

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

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

SOLVER_UTILS_EXPORT void	Output ()
	Perform output operations after solve. More...

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

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

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

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

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

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

SOLVER_UTILS_EXPORT void	SetLambda (NekDouble lambda)
	Set parameter m_lambda. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SOLVER_UTILS_EXPORT NekDouble	GetTime ()
	Return final time. More...

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 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	SetSteps (const int steps)

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

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

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

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)

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

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)

Protected Member Functions
SOLVER_UTILS_EXPORT bool	v_PostIntegrate (int step) override

virtual SOLVER_UTILS_EXPORT Array< OneD, NekDouble >	v_GetMaxStdVelocity (const NekDouble SpeedSoundFactor=1.0)

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

SOLVER_UTILS_EXPORT void	v_InitObject (bool DeclareField=true) override
	Init object for UnsteadySystem class. More...

SOLVER_UTILS_EXPORT void	v_DoSolve () override
	Solves an unsteady problem. More...

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

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

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

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

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

virtual SOLVER_UTILS_EXPORT bool	v_PreIntegrate (int step)

virtual SOLVER_UTILS_EXPORT bool	v_PostIntegrate (int step)

virtual SOLVER_UTILS_EXPORT bool	v_RequireFwdTrans ()

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

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

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

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

virtual SOLVER_UTILS_EXPORT void	v_InitObject (bool DeclareFeld=true)
	Initialisation object for EquationSystem. More...

virtual SOLVER_UTILS_EXPORT void	v_DoInitialise (bool dumpInitialConditions=true)
	Virtual function for initialisation implementation. More...

virtual SOLVER_UTILS_EXPORT void	v_DoSolve ()
	Virtual function for solve implementation. More...

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

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

virtual SOLVER_UTILS_EXPORT void	v_TransCoeffToPhys ()
	Virtual function for transformation to physical space. More...

virtual SOLVER_UTILS_EXPORT void	v_TransPhysToCoeff ()
	Virtual function for transformation to coefficient space. More...

virtual SOLVER_UTILS_EXPORT void	v_GenerateSummary (SummaryList &l)
	Virtual function for generating summary information. More...

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 MultiRegions::ExpListSharedPtr	v_GetPressure (void)

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

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

Protected Attributes
SolverUtils::AdvectionSharedPtr	m_advObject
	Advection term. More...

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

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

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

std::vector< int >	m_intVariables

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

NekDouble	m_CFLGrowth
	CFL growth rate. More...

NekDouble	m_CFLEnd
	Maximun cfl in cfl growth. More...

int	m_abortSteps
	Number of steps between checks for abort conditions. More...

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

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

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

int	m_steadyStateSteps
	Check for steady state at step interval. More...

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

int	m_filtersInfosteps
	Number of time steps between outputting filters information. More...

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

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

std::ofstream	m_errFile

NekDouble	m_epsilon
	Diffusion coefficient. More...

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

bool	m_verbose

LibUtilities::SessionReaderSharedPtr	m_session
	The session reader. More...

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

LibUtilities::FieldIOSharedPtr	m_fld
	Field input/output. More...

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

SpatialDomains::BoundaryConditionsSharedPtr	m_boundaryConditions
	Pointer to boundary conditions object. More...

SpatialDomains::MeshGraphSharedPtr	m_graph
	Pointer to graph defining mesh. More...

std::string	m_sessionName
	Name of the session. More...

NekDouble	m_time
	Current time of simulation. More...

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

NekDouble	m_fintime
	Finish time of the simulation. More...

NekDouble	m_timestep
	Time step size. More...

NekDouble	m_lambda
	Lambda constant in real system if one required. More...

NekDouble	m_checktime
	Time between checkpoints. More...

NekDouble	m_lastCheckTime

NekDouble	m_TimeIncrementFactor

int	m_nchk
	Number of checkpoints written so far. More...

int	m_steps
	Number of steps to take. More...

int	m_checksteps
	Number of steps between checkpoints. More...

int	m_infosteps
	Number of time steps between outputting status information. More...

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

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

int	m_spacedim
	Spatial dimension (>= expansion dim). More...

int	m_expdim
	Expansion dimension. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

enum HomogeneousType	m_HomogeneousType

NekDouble	m_LhomX
	physical length in X direction (if homogeneous) More...

NekDouble	m_LhomY
	physical length in Y direction (if homogeneous) More...

NekDouble	m_LhomZ
	physical length in Z direction (if homogeneous) More...

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

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

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

int	m_HomoDirec
	number of homogenous directions More...

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_ImplicitALESolver = false

NekDouble	m_prevStageTime = 0.0

int	m_spaceDim

Private Attributes
int	m_cflsteps
	Dump cfl estimate. More...

NekDouble	m_cflWriteFld
	Write field if cfl is higher than IO_CFLWriteFld treshold. More...

int	m_cflWriteFldWaitSteps
	Number of timesteps after which IO_CFLWriteFld is activated. More...

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

static std::string	cmdSetStartChkNum

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

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

static std::string	projectionTypeLookupIds []

Detailed Description

A base class for PDEs which include an advection component.

Definition at line 45 of file AdvectionSystem.h.

Constructor & Destructor Documentation

◆ AdvectionSystem()

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

Definition at line 43 of file AdvectionSystem.cpp.

    : UnsteadySystem(pSession, pGraph)
{
}

◆ ~AdvectionSystem()

Nektar::SolverUtils::AdvectionSystem::~AdvectionSystem ( )

override

Definition at line 53 of file AdvectionSystem.cpp.

54{

55}

Member Function Documentation

◆ GetAdvObject()

SOLVER_UTILS_EXPORT AdvectionSharedPtr Nektar::SolverUtils::AdvectionSystem::GetAdvObject ( )

inline

Returns the advection object held by this instance.

Definition at line 57 of file AdvectionSystem.h.

    {
        return m_advObject;
    }

References m_advObject.

◆ GetCFLEstimate()

NekDouble Nektar::SolverUtils::AdvectionSystem::GetCFLEstimate ( int & elmtid )

Definition at line 144 of file AdvectionSystem.cpp.

{
    int n_element = m_fields[0]->GetExpSize();
 
    Array<OneD, NekDouble> cfl = GetElmtCFLVals();
 
    elmtid = Vmath::Imax(n_element, cfl, 1);
 
    NekDouble CFL, CFL_loc;
    CFL = CFL_loc = cfl[elmtid];
    m_comm->GetSpaceComm()->AllReduce(CFL, LibUtilities::ReduceMax);
 
    // unshuffle elmt id if data is not stored in consecutive order.
    elmtid = m_fields[0]->GetExp(elmtid)->GetGeom()->GetGlobalID();
    if (CFL != CFL_loc)
    {
        elmtid = -1;
    }
 
    m_comm->GetSpaceComm()->AllReduce(elmtid, LibUtilities::ReduceMax);
 
    // express element id with respect to plane
    if (m_HomogeneousType == eHomogeneous1D)
    {
        elmtid = elmtid % m_fields[0]->GetPlane(0)->GetExpSize();
    }
    return CFL;
}

References Nektar::SolverUtils::EquationSystem::eHomogeneous1D, GetElmtCFLVals(), Vmath::Imax(), Nektar::SolverUtils::EquationSystem::m_comm, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_HomogeneousType, and Nektar::LibUtilities::ReduceMax.

Referenced by v_PostIntegrate().

◆ GetElmtCFLVals()

Array< OneD, NekDouble > Nektar::SolverUtils::AdvectionSystem::GetElmtCFLVals ( const bool FlagAcousticCFL = true )

Definition at line 111 of file AdvectionSystem.cpp.

{
    int nelmt = m_fields[0]->GetExpSize();
 
    const Array<OneD, int> expOrder = GetNumExpModesPerExp();
 
    const NekDouble cLambda = 0.2; // Spencer book pag. 317
 
    Array<OneD, NekDouble> stdVelocity(nelmt, 0.0);
    if (FlagAcousticCFL)
    {
        stdVelocity = v_GetMaxStdVelocity();
    }
    else
    {
        stdVelocity = v_GetMaxStdVelocity(0.0);
    }
 
    Array<OneD, NekDouble> cfl(nelmt, 0.0);
    NekDouble order;
    for (int el = 0; el < nelmt; ++el)
    {
        order   = std::max(expOrder[el] - 1, 1);
        cfl[el] = m_timestep * (stdVelocity[el] * cLambda * order * order);
    }
 
    return cfl;
}

References Nektar::SolverUtils::EquationSystem::GetNumExpModesPerExp(), Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_timestep, and v_GetMaxStdVelocity().

Referenced by GetCFLEstimate(), and Nektar::CompressibleFlowSystem::GetElmtTimeStep().

◆ v_GetMaxStdVelocity()

virtual SOLVER_UTILS_EXPORT Array< OneD, NekDouble > Nektar::SolverUtils::AdvectionSystem::v_GetMaxStdVelocity ( const NekDouble SpeedSoundFactor = 1.0 )

inlineprotectedvirtual

Reimplemented in Nektar::AcousticSystem, Nektar::CompressibleFlowSystem, and Nektar::IncNavierStokes.

Definition at line 73 of file AdvectionSystem.h.

    {
        ASSERTL0(false,
                 "v_GetMaxStdVelocity is not implemented by the base class.");
        Array<OneD, NekDouble> dummy(1);
        return dummy;
    }

References ASSERTL0.

Referenced by GetElmtCFLVals().

◆ v_InitObject()

void Nektar::SolverUtils::AdvectionSystem::v_InitObject ( bool DeclareFeld = true )

overridevirtual

Initialisation object for EquationSystem.

Continuous field

Setting up the normals

Reimplemented from Nektar::SolverUtils::EquationSystem.

Reimplemented in Nektar::NavierStokesCFE, Nektar::ImageWarpingSystem, Nektar::CoupledLinearNS, Nektar::IncNavierStokes, Nektar::SmoothedProfileMethod, Nektar::VCSMapping, Nektar::VelocityCorrectionScheme, Nektar::SolverUtils::FileSolution, Nektar::AcousticSystem, Nektar::APE, Nektar::LEE, Nektar::CFLtester, Nektar::MMFAdvection, Nektar::UnsteadyAdvection, Nektar::UnsteadyAdvectionDiffusion, Nektar::UnsteadyInviscidBurgers, Nektar::UnsteadyViscousBurgers, Nektar::CompressibleFlowSystem, Nektar::CFSImplicit, Nektar::EulerCFE, Nektar::EulerImplicitCFE, Nektar::NavierStokesCFEAxisym, and Nektar::NavierStokesImplicitCFE.

Definition at line 60 of file AdvectionSystem.cpp.

{
    UnsteadySystem::v_InitObject(DeclareField);
    m_session->LoadParameter("IO_CFLSteps", m_cflsteps, 0);
    m_session->LoadParameter("IO_CFLWriteFld", m_cflWriteFld, 0);
    m_session->LoadParameter("IO_CFLWriteFldWaitSteps", m_cflWriteFldWaitSteps,
                             0);
}

References m_cflsteps, m_cflWriteFld, m_cflWriteFldWaitSteps, Nektar::SolverUtils::EquationSystem::m_session, and Nektar::SolverUtils::UnsteadySystem::v_InitObject().

Referenced by Nektar::ImageWarpingSystem::v_InitObject(), Nektar::IncNavierStokes::v_InitObject(), Nektar::SolverUtils::FileSolution::v_InitObject(), Nektar::AcousticSystem::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyInviscidBurgers::v_InitObject(), and Nektar::CompressibleFlowSystem::v_InitObject().

◆ v_PostIntegrate()

bool Nektar::SolverUtils::AdvectionSystem::v_PostIntegrate ( int step )

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

Reimplemented in Nektar::VelocityCorrectionScheme, and Nektar::SolverUtils::FileSolution.

Definition at line 72 of file AdvectionSystem.cpp.

{
    bool result = UnsteadySystem::v_PostIntegrate(step);
 
    if ((m_cflsteps && !((step + 1) % m_cflsteps)) || m_cflWriteFld > 0)
    {
        int elmtid;
        NekDouble cfl = GetCFLEstimate(elmtid);
 
        if (m_cflsteps && !((step + 1) % m_cflsteps) && m_comm->GetRank() == 0)
        {
            if (m_HomogeneousType == eNotHomogeneous)
            {
                std::cout << "CFL: ";
            }
            else
            {
                std::cout << "CFL (zero plane): ";
            }
            std::cout << cfl << " (in elmt " << elmtid << ")" << std::endl;
        }
 
        // At each timestep, if cflWriteFld is set check if cfl is above
        // treshold
        if (m_cflWriteFld > 0 && cfl >= m_cflWriteFld &&
            step >= m_cflWriteFldWaitSteps)
        {
            std::string outname = m_sessionName + "_CFLWriteFld";
            WriteFld(outname + ".fld");
            m_cflWriteFld = 0;
        }
    }
 
    return result;
}

References Nektar::SolverUtils::EquationSystem::eNotHomogeneous, GetCFLEstimate(), m_cflsteps, m_cflWriteFld, m_cflWriteFldWaitSteps, Nektar::SolverUtils::EquationSystem::m_comm, Nektar::SolverUtils::EquationSystem::m_HomogeneousType, Nektar::SolverUtils::EquationSystem::m_sessionName, Nektar::SolverUtils::UnsteadySystem::v_PostIntegrate(), and Nektar::SolverUtils::EquationSystem::WriteFld().

Referenced by Nektar::VelocityCorrectionScheme::v_PostIntegrate().

Member Data Documentation

◆ m_advObject

SolverUtils::AdvectionSharedPtr Nektar::SolverUtils::AdvectionSystem::m_advObject

protected

Advection term.

Definition at line 69 of file AdvectionSystem.h.

Referenced by Nektar::CFSImplicit::AddMatNSBlkDiagBnd(), Nektar::CFSImplicit::CalcTraceNumericalFlux(), Nektar::CompressibleFlowSystem::DoAdvection(), Nektar::CFSImplicit::DoAdvectionCoeff(), Nektar::MMFAdvection::DoOdeRhs(), Nektar::UnsteadyAdvection::DoOdeRhs(), Nektar::UnsteadyInviscidBurgers::DoOdeRhs(), Nektar::ImageWarpingSystem::DoOdeRhs(), Nektar::IncNavierStokes::EvaluateAdvectionTerms(), GetAdvObject(), Nektar::CompressibleFlowSystem::InitAdvection(), Nektar::VelocityCorrectionScheme::SetUpExtrapolation(), Nektar::UnsteadyAdvectionDiffusion::SubStepAdvection(), Nektar::ImageWarpingSystem::v_InitObject(), Nektar::CoupledLinearNS::v_InitObject(), Nektar::IncNavierStokes::v_InitObject(), Nektar::VCSMapping::v_InitObject(), Nektar::MMFAdvection::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurgers::v_InitObject(), and Nektar::UnsteadyViscousBurgers::v_InitObject().

◆ m_cflsteps

int Nektar::SolverUtils::AdvectionSystem::m_cflsteps

private

Dump cfl estimate.

Definition at line 84 of file AdvectionSystem.h.

Referenced by v_InitObject(), and v_PostIntegrate().

◆ m_cflWriteFld

NekDouble Nektar::SolverUtils::AdvectionSystem::m_cflWriteFld

private

Write field if cfl is higher than IO_CFLWriteFld treshold.

Definition at line 86 of file AdvectionSystem.h.

Referenced by v_InitObject(), and v_PostIntegrate().

◆ m_cflWriteFldWaitSteps

int Nektar::SolverUtils::AdvectionSystem::m_cflWriteFldWaitSteps

private

Number of timesteps after which IO_CFLWriteFld is activated.

Definition at line 88 of file AdvectionSystem.h.

Referenced by v_InitObject(), and v_PostIntegrate().

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AdvectionSystem()

◆ ~AdvectionSystem()

Member Function Documentation

◆ GetAdvObject()

◆ GetCFLEstimate()

◆ GetElmtCFLVals()

◆ v_GetMaxStdVelocity()

◆ v_InitObject()

◆ v_PostIntegrate()

Member Data Documentation

◆ m_advObject

◆ m_cflsteps

◆ m_cflWriteFld

◆ m_cflWriteFldWaitSteps