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)

virtual SOLVER_UTILS_EXPORT	~AdvectionSystem ()

virtual SOLVER_UTILS_EXPORT void	v_InitObject ()
	Init object for UnsteadySystem class. 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
virtual SOLVER_UTILS_EXPORT	~UnsteadySystem ()
	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 void	SteadyStateResidual (int step, Array< OneD, NekDouble > &L2)

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

SOLVER_UTILS_EXPORT void	SetUpTraceNormals (void)

SOLVER_UTILS_EXPORT void	InitObject ()
	Initialises the members of this object. More...

SOLVER_UTILS_EXPORT void	DoInitialise ()
	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 NekDouble	LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Linf error computation. 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 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	GetFinalTime ()
	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, Array< OneD, NekDouble > &output)

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 void	SetTime (const NekDouble time)

SOLVER_UTILS_EXPORT void	SetInitialStep (const int step)

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

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

Protected Member Functions
virtual SOLVER_UTILS_EXPORT bool	v_PostIntegrate (int step)

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 NekDouble	MaxTimeStepEstimator ()
	Get the maximum timestep estimator for cfl control. More...

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

virtual SOLVER_UTILS_EXPORT void	v_DoInitialise ()
	Sets up initial conditions. More...

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

virtual SOLVER_UTILS_EXPORT void	v_AppendOutput1D (Array< OneD, Array< OneD, NekDouble >> &solution1D)
	Print the solution at each solution point in a txt file. 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_RequireFwdTrans ()

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

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

virtual SOLVER_UTILS_EXPORT bool	UpdateTimeStepCheck ()

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 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_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 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
int	m_infosteps
	Number of time steps between outputting status information. More...

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

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

int	m_nanSteps

LibUtilities::TimeIntegrationSchemeSharedPtr	m_intScheme
	Wrapper to the time integration scheme. More...

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

NekDouble	m_epsilon

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

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

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

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

NekDouble	m_steadyStateRes = 1.0

NekDouble	m_steadyStateRes0 = 1.0

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

std::ofstream	m_errFile

std::vector< int >	m_intVariables

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

NekDouble	m_filterTimeWarning
	Number of time steps between outputting status information. More...

NekDouble	m_TimeIntegLambda =0.0
	coefff of spacial derivatives(rhs or m_F in GLM) in calculating the residual of the whole equation(used in unsteady time integrations) More...

bool	m_flagImplicitItsStatistics

bool	m_flagImplicitSolver = false

Array< OneD, NekDouble >	m_magnitdEstimat
	estimate the magnitude of each conserved varibles More...

Array< OneD, NekDouble >	m_locTimeStep
	local time step(notice only for jfnk other see m_cflSafetyFactor) More...

NekDouble	m_inArrayNorm =-1.0

int	m_TotLinItePerStep =0

int	m_StagesPerStep =1

bool	m_flagUpdatePreconMat

int	m_maxLinItePerNewton

int	m_TotNewtonIts =0

int	m_TotLinIts =0

int	m_TotImpStages =0

bool	m_CalcPhysicalAV = true
	flag to update artificial viscosity More...

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

bool	m_verbose

bool	m_root

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_timestepMax = -1.0
	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_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...

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

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
Public Attributes inherited from Nektar::SolverUtils::UnsteadySystem
NekDouble	m_cflSafetyFactor
	CFL safety factor (comprise between 0 to 1). More...

NekDouble	m_cflNonAcoustic

NekDouble	m_CFLGrowth
	CFL growth rate. More...

NekDouble	m_CFLEnd
	maximun cfl in cfl growth More...

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 []

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 ( )

virtual

Definition at line 54 of file AdvectionSystem.cpp.

 {
  
 }

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 143 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->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->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(), Nektar::CompressibleFlowSystem::GetElmtTimeStep(), and Nektar::CompressibleFlowSystem::v_GetTimeStep().

◆ v_GetMaxStdVelocity()

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

inlineprotectedvirtual

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

Definition at line 73 of file AdvectionSystem.h.

     {
         boost::ignore_unused(SpeedSoundFactor);
         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 ( )

virtual

Init object for UnsteadySystem class.

Initialization object for UnsteadySystem class.

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

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

Definition at line 63 of file AdvectionSystem.cpp.

 {
     UnsteadySystem::v_InitObject();
     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::AcousticSystem::v_InitObject(), Nektar::CFLtester::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurger::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), Nektar::CompressibleFlowSystem::v_InitObject(), Nektar::ImageWarpingSystem::v_InitObject(), and Nektar::IncNavierStokes::v_InitObject().

◆ v_PostIntegrate()

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

protectedvirtual

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

Reimplemented in Nektar::VelocityCorrectionScheme.

Definition at line 74 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 68 of file AdvectionSystem.h.

◆ 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