Base class for unsteady solvers. More...

#include <UnsteadySystem.h>

Inheritance diagram for Nektar::SolverUtils::UnsteadySystem:

Public Member Functions
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...

Public Attributes
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 Member Functions
SOLVER_UTILS_EXPORT	UnsteadySystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Initialises UnsteadySystem class members. More...

virtual SOLVER_UTILS_EXPORT void	v_InitObject ()
	Init object for UnsteadySystem class. 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_PostIntegrate (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
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 Member Functions
void	InitializeSteadyState ()

bool	CheckSteadyState (int step)
	Calculate whether the system has reached a steady state by observing residuals to a user-defined tolerance. More...

bool	CheckSteadyState (int step, NekDouble totCPUTime)

Additional Inherited Members
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

Base class for unsteady solvers.

Provides the underlying timestepping framework for unsteady solvers including the general timestepping routines. This class is not intended to be directly instantiated, but rather is a base class on which to define unsteady solvers.

For details on implementing unsteady solvers see sectionADRSolverModuleImplementation here

Definition at line 48 of file UnsteadySystem.h.

Constructor & Destructor Documentation

◆ ~UnsteadySystem()

Nektar::SolverUtils::UnsteadySystem::~UnsteadySystem ( )

virtual

Destructor.

Destructor for the class UnsteadyAdvection.

Definition at line 184 of file UnsteadySystem.cpp.

185 {

186 }

◆ UnsteadySystem()

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

protected

Initialises UnsteadySystem class members.

Processes SolverInfo parameters from the session file and sets up timestepping-specific code.

Parameters

pSession Session object to read parameters from.

Definition at line 69 of file UnsteadySystem.cpp.

             : EquationSystem(pSession, pGraph),
               m_infosteps(10)
  
         {
         }

Member Function Documentation

◆ CheckForRestartTime()

void Nektar::SolverUtils::UnsteadySystem::CheckForRestartTime	(	NekDouble &	time,
		int &	nchk
	)

protected

Definition at line 662 of file UnsteadySystem.cpp.

         {
             if (m_session->DefinesFunction("InitialConditions"))
             {
                 for (int i = 0; i < m_fields.size(); ++i)
                 {
                     LibUtilities::FunctionType vType;
  
                     vType = m_session->GetFunctionType(
                         "InitialConditions", m_session->GetVariable(i));
  
                     if (vType == LibUtilities::eFunctionTypeFile)
                     {
                         std::string filename
                             = m_session->GetFunctionFilename(
                                 "InitialConditions", m_session->GetVariable(i));
  
                         fs::path pfilename(filename);
  
                         // redefine path for parallel file which is in directory
                         if(fs::is_directory(pfilename))
                         {
                             fs::path metafile("Info.xml");
                             fs::path fullpath = pfilename / metafile;
                             filename = LibUtilities::PortablePath(fullpath);
                         }
                         LibUtilities::FieldIOSharedPtr fld =
                             LibUtilities::FieldIO::CreateForFile(
                                 m_session, filename);
                         fld->ImportFieldMetaData(filename, m_fieldMetaDataMap);
  
                         // check to see if time defined
                         if (m_fieldMetaDataMap !=
                                 LibUtilities::NullFieldMetaDataMap)
                         {
                             auto iter = m_fieldMetaDataMap.find("Time");
                             if (iter != m_fieldMetaDataMap.end())
                             {
                                 time = boost::lexical_cast<NekDouble>(
                                     iter->second);
                             }
  
                             iter = m_fieldMetaDataMap.find("ChkFileNum");
                             if (iter != m_fieldMetaDataMap.end())
                             {
                                 nchk = boost::lexical_cast<NekDouble>(
                                     iter->second);
                             }
                         }
  
                         break;
                     }
                 }
             }
         }

References Nektar::LibUtilities::FieldIO::CreateForFile(), Nektar::LibUtilities::eFunctionTypeFile, Nektar::SolverUtils::EquationSystem::m_fieldMetaDataMap, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_session, Nektar::LibUtilities::NullFieldMetaDataMap, and Nektar::LibUtilities::PortablePath().

Referenced by v_DoInitialise().

◆ CheckSteadyState() [1/2]

bool Nektar::SolverUtils::UnsteadySystem::CheckSteadyState ( int step )

private

Calculate whether the system has reached a steady state by observing residuals to a user-defined tolerance.

Definition at line 839 of file UnsteadySystem.cpp.

         {
             return CheckSteadyState(step,0.0);
         }

Referenced by v_DoSolve().

◆ CheckSteadyState() [2/2]

bool Nektar::SolverUtils::UnsteadySystem::CheckSteadyState	(	int	step,
		NekDouble	totCPUTime
	)

private

Definition at line 844 of file UnsteadySystem.cpp.

         {
             const int nPoints = GetTotPoints();
             const int nFields = m_fields.size();
  
             // Holds L2 errors.
             Array<OneD, NekDouble> L2       (nFields);
  
             SteadyStateResidual(step, L2);
  
             if (m_comm->GetRank() == 0 && ( ((step+1) % m_infosteps == 0)||((step== m_initialStep)) ))
             {
                 // Output time
                 m_errFile << boost::format("%25.19e") % m_time;
  
                 m_errFile << " "<< boost::format("%25.19e") % totCPUTime;
  
                 int stepp = step +1;
  
                 m_errFile << " "<< boost::format("%25.19e") % stepp;
  
                 // Output residuals
                 for (int i = 0; i < nFields; ++i)
                 {
                     m_errFile << " " << boost::format("%25.19e") % L2[i];
                 }
  
                 m_errFile << endl;
             }
  
             // Calculate maximum L2 error
             NekDouble maxL2 = Vmath::Vmax(nFields, L2, 1);
  
             if (m_session->DefinesCmdLineArgument("verbose") &&
                 m_comm->GetRank() == 0 && ((step+1) % m_infosteps == 0))
             {
                 cout << "-- Maximum L^2 residual: " << maxL2 << endl;
             }
  
             if (maxL2 <= m_steadyStateTol)
             {
                 return true;
             }
  
             for (int i = 0; i < m_fields.size(); ++i)
             {
                 Vmath::Vcopy(nPoints, m_fields[i]->GetPhys(), 1,
                                       m_previousSolution[i], 1);
             }
  
             m_steadyStateRes0 = m_steadyStateRes;
             m_steadyStateRes = maxL2;
  
             return false;
         }

References CellMLToNektar.pycml::format, Nektar::SolverUtils::EquationSystem::GetTotPoints(), Nektar::SolverUtils::EquationSystem::m_comm, m_errFile, Nektar::SolverUtils::EquationSystem::m_fields, m_infosteps, Nektar::SolverUtils::EquationSystem::m_initialStep, m_previousSolution, Nektar::SolverUtils::EquationSystem::m_session, m_steadyStateRes, m_steadyStateRes0, m_steadyStateTol, Nektar::SolverUtils::EquationSystem::m_time, SteadyStateResidual(), Vmath::Vcopy(), and Vmath::Vmax().

◆ GetTimeStep()

NekDouble Nektar::SolverUtils::UnsteadySystem::GetTimeStep ( const Array< OneD, const Array< OneD, NekDouble >> & inarray )

Calculate the larger time-step mantaining the problem stable.

Return the timestep to be used for the next step in the time-marching loop.

This function can be overloaded to facilitate solver which utilise a CFL (or other) parameter to determine a maximum timestep under which the problem remains stable.

Definition at line 726 of file UnsteadySystem.cpp.

         {
             return v_GetTimeStep(inarray);
         }

References v_GetTimeStep().

◆ InitializeSteadyState()

void Nektar::SolverUtils::UnsteadySystem::InitializeSteadyState ( )

private

Definition at line 799 of file UnsteadySystem.cpp.

         {
             if (m_steadyStateTol > 0.0)
             {
                 const int nPoints = m_fields[0]->GetTotPoints();
                 m_previousSolution = Array<OneD, Array<OneD, NekDouble> > (
                             m_fields.size());
  
                 for (int i = 0; i < m_fields.size(); ++i)
                 {
                     m_previousSolution[i] = Array<OneD, NekDouble>(nPoints);
                     Vmath::Vcopy(nPoints, m_fields[i]->GetPhys(), 1,
                                           m_previousSolution[i], 1);
                 }
  
                 if (m_comm->GetRank() == 0)
                 {
                     std::string fName = m_session->GetSessionName() +
                         std::string(".resd");
                     m_errFile.open(fName.c_str());
                     m_errFile << setw(26) << left << "# Time";
  
                     m_errFile << setw(26) << left << "CPU_Time";
  
                     m_errFile << setw(26) << left << "Step";
  
                     for (int i = 0; i < m_fields.size(); ++i)
                     {
                        m_errFile << setw(26) << m_session->GetVariables()[i];
                     }
  
                     m_errFile << endl;
                 }
             }
         }

References Nektar::SolverUtils::EquationSystem::m_comm, m_errFile, Nektar::SolverUtils::EquationSystem::m_fields, m_previousSolution, Nektar::SolverUtils::EquationSystem::m_session, m_steadyStateTol, and Vmath::Vcopy().

Referenced by v_DoInitialise().

◆ MaxTimeStepEstimator()

NekDouble Nektar::SolverUtils::UnsteadySystem::MaxTimeStepEstimator ( )

protected

Get the maximum timestep estimator for cfl control.

Returns the maximum time estimator for CFL control.

Definition at line 191 of file UnsteadySystem.cpp.

         {
             return m_intScheme->GetTimeStability();
         }

References m_intScheme.

Referenced by Nektar::CompressibleFlowSystem::GetElmtTimeStep().

◆ SteadyStateResidual()

SOLVER_UTILS_EXPORT void Nektar::SolverUtils::UnsteadySystem::SteadyStateResidual	(	int	step,
		Array< OneD, NekDouble > &	L2
	)

inline

Definition at line 58 of file UnsteadySystem.h.

     {
         v_SteadyStateResidual(step,L2);
     }

References v_SteadyStateResidual().

Referenced by CheckSteadyState().

◆ SVVVarDiffCoeff()

void Nektar::SolverUtils::UnsteadySystem::SVVVarDiffCoeff	(	const Array< OneD, Array< OneD, NekDouble >>	vel,
		StdRegions::VarCoeffMap &	varCoeffMap
	)

protected

Evaluate the SVV diffusion coefficient according to Moura's paper where it should proportional to h time velocity.

Definition at line 758 of file UnsteadySystem.cpp.

         {
             int phystot = m_fields[0]->GetTotPoints();
             int nvel = vel.size();
  
             Array<OneD, NekDouble> varcoeff(phystot),tmp;
  
             // calculate magnitude of v
             Vmath::Vmul(phystot,vel[0],1,vel[0],1,varcoeff,1);
             for(int n = 1; n < nvel; ++n)
             {
                 Vmath::Vvtvp(phystot,vel[n],1,vel[n],1,varcoeff,1,varcoeff,1);
             }
             Vmath::Vsqrt(phystot,varcoeff,1,varcoeff,1);
  
             for(int i = 0; i < m_fields[0]->GetNumElmts(); ++i)
             {
                 int offset = m_fields[0]->GetPhys_Offset(i);
                 int nq = m_fields[0]->GetExp(i)->GetTotPoints();
                 Array<OneD, NekDouble> unit(nq,1.0);
  
                 int nmodes = 0;
  
                 for(int n = 0; n < m_fields[0]->GetExp(i)->GetNumBases(); ++n)
                 {
                     nmodes = max(nmodes,
                                  m_fields[0]->GetExp(i)->GetBasisNumModes(n));
                 }
  
                 NekDouble h = m_fields[0]->GetExp(i)->Integral(unit);
                 h = pow(h,(NekDouble) (1.0/nvel))/((NekDouble) nmodes);
  
                 Vmath::Smul(nq,h,varcoeff+offset,1,tmp = varcoeff+offset,1);
             }
  
             // set up map with eVarCoffLaplacian key
             varCoeffMap[StdRegions::eVarCoeffLaplacian] = varcoeff;
         }

References Nektar::StdRegions::eVarCoeffLaplacian, Nektar::SolverUtils::EquationSystem::m_fields, Vmath::Smul(), Vmath::Vmul(), Vmath::Vsqrt(), and Vmath::Vvtvp().

Referenced by Nektar::UnsteadyViscousBurgers::DoImplicitSolve(), and Nektar::UnsteadyViscousBurgers::v_InitObject().

◆ UpdateTimeStepCheck()

bool Nektar::SolverUtils::UnsteadySystem::UpdateTimeStepCheck ( )

inlineprotectedvirtual

Reimplemented in Nektar::CFSImplicit.

Definition at line 205 of file UnsteadySystem.h.

     {
         return true;
     }

Referenced by v_DoSolve().

◆ v_AppendOutput1D()

void Nektar::SolverUtils::UnsteadySystem::v_AppendOutput1D ( Array< OneD, Array< OneD, NekDouble >> & solution1D )

protectedvirtual

Print the solution at each solution point in a txt file.

Stores the solution in a file for 1D problems only. This method has been implemented to facilitate the post-processing for 1D problems.

Definition at line 641 of file UnsteadySystem.cpp.

         {
             // Coordinates of the quadrature points in the real physical space
             Array<OneD,NekDouble> x(GetNpoints());
             Array<OneD,NekDouble> y(GetNpoints());
             Array<OneD,NekDouble> z(GetNpoints());
             m_fields[0]->GetCoords(x, y, z);
  
             // Print out the solution in a txt file
             ofstream outfile;
             outfile.open("solution1D.txt");
             for(int i = 0; i < GetNpoints(); i++)
             {
                 outfile << scientific << setw (17) << setprecision(16) << x[i]
                         << "  " << solution1D[0][i] << endl;
             }
             outfile << endl << endl;
             outfile.close();
         }

References Nektar::SolverUtils::EquationSystem::GetNpoints(), and Nektar::SolverUtils::EquationSystem::m_fields.

Referenced by v_DoSolve().

◆ v_DoInitialise()

void Nektar::SolverUtils::UnsteadySystem::v_DoInitialise ( void )

protectedvirtual

Sets up initial conditions.

Sets the initial conditions.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Reimplemented in Nektar::VelocityCorrectionScheme, Nektar::VCSMapping, Nektar::CoupledLinearNS, Nektar::MMFSWE, and Nektar::PulseWaveSystem.

Definition at line 597 of file UnsteadySystem.cpp.

         {
             CheckForRestartTime(m_time, m_nchk);
             SetBoundaryConditions(m_time);
             SetInitialConditions(m_time);
             InitializeSteadyState();
         }

References CheckForRestartTime(), InitializeSteadyState(), Nektar::SolverUtils::EquationSystem::m_nchk, Nektar::SolverUtils::EquationSystem::m_time, Nektar::SolverUtils::EquationSystem::SetBoundaryConditions(), and Nektar::SolverUtils::EquationSystem::SetInitialConditions().

Referenced by Nektar::VCSMapping::v_DoInitialise(), and Nektar::VelocityCorrectionScheme::v_DoInitialise().

◆ v_DoSolve()

void Nektar::SolverUtils::UnsteadySystem::v_DoSolve ( void )

protectedvirtual

Solves an unsteady problem.

Initialises the time integration scheme (as specified in the session file), and perform the time integration.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Reimplemented in Nektar::CoupledLinearNS, Nektar::MMFSWE, Nektar::PulseWaveSystem, Nektar::MMFMaxwell, and Nektar::MMFAdvection.

Definition at line 200 of file UnsteadySystem.cpp.

         {
             ASSERTL0(m_intScheme != 0, "No time integration scheme.");
  
             int i = 1;
             int nvariables = 0;
             int nfields = m_fields.size();
  
             if (m_intVariables.empty())
             {
                 for (i = 0; i < nfields; ++i)
                 {
                     m_intVariables.push_back(i);
                 }
                 nvariables = nfields;
             }
             else
             {
                 nvariables = m_intVariables.size();
             }
  
             // Integrate in wave-space if using homogeneous1D
             if(m_HomogeneousType != eNotHomogeneous && m_homoInitialFwd)
             {
                 for(i = 0; i < nfields; ++i)
                 {
                     m_fields[i]->HomogeneousFwdTrans(m_fields[i]->GetPhys(),
                                                      m_fields[i]->UpdatePhys());
                     m_fields[i]->SetWaveSpace(true);
                     m_fields[i]->SetPhysState(false);
                 }
             }
  
             // Set up wrapper to fields data storage.
             Array<OneD, Array<OneD, NekDouble> > fields(nvariables);
  
             // Order storage to list time-integrated fields first.
             for(i = 0; i < nvariables; ++i)
             {
                 fields[i] = m_fields[m_intVariables[i]]->GetPhys();
                 m_fields[m_intVariables[i]]->SetPhysState(false);
             }
  
             // Initialise time integration scheme
             m_intScheme->InitializeScheme( m_timestep, fields, m_time, m_ode );
  
             // Initialise filters
             for( auto &x : m_filters )
             {
                 x.second->Initialise(m_fields, m_time);
             }
  
             LibUtilities::Timer         timer;
             bool      doCheckTime       = false;
             int       step              = m_initialStep;
             int       stepCounter       = 0;
             int       restartStep      = -1;
             NekDouble intTime           = 0.0;
             NekDouble cpuTime           = 0.0;
             NekDouble cpuPrevious       = 0.0;
             NekDouble elapsed           = 0.0;
             NekDouble totFilterTime     = 0.0;
  
             m_lastCheckTime             = 0.0;
  
             m_TotNewtonIts  = 0;
             m_TotLinIts   = 0;
             m_TotImpStages  = 0;
  
            Array<OneD, int> abortFlags(2, 0);
             string    abortFile     = "abort";
             if (m_session->DefinesSolverInfo("CheckAbortFile"))
             {
                 abortFile = m_session->GetSolverInfo("CheckAbortFile");
             }
  
             NekDouble tmp_cflSafetyFactor = m_cflSafetyFactor;
  
             m_timestepMax = m_timestep;
             while ((step   < m_steps ||
                    m_time < m_fintime - NekConstants::kNekZeroTol) &&
                    abortFlags[1] == 0)
             {
                 restartStep++;
                 
                 if(m_CFLGrowth > 1.0&&m_cflSafetyFactor<m_CFLEnd)
                 {
                     tmp_cflSafetyFactor = 
                         min(m_CFLEnd,m_CFLGrowth*tmp_cflSafetyFactor);
                 }
  
                 m_flagUpdatePreconMat = true;
  
                 // Flag to update AV
                 m_CalcPhysicalAV = true;
                 // Frozen preconditioner checks
                 if (UpdateTimeStepCheck())
                 {
                     m_cflSafetyFactor = tmp_cflSafetyFactor;
  
                     if (m_cflSafetyFactor)
                     {
                         m_timestep = GetTimeStep(fields);
                     }
  
                     // Ensure that the final timestep finishes at the final
                     // time, or at a prescribed IO_CheckTime.
                     if (m_time + m_timestep > m_fintime && m_fintime > 0.0)
                     {
                         m_timestep = m_fintime - m_time;
                     }
                     else if (m_checktime &&
                         m_time + m_timestep - m_lastCheckTime >= m_checktime)
                     {
                         m_lastCheckTime += m_checktime;
                         m_timestep     = m_lastCheckTime - m_time;
                         doCheckTime    = true;
                     }
                 }
  
                 if (m_TimeIncrementFactor > 1.0)
                 {
                     NekDouble timeincrementFactor = m_TimeIncrementFactor;
                     m_timestep  *=  timeincrementFactor;
  
                     if (m_time + m_timestep > m_fintime && m_fintime > 0.0)
                     {
                         m_timestep = m_fintime - m_time;
                     }
                 }
  
                 // Perform any solver-specific pre-integration steps
                 timer.Start();
                 if (v_PreIntegrate(step))
                 {
                     break;
                 }
  
                 m_StagesPerStep = 0;
                 m_TotLinItePerStep = 0;
  
                 ASSERTL0(m_timestep > 0, "m_timestep < 0");
  
                 fields =
                     m_intScheme->TimeIntegrate( stepCounter, m_timestep, m_ode);
                 timer.Stop();
  
                 m_time  += m_timestep;
                 elapsed  = timer.TimePerTest(1);
                 intTime += elapsed;
                 cpuTime += elapsed;
  
                 // Write out status information
                 if (m_session->GetComm()->GetRank() == 0 &&
                     !((step+1) % m_infosteps))
                 {
                     cout << "Steps: " << setw(8)  << left << step+1 << " "
                          << "Time: "  << setw(12) << left << m_time;
  
                     if (m_cflSafetyFactor)
                     {
                         cout << " Time-step: " << setw(12)
                              << left << m_timestep;
                     }
  
                     stringstream ss;
                     ss << cpuTime << "s";
                     cout << " CPU Time: " << setw(8) << left
                          << ss.str() << endl;
                     cpuPrevious = cpuTime;
                     cpuTime = 0.0;
  
                     if(m_flagImplicitItsStatistics && m_flagImplicitSolver)
                     {
                         cout 
                              << "       &&" 
                              << " TotImpStages= " << m_TotImpStages 
                              << " TotNewtonIts= " << m_TotNewtonIts
                              << " TotLinearIts = " << m_TotLinIts  
                              << endl;
                     }
                 }
  
                 // Transform data into coefficient space
                 for (i = 0; i < nvariables; ++i)
                 {
                     // copy fields into ExpList::m_phys and assign the new
                     // array to fields
                     m_fields[m_intVariables[i]]->SetPhys(fields[i]);
                     fields[i] = m_fields[m_intVariables[i]]->UpdatePhys();
                     if( v_RequireFwdTrans() )
                     {
                         m_fields[m_intVariables[i]]->FwdTrans_IterPerExp(
                             fields[i],
                             m_fields[m_intVariables[i]]->UpdateCoeffs());
                     }
                     m_fields[m_intVariables[i]]->SetPhysState(false);
                 }
                 
                 // Perform any solver-specific post-integration steps
                 if (v_PostIntegrate(step))
                 {
                     break;
                 }
  
                 // Check for steady-state
                 if (m_steadyStateTol > 0.0 && (!((step+1)%m_steadyStateSteps)) )
                 {
                     if (CheckSteadyState(step,intTime))
                     {
                         if (m_comm->GetRank() == 0)
                         {
                             cout << "Reached Steady State to tolerance "
                                  << m_steadyStateTol << endl;
                         }
                         break;
                     }
                 }
  
                 // test for abort conditions (nan, or abort file)
                 if (m_abortSteps && !((step+1) % m_abortSteps) )
                 {
                     abortFlags[0] = 0;
                     for (i = 0; i < nvariables; ++i)
                     {
                         if (Vmath::Nnan(fields[i].size(),
                                 fields[i], 1) > 0)
                         {
                             abortFlags[0] = 1;
                         }
                     }
  
                     //rank zero looks for abort file and deltes it
                     //if it exists. The communicates the abort
                     if(m_session->GetComm()->GetRank() == 0)
                     {
                         if(boost::filesystem::exists(abortFile))
                         {
                             boost::filesystem::remove(abortFile);
                             abortFlags[1] = 1;
                         }
                     }
  
                     m_session->GetComm()->AllReduce(abortFlags,
                                 LibUtilities::ReduceMax);
  
                     ASSERTL0 (!abortFlags[0],
                                 "NaN found during time integration.");
                 }
  
                 // Update filters
                 for (auto &x : m_filters)
                 {
                     timer.Start();
                     x.second->Update(m_fields, m_time);
                     timer.Stop();
                     elapsed = timer.TimePerTest(1);
                     totFilterTime += elapsed;
  
                     // Write out individual filter status information
                     if(m_session->GetComm()->GetRank() == 0 &&
                     !((step+1) % m_filtersInfosteps) && !m_filters.empty() &&
                     m_session->DefinesCmdLineArgument("verbose"))
                     {
                         stringstream s0;
                         s0 << x.first << ":";
                         stringstream s1;
                         s1 << elapsed << "s";
                         stringstream s2;
                         s2 << elapsed / cpuPrevious * 100 << "%";
                         cout << "CPU time for filter " << setw(25) << left
                             << s0.str() << setw(12) << left << s1.str() <<
                             endl << "\t Percentage of time integration:     "
                              << setw(10) << left << s2.str() << endl;
                     }
                 }
  
                 // Write out overall filter status information
                 if (m_session->GetComm()->GetRank() == 0 &&
                     !((step+1) % m_filtersInfosteps) && !m_filters.empty())
                  {
                     stringstream ss;
                     ss << totFilterTime << "s";
                     cout << "Total filters CPU Time:\t\t\t     " << setw(10)
                         << left << ss.str() << endl;
                  }
                 totFilterTime = 0.0;
  
                 // Write out checkpoint files
                 if ((m_checksteps && !((step + 1) % m_checksteps)) ||
                      doCheckTime)
                 {
                     if(m_HomogeneousType != eNotHomogeneous)
                     {
                         vector<bool> transformed(nfields, false);
                         for(i = 0; i < nfields; i++)
                         {
                             if (m_fields[i]->GetWaveSpace())
                             {
                                 m_fields[i]->SetWaveSpace(false);
                                 m_fields[i]->BwdTrans(m_fields[i]->GetCoeffs(),
                                                       m_fields[i]->UpdatePhys());
                                 m_fields[i]->SetPhysState(true);
                                 transformed[i] = true;
                             }
                         }
                         Checkpoint_Output(m_nchk);
                         m_nchk++;
                         for(i = 0; i < nfields; i++)
                         {
                             if (transformed[i])
                             {
                                 m_fields[i]->SetWaveSpace(true);
                                 m_fields[i]->HomogeneousFwdTrans(
                                     m_fields[i]->GetPhys(),
                                     m_fields[i]->UpdatePhys());
                                 m_fields[i]->SetPhysState(false);
                             }
                         }
                     }
                     else
                     {
                         Checkpoint_Output(m_nchk);
                         m_nchk++;
                     }
                     doCheckTime = false;
                 }
  
                 // Step advance
                 ++step;
                 ++stepCounter;
             }
  
             // Print out summary statistics
             if (m_session->GetComm()->GetRank() == 0)
             {
                 if (m_cflSafetyFactor > 0.0)
                 {
                     cout << "CFL safety factor : " << m_cflSafetyFactor << endl
                          << "CFL time-step     : " << m_timestep        << endl;
                 }
  
                 if (m_session->GetSolverInfo("Driver") != "SteadyState")
                 {
                     cout << "Time-integration  : " << intTime  << "s"   << endl;
                 }
  
                 if(m_flagImplicitItsStatistics && m_flagImplicitSolver)
                 {
                     cout 
                     << "-------------------------------------------" << endl
                     << "Total Implicit Stages: " << m_TotImpStages << endl
                     << "Total Newton Its     : " << m_TotNewtonIts << endl
                     << "Total Linear Its     : " << m_TotLinIts  << endl 
                     << "-------------------------------------------" << endl;
                 }
             }
  
             // If homogeneous, transform back into physical space if necessary.
             if(m_HomogeneousType != eNotHomogeneous)
             {
                 for(i = 0; i < nfields; i++)
                 {
                     if (m_fields[i]->GetWaveSpace())
                     {
                         m_fields[i]->SetWaveSpace(false);
                         m_fields[i]->BwdTrans(m_fields[i]->GetCoeffs(),
                                               m_fields[i]->UpdatePhys());
                         m_fields[i]->SetPhysState(true);
                     }
                 }
             }
             else
             {
                 for(i = 0; i < nvariables; ++i)
                 {
                     m_fields[m_intVariables[i]]->SetPhys(fields[i]);
                     m_fields[m_intVariables[i]]->SetPhysState(true);
                 }
             }
  
             // Finalise filters
             for (auto &x : m_filters)
             {
                 x.second->Finalise(m_fields, m_time);
             }
  
             // Print for 1D problems
             if(m_spacedim == 1)
             {
                 v_AppendOutput1D(fields);
             }
         }

Referenced by Nektar::CoupledLinearNS::v_DoSolve().

◆ v_GenerateSummary()

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

protectedvirtual

Print a summary of time stepping parameters.

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

Reimplemented from Nektar::SolverUtils::EquationSystem.

Reimplemented in Nektar::Monodomain, Nektar::BidomainRoth, Nektar::Bidomain, Nektar::UnsteadyDiffusion, Nektar::CFLtester, Nektar::SolverUtils::MMFSystem, Nektar::ShallowWaterSystem, Nektar::NonlinearSWE, Nektar::NonlinearPeregrine, Nektar::MMFSWE, Nektar::LinearSWE, Nektar::PulseWavePropagation, Nektar::MMFMaxwell, Nektar::VCSWeakPressure, Nektar::VelocityCorrectionScheme, Nektar::SmoothedProfileMethod, Nektar::CoupledLinearNS, Nektar::ImageWarpingSystem, Nektar::MMFDiffusion, Nektar::RinglebFlow, Nektar::IsentropicVortex, Nektar::UnsteadyViscousBurgers, Nektar::UnsteadyAdvectionDiffusion, Nektar::UnsteadyAdvection, and Nektar::MMFAdvection.

Definition at line 609 of file UnsteadySystem.cpp.

         {
             EquationSystem::v_GenerateSummary(s);
             AddSummaryItem(s, "Advection",
                            m_explicitAdvection ? "explicit" : "implicit");
  
             if(m_session->DefinesSolverInfo("AdvectionType"))
             {
                 AddSummaryItem(s, "AdvectionType",
                                m_session->GetSolverInfo("AdvectionType"));
             }
  
             AddSummaryItem(s, "Diffusion",
                            m_explicitDiffusion ? "explicit" : "implicit");
  
             if (m_session->GetSolverInfo("EQTYPE")
                     == "SteadyAdvectionDiffusionReaction")
             {
                 AddSummaryItem(s, "Reaction",
                                m_explicitReaction  ? "explicit" : "implicit");
             }
  
             AddSummaryItem( s, "Time Step", m_timestep );
             AddSummaryItem( s, "No. of Steps", m_steps );
             AddSummaryItem( s, "Checkpoints (steps)", m_checksteps );
             AddSummaryItem( s, "Integration Type", m_intScheme->GetName() );
         }

References Nektar::SolverUtils::AddSummaryItem(), Nektar::SolverUtils::EquationSystem::m_checksteps, m_explicitAdvection, m_explicitDiffusion, m_explicitReaction, m_intScheme, Nektar::SolverUtils::EquationSystem::m_session, Nektar::SolverUtils::EquationSystem::m_steps, Nektar::SolverUtils::EquationSystem::m_timestep, and Nektar::SolverUtils::EquationSystem::v_GenerateSummary().

◆ v_GetTimeStep()

NekDouble Nektar::SolverUtils::UnsteadySystem::v_GetTimeStep ( const Array< OneD, const Array< OneD, NekDouble >> & inarray )

protectedvirtual

Return the timestep to be used for the next step in the time-marching loop.

See also: UnsteadySystem::GetTimeStep

Definition at line 738 of file UnsteadySystem.cpp.

         {
             boost::ignore_unused(inarray);
             NEKERROR(ErrorUtil::efatal, "Not defined for this class");
             return 0.0;
         }

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

Referenced by GetTimeStep().

◆ v_InitObject()

void Nektar::SolverUtils::UnsteadySystem::v_InitObject ( )

protectedvirtual

Init object for UnsteadySystem class.

Initialization object for UnsteadySystem class.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Reimplemented in Nektar::ShallowWaterSystem, Nektar::NonlinearSWE, Nektar::NonlinearPeregrine, Nektar::MMFSWE, Nektar::LinearSWE, Nektar::PulseWaveSystemOutput, Nektar::PulseWaveSystem, Nektar::PulseWavePropagation, Nektar::MMFMaxwell, Nektar::VelocityCorrectionScheme, Nektar::VCSMapping, Nektar::SmoothedProfileMethod, Nektar::IncNavierStokes, Nektar::CoupledLinearNS, Nektar::ImageWarpingSystem, Nektar::Dummy, Nektar::MMFDiffusion, Nektar::NavierStokesImplicitCFE, Nektar::NavierStokesCFEAxisym, Nektar::NavierStokesCFE, Nektar::EulerImplicitCFE, Nektar::EulerCFE, Nektar::CFSImplicit, Nektar::CompressibleFlowSystem, Nektar::Monodomain, Nektar::BidomainRoth, Nektar::Bidomain, Nektar::UnsteadyViscousBurgers, Nektar::UnsteadyReactionDiffusion, Nektar::UnsteadyInviscidBurger, Nektar::UnsteadyDiffusion, Nektar::UnsteadyAdvectionDiffusion, Nektar::UnsteadyAdvection, Nektar::MMFAdvection, Nektar::CFLtester, Nektar::LEE, Nektar::APE, Nektar::AcousticSystem, and Nektar::SolverUtils::AdvectionSystem.

Definition at line 81 of file UnsteadySystem.cpp.

         {
             EquationSystem::v_InitObject();
  
             m_initialStep = 0;
  
             // Load SolverInfo parameters
             m_session->MatchSolverInfo("DIFFUSIONADVANCEMENT","Explicit",
                                        m_explicitDiffusion,true);
             m_session->MatchSolverInfo("ADVECTIONADVANCEMENT","Explicit",
                                        m_explicitAdvection,true);
             m_session->MatchSolverInfo("REACTIONADVANCEMENT", "Explicit",
                                        m_explicitReaction, true);
             
             m_session->MatchSolverInfo("FLAGIMPLICITITSSTATISTICS", "True",
                                        m_flagImplicitItsStatistics, false);
  
             m_session->LoadParameter("CheckAbortSteps", m_abortSteps, 1);
             // Steady state tolerance
             m_session->LoadParameter("SteadyStateTol", m_steadyStateTol, 0.0);
             // Frequency for checking steady state
             m_session->LoadParameter("SteadyStateSteps",
                                           m_steadyStateSteps, 1);
  
             // For steady problems, we do not initialise the time integration
             if (m_session->DefinesSolverInfo("TimeIntegrationMethod") ||
                 m_session->DefinesTimeIntScheme())
             {
                 LibUtilities::TimeIntScheme timeInt;
                 if (m_session->DefinesTimeIntScheme())
                 {
                     timeInt = m_session->GetTimeIntScheme();
                 }
                 else
                 {
                     timeInt.method = m_session->GetSolverInfo(
                         "TimeIntegrationMethod");
                 }
  
                 m_intScheme = LibUtilities::GetTimeIntegrationSchemeFactory()
                     .CreateInstance(timeInt.method,
                                     timeInt.variant,
                                     timeInt.order,
                                     timeInt.freeParams);
  
                 // Load generic input parameters
                 m_session->LoadParameter("IO_InfoSteps", m_infosteps, 0);
                 m_session->LoadParameter("IO_FiltersInfoSteps",
                     m_filtersInfosteps, 10.0 * m_infosteps);
                 m_session->LoadParameter("CFL", m_cflSafetyFactor, 0.0);
                 m_session->LoadParameter("CFLEnd", m_CFLEnd, 0.0);
                 m_session->LoadParameter("CFLGrowth", m_CFLGrowth, 1.0);
                 m_session->LoadParameter("CFLGrowth", m_CFLGrowth, 1.0);
  
  
                 // Time tolerance between filter update time and time integration
                 m_session->LoadParameter("FilterTimeWarning",
                                          m_filterTimeWarning, 1);
  
                 // Ensure that there is no conflict of parameters
                 if(m_cflSafetyFactor > 0.0)
                 {
                     // Check final condition
                     ASSERTL0(m_fintime == 0.0 || m_steps == 0,
                              "Final condition not unique: "
                              "fintime > 0.0 and Nsteps > 0");
                     // Check timestep condition
                     ASSERTL0(m_timestep == 0.0,
                              "Timestep not unique: timestep > 0.0 & CFL > 0.0");
                 }
                 else
                 {
                     ASSERTL0(m_timestep != 0.0,
                              "Need to set either TimeStep or CFL");
                 }
  
                 // Ensure that there is no conflict of parameters
                 if (m_CFLGrowth > 1.0)
                 {
                     // Check final condition
                     ASSERTL0(m_CFLEnd >= m_cflSafetyFactor,
                              "m_CFLEnd >= m_cflSafetyFactor required");
                 }
  
                 // Set up time to be dumped in field information
                 m_fieldMetaDataMap["Time"] =
                         boost::lexical_cast<std::string>(m_time);
             }
  
             // By default attempt to forward transform initial condition.
             m_homoInitialFwd = true;
  
             // Set up filters
             for (auto &x : m_session->GetFilters())
             {
                 m_filters.push_back(make_pair(x.first, GetFilterFactory().CreateInstance(
                         x.first, m_session, shared_from_this(), x.second)));
             }
         }

◆ v_PostIntegrate()

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

protectedvirtual

Reimplemented in Nektar::VelocityCorrectionScheme, Nektar::Dummy, and Nektar::SolverUtils::AdvectionSystem.

Definition at line 752 of file UnsteadySystem.cpp.

         {
             boost::ignore_unused(step);
             return false;
         }

Referenced by v_DoSolve(), Nektar::SolverUtils::AdvectionSystem::v_PostIntegrate(), and Nektar::Dummy::v_PostIntegrate().

◆ v_PreIntegrate()

bool Nektar::SolverUtils::UnsteadySystem::v_PreIntegrate ( int step )

protectedvirtual

Reimplemented in Nektar::IncNavierStokes, Nektar::Dummy, Nektar::UnsteadyAdvectionDiffusion, and Nektar::AcousticSystem.

Definition at line 746 of file UnsteadySystem.cpp.

         {
             boost::ignore_unused(step);
             return false;
         }

Referenced by v_DoSolve(), Nektar::AcousticSystem::v_PreIntegrate(), and Nektar::Dummy::v_PreIntegrate().

◆ v_RequireFwdTrans()

virtual SOLVER_UTILS_EXPORT bool Nektar::SolverUtils::UnsteadySystem::v_RequireFwdTrans ( )

inlineprotectedvirtual

Reimplemented in Nektar::VelocityCorrectionScheme, and Nektar::Dummy.

Definition at line 177 of file UnsteadySystem.h.

     {
         return true;
     }

Referenced by v_DoSolve().

◆ v_SteadyStateResidual()

void Nektar::SolverUtils::UnsteadySystem::v_SteadyStateResidual	(	int	step,
		Array< OneD, NekDouble > &	L2
	)

protectedvirtual

Reimplemented in Nektar::CompressibleFlowSystem.

Definition at line 900 of file UnsteadySystem.cpp.

         {
             boost::ignore_unused(step);
             const int nPoints = GetTotPoints();
             const int nFields = m_fields.size();
  
             // Holds L2 errors.
             Array<OneD, NekDouble> RHSL2    (nFields);
             Array<OneD, NekDouble> residual (nFields);
             Array<OneD, NekDouble> reference(nFields);
  
             for (int i = 0; i < nFields; ++i)
             {
                 Array<OneD, NekDouble> tmp(nPoints);
  
                 Vmath::Vsub(nPoints, m_fields[i]->GetPhys(), 1,
                                      m_previousSolution[i], 1, tmp, 1);
                 Vmath::Vmul(nPoints, tmp, 1, tmp, 1, tmp, 1);
                 residual[i] = Vmath::Vsum(nPoints, tmp, 1);
  
                 Vmath::Vmul(nPoints, m_previousSolution[i], 1,
                                      m_previousSolution[i], 1, tmp, 1);
                 reference[i] = Vmath::Vsum(nPoints, tmp, 1);
             }
  
             m_comm->AllReduce(residual , LibUtilities::ReduceSum);
             m_comm->AllReduce(reference, LibUtilities::ReduceSum);
  
             // L2 error
             for (int i = 0; i < nFields; ++i)
             {
                 reference[i] = (reference[i] == 0) ? 1 : reference[i];
                 L2[i] = sqrt(residual[i] / reference[i]);
             }
         }

References Nektar::SolverUtils::EquationSystem::GetTotPoints(), Nektar::SolverUtils::EquationSystem::m_comm, Nektar::SolverUtils::EquationSystem::m_fields, m_previousSolution, Nektar::LibUtilities::ReduceSum, tinysimd::sqrt(), Vmath::Vmul(), Vmath::Vsub(), and Vmath::Vsum().

Referenced by SteadyStateResidual().

Member Data Documentation

◆ m_abortSteps

int Nektar::SolverUtils::UnsteadySystem::m_abortSteps

protected

Number of steps between checks for abort conditions.

Definition at line 77 of file UnsteadySystem.h.

Referenced by v_DoSolve(), and v_InitObject().

◆ m_CalcPhysicalAV

bool Nektar::SolverUtils::UnsteadySystem::m_CalcPhysicalAV = true

protected

flag to update artificial viscosity

Definition at line 144 of file UnsteadySystem.h.

Referenced by Nektar::NavierStokesCFE::v_DoDiffusion(), Nektar::NavierStokesImplicitCFE::v_DoDiffusionCoeff(), v_DoSolve(), Nektar::NavierStokesCFE::v_GetViscousFluxVector(), and Nektar::NavierStokesCFE::v_GetViscousFluxVectorDeAlias().

◆ m_CFLEnd

NekDouble Nektar::SolverUtils::UnsteadySystem::m_CFLEnd

maximun cfl in cfl growth

Definition at line 71 of file UnsteadySystem.h.

Referenced by v_DoSolve(), and v_InitObject().

◆ m_CFLGrowth

NekDouble Nektar::SolverUtils::UnsteadySystem::m_CFLGrowth

CFL growth rate.

Definition at line 69 of file UnsteadySystem.h.

Referenced by v_DoSolve(), and v_InitObject().

◆ m_cflNonAcoustic

NekDouble Nektar::SolverUtils::UnsteadySystem::m_cflNonAcoustic

Definition at line 67 of file UnsteadySystem.h.

Referenced by Nektar::CompressibleFlowSystem::v_GetTimeStep().

◆ m_cflSafetyFactor

NekDouble Nektar::SolverUtils::UnsteadySystem::m_cflSafetyFactor

CFL safety factor (comprise between 0 to 1).

Definition at line 66 of file UnsteadySystem.h.

Referenced by Nektar::CompressibleFlowSystem::GetElmtTimeStep(), Nektar::CompressibleFlowSystem::InitialiseParameters(), v_DoSolve(), Nektar::MMFAdvection::v_DoSolve(), Nektar::MMFSWE::v_DoSolve(), and v_InitObject().

◆ m_epsilon

NekDouble Nektar::SolverUtils::UnsteadySystem::m_epsilon

protected

Definition at line 86 of file UnsteadySystem.h.

◆ m_errFile

std::ofstream Nektar::SolverUtils::UnsteadySystem::m_errFile

protected

Definition at line 107 of file UnsteadySystem.h.

Referenced by CheckSteadyState(), and InitializeSteadyState().

◆ m_explicitAdvection

bool Nektar::SolverUtils::UnsteadySystem::m_explicitAdvection

protected

Indicates if explicit or implicit treatment of advection is used.

Definition at line 90 of file UnsteadySystem.h.

◆ m_explicitDiffusion

bool Nektar::SolverUtils::UnsteadySystem::m_explicitDiffusion

protected

Indicates if explicit or implicit treatment of diffusion is used.

Definition at line 88 of file UnsteadySystem.h.

◆ m_explicitReaction

bool Nektar::SolverUtils::UnsteadySystem::m_explicitReaction

protected

Indicates if explicit or implicit treatment of reaction is used.

Definition at line 92 of file UnsteadySystem.h.

Referenced by v_GenerateSummary(), and v_InitObject().

◆ m_filters

std::vector<std::pair<std::string, FilterSharedPtr> > Nektar::SolverUtils::UnsteadySystem::m_filters

protected

Definition at line 111 of file UnsteadySystem.h.

Referenced by v_DoSolve(), v_InitObject(), Nektar::Bidomain::v_InitObject(), Nektar::BidomainRoth::v_InitObject(), Nektar::Monodomain::v_InitObject(), and Nektar::SmoothedProfileMethod::v_SolveUnsteadyStokesSystem().

◆ m_filtersInfosteps

int Nektar::SolverUtils::UnsteadySystem::m_filtersInfosteps

protected

Number of time steps between outputting filters information.

Definition at line 79 of file UnsteadySystem.h.

Referenced by v_DoSolve(), and v_InitObject().

◆ m_filterTimeWarning

NekDouble Nektar::SolverUtils::UnsteadySystem::m_filterTimeWarning

protected

Number of time steps between outputting status information.

Definition at line 114 of file UnsteadySystem.h.

Referenced by v_InitObject().

◆ m_flagImplicitItsStatistics

bool Nektar::SolverUtils::UnsteadySystem::m_flagImplicitItsStatistics

protected

Definition at line 119 of file UnsteadySystem.h.

Referenced by v_DoSolve(), and v_InitObject().

◆ m_flagImplicitSolver

bool Nektar::SolverUtils::UnsteadySystem::m_flagImplicitSolver = false

protected

Definition at line 120 of file UnsteadySystem.h.

Referenced by v_DoSolve(), and Nektar::CFSImplicit::v_InitObject().

◆ m_flagUpdatePreconMat

bool Nektar::SolverUtils::UnsteadySystem::m_flagUpdatePreconMat

protected

Definition at line 135 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::PreconCoeff(), and v_DoSolve().

◆ m_homoInitialFwd

bool Nektar::SolverUtils::UnsteadySystem::m_homoInitialFwd

protected

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

Definition at line 95 of file UnsteadySystem.h.

Referenced by v_DoSolve(), v_InitObject(), Nektar::AcousticSystem::v_InitObject(), Nektar::CFLtester::v_InitObject(), Nektar::UnsteadyAdvection::v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyDiffusion::v_InitObject(), Nektar::UnsteadyViscousBurgers::v_InitObject(), and Nektar::CompressibleFlowSystem::v_InitObject().

◆ m_inArrayNorm

NekDouble Nektar::SolverUtils::UnsteadySystem::m_inArrayNorm =-1.0

protected

Definition at line 128 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::CalcRefValues(), Nektar::CFSImplicit::DoImplicitSolveCoeff(), and Nektar::CFSImplicit::MatrixMultiplyMatrixFreeCoeff().

◆ m_infosteps

int Nektar::SolverUtils::UnsteadySystem::m_infosteps

protected

Number of time steps between outputting status information.

Definition at line 75 of file UnsteadySystem.h.

Referenced by CheckSteadyState(), v_DoSolve(), Nektar::MMFAdvection::v_DoSolve(), Nektar::MMFMaxwell::v_DoSolve(), Nektar::PulseWaveSystem::v_DoSolve(), Nektar::MMFSWE::v_DoSolve(), v_InitObject(), and Nektar::ShallowWaterSystem::v_InitObject().

◆ m_intScheme

LibUtilities::TimeIntegrationSchemeSharedPtr Nektar::SolverUtils::UnsteadySystem::m_intScheme

protected

Wrapper to the time integration scheme.

Definition at line 82 of file UnsteadySystem.h.

Referenced by MaxTimeStepEstimator(), Nektar::VelocityCorrectionScheme::SetUpExtrapolation(), Nektar::UnsteadyAdvectionDiffusion::SubStepAdvance(), v_DoSolve(), Nektar::MMFAdvection::v_DoSolve(), Nektar::MMFMaxwell::v_DoSolve(), Nektar::PulseWaveSystem::v_DoSolve(), Nektar::MMFSWE::v_DoSolve(), v_GenerateSummary(), v_InitObject(), Nektar::UnsteadyAdvectionDiffusion::v_InitObject(), Nektar::UnsteadyReactionDiffusion::v_InitObject(), and Nektar::VCSMapping::v_InitObject().

◆ m_intVariables

std::vector<int> Nektar::SolverUtils::UnsteadySystem::m_intVariables

protected

Definition at line 109 of file UnsteadySystem.h.

Referenced by v_DoSolve(), Nektar::MMFAdvection::v_DoSolve(), Nektar::MMFMaxwell::v_DoSolve(), Nektar::MMFSWE::v_DoSolve(), Nektar::Bidomain::v_InitObject(), Nektar::BidomainRoth::v_InitObject(), Nektar::Monodomain::v_InitObject(), Nektar::Dummy::v_InitObject(), Nektar::ImageWarpingSystem::v_InitObject(), and Nektar::VelocityCorrectionScheme::v_InitObject().

◆ m_locTimeStep

Array<OneD, NekDouble> Nektar::SolverUtils::UnsteadySystem::m_locTimeStep

protected

local time step(notice only for jfnk other see m_cflSafetyFactor)

Definition at line 126 of file UnsteadySystem.h.

◆ m_magnitdEstimat

Array<OneD, NekDouble> Nektar::SolverUtils::UnsteadySystem::m_magnitdEstimat

protected

estimate the magnitude of each conserved varibles

Definition at line 123 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::CalcRefValues(), and Nektar::CFSImplicit::NumCalcRiemFluxJac().

◆ m_maxLinItePerNewton

int Nektar::SolverUtils::UnsteadySystem::m_maxLinItePerNewton

protected

Definition at line 137 of file UnsteadySystem.h.

◆ m_nanSteps

int Nektar::SolverUtils::UnsteadySystem::m_nanSteps

protected

Definition at line 80 of file UnsteadySystem.h.

Referenced by Nektar::Dummy::v_InitObject().

◆ m_ode

LibUtilities::TimeIntegrationSchemeOperators Nektar::SolverUtils::UnsteadySystem::m_ode

protected

The time integration scheme operators to use.

Definition at line 84 of file UnsteadySystem.h.

◆ m_previousSolution

Array<OneD, Array<OneD, NekDouble> > Nektar::SolverUtils::UnsteadySystem::m_previousSolution

protected

Storage for previous solution for steady-state check.

Definition at line 105 of file UnsteadySystem.h.

Referenced by CheckSteadyState(), InitializeSteadyState(), and v_SteadyStateResidual().

◆ m_StagesPerStep

int Nektar::SolverUtils::UnsteadySystem::m_StagesPerStep =1

protected

Definition at line 131 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::DoImplicitSolveCoeff(), and v_DoSolve().

◆ m_steadyStateRes

NekDouble Nektar::SolverUtils::UnsteadySystem::m_steadyStateRes = 1.0

protected

Definition at line 101 of file UnsteadySystem.h.

Referenced by CheckSteadyState().

◆ m_steadyStateRes0

NekDouble Nektar::SolverUtils::UnsteadySystem::m_steadyStateRes0 = 1.0

protected

Definition at line 102 of file UnsteadySystem.h.

Referenced by CheckSteadyState().

◆ m_steadyStateSteps

int Nektar::SolverUtils::UnsteadySystem::m_steadyStateSteps

protected

Check for steady state at step interval.

Definition at line 100 of file UnsteadySystem.h.

Referenced by v_DoSolve(), and v_InitObject().

◆ m_steadyStateTol

NekDouble Nektar::SolverUtils::UnsteadySystem::m_steadyStateTol

protected

Tolerance to which steady state should be evaluated at.

Definition at line 98 of file UnsteadySystem.h.

Referenced by CheckSteadyState(), InitializeSteadyState(), v_DoSolve(), and v_InitObject().

◆ m_TimeIntegLambda

NekDouble Nektar::SolverUtils::UnsteadySystem::m_TimeIntegLambda =0.0

protected

coefff of spacial derivatives(rhs or m_F in GLM) in calculating the residual of the whole equation(used in unsteady time integrations)

Definition at line 117 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::CalcPreconMatBRJCoeff(), Nektar::CFSImplicit::DoImplicitSolveCoeff(), Nektar::CFSImplicit::NonlinSysEvaluatorCoeff(), Nektar::CFSImplicit::PreconCoeff(), and Nektar::CFSImplicit::UpdateTimeStepCheck().

◆ m_TotImpStages

int Nektar::SolverUtils::UnsteadySystem::m_TotImpStages =0

protected

Definition at line 141 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::DoImplicitSolveCoeff(), and v_DoSolve().

◆ m_TotLinItePerStep

int Nektar::SolverUtils::UnsteadySystem::m_TotLinItePerStep =0

protected

Definition at line 130 of file UnsteadySystem.h.

Referenced by v_DoSolve().

◆ m_TotLinIts

int Nektar::SolverUtils::UnsteadySystem::m_TotLinIts =0

protected

Definition at line 140 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::DoImplicitSolveCoeff(), and v_DoSolve().

◆ m_TotNewtonIts

int Nektar::SolverUtils::UnsteadySystem::m_TotNewtonIts =0

protected

Definition at line 139 of file UnsteadySystem.h.

Referenced by Nektar::CFSImplicit::DoImplicitSolveCoeff(), and v_DoSolve().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~UnsteadySystem()

◆ UnsteadySystem()

Member Function Documentation

◆ CheckForRestartTime()

◆ CheckSteadyState() [1/2]

◆ CheckSteadyState() [2/2]

◆ GetTimeStep()

◆ InitializeSteadyState()

◆ MaxTimeStepEstimator()

◆ SteadyStateResidual()

◆ SVVVarDiffCoeff()

◆ UpdateTimeStepCheck()

◆ v_AppendOutput1D()

◆ v_DoInitialise()

◆ v_DoSolve()

◆ v_GenerateSummary()

◆ v_GetTimeStep()

◆ v_InitObject()

◆ v_PostIntegrate()

◆ v_PreIntegrate()

◆ v_RequireFwdTrans()

◆ v_SteadyStateResidual()

Member Data Documentation

◆ m_abortSteps

◆ m_CalcPhysicalAV

◆ m_CFLEnd

◆ m_CFLGrowth

◆ m_cflNonAcoustic

◆ m_cflSafetyFactor

◆ m_epsilon

◆ m_errFile

◆ m_explicitAdvection

◆ m_explicitDiffusion

◆ m_explicitReaction

◆ m_filters

◆ m_filtersInfosteps

◆ m_filterTimeWarning

◆ m_flagImplicitItsStatistics

◆ m_flagImplicitSolver

◆ m_flagUpdatePreconMat

◆ m_homoInitialFwd

◆ m_inArrayNorm

◆ m_infosteps

◆ m_intScheme

◆ m_intVariables

◆ m_locTimeStep

◆ m_magnitdEstimat

◆ m_maxLinItePerNewton

◆ m_nanSteps

◆ m_ode

◆ m_previousSolution

◆ m_StagesPerStep

◆ m_steadyStateRes

◆ m_steadyStateRes0

◆ m_steadyStateSteps

◆ m_steadyStateTol

◆ m_TimeIntegLambda

◆ m_TotImpStages

◆ m_TotLinItePerStep

◆ m_TotLinIts

◆ m_TotNewtonIts