Nektar::LinearSWE Class Reference

#include <LinearSWE.h>

Inheritance diagram for Nektar::LinearSWE:

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

Static Public Attributes
static std::string	className
	Name of class.
Static Public Attributes inherited from Nektar::ShallowWaterSystem
static std::string	className
	Name of class.
Static Public Attributes inherited from Nektar::SolverUtils::UnsteadySystem
static std::string	cmdSetStartTime
static std::string	cmdSetStartChkNum

Protected Member Functions
	LinearSWE (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	~LinearSWE () override=default
void	v_InitObject (bool DeclareFields=true) override
	Initialisation object for EquationSystem.
void	v_DoOdeRhs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) override
void	v_GenerateSummary (SolverUtils::SummaryList &s) override
	Virtual function for generating summary information.
void	GetFluxVector (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &flux)
void	GetVelocityVector (const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &velocity)
	Compute the velocity field \( \mathbf{v} \) given the momentum \( h\mathbf{v} \).
void	CopyBoundaryTrace (const Array< OneD, const NekDouble > &Fwd, Array< OneD, NekDouble > &Bwd)
const Array< OneD, NekDouble > &	GetDepthFwd ()
const Array< OneD, NekDouble > &	GetDepthBwd ()
Protected Member Functions inherited from Nektar::ShallowWaterSystem
	ShallowWaterSystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	~ShallowWaterSystem () override=default
void	v_InitObject (bool DeclareFields=true) override
	Initialisation object for EquationSystem.
void	v_GenerateSummary (SolverUtils::SummaryList &s) override
	Virtual function for generating summary information.
