A base class for PDEs which include an advection component. More...
#include <AdvectionSystem.h>
Protected Member Functions | |
| virtual 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 NekDouble | MaxTimeStepEstimator () |
| Get the maximum timestep estimator for cfl control. More... | |
| virtual SOLVER_UTILS_EXPORT void | v_DoSolve () override |
| Solves an unsteady problem. More... | |
| virtual SOLVER_UTILS_EXPORT void | v_DoInitialise () override |
| Sets up initial conditions. More... | |
| virtual 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_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 | v_UpdateTimeStepCheck () |
| 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 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_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 |
| 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_infosteps |
| Number of time steps between outputting status information. More... | |
| int | m_pararealIter |
| Number of parareal 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_useInitialCondition |
| Flag to determine if IC are used. 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_movingFrameVelsxyz |
| Moving frame of reference velocities. More... | |
| Array< OneD, NekDouble > | m_movingFrameTheta |
| Moving frame of reference angles with respect to the. More... | |
| boost::numeric::ublas::matrix< NekDouble > | m_movingFrameProjMat |
| Projection matrix for transformation between inertial and moving. 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... | |
| 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 [] |
Detailed Description
A base class for PDEs which include an advection component.
Definition at line 47 of file AdvectionSystem.h.
Constructor & Destructor Documentation
◆ AdvectionSystem()
| Nektar::SolverUtils::AdvectionSystem::AdvectionSystem | ( | const LibUtilities::SessionReaderSharedPtr & | pSession, |
| const SpatialDomains::MeshGraphSharedPtr & | pGraph | ||
| ) |
Definition at line 45 of file AdvectionSystem.cpp.
◆ ~AdvectionSystem()
|
virtual |
Definition at line 55 of file AdvectionSystem.cpp.
Member Function Documentation
◆ GetAdvObject()
|
inline |
Returns the advection object held by this instance.
Definition at line 60 of file AdvectionSystem.h.
References m_advObject.
◆ GetCFLEstimate()
| NekDouble Nektar::SolverUtils::AdvectionSystem::GetCFLEstimate | ( | int & | elmtid | ) |
Definition at line 146 of file AdvectionSystem.cpp.
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 113 of file AdvectionSystem.cpp.
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()
|
inlineprotectedvirtual |
Reimplemented in Nektar::IncNavierStokes, Nektar::CompressibleFlowSystem, and Nektar::AcousticSystem.
Definition at line 75 of file AdvectionSystem.h.
References ASSERTL0.
Referenced by GetElmtCFLVals().
◆ v_InitObject()
|
overridevirtual |
Init object for UnsteadySystem class.
Initialization object for UnsteadySystem class.
Reimplemented from Nektar::SolverUtils::UnsteadySystem.
Reimplemented in Nektar::NavierStokesImplicitCFE, Nektar::NavierStokesCFEAxisym, Nektar::EulerImplicitCFE, Nektar::EulerCFE, Nektar::CFSImplicit, Nektar::CompressibleFlowSystem, Nektar::UnsteadyViscousBurgers, Nektar::UnsteadyInviscidBurger, Nektar::UnsteadyAdvectionDiffusion, Nektar::UnsteadyAdvection, Nektar::MMFAdvection, Nektar::CFLtester, Nektar::LEE, Nektar::APE, Nektar::AcousticSystem, Nektar::VelocityCorrectionScheme, Nektar::VCSMapping, Nektar::SmoothedProfileMethod, Nektar::IncNavierStokes, Nektar::CoupledLinearNS, Nektar::ImageWarpingSystem, and Nektar::NavierStokesCFE.
Definition at line 62 of file AdvectionSystem.cpp.
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::AcousticSystem::v_InitObject(), Nektar::CFLtester::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurger::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), and Nektar::CompressibleFlowSystem::v_InitObject().
◆ v_PostIntegrate()
|
overrideprotectedvirtual |
Reimplemented from Nektar::SolverUtils::UnsteadySystem.
Reimplemented in Nektar::VelocityCorrectionScheme.
Definition at line 74 of file AdvectionSystem.cpp.
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
|
protected |
Advection term.
Definition at line 71 of file AdvectionSystem.h.
Referenced by Nektar::CFSImplicit::AddMatNSBlkDiagBnd(), Nektar::CFSImplicit::CalcTraceNumericalFlux(), Nektar::CompressibleFlowSystem::DoAdvection(), Nektar::CFSImplicit::DoAdvectionCoeff(), Nektar::CFLtester::DoOdeRhs(), Nektar::MMFAdvection::DoOdeRhs(), Nektar::UnsteadyAdvection::DoOdeRhs(), Nektar::UnsteadyAdvectionDiffusion::DoOdeRhs(), Nektar::UnsteadyInviscidBurger::DoOdeRhs(), Nektar::UnsteadyViscousBurgers::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::CFLtester::v_InitObject(), Nektar::MMFAdvection::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyInviscidBurger::v_InitObject(), and Nektar::UnsteadyViscousBurgers::v_InitObject().
◆ m_cflsteps
|
private |
dump cfl estimate
Definition at line 87 of file AdvectionSystem.h.
Referenced by v_InitObject(), and v_PostIntegrate().
◆ m_cflWriteFld
|
private |
Write field if cfl is higher than IO_CFLWriteFld treshold.
Definition at line 89 of file AdvectionSystem.h.
Referenced by v_InitObject(), and v_PostIntegrate().
◆ m_cflWriteFldWaitSteps
|
private |
Number of timesteps after which IO_CFLWriteFld is activated.
Definition at line 91 of file AdvectionSystem.h.
Referenced by v_InitObject(), and v_PostIntegrate().