void	InitialiseNonlinSysSolver (void)
void	DoImplicitSolve (const Array< OneD, const Array< OneD, NekDouble > > &inpnts, Array< OneD, Array< OneD, NekDouble > > &outpnt, const NekDouble time, const NekDouble lambda)
void	DoImplicitSolve1D (const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &out)
void	CalcRefValues (const Array< OneD, const NekDouble > &inarray)
void	NonlinSysEvaluator1D (const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &out, const bool &flag)
void	NonlinSysEvaluator (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &out)
void	MatrixMultiplyMatrixFree (const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &out, const bool &flag)
void	DoNullPrecon (const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &outarray, const bool &flag)
void	DoOdeProjection (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
void	SetBoundaryConditions (const Array< OneD, const Array< OneD, NekDouble > > &physarray, NekDouble time)
void	WallBoundary2D (int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &Fwd)
void	AddCoriolis (const Array< OneD, const Array< OneD, NekDouble > > &physarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
void	PrimitiveToConservative ()
void	ConservativeToPrimitive ()
NekDouble	GetGravity ()
const Array< OneD, const Array< OneD, NekDouble > > &	GetVecLocs ()
const Array< OneD, const Array< OneD, NekDouble > > &	GetNormals ()
const Array< OneD, NekDouble > &	GetDepth ()
bool	IsConstantDepth ()
Protected Member Functions inherited from Nektar::SolverUtils::UnsteadySystem
SOLVER_UTILS_EXPORT	UnsteadySystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Initialises UnsteadySystem class members.
SOLVER_UTILS_EXPORT void	v_InitObject (bool DeclareField=true) override
	Init object for UnsteadySystem class.
SOLVER_UTILS_EXPORT void	v_DoSolve () override
	Solves an unsteady problem.
virtual SOLVER_UTILS_EXPORT void	v_PrintStatusInformation (const int step, const NekDouble cpuTime)
	Print Status Information.
virtual SOLVER_UTILS_EXPORT void	v_PrintSummaryStatistics (const NekDouble intTime)
	Print Summary Statistics.
SOLVER_UTILS_EXPORT void	v_DoInitialise (bool dumpInitialConditions=true) override
	Sets up initial conditions.
SOLVER_UTILS_EXPORT void	v_GenerateSummary (SummaryList &s) override
	Print a summary of time stepping parameters.
virtual SOLVER_UTILS_EXPORT NekDouble	v_GetTimeStep (const Array< OneD, const Array< OneD, NekDouble > > &inarray)
	Return the timestep to be used for the next step in the time-marching loop.
virtual SOLVER_UTILS_EXPORT bool	v_PreIntegrate (int step)
virtual SOLVER_UTILS_EXPORT bool	v_PostIntegrate (int step)
virtual SOLVER_UTILS_EXPORT bool	v_RequireFwdTrans ()
virtual SOLVER_UTILS_EXPORT void	v_SteadyStateResidual (int step, Array< OneD, NekDouble > &L2)
virtual SOLVER_UTILS_EXPORT bool	v_UpdateTimeStepCheck ()
SOLVER_UTILS_EXPORT NekDouble	MaxTimeStepEstimator ()
	Get the maximum timestep estimator for cfl control.
SOLVER_UTILS_EXPORT void	CheckForRestartTime (NekDouble &time, int &nchk)
SOLVER_UTILS_EXPORT void	SVVVarDiffCoeff (const Array< OneD, Array< OneD, NekDouble > > vel, StdRegions::VarCoeffMap &varCoeffMap)
	Evaluate the SVV diffusion coefficient according to Moura's paper where it should proportional to h time velocity.
SOLVER_UTILS_EXPORT void	DoDummyProjection (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
	Perform dummy projection.
Protected Member Functions inherited from Nektar::SolverUtils::EquationSystem
SOLVER_UTILS_EXPORT	EquationSystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Initialises EquationSystem class members.
virtual SOLVER_UTILS_EXPORT NekDouble	v_LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Virtual function for the L_inf error computation between fields and a given exact solution.
virtual SOLVER_UTILS_EXPORT NekDouble	v_L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
	Virtual function for the L_2 error computation between fields and a given exact solution.
virtual SOLVER_UTILS_EXPORT NekDouble	v_H1Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
	Virtual function for the H_1 error computation between fields and a given exact solution.
virtual SOLVER_UTILS_EXPORT void	v_TransCoeffToPhys ()
	Virtual function for transformation to physical space.
virtual SOLVER_UTILS_EXPORT void	v_TransPhysToCoeff ()
	Virtual function for transformation to coefficient space.
virtual SOLVER_UTILS_EXPORT void	v_SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
virtual SOLVER_UTILS_EXPORT void	v_EvaluateExactSolution (unsigned int field, Array< OneD, NekDouble > &outfield, const NekDouble time)
virtual SOLVER_UTILS_EXPORT void	v_Output (void)
virtual SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr	v_GetPressure (void)
virtual SOLVER_UTILS_EXPORT bool	v_NegatedOp (void)
	Virtual function to identify if operator is negated in DoSolve.
virtual SOLVER_UTILS_EXPORT void	v_ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)

Private Attributes
Array< OneD, NekDouble >	m_dFwd
	Still water depth traces.
Array< OneD, NekDouble >	m_dBwd

Friends
class	MemoryManager< LinearSWE >

Additional Inherited Members
Public Member Functions inherited from Nektar::SolverUtils::UnsteadySystem
SOLVER_UTILS_EXPORT	~UnsteadySystem () override=default
	Destructor.
SOLVER_UTILS_EXPORT NekDouble	GetTimeStep (const Array< OneD, const Array< OneD, NekDouble > > &inarray)
	Calculate the larger time-step mantaining the problem stable.
SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()
SOLVER_UTILS_EXPORT void	SetTimeStep (const NekDouble timestep)
SOLVER_UTILS_EXPORT void	SteadyStateResidual (int step, Array< OneD, NekDouble > &L2)
SOLVER_UTILS_EXPORT LibUtilities::TimeIntegrationSchemeSharedPtr &	GetTimeIntegrationScheme ()
	Returns the time integration scheme.
SOLVER_UTILS_EXPORT LibUtilities::TimeIntegrationSchemeOperators &	GetTimeIntegrationSchemeOperators ()
	Returns the time integration scheme operators.
Public Member Functions inherited from Nektar::SolverUtils::EquationSystem
virtual SOLVER_UTILS_EXPORT	~EquationSystem ()
	Destructor.
SOLVER_UTILS_EXPORT void	InitObject (bool DeclareField=true)
	Initialises the members of this object.
SOLVER_UTILS_EXPORT void	DoInitialise (bool dumpInitialConditions=true)
	Perform any initialisation necessary before solving the problem.
SOLVER_UTILS_EXPORT void	DoSolve ()
	Solve the problem.
SOLVER_UTILS_EXPORT void	TransCoeffToPhys ()
	Transform from coefficient to physical space.
SOLVER_UTILS_EXPORT void	TransPhysToCoeff ()
	Transform from physical to coefficient space.
SOLVER_UTILS_EXPORT void	Output ()
	Perform output operations after solve.
SOLVER_UTILS_EXPORT std::string	GetSessionName ()
	Get Session name.
template<class T >
std::shared_ptr< T >	as ()
SOLVER_UTILS_EXPORT void	ResetSessionName (std::string newname)
	Reset Session name.
SOLVER_UTILS_EXPORT LibUtilities::SessionReaderSharedPtr	GetSession ()
	Get Session name.
SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr	GetPressure ()
	Get pressure field if available.
SOLVER_UTILS_EXPORT void	ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
SOLVER_UTILS_EXPORT void	PrintSummary (std::ostream &out)
	Print a summary of parameters and solver characteristics.
SOLVER_UTILS_EXPORT void	SetLambda (NekDouble lambda)
	Set parameter m_lambda.
SOLVER_UTILS_EXPORT SessionFunctionSharedPtr	GetFunction (std::string name, const MultiRegions::ExpListSharedPtr &field=MultiRegions::NullExpListSharedPtr, bool cache=false)
	Get a SessionFunction by name.
SOLVER_UTILS_EXPORT void	SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
	Initialise the data in the dependent fields.
SOLVER_UTILS_EXPORT void	EvaluateExactSolution (int field, Array< OneD, NekDouble > &outfield, const NekDouble time)
	Evaluates an exact solution.
SOLVER_UTILS_EXPORT NekDouble	L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
	Compute the L2 error between fields and a given exact solution.
SOLVER_UTILS_EXPORT NekDouble	L2Error (unsigned int field, bool Normalised=false)
	Compute the L2 error of the fields.
SOLVER_UTILS_EXPORT NekDouble	LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Linf error computation.
SOLVER_UTILS_EXPORT NekDouble	H1Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
	Compute the H1 error between fields and a given exact solution.
SOLVER_UTILS_EXPORT Array< OneD, NekDouble >	ErrorExtraPoints (unsigned int field)
	Compute error (L2 and L_inf) over an larger set of quadrature points return [L2 Linf].
SOLVER_UTILS_EXPORT void	Checkpoint_Output (const int n)
	Write checkpoint file of m_fields.
SOLVER_UTILS_EXPORT void	Checkpoint_Output (const int n, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write checkpoint file of custom data fields.
SOLVER_UTILS_EXPORT void	Checkpoint_BaseFlow (const int n)
	Write base flow file of m_fields.
SOLVER_UTILS_EXPORT void	WriteFld (const std::string &outname)
	Write field data to the given filename.
SOLVER_UTILS_EXPORT void	WriteFld (const std::string &outname, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write input fields to the given filename.
SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
	Input field data from the given file.
SOLVER_UTILS_EXPORT void	ImportFldToMultiDomains (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int ndomains)
	Input field data from the given file to multiple domains.
SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, std::vector< std::string > &fieldStr, Array< OneD, Array< OneD, NekDouble > > &coeffs)
	Output a field. Input field data into array from the given file.
SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, MultiRegions::ExpListSharedPtr &pField, std::string &pFieldName)
	Output a field. Input field data into ExpList from the given file.
SOLVER_UTILS_EXPORT void	SessionSummary (SummaryList &vSummary)
	Write out a session summary.
SOLVER_UTILS_EXPORT Array< OneD, MultiRegions::ExpListSharedPtr > &	UpdateFields ()
SOLVER_UTILS_EXPORT LibUtilities::FieldMetaDataMap &	UpdateFieldMetaDataMap ()
	Get hold of FieldInfoMap so it can be updated.
SOLVER_UTILS_EXPORT NekDouble	GetTime ()
	Return final time.
SOLVER_UTILS_EXPORT int	GetNcoeffs ()
SOLVER_UTILS_EXPORT int	GetNcoeffs (const int eid)
SOLVER_UTILS_EXPORT int	GetNumExpModes ()
SOLVER_UTILS_EXPORT const Array< OneD, int >	GetNumExpModesPerExp ()
SOLVER_UTILS_EXPORT int	GetNvariables ()
SOLVER_UTILS_EXPORT const std::string	GetVariable (unsigned int i)
SOLVER_UTILS_EXPORT int	GetTraceTotPoints ()
SOLVER_UTILS_EXPORT int	GetTraceNpoints ()
SOLVER_UTILS_EXPORT int	GetExpSize ()
SOLVER_UTILS_EXPORT int	GetPhys_Offset (int n)
SOLVER_UTILS_EXPORT int	GetCoeff_Offset (int n)
SOLVER_UTILS_EXPORT int	GetTotPoints ()
SOLVER_UTILS_EXPORT int	GetTotPoints (int n)
SOLVER_UTILS_EXPORT int	GetNpoints ()
SOLVER_UTILS_EXPORT int	GetSteps ()
SOLVER_UTILS_EXPORT void	SetSteps (const int steps)
SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()
SOLVER_UTILS_EXPORT void	CopyFromPhysField (const int i, Array< OneD, NekDouble > &output)
SOLVER_UTILS_EXPORT void	CopyToPhysField (const int i, const Array< OneD, const NekDouble > &input)
SOLVER_UTILS_EXPORT Array< OneD, NekDouble > &	UpdatePhysField (const int i)
SOLVER_UTILS_EXPORT void	ZeroPhysFields ()
SOLVER_UTILS_EXPORT void	FwdTransFields ()
SOLVER_UTILS_EXPORT void	SetModifiedBasis (const bool modbasis)
SOLVER_UTILS_EXPORT int	GetCheckpointNumber ()
SOLVER_UTILS_EXPORT void	SetCheckpointNumber (int num)
SOLVER_UTILS_EXPORT int	GetCheckpointSteps ()
SOLVER_UTILS_EXPORT void	SetCheckpointSteps (int num)
SOLVER_UTILS_EXPORT int	GetInfoSteps ()
SOLVER_UTILS_EXPORT void	SetInfoSteps (int num)
SOLVER_UTILS_EXPORT void	SetIterationNumberPIT (int num)
SOLVER_UTILS_EXPORT void	SetWindowNumberPIT (int num)
SOLVER_UTILS_EXPORT Array< OneD, const Array< OneD, NekDouble > >	GetTraceNormals ()
SOLVER_UTILS_EXPORT void	SetTime (const NekDouble time)
SOLVER_UTILS_EXPORT void	SetTimeStep (const NekDouble timestep)
SOLVER_UTILS_EXPORT void	SetInitialStep (const int step)
SOLVER_UTILS_EXPORT void	SetBoundaryConditions (NekDouble time)
	Evaluates the boundary conditions at the given time.
SOLVER_UTILS_EXPORT bool	NegatedOp ()
	Identify if operator is negated in DoSolve.
Public Member Functions inherited from Nektar::SolverUtils::ALEHelper
virtual	~ALEHelper ()=default
virtual SOLVER_UTILS_EXPORT void	v_ALEInitObject (int spaceDim, Array< OneD, MultiRegions::ExpListSharedPtr > &fields)
SOLVER_UTILS_EXPORT void	InitObject (int spaceDim, Array< OneD, MultiRegions::ExpListSharedPtr > &fields)
virtual SOLVER_UTILS_EXPORT void	v_UpdateGridVelocity (const NekDouble &time)
virtual SOLVER_UTILS_EXPORT void	v_ALEPreMultiplyMass (Array< OneD, Array< OneD, NekDouble > > &fields)
SOLVER_UTILS_EXPORT void	ALEDoElmtInvMass (Array< OneD, Array< OneD, NekDouble > > &traceNormals, Array< OneD, Array< OneD, NekDouble > > &fields, NekDouble time)
	Update m_fields with u^n by multiplying by inverse mass matrix. That's then used in e.g. checkpoint output and L^2 error calculation.
SOLVER_UTILS_EXPORT void	ALEDoElmtInvMassBwdTrans (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
SOLVER_UTILS_EXPORT void	MoveMesh (const NekDouble &time, Array< OneD, Array< OneD, NekDouble > > &traceNormals)
SOLVER_UTILS_EXPORT void	ResetMatricesNormal (Array< OneD, Array< OneD, NekDouble > > &traceNormals)
SOLVER_UTILS_EXPORT void	UpdateNormalsFlag ()
const Array< OneD, const Array< OneD, NekDouble > > &	GetGridVelocity ()
bool &	GetUpdateNormalsFlag ()
SOLVER_UTILS_EXPORT const Array< OneD, const Array< OneD, NekDouble > > &	GetGridVelocityTrace ()
SOLVER_UTILS_EXPORT void	ExtraFldOutputGridVelocity (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
SOLVER_UTILS_EXPORT void	ExtraFldOutputGrid (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
Protected Types inherited from Nektar::SolverUtils::EquationSystem
enum	HomogeneousType { eHomogeneous1D , eHomogeneous2D , eHomogeneous3D , eNotHomogeneous }
	Parameter for homogeneous expansions. More...
Protected Attributes inherited from Nektar::ShallowWaterSystem
SolverUtils::RiemannSolverSharedPtr	m_riemannSolver
SolverUtils::AdvectionSharedPtr	m_advection
SolverUtils::DiffusionSharedPtr	m_diffusion
int	m_TotNewtonIts = 0
int	m_TotLinIts = 0
int	m_TotImpStages = 0
NekDouble	m_jacobiFreeEps = 5.0E-08
NekDouble	m_bndEvaluateTime = 0.0
NekDouble	m_TimeIntegLambda = 0.0
NekDouble	m_inArrayNorm = -1.0
LibUtilities::NekNonlinSysIterSharedPtr	m_nonlinsol
bool	m_constantDepth
	Indicates if constant depth case.
NekDouble	m_g
	Acceleration of gravity.
Array< OneD, NekDouble >	m_depth
	Still water depth.
Array< OneD, Array< OneD, NekDouble > >	m_bottomSlope
Array< OneD, NekDouble >	m_coriolis
	Coriolis force.
Array< OneD, Array< OneD, NekDouble > >	m_vecLocs
Protected Attributes inherited from Nektar::SolverUtils::UnsteadySystem
LibUtilities::TimeIntegrationSchemeSharedPtr	m_intScheme
	Wrapper to the time integration scheme.
LibUtilities::TimeIntegrationSchemeOperators	m_ode
	The time integration scheme operators to use.
Array< OneD, Array< OneD, NekDouble > >	m_previousSolution
	Storage for previous solution for steady-state check.
std::vector< int >	m_intVariables
NekDouble	m_cflSafetyFactor
	CFL safety factor (comprise between 0 to 1).
NekDouble	m_CFLGrowth
	CFL growth rate.
NekDouble	m_CFLEnd
	Maximun cfl in cfl growth.
int	m_abortSteps
	Number of steps between checks for abort conditions.
bool	m_explicitDiffusion
	Indicates if explicit or implicit treatment of diffusion is used.
bool	m_explicitAdvection
	Indicates if explicit or implicit treatment of advection is used.
bool	m_explicitReaction
	Indicates if explicit or implicit treatment of reaction is used.
int	m_steadyStateSteps
	Check for steady state at step interval.
NekDouble	m_steadyStateTol
	Tolerance to which steady state should be evaluated at.
int	m_filtersInfosteps
	Number of time steps between outputting filters information.
std::vector< std::pair< std::string, FilterSharedPtr > >	m_filters
bool	m_homoInitialFwd
	Flag to determine if simulation should start in homogeneous forward transformed state.
std::ofstream	m_errFile
NekDouble	m_epsilon
	Diffusion coefficient.
Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
LibUtilities::CommSharedPtr	m_comm
	Communicator.
bool	m_verbose
LibUtilities::SessionReaderSharedPtr	m_session
	The session reader.
std::map< std::string, SolverUtils::SessionFunctionSharedPtr >	m_sessionFunctions
	Map of known SessionFunctions.
LibUtilities::FieldIOSharedPtr	m_fld
	Field input/output.
Array< OneD, MultiRegions::ExpListSharedPtr >	m_fields
	Array holding all dependent variables.
SpatialDomains::BoundaryConditionsSharedPtr	m_boundaryConditions
	Pointer to boundary conditions object.
SpatialDomains::MeshGraphSharedPtr	m_graph
	Pointer to graph defining mesh.
std::string	m_sessionName
	Name of the session.
NekDouble	m_time
	Current time of simulation.
int	m_initialStep
	Number of the step where the simulation should begin.
NekDouble	m_fintime
	Finish time of the simulation.
NekDouble	m_timestep
	Time step size.
NekDouble	m_lambda
	Lambda constant in real system if one required.
NekDouble	m_checktime
	Time between checkpoints.
NekDouble	m_lastCheckTime
NekDouble	m_TimeIncrementFactor
int	m_nchk
	Number of checkpoints written so far.
int	m_steps
	Number of steps to take.
int	m_checksteps
	Number of steps between checkpoints.
int	m_infosteps
	Number of time steps between outputting status information.
int	m_iterPIT = 0
	Number of parallel-in-time time iteration.
int	m_windowPIT = 0
	Index of windows for parallel-in-time time iteration.
int	m_spacedim
	Spatial dimension (>= expansion dim).
int	m_expdim
	Expansion dimension.
bool	m_singleMode
	Flag to determine if single homogeneous mode is used.
bool	m_halfMode
	Flag to determine if half homogeneous mode is used.
bool	m_multipleModes
	Flag to determine if use multiple homogenenous modes are used.
bool	m_useFFT
	Flag to determine if FFT is used for homogeneous transform.
bool	m_homogen_dealiasing
	Flag to determine if dealiasing is used for homogeneous simulations.
bool	m_specHP_dealiasing
	Flag to determine if dealisising is usde for the Spectral/hp element discretisation.
enum MultiRegions::ProjectionType	m_projectionType
	Type of projection; e.g continuous or discontinuous.
Array< OneD, Array< OneD, NekDouble > >	m_traceNormals
	Array holding trace normals for DG simulations in the forwards direction.
Array< OneD, bool >	m_checkIfSystemSingular
	Flag to indicate if the fields should be checked for singularity.
LibUtilities::FieldMetaDataMap	m_fieldMetaDataMap
	Map to identify relevant solver info to dump in output fields.
Array< OneD, NekDouble >	m_movingFrameData
	Moving reference frame status in the inertial frame X, Y, Z, Theta_x, Theta_y, Theta_z, U, V, W, Omega_x, Omega_y, Omega_z, A_x, A_y, A_z, DOmega_x, DOmega_y, DOmega_z, pivot_x, pivot_y, pivot_z.
std::vector< std::string >	m_strFrameData
	variable name in m_movingFrameData
int	m_NumQuadPointsError
	Number of Quadrature points used to work out the error.
enum HomogeneousType	m_HomogeneousType
NekDouble	m_LhomX
	physical length in X direction (if homogeneous)
NekDouble	m_LhomY
	physical length in Y direction (if homogeneous)
NekDouble	m_LhomZ
	physical length in Z direction (if homogeneous)
int	m_npointsX
	number of points in X direction (if homogeneous)
int	m_npointsY
	number of points in Y direction (if homogeneous)
int	m_npointsZ
	number of points in Z direction (if homogeneous)
int	m_HomoDirec
	number of homogenous directions
Protected Attributes inherited from Nektar::SolverUtils::ALEHelper
Array< OneD, MultiRegions::ExpListSharedPtr >	m_fieldsALE
Array< OneD, Array< OneD, NekDouble > >	m_gridVelocity
Array< OneD, Array< OneD, NekDouble > >	m_gridVelocityTrace
std::vector< ALEBaseShPtr >	m_ALEs
bool	m_ALESolver = false
bool	m_meshDistorted = false
bool	m_implicitALESolver = false
bool	m_updateNormals = false
NekDouble	m_prevStageTime = 0.0
int	m_spaceDim
Static Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
static std::string	equationSystemTypeLookupIds []
static std::string	projectionTypeLookupIds []

Detailed Description

Definition at line 43 of file LinearSWE.h.

Constructor & Destructor Documentation

LinearSWE()

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

protected

Definition at line 49 of file LinearSWE.cpp.

    : ShallowWaterSystem(pSession, pGraph)
{
}

~LinearSWE()

Nektar::LinearSWE::~LinearSWE ( )

overrideprotecteddefault

Member Function Documentation

CopyBoundaryTrace()

void Nektar::LinearSWE::CopyBoundaryTrace ( const Array< OneD, const NekDouble > &  Fwd, Array< OneD, NekDouble > &  Bwd  )

protected

Definition at line 287 of file LinearSWE.cpp.

{
    int cnt = 0;
 
    // loop over Boundary Regions
    for (int bcRegion = 0; bcRegion < m_fields[0]->GetBndConditions().size();
         ++bcRegion)
    {
        if (m_fields[0]
                ->GetBndConditions()[bcRegion]
                ->GetBoundaryConditionType() == SpatialDomains::ePeriodic)
        {
            continue;
        }
 
        // Copy the forward trace of the field to the backward trace
        int id2, npts;
 
        for (int e = 0;
             e < m_fields[0]->GetBndCondExpansions()[bcRegion]->GetExpSize();
             ++e)
        {
            npts = m_fields[0]
                       ->GetBndCondExpansions()[bcRegion]
                       ->GetExp(e)
                       ->GetTotPoints();
            id2 = m_fields[0]->GetTrace()->GetPhys_Offset(
                m_fields[0]->GetTraceMap()->GetBndCondIDToGlobalTraceID(cnt +
                                                                        e));
 
            Vmath::Vcopy(npts, &Fwd[id2], 1, &Bwd[id2], 1);
        }
 
        cnt += m_fields[0]->GetBndCondExpansions()[bcRegion]->GetExpSize();
    }
}

References Nektar::SpatialDomains::ePeriodic, Nektar::SolverUtils::EquationSystem::GetExpSize(), Nektar::SolverUtils::EquationSystem::m_fields, and Vmath::Vcopy().

Referenced by v_InitObject().

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 49 of file LinearSWE.h.

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

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

GetDepthBwd()

const Array< OneD, NekDouble > & Nektar::LinearSWE::GetDepthBwd ( )

inlineprotected

Definition at line 92 of file LinearSWE.h.

    {
        return m_dBwd;
    }

References m_dBwd.

Referenced by v_InitObject().

GetDepthFwd()

const Array< OneD, NekDouble > & Nektar::LinearSWE::GetDepthFwd ( )

inlineprotected

Definition at line 87 of file LinearSWE.h.

    {
        return m_dFwd;
    }

References m_dFwd.

Referenced by v_InitObject().

GetFluxVector()

void Nektar::LinearSWE::GetFluxVector ( const Array< OneD, const Array< OneD, NekDouble > > &  physfield, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &  flux  )

protected

Definition at line 240 of file LinearSWE.cpp.

{
    int nq = m_fields[0]->GetTotPoints();
 
    NekDouble g = m_g;
 
    // Flux vector for the mass equation
    for (int i = 0; i < m_spacedim; ++i)
    {
        Vmath::Vmul(nq, m_depth, 1, physfield[i + 1], 1, flux[0][i], 1);
    }
 
    // Flux vector for the momentum equations
    for (int i = 0; i < m_spacedim; ++i)
    {
        for (int j = 0; j < m_spacedim; ++j)
        {
            // must zero fluxes as not initialised to zero in AdvectionWeakDG
            Vmath::Zero(nq, flux[i + 1][j], 1);
        }
 
        // Add (g eta) to appropriate field
        Vmath::Smul(nq, g, physfield[0], 1, flux[i + 1][i], 1);
    }
}

References Nektar::ShallowWaterSystem::m_depth, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::ShallowWaterSystem::m_g, Nektar::SolverUtils::EquationSystem::m_spacedim, Vmath::Smul(), Vmath::Vmul(), and Vmath::Zero().

Referenced by v_DoOdeRhs(), and v_InitObject().

GetVelocityVector()

void Nektar::LinearSWE::GetVelocityVector ( const Array< OneD, const Array< OneD, NekDouble > > &  physfield, Array< OneD, Array< OneD, NekDouble > > &  velocity  )

protected

Compute the velocity field \( \mathbf{v} \) given the momentum \( h\mathbf{v} \).

Parameters

physfield	Velocity field.
velocity	Velocity field.

Definition at line 275 of file LinearSWE.cpp.

{
    const int npts = physfield[0].size();
 
    for (int i = 0; i < m_spacedim; ++i)
    {
        Vmath::Vcopy(npts, physfield[1 + i], 1, velocity[i], 1);
    }
}

References Nektar::SolverUtils::EquationSystem::m_spacedim, and Vmath::Vcopy().

v_DoOdeRhs()

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

overrideprotectedvirtual

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 125 of file LinearSWE.cpp.

{
    int ndim       = m_spacedim;
    int nvariables = inarray.size();
    int nq         = GetTotPoints();
 
    switch (m_projectionType)
    {
        case MultiRegions::eDiscontinuous:
        {
            //-------------------------------------------------------
            // Compute the DG advection including the numerical flux
            // by using SolverUtils/Advection
            // Input and output in physical space
            m_advection->Advect(nvariables, m_fields, NullNekDoubleArrayOfArray,
                                inarray, outarray, time);
            //-------------------------------------------------------
 
            //-------------------------------------------------------
            // negate the outarray since moving terms to the rhs
            for (int i = 0; i < nvariables; ++i)
            {
                Vmath::Neg(nq, outarray[i], 1);
            }
            //-------------------------------------------------------
 
            //-------------------------------------------------
            // Add "source terms"
            // Input and output in physical space
 
            // Coriolis forcing
            if (m_coriolis.size() != 0)
            {
                AddCoriolis(inarray, outarray);
            }
            //-------------------------------------------------
        }
        break;
        case MultiRegions::eGalerkin:
        {
            //-------------------------------------------------------
            // Compute the fluxvector in physical space
            Array<OneD, Array<OneD, Array<OneD, NekDouble>>> fluxvector(
                nvariables);
 
            for (int i = 0; i < nvariables; ++i)
            {
                fluxvector[i] = Array<OneD, Array<OneD, NekDouble>>(ndim);
                for (int j = 0; j < ndim; ++j)
                {
                    fluxvector[i][j] = Array<OneD, NekDouble>(nq);
                }
            }
 
            LinearSWE::GetFluxVector(inarray, fluxvector);
            //-------------------------------------------------------
 
            //-------------------------------------------------------
            // Take the derivative of the flux terms
            // and negate the outarray since moving terms to the rhs
            Array<OneD, NekDouble> tmp0(nq);
            Array<OneD, NekDouble> tmp1(nq);
 
            for (int i = 0; i < nvariables; ++i)
            {
                m_fields[i]->PhysDeriv(MultiRegions::DirCartesianMap[0],
                                       fluxvector[i][0], tmp0);
                m_fields[i]->PhysDeriv(MultiRegions::DirCartesianMap[1],
                                       fluxvector[i][1], tmp1);
                Vmath::Vadd(nq, tmp0, 1, tmp1, 1, outarray[i], 1);
                Vmath::Neg(nq, outarray[i], 1);
            }
 
            //-------------------------------------------------
            // Add "source terms"
            // Input and output in physical space
 
            // Coriolis forcing
            if (m_coriolis.size() != 0)
            {
                AddCoriolis(inarray, outarray);
            }
            //-------------------------------------------------
        }
        break;
        default:
            ASSERTL0(false, "Unknown projection scheme for the LinearSWE");
            break;
    }
}

References Nektar::ShallowWaterSystem::AddCoriolis(), ASSERTL0, Nektar::MultiRegions::DirCartesianMap, Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, GetFluxVector(), Nektar::SolverUtils::EquationSystem::GetTotPoints(), Nektar::ShallowWaterSystem::m_advection, Nektar::ShallowWaterSystem::m_coriolis, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_projectionType, Nektar::SolverUtils::EquationSystem::m_spacedim, Vmath::Neg(), Nektar::NullNekDoubleArrayOfArray, and Vmath::Vadd().

Referenced by v_InitObject().

v_GenerateSummary()

void Nektar::LinearSWE::v_GenerateSummary ( SolverUtils::SummaryList &  l )

overrideprotectedvirtual

Virtual function for generating summary information.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Definition at line 218 of file LinearSWE.cpp.

{
    ShallowWaterSystem::v_GenerateSummary(s);
    if (m_session->DefinesSolverInfo("UpwindType"))
    {
        std::string UpwindType;
        UpwindType = m_session->GetSolverInfo("UpwindType");
        if (UpwindType == "LinearAverage")
        {
            SolverUtils::AddSummaryItem(s, "Riemann Solver", "Linear Average");
        }
        else if (UpwindType == "LinearHLL")
        {
            SolverUtils::AddSummaryItem(s, "Riemann Solver", "Linear HLL");
        }
    }
    SolverUtils::AddSummaryItem(s, "Variables", "eta  should be in field[0]");
    SolverUtils::AddSummaryItem(s, "", "u    should be in field[1]");
    SolverUtils::AddSummaryItem(s, "", "v    should be in field[2]");
}

References Nektar::SolverUtils::AddSummaryItem(), Nektar::SolverUtils::EquationSystem::m_session, and Nektar::ShallowWaterSystem::v_GenerateSummary().

v_InitObject()

void Nektar::LinearSWE::v_InitObject ( bool  DeclareFeld = true )

overrideprotectedvirtual

Initialisation object for EquationSystem.

Continuous field

Setting up the normals

Setting up the normals

Reimplemented from Nektar::SolverUtils::EquationSystem.

Definition at line 55 of file LinearSWE.cpp.

{
    ShallowWaterSystem::v_InitObject(DeclareFields);
 
    // Type of advection class to be used
    switch (m_projectionType)
    {
        // Continuous field
        case MultiRegions::eGalerkin:
        {
            //  Do nothing
            break;
        }
        // Discontinuous field
        case MultiRegions::eDiscontinuous:
        {
            std::string advName;
            std::string diffName;
            std::string riemName;
 
            //---------------------------------------------------------------
            // Setting up advection and diffusion operators
            m_session->LoadSolverInfo("AdvectionType", advName, "WeakDG");
            m_advection = SolverUtils::GetAdvectionFactory().CreateInstance(
                advName, advName);
            m_advection->SetFluxVector(&LinearSWE::GetFluxVector, this);
 
            // Setting up Riemann solver for advection operator
            m_session->LoadSolverInfo("UpwindType", riemName, "NoSolver");
            if ((riemName == "LinearHLL") && (m_constantDepth != true))
            {
                ASSERTL0(false, "LinearHLL only valid for constant depth");
            }
            m_riemannSolver =
                SolverUtils::GetRiemannSolverFactory().CreateInstance(
                    riemName, m_session);
 
            // Setting up parameters for advection operator Riemann solver
            m_riemannSolver->SetParam("gravity", &LinearSWE::GetGravity, this);
            m_riemannSolver->SetAuxVec("vecLocs", &LinearSWE::GetVecLocs, this);
            m_riemannSolver->SetVector("N", &LinearSWE::GetNormals, this);
 
            // The numerical flux for linear SWE requires depth information
            int nTracePointsTot = m_fields[0]->GetTrace()->GetTotPoints();
            m_dFwd              = Array<OneD, NekDouble>(nTracePointsTot);
            m_dBwd              = Array<OneD, NekDouble>(nTracePointsTot);
            m_fields[0]->GetFwdBwdTracePhys(m_depth, m_dFwd, m_dBwd);
            CopyBoundaryTrace(m_dFwd, m_dBwd);
            m_riemannSolver->SetScalar("depthFwd", &LinearSWE::GetDepthFwd,
                                       this);
            m_riemannSolver->SetScalar("depthBwd", &LinearSWE::GetDepthBwd,
                                       this);
 
            // Concluding initialisation of advection operators
            m_advection->SetRiemannSolver(m_riemannSolver);
            m_advection->InitObject(m_session, m_fields);
            break;
        }
        default:
        {
            ASSERTL0(false, "Unsupported projection type.");
            break;
        }
    }
 
    m_ode.DefineOdeRhs(&LinearSWE::v_DoOdeRhs, this);
    m_ode.DefineProjection(&LinearSWE::DoOdeProjection, this);
    m_ode.DefineImplicitSolve(&LinearSWE::DoImplicitSolve, this);
}

References ASSERTL0, CopyBoundaryTrace(), Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineImplicitSolve(), Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineOdeRhs(), Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineProjection(), Nektar::ShallowWaterSystem::DoImplicitSolve(), Nektar::ShallowWaterSystem::DoOdeProjection(), Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, Nektar::SolverUtils::GetAdvectionFactory(), GetDepthBwd(), GetDepthFwd(), GetFluxVector(), Nektar::ShallowWaterSystem::GetGravity(), Nektar::ShallowWaterSystem::GetNormals(), Nektar::SolverUtils::GetRiemannSolverFactory(), Nektar::ShallowWaterSystem::GetVecLocs(), Nektar::ShallowWaterSystem::m_advection, Nektar::ShallowWaterSystem::m_constantDepth, m_dBwd, Nektar::ShallowWaterSystem::m_depth, m_dFwd, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::UnsteadySystem::m_ode, Nektar::SolverUtils::EquationSystem::m_projectionType, Nektar::ShallowWaterSystem::m_riemannSolver, Nektar::SolverUtils::EquationSystem::m_session, v_DoOdeRhs(), and Nektar::ShallowWaterSystem::v_InitObject().

Friends And Related Symbol Documentation

MemoryManager< LinearSWE >

friend class MemoryManager< LinearSWE >

friend

Definition at line 1 of file LinearSWE.h.

Member Data Documentation

className

std::string Nektar::LinearSWE::className

static

Initial value:

=
    SolverUtils::GetEquationSystemFactory().RegisterCreatorFunction(
        "LinearSWE", LinearSWE::create,
        "Linear shallow water equation in primitive variables.")

Name of class.

Definition at line 60 of file LinearSWE.h.

m_dBwd

Array<OneD, NekDouble> Nektar::LinearSWE::m_dBwd

private

Definition at line 100 of file LinearSWE.h.

Referenced by GetDepthBwd(), and v_InitObject().

m_dFwd

Array<OneD, NekDouble> Nektar::LinearSWE::m_dFwd

private

Still water depth traces.

Definition at line 99 of file LinearSWE.h.

Referenced by GetDepthFwd(), and v_InitObject().