Base class for unsteady solvers. More...

#include <ShallowWaterSystem.h>

Inheritance diagram for Nektar::ShallowWaterSystem:

Public Member Functions
	~ShallowWaterSystem () override=default
	Destructor. More...

Public Member Functions inherited from Nektar::SolverUtils::UnsteadySystem
SOLVER_UTILS_EXPORT	~UnsteadySystem () override
	Destructor. More...

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

SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()

SOLVER_UTILS_EXPORT void	SetTimeStep (const NekDouble timestep)

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

SOLVER_UTILS_EXPORT LibUtilities::TimeIntegrationSchemeSharedPtr &	GetTimeIntegrationScheme ()
	Returns the time integration scheme. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SOLVER_UTILS_EXPORT void	PrintSummary (std::ostream &out)
	Print a summary of parameters and solver characteristics. More...

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

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

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

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

SOLVER_UTILS_EXPORT NekDouble	L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
	Compute the L2 error between fields and a given exact solution. More...

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

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

SOLVER_UTILS_EXPORT Array< OneD, NekDouble >	ErrorExtraPoints (unsigned int field)
	Compute error (L2 and L_inf) over an larger set of quadrature points return [L2 Linf]. More...

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

SOLVER_UTILS_EXPORT void	Checkpoint_Output (const int n, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write checkpoint file of custom data fields. More...

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

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

SOLVER_UTILS_EXPORT void	WriteFld (const std::string &outname, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
	Write input fields to the given filename. More...

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

SOLVER_UTILS_EXPORT void	ImportFldToMultiDomains (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int ndomains)
	Input field data from the given file to multiple domains. More...

SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, std::vector< std::string > &fieldStr, Array< OneD, Array< OneD, NekDouble > > &coeffs)
	Output a field. Input field data into array from the given file. More...

SOLVER_UTILS_EXPORT void	ImportFld (const std::string &infile, MultiRegions::ExpListSharedPtr &pField, std::string &pFieldName)
	Output a field. Input field data into ExpList from the given file. More...

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

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

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

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

SOLVER_UTILS_EXPORT int	GetNcoeffs ()

SOLVER_UTILS_EXPORT int	GetNcoeffs (const int eid)

SOLVER_UTILS_EXPORT int	GetNumExpModes ()

SOLVER_UTILS_EXPORT const Array< OneD, int >	GetNumExpModesPerExp ()

SOLVER_UTILS_EXPORT int	GetNvariables ()

SOLVER_UTILS_EXPORT const std::string	GetVariable (unsigned int i)

SOLVER_UTILS_EXPORT int	GetTraceTotPoints ()

SOLVER_UTILS_EXPORT int	GetTraceNpoints ()

SOLVER_UTILS_EXPORT int	GetExpSize ()

SOLVER_UTILS_EXPORT int	GetPhys_Offset (int n)

SOLVER_UTILS_EXPORT int	GetCoeff_Offset (int n)

SOLVER_UTILS_EXPORT int	GetTotPoints ()

SOLVER_UTILS_EXPORT int	GetTotPoints (int n)

SOLVER_UTILS_EXPORT int	GetNpoints ()

SOLVER_UTILS_EXPORT int	GetSteps ()

SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()

SOLVER_UTILS_EXPORT void	CopyFromPhysField (const int i, Array< OneD, NekDouble > &output)

SOLVER_UTILS_EXPORT void	CopyToPhysField (const int i, const Array< OneD, const NekDouble > &input)

SOLVER_UTILS_EXPORT Array< OneD, NekDouble > &	UpdatePhysField (const int i)

SOLVER_UTILS_EXPORT void	SetSteps (const int steps)

SOLVER_UTILS_EXPORT void	ZeroPhysFields ()

SOLVER_UTILS_EXPORT void	FwdTransFields ()

SOLVER_UTILS_EXPORT void	SetModifiedBasis (const bool modbasis)

SOLVER_UTILS_EXPORT int	GetCheckpointNumber ()

SOLVER_UTILS_EXPORT void	SetCheckpointNumber (int num)

SOLVER_UTILS_EXPORT int	GetCheckpointSteps ()

SOLVER_UTILS_EXPORT void	SetCheckpointSteps (int num)

SOLVER_UTILS_EXPORT int	GetInfoSteps ()

SOLVER_UTILS_EXPORT void	SetInfoSteps (int num)

SOLVER_UTILS_EXPORT void	SetIterationNumberPIT (int num)

SOLVER_UTILS_EXPORT void	SetWindowNumberPIT (int num)

SOLVER_UTILS_EXPORT Array< OneD, const Array< OneD, NekDouble > >	GetTraceNormals ()

SOLVER_UTILS_EXPORT void	SetTime (const NekDouble time)

SOLVER_UTILS_EXPORT void	SetTimeStep (const NekDouble timestep)

SOLVER_UTILS_EXPORT void	SetInitialStep (const int step)

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

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

Public Member Functions inherited from Nektar::SolverUtils::ALEHelper
virtual	~ALEHelper ()=default

virtual SOLVER_UTILS_EXPORT void	v_ALEInitObject (int spaceDim, Array< OneD, MultiRegions::ExpListSharedPtr > &fields)

SOLVER_UTILS_EXPORT void	InitObject (int spaceDim, Array< OneD, MultiRegions::ExpListSharedPtr > &fields)

virtual SOLVER_UTILS_EXPORT void	v_UpdateGridVelocity (const NekDouble &time)

virtual SOLVER_UTILS_EXPORT void	v_ALEPreMultiplyMass (Array< OneD, Array< OneD, NekDouble > > &fields)

SOLVER_UTILS_EXPORT void	ALEDoElmtInvMass (Array< OneD, Array< OneD, NekDouble > > &traceNormals, Array< OneD, Array< OneD, NekDouble > > &fields, NekDouble time)
	Update m_fields with u^n by multiplying by inverse mass matrix. That's then used in e.g. checkpoint output and L^2 error calculation. More...

SOLVER_UTILS_EXPORT void	ALEDoElmtInvMassBwdTrans (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray)

SOLVER_UTILS_EXPORT void	MoveMesh (const NekDouble &time, Array< OneD, Array< OneD, NekDouble > > &traceNormals)

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

SOLVER_UTILS_EXPORT const Array< OneD, const Array< OneD, NekDouble > > &	GetGridVelocityTrace ()

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

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

Static Public Attributes
static std::string	className
	Name of class. More...

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

static std::string	cmdSetStartChkNum

Protected Member Functions
	ShallowWaterSystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Initialises UnsteadySystem class members. More...

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

virtual void	v_DoOdeRhs (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)

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

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

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

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

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

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

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

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

virtual SOLVER_UTILS_EXPORT NekDouble	v_GetTimeStep (const Array< OneD, const Array< OneD, NekDouble > > &inarray)
	Return the timestep to be used for the next step in the time-marching loop. More...

virtual SOLVER_UTILS_EXPORT bool	v_PreIntegrate (int step)

virtual SOLVER_UTILS_EXPORT bool	v_PostIntegrate (int step)

virtual SOLVER_UTILS_EXPORT bool	v_RequireFwdTrans ()

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

virtual SOLVER_UTILS_EXPORT bool	v_UpdateTimeStepCheck ()

SOLVER_UTILS_EXPORT NekDouble	MaxTimeStepEstimator ()
	Get the maximum timestep estimator for cfl control. More...

SOLVER_UTILS_EXPORT void	CheckForRestartTime (NekDouble &time, int &nchk)

SOLVER_UTILS_EXPORT void	SVVVarDiffCoeff (const Array< OneD, Array< OneD, NekDouble > > vel, StdRegions::VarCoeffMap &varCoeffMap)
	Evaluate the SVV diffusion coefficient according to Moura's paper where it should proportional to h time velocity. More...

SOLVER_UTILS_EXPORT void	DoDummyProjection (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
	Perform dummy projection. More...

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

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

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

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

virtual SOLVER_UTILS_EXPORT NekDouble	v_LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
	Virtual function for the L_inf error computation between fields and a given exact solution. More...

virtual SOLVER_UTILS_EXPORT NekDouble	v_L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
	Virtual function for the L_2 error computation between fields and a given exact solution. More...

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

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

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

virtual SOLVER_UTILS_EXPORT void	v_SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)

virtual SOLVER_UTILS_EXPORT void	v_EvaluateExactSolution (unsigned int field, Array< OneD, NekDouble > &outfield, const NekDouble time)

virtual SOLVER_UTILS_EXPORT void	v_Output (void)

virtual SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr	v_GetPressure (void)

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

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

Protected Attributes
SolverUtils::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. More...

NekDouble	m_g
	Acceleration of gravity. More...

Array< OneD, NekDouble >	m_depth
	Still water depth. More...

Array< OneD, Array< OneD, NekDouble > >	m_bottomSlope

Array< OneD, NekDouble >	m_coriolis
	Coriolis force. More...

Array< OneD, Array< OneD, NekDouble > >	m_vecLocs

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

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

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

std::vector< int >	m_intVariables

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

NekDouble	m_CFLGrowth
	CFL growth rate. More...

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

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

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

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

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

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

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

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

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

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

std::ofstream	m_errFile

NekDouble	m_epsilon
	Diffusion coefficient. More...

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

bool	m_verbose

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

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

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

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

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

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

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

NekDouble	m_time
	Current time of simulation. More...

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

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

NekDouble	m_timestep
	Time step size. More...

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

NekDouble	m_checktime
	Time between checkpoints. More...

NekDouble	m_lastCheckTime

NekDouble	m_TimeIncrementFactor

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

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

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

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

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

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

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

int	m_expdim
	Expansion dimension. More...

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

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

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

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

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

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

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

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

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

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

Array< OneD, NekDouble >	m_movingFrameData
	Moving reference frame status in the inertial frame X, Y, Z, Theta_x, Theta_y, Theta_z, U, V, W, Omega_x, Omega_y, Omega_z, A_x, A_y, A_z, DOmega_x, DOmega_y, DOmega_z, pivot_x, pivot_y, pivot_z. More...

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

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

enum HomogeneousType	m_HomogeneousType

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

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

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

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

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

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

int	m_HomoDirec
	number of homogenous directions More...

Protected Attributes inherited from Nektar::SolverUtils::ALEHelper
Array< OneD, MultiRegions::ExpListSharedPtr >	m_fieldsALE

Array< OneD, Array< OneD, NekDouble > >	m_gridVelocity

Array< OneD, Array< OneD, NekDouble > >	m_gridVelocityTrace

std::vector< ALEBaseShPtr >	m_ALEs

bool	m_ALESolver = false

bool	m_ImplicitALESolver = false

NekDouble	m_prevStageTime = 0.0

int	m_spaceDim

Private Member Functions
void	EvaluateWaterDepth (void)

void	EvaluateCoriolis (void)

Friends
class	MemoryManager< ShallowWaterSystem >

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

static std::string	projectionTypeLookupIds []

Detailed Description

Base class for unsteady solvers.

Provides the underlying timestepping framework for shallow water flow 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 shallow water solvers, e.g. SWE, Boussinesq, linear and nonlinear versions.

For details on implementing unsteady solvers see sectionADRSolverModuleImplementation

Definition at line 47 of file ShallowWaterSystem.h.

Constructor & Destructor Documentation

◆ ~ShallowWaterSystem()

Nektar::ShallowWaterSystem::~ShallowWaterSystem ( )

overridedefault

Destructor.

◆ ShallowWaterSystem()

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

protected

Initialises UnsteadySystem class members.

Definition at line 65 of file ShallowWaterSystem.cpp.

    : UnsteadySystem(pSession, pGraph)
{
}

Member Function Documentation

◆ AddCoriolis()

void Nektar::ShallowWaterSystem::AddCoriolis	(	const Array< OneD, const Array< OneD, NekDouble > > &	physarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

protected

Definition at line 484 of file ShallowWaterSystem.cpp.

{
    int ncoeffs = GetNcoeffs();
    int nq      = GetTotPoints();
 
    Array<OneD, NekDouble> tmp(nq);
    Array<OneD, NekDouble> mod(ncoeffs);
 
    switch (m_projectionType)
    {
        case MultiRegions::eDiscontinuous:
        {
            // add to u equation
            Vmath::Vmul(nq, m_coriolis, 1, physarray[2], 1, tmp, 1);
            m_fields[0]->IProductWRTBase(tmp, mod);
            m_fields[0]->MultiplyByElmtInvMass(mod, mod);
            m_fields[0]->BwdTrans(mod, tmp);
            Vmath::Vadd(nq, tmp, 1, outarray[1], 1, outarray[1], 1);
 
            // add to v equation
            Vmath::Vmul(nq, m_coriolis, 1, physarray[1], 1, tmp, 1);
            Vmath::Neg(nq, tmp, 1);
            m_fields[0]->IProductWRTBase(tmp, mod);
            m_fields[0]->MultiplyByElmtInvMass(mod, mod);
            m_fields[0]->BwdTrans(mod, tmp);
            Vmath::Vadd(nq, tmp, 1, outarray[2], 1, outarray[2], 1);
        }
        break;
        case MultiRegions::eGalerkin:
        {
            // add to u equation
            Vmath::Vmul(nq, m_coriolis, 1, physarray[2], 1, tmp, 1);
            Vmath::Vadd(nq, tmp, 1, outarray[1], 1, outarray[1], 1);
 
            // add to v equation
            Vmath::Vmul(nq, m_coriolis, 1, physarray[1], 1, tmp, 1);
            Vmath::Neg(nq, tmp, 1);
            Vmath::Vadd(nq, tmp, 1, outarray[2], 1, outarray[2], 1);
        }
        break;
        default:
            ASSERTL0(false, "Unknown projection scheme for the NonlinearSWE");
            break;
    }
}

References ASSERTL0, Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, Nektar::SolverUtils::EquationSystem::GetNcoeffs(), Nektar::SolverUtils::EquationSystem::GetTotPoints(), m_coriolis, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_projectionType, Vmath::Neg(), Vmath::Vadd(), and Vmath::Vmul().

Referenced by Nektar::LinearSWE::v_DoOdeRhs(), Nektar::NonlinearPeregrine::v_DoOdeRhs(), and Nektar::NonlinearSWE::v_DoOdeRhs().

◆ CalcRefValues()

void Nektar::ShallowWaterSystem::CalcRefValues ( const Array< OneD, const NekDouble > & inarray )

protected

Definition at line 223 of file ShallowWaterSystem.cpp.

{
    unsigned int npoints = m_fields[0]->GetNpoints();
 
    Array<OneD, NekDouble> magnitdEstimat(3, 0.0);
 
    for (int i = 0; i < 3; ++i)
    {
        int offset = i * npoints;
        magnitdEstimat[i] =
            Vmath::Dot(npoints, inarray + offset, inarray + offset);
    }
    m_comm->GetSpaceComm()->AllReduce(magnitdEstimat,
                                      Nektar::LibUtilities::ReduceSum);
 
    m_inArrayNorm = 0.0;
    for (int i = 0; i < 3; ++i)
    {
        m_inArrayNorm += magnitdEstimat[i];
    }
}

References Vmath::Dot(), Nektar::SolverUtils::EquationSystem::m_comm, Nektar::SolverUtils::EquationSystem::m_fields, m_inArrayNorm, and Nektar::LibUtilities::ReduceSum.

Referenced by DoImplicitSolve1D().

◆ ConservativeToPrimitive()

void Nektar::ShallowWaterSystem::ConservativeToPrimitive ( void )

protected

Definition at line 532 of file ShallowWaterSystem.cpp.

{
    int nq = GetTotPoints();
 
    // \eta = h - d
    Vmath::Vsub(nq, m_fields[0]->GetPhys(), 1, m_depth, 1,
                m_fields[0]->UpdatePhys(), 1);
 
    // u = hu / h
    Vmath::Vdiv(nq, m_fields[1]->GetPhys(), 1, m_fields[0]->GetPhys(), 1,
                m_fields[1]->UpdatePhys(), 1);
 
    // v = hv / v
    Vmath::Vdiv(nq, m_fields[2]->GetPhys(), 1, m_fields[0]->GetPhys(), 1,
                m_fields[2]->UpdatePhys(), 1);
}

References Nektar::SolverUtils::EquationSystem::GetTotPoints(), m_depth, Nektar::SolverUtils::EquationSystem::m_fields, Vmath::Vdiv(), and Vmath::Vsub().

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 53 of file ShallowWaterSystem.h.

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

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

◆ DoImplicitSolve()

void Nektar::ShallowWaterSystem::DoImplicitSolve	(	const Array< OneD, const Array< OneD, NekDouble > > &	inpnts,
		Array< OneD, Array< OneD, NekDouble > > &	outpnt,
		const NekDouble	time,
		const NekDouble	lambda
	)

protected

Definition at line 180 of file ShallowWaterSystem.cpp.

{
    m_TimeIntegLambda       = lambda;
    m_bndEvaluateTime       = time;
    unsigned int npoints    = m_fields[0]->GetNpoints();
    unsigned int nvariables = m_fields.size();
 
    Array<OneD, NekDouble> inarray(nvariables * npoints);
    Array<OneD, NekDouble> outarray(nvariables * npoints);
    Array<OneD, NekDouble> tmp;
 
    for (int i = 0; i < nvariables; ++i)
    {
        int noffset = i * npoints;
        Vmath::Vcopy(npoints, inpnts[i], 1, tmp = inarray + noffset, 1);
    }
 
    DoImplicitSolve1D(inarray, outarray);
 
    for (int i = 0; i < nvariables; ++i)
    {
        int noffset = i * npoints;
        Vmath::Vcopy(npoints, outarray + noffset, 1, outpnt[i], 1);
    }
}

References DoImplicitSolve1D(), m_bndEvaluateTime, Nektar::SolverUtils::EquationSystem::m_fields, m_TimeIntegLambda, and Vmath::Vcopy().

Referenced by Nektar::LinearSWE::v_InitObject(), Nektar::NonlinearPeregrine::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ DoImplicitSolve1D()

void Nektar::ShallowWaterSystem::DoImplicitSolve1D	(	const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	out
	)

protected

Definition at line 209 of file ShallowWaterSystem.cpp.

{
    CalcRefValues(inarray);
 
    m_nonlinsol->SetRhsMagnitude(m_inArrayNorm);
 
    m_TotNewtonIts += m_nonlinsol->SolveSystem(inarray.size(), inarray, out, 0);
 
    m_TotLinIts += m_nonlinsol->GetNtotLinSysIts();
 
    m_TotImpStages++;
}

References CalcRefValues(), m_inArrayNorm, m_nonlinsol, m_TotImpStages, m_TotLinIts, and m_TotNewtonIts.

Referenced by DoImplicitSolve().

◆ DoNullPrecon()

void Nektar::ShallowWaterSystem::DoNullPrecon	(	const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	outarray,
		const bool &	flag
	)

protected

Definition at line 310 of file ShallowWaterSystem.cpp.

{
    Vmath::Vcopy(inarray.size(), inarray, 1, outarray, 1);
}

References Vmath::Vcopy().

Referenced by InitialiseNonlinSysSolver().

◆ DoOdeProjection()

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

protected

Definition at line 317 of file ShallowWaterSystem.cpp.

{
    int nvariables = inarray.size();
 
    switch (m_projectionType)
    {
        case MultiRegions::eDiscontinuous:
        {
            // Just copy over array
            if (inarray != outarray)
            {
                int npoints = GetNpoints();
 
                for (int i = 0; i < nvariables; ++i)
                {
                    Vmath::Vcopy(npoints, inarray[i], 1, outarray[i], 1);
                }
            }
 
            SetBoundaryConditions(outarray, time);
            break;
        }
        case MultiRegions::eGalerkin:
        {
            EquationSystem::SetBoundaryConditions(time);
            Array<OneD, NekDouble> coeffs(m_fields[0]->GetNcoeffs(), 0.0);
 
            for (int i = 0; i < nvariables; ++i)
            {
                m_fields[i]->FwdTrans(inarray[i], coeffs);
                m_fields[i]->BwdTrans(coeffs, outarray[i]);
            }
            break;
        }
        default:
            ASSERTL0(false, "Unknown projection scheme");
            break;
    }
}

References ASSERTL0, Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, Nektar::SolverUtils::EquationSystem::GetNcoeffs(), Nektar::SolverUtils::EquationSystem::GetNpoints(), Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_projectionType, SetBoundaryConditions(), Nektar::SolverUtils::EquationSystem::SetBoundaryConditions(), and Vmath::Vcopy().

Referenced by NonlinSysEvaluator(), Nektar::LinearSWE::v_InitObject(), Nektar::NonlinearPeregrine::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ EvaluateCoriolis()

void Nektar::ShallowWaterSystem::EvaluateCoriolis ( void )

private

Definition at line 571 of file ShallowWaterSystem.cpp.

{
    GetFunction("Coriolis")->Evaluate("f", m_coriolis);
}

References Nektar::SolverUtils::EquationSystem::GetFunction(), and m_coriolis.

Referenced by v_InitObject().

◆ EvaluateWaterDepth()

void Nektar::ShallowWaterSystem::EvaluateWaterDepth ( void )

private

Definition at line 566 of file ShallowWaterSystem.cpp.

{
    GetFunction("WaterDepth")->Evaluate("d", m_depth);
}

References Nektar::SolverUtils::EquationSystem::GetFunction(), and m_depth.

Referenced by v_InitObject().

◆ GetDepth()

const Array< OneD, NekDouble > & Nektar::ShallowWaterSystem::GetDepth ( )

inlineprotected

Definition at line 171 of file ShallowWaterSystem.h.

    {
        return m_depth;
    }

References m_depth.

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

◆ GetGravity()

NekDouble Nektar::ShallowWaterSystem::GetGravity ( )

inlineprotected

Definition at line 156 of file ShallowWaterSystem.h.

    {
        return m_g;
    }

References m_g.

Referenced by Nektar::LinearSWE::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ GetNormals()

const Array< OneD, const Array< OneD, NekDouble > > & Nektar::ShallowWaterSystem::GetNormals ( )

inlineprotected

Definition at line 166 of file ShallowWaterSystem.h.

    {
        return m_traceNormals;
    }

References Nektar::SolverUtils::EquationSystem::m_traceNormals.

Referenced by Nektar::LinearSWE::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ GetVecLocs()

const Array< OneD, const Array< OneD, NekDouble > > & Nektar::ShallowWaterSystem::GetVecLocs ( )

inlineprotected

Definition at line 161 of file ShallowWaterSystem.h.

    {
        return m_vecLocs;
    }

References m_vecLocs.

Referenced by Nektar::LinearSWE::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ InitialiseNonlinSysSolver()

void Nektar::ShallowWaterSystem::InitialiseNonlinSysSolver ( void )

protected

Definition at line 136 of file ShallowWaterSystem.cpp.

{
    unsigned int nvariables = m_fields.size();
    int ntotal              = nvariables * m_fields[0]->GetNpoints();
 
    // Create the key to hold settings for nonlin solver
    LibUtilities::NekSysKey key = LibUtilities::NekSysKey();
 
    // Load required LinSys parameters:
    m_session->LoadParameter("NekLinSysMaxIterations",
                             key.m_NekLinSysMaxIterations, 30);
    m_session->LoadParameter("LinSysMaxStorage", key.m_LinSysMaxStorage, 30);
    m_session->LoadParameter("LinSysRelativeTolInNonlin",
                             key.m_NekLinSysTolerance, 5.0E-2);
    m_session->LoadParameter("GMRESMaxHessMatBand", key.m_KrylovMaxHessMatBand,
                             31);
 
    // Load required NonLinSys parameters:
    m_session->LoadParameter("JacobiFreeEps", m_jacobiFreeEps, 5.0E-8);
    m_session->LoadParameter("NekNonlinSysMaxIterations",
                             key.m_NekNonlinSysMaxIterations, 10);
    m_session->LoadParameter("NewtonRelativeIteTol",
                             key.m_NekNonLinSysTolerance, 1.0E-12);
    WARNINGL0(!m_session->DefinesParameter("NewtonAbsoluteIteTol"),
              "Please specify NewtonRelativeIteTol instead of "
              "NewtonAbsoluteIteTol in XML session file");
    m_session->LoadParameter("NonlinIterTolRelativeL2",
                             key.m_NonlinIterTolRelativeL2, 1.0E-3);
    m_session->LoadSolverInfo("LinSysIterSolverTypeInNonlin",
                              key.m_LinSysIterSolverTypeInNonlin, "GMRES");
 
    LibUtilities::NekSysOperators nekSysOp;
    nekSysOp.DefineNekSysResEval(&ShallowWaterSystem::NonlinSysEvaluator1D,
                                 this);
    nekSysOp.DefineNekSysLhsEval(&ShallowWaterSystem::MatrixMultiplyMatrixFree,
                                 this);
    nekSysOp.DefineNekSysPrecon(&ShallowWaterSystem::DoNullPrecon, this);
 
    // Initialize non-linear system
    m_nonlinsol = LibUtilities::GetNekNonlinSysIterFactory().CreateInstance(
        "Newton", m_session, m_comm->GetRowComm(), ntotal, key);
    m_nonlinsol->SetSysOperators(nekSysOp);
}

Referenced by v_InitObject().

◆ IsConstantDepth()

bool Nektar::ShallowWaterSystem::IsConstantDepth ( )

inlineprotected

Definition at line 176 of file ShallowWaterSystem.h.

    {
        return m_constantDepth;
    }

References m_constantDepth.

◆ MatrixMultiplyMatrixFree()

void Nektar::ShallowWaterSystem::MatrixMultiplyMatrixFree	(	const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	out,
		const bool &	flag
	)

protected

Definition at line 287 of file ShallowWaterSystem.cpp.

{
    const Array<OneD, const NekDouble> solref = m_nonlinsol->GetRefSolution();
    const Array<OneD, const NekDouble> resref = m_nonlinsol->GetRefResidual();
 
    unsigned int ntotal   = inarray.size();
    NekDouble magninarray = Vmath::Dot(ntotal, inarray, inarray);
    m_comm->GetSpaceComm()->AllReduce(magninarray,
                                      Nektar::LibUtilities::ReduceSum);
    NekDouble eps =
        m_jacobiFreeEps * sqrt((sqrt(m_inArrayNorm) + 1.0) / magninarray);
 
    Array<OneD, NekDouble> solplus{ntotal};
    Array<OneD, NekDouble> resplus{ntotal};
 
    Vmath::Svtvp(ntotal, eps, inarray, 1, solref, 1, solplus, 1);
    NonlinSysEvaluator1D(solplus, resplus, flag);
    Vmath::Vsub(ntotal, resplus, 1, resref, 1, out, 1);
    Vmath::Smul(ntotal, 1.0 / eps, out, 1, out, 1);
}

References Vmath::Dot(), Nektar::SolverUtils::EquationSystem::m_comm, m_inArrayNorm, m_jacobiFreeEps, m_nonlinsol, NonlinSysEvaluator1D(), Nektar::LibUtilities::ReduceSum, Vmath::Smul(), tinysimd::sqrt(), Vmath::Svtvp(), and Vmath::Vsub().

Referenced by InitialiseNonlinSysSolver().

◆ NonlinSysEvaluator()

void Nektar::ShallowWaterSystem::NonlinSysEvaluator	(	const Array< OneD, const Array< OneD, NekDouble > > &	inarray,
		Array< OneD, Array< OneD, NekDouble > > &	out
	)

protected

Definition at line 263 of file ShallowWaterSystem.cpp.

{
    unsigned int npoints    = m_fields[0]->GetNpoints();
    unsigned int nvariables = m_fields.size();
    Array<OneD, Array<OneD, NekDouble>> inpnts(nvariables);
    for (int i = 0; i < nvariables; ++i)
    {
        inpnts[i] = Array<OneD, NekDouble>(npoints, 0.0);
    }
 
    DoOdeProjection(inarray, inpnts, m_bndEvaluateTime);
    v_DoOdeRhs(inpnts, out, m_bndEvaluateTime);
 
    for (int i = 0; i < nvariables; ++i)
    {
        Vmath::Svtvp(npoints, -m_TimeIntegLambda, out[i], 1, inarray[i], 1,
                     out[i], 1);
        Vmath::Vsub(npoints, out[i], 1,
                    m_nonlinsol->GetRefSourceVec() + i * npoints, 1, out[i], 1);
    }
}

References DoOdeProjection(), m_bndEvaluateTime, Nektar::SolverUtils::EquationSystem::m_fields, m_nonlinsol, m_TimeIntegLambda, Vmath::Svtvp(), v_DoOdeRhs(), and Vmath::Vsub().

Referenced by NonlinSysEvaluator1D().

◆ NonlinSysEvaluator1D()

void Nektar::ShallowWaterSystem::NonlinSysEvaluator1D	(	const Array< OneD, const NekDouble > &	inarray,
		Array< OneD, NekDouble > &	out,
		const bool &	flag
	)

protected

Definition at line 246 of file ShallowWaterSystem.cpp.

{
    unsigned int npoints    = m_fields[0]->GetNpoints();
    unsigned int nvariables = m_fields.size();
    Array<OneD, Array<OneD, NekDouble>> in2D(nvariables);
    Array<OneD, Array<OneD, NekDouble>> out2D(nvariables);
    for (int i = 0; i < nvariables; ++i)
    {
        int offset = i * npoints;
        in2D[i]    = inarray + offset;
        out2D[i]   = out + offset;
    }
    NonlinSysEvaluator(in2D, out2D);
}

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

Referenced by InitialiseNonlinSysSolver(), and MatrixMultiplyMatrixFree().

◆ PrimitiveToConservative()

void Nektar::ShallowWaterSystem::PrimitiveToConservative ( void )

protected

Definition at line 549 of file ShallowWaterSystem.cpp.

{
    int nq = GetTotPoints();
 
    // h = \eta + d
    Vmath::Vadd(nq, m_fields[0]->GetPhys(), 1, m_depth, 1,
                m_fields[0]->UpdatePhys(), 1);
 
    // hu = h * u
    Vmath::Vmul(nq, m_fields[0]->GetPhys(), 1, m_fields[1]->GetPhys(), 1,
                m_fields[1]->UpdatePhys(), 1);
 
    // hv = h * v
    Vmath::Vmul(nq, m_fields[0]->GetPhys(), 1, m_fields[2]->GetPhys(), 1,
                m_fields[2]->UpdatePhys(), 1);
}

References Nektar::SolverUtils::EquationSystem::GetTotPoints(), m_depth, Nektar::SolverUtils::EquationSystem::m_fields, Vmath::Vadd(), and Vmath::Vmul().

◆ SetBoundaryConditions()

void Nektar::ShallowWaterSystem::SetBoundaryConditions	(	const Array< OneD, const Array< OneD, NekDouble > > &	physarray,
		NekDouble	time
	)

protected

Definition at line 359 of file ShallowWaterSystem.cpp.

{
    std::string varName;
    int nvariables = 3;
    int cnt        = 0;
    int nTracePts  = GetTraceTotPoints();
 
    // Extract trace for boundaries. Needs to be done on all processors to avoid
    // deadlock.
    Array<OneD, Array<OneD, NekDouble>> Fwd(nvariables);
    for (int i = 0; i < nvariables; ++i)
    {
        Fwd[i] = Array<OneD, NekDouble>(nTracePts);
        m_fields[i]->ExtractTracePhys(inarray[i], Fwd[i]);
    }
 
    // Loop over Boundary Regions
    for (int n = 0; n < m_fields[0]->GetBndConditions().size(); ++n)
    {
        if (m_fields[0]->GetBndConditions()[n]->GetBoundaryConditionType() ==
            SpatialDomains::ePeriodic)
        {
            continue;
        }
 
        // Wall Boundary Condition
        if (boost::iequals(m_fields[0]->GetBndConditions()[n]->GetUserDefined(),
                           "Wall"))
        {
            WallBoundary2D(n, cnt, Fwd);
        }
 
        // Time Dependent Boundary Condition (specified in meshfile)
        if (m_fields[0]->GetBndConditions()[n]->IsTimeDependent())
        {
            for (int i = 0; i < nvariables; ++i)
            {
                varName = m_session->GetVariable(i);
                m_fields[i]->EvaluateBoundaryConditions(time, varName);
            }
        }
        cnt += m_fields[0]->GetBndCondExpansions()[n]->GetExpSize();
    }
}

References Nektar::SpatialDomains::ePeriodic, Nektar::SolverUtils::EquationSystem::GetTraceTotPoints(), Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_session, and WallBoundary2D().

Referenced by DoOdeProjection().

◆ v_DoOdeRhs()

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

protectedvirtual

Reimplemented in Nektar::LinearSWE, Nektar::NonlinearPeregrine, and Nektar::NonlinearSWE.

Definition at line 122 of file ShallowWaterSystem.cpp.

126{

127}

Referenced by NonlinSysEvaluator().

◆ v_GenerateSummary()

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

overrideprotectedvirtual

Print a summary of time stepping parameters.

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

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

Definition at line 129 of file ShallowWaterSystem.cpp.

{
    UnsteadySystem::v_GenerateSummary(s);
    SolverUtils::AddSummaryItem(s, "Depth",
                                m_constantDepth ? "constant" : "variable");
}

References Nektar::SolverUtils::AddSummaryItem(), m_constantDepth, and Nektar::SolverUtils::UnsteadySystem::v_GenerateSummary().

Referenced by Nektar::LinearSWE::v_GenerateSummary(), and Nektar::NonlinearSWE::v_GenerateSummary().

◆ v_InitObject()

void Nektar::ShallowWaterSystem::v_InitObject ( bool DeclareField = true )

overrideprotectedvirtual

Init object for UnsteadySystem class.

Initialization object for UnsteadySystem class.

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

Definition at line 72 of file ShallowWaterSystem.cpp.

{
    UnsteadySystem::v_InitObject(DeclareFields);
 
    // Set up locations of velocity vector.
    m_vecLocs    = Array<OneD, Array<OneD, NekDouble>>(1);
    m_vecLocs[0] = Array<OneD, NekDouble>(m_spacedim);
    for (int i = 0; i < m_spacedim; ++i)
    {
        m_vecLocs[0][i] = 1 + i;
    }
 
    // Load acceleration of gravity
    m_session->LoadParameter("Gravity", m_g, 9.81);
 
    EvaluateWaterDepth();
 
    m_constantDepth = true;
    NekDouble depth = m_depth[0];
    for (int i = 0; i < GetTotPoints(); ++i)
    {
        if (m_depth[i] != depth)
        {
            m_constantDepth = false;
            break;
        }
    }
 
    // Compute the bottom slopes
    int nq = GetTotPoints();
    if (m_constantDepth != true)
    {
        m_bottomSlope = Array<OneD, Array<OneD, NekDouble>>(m_spacedim);
        for (int i = 0; i < m_spacedim; ++i)
        {
            m_bottomSlope[i] = Array<OneD, NekDouble>(nq);
            m_fields[0]->PhysDeriv(MultiRegions::DirCartesianMap[i], m_depth,
                                   m_bottomSlope[i]);
            Vmath::Neg(nq, m_bottomSlope[i], 1);
        }
    }
 
    EvaluateCoriolis();
 
    if (!m_explicitAdvection)
    {
        InitialiseNonlinSysSolver();
    }
}

References Nektar::MultiRegions::DirCartesianMap, EvaluateCoriolis(), EvaluateWaterDepth(), Nektar::SolverUtils::EquationSystem::GetTotPoints(), InitialiseNonlinSysSolver(), m_bottomSlope, m_constantDepth, m_depth, Nektar::SolverUtils::UnsteadySystem::m_explicitAdvection, Nektar::SolverUtils::EquationSystem::m_fields, m_g, Nektar::SolverUtils::EquationSystem::m_session, Nektar::SolverUtils::EquationSystem::m_spacedim, m_vecLocs, Vmath::Neg(), and Nektar::SolverUtils::UnsteadySystem::v_InitObject().

Referenced by Nektar::LinearSWE::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ WallBoundary2D()

void Nektar::ShallowWaterSystem::WallBoundary2D	(	int	bcRegion,
		int	cnt,
		Array< OneD, Array< OneD, NekDouble > > &	Fwd
	)

protected

Definition at line 405 of file ShallowWaterSystem.cpp.

{
    int nvariables = 3;
 
    // Adjust the physical values of the trace to take
    // user defined boundaries into account
    int id1, id2, npts;
 
    for (int e = 0;
         e < m_fields[0]->GetBndCondExpansions()[bcRegion]->GetExpSize(); ++e)
    {
        npts = m_fields[0]
                   ->GetBndCondExpansions()[bcRegion]
                   ->GetExp(e)
                   ->GetNumPoints(0);
        id1 = m_fields[0]->GetBndCondExpansions()[bcRegion]->GetPhys_Offset(e);
        id2 = m_fields[0]->GetTrace()->GetPhys_Offset(
            m_fields[0]->GetTraceMap()->GetBndCondIDToGlobalTraceID(cnt + e));
 
        switch (m_expdim)
        {
            case 1:
            {
                // negate the forward flux
                Vmath::Neg(npts, &Fwd[1][id2], 1);
            }
            break;
            case 2:
            {
                Array<OneD, NekDouble> tmp_n(npts);
                Array<OneD, NekDouble> tmp_t(npts);
 
                Vmath::Vmul(npts, &Fwd[1][id2], 1, &m_traceNormals[0][id2], 1,
                            &tmp_n[0], 1);
                Vmath::Vvtvp(npts, &Fwd[2][id2], 1, &m_traceNormals[1][id2], 1,
                             &tmp_n[0], 1, &tmp_n[0], 1);
 
                Vmath::Vmul(npts, &Fwd[1][id2], 1, &m_traceNormals[1][id2], 1,
                            &tmp_t[0], 1);
                Vmath::Vvtvm(npts, &Fwd[2][id2], 1, &m_traceNormals[0][id2], 1,
                             &tmp_t[0], 1, &tmp_t[0], 1);
 
                // negate the normal flux
                Vmath::Neg(npts, tmp_n, 1);
 
                // rotate back to Cartesian
                Vmath::Vmul(npts, &tmp_t[0], 1, &m_traceNormals[1][id2], 1,
                            &Fwd[1][id2], 1);
                Vmath::Vvtvm(npts, &tmp_n[0], 1, &m_traceNormals[0][id2], 1,
                             &Fwd[1][id2], 1, &Fwd[1][id2], 1);
 
                Vmath::Vmul(npts, &tmp_t[0], 1, &m_traceNormals[0][id2], 1,
                            &Fwd[2][id2], 1);
                Vmath::Vvtvp(npts, &tmp_n[0], 1, &m_traceNormals[1][id2], 1,
                             &Fwd[2][id2], 1, &Fwd[2][id2], 1);
            }
            break;
            case 3:
                ASSERTL0(false,
                         "3D not implemented for Shallow Water Equations");
                break;
            default:
                ASSERTL0(false, "Illegal expansion dimension");
        }
 
        // copy boundary adjusted values into the boundary expansion
        for (int i = 0; i < nvariables; ++i)
        {
            Vmath::Vcopy(npts, &Fwd[i][id2], 1,
                         &(m_fields[i]
                               ->GetBndCondExpansions()[bcRegion]
                               ->UpdatePhys())[id1],
                         1);
        }
    }
}

References ASSERTL0, Nektar::SolverUtils::EquationSystem::GetExpSize(), Nektar::SolverUtils::EquationSystem::m_expdim, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_traceNormals, Vmath::Neg(), Vmath::Vcopy(), Vmath::Vmul(), Vmath::Vvtvm(), and Vmath::Vvtvp().

Referenced by SetBoundaryConditions().

Friends And Related Function Documentation

◆ MemoryManager< ShallowWaterSystem >

friend class MemoryManager< ShallowWaterSystem >

friend

Definition at line 1 of file ShallowWaterSystem.h.

Member Data Documentation

◆ className

std::string Nektar::ShallowWaterSystem::className

static

Initial value:

=
    SolverUtils::GetEquationSystemFactory().RegisterCreatorFunction(
        "ShallowWaterSystem", ShallowWaterSystem::create,
        "Auxiliary functions for the shallow water system.")

Name of class.

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

Parameters

pSession Session object to read parameters from.

Definition at line 65 of file ShallowWaterSystem.h.

◆ m_advection

SolverUtils::AdvectionSharedPtr Nektar::ShallowWaterSystem::m_advection

protected

Definition at line 72 of file ShallowWaterSystem.h.

Referenced by Nektar::LinearSWE::v_DoOdeRhs(), Nektar::NonlinearPeregrine::v_DoOdeRhs(), Nektar::NonlinearSWE::v_DoOdeRhs(), Nektar::LinearSWE::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ m_bndEvaluateTime

NekDouble Nektar::ShallowWaterSystem::m_bndEvaluateTime = 0.0

protected

Definition at line 80 of file ShallowWaterSystem.h.

Referenced by DoImplicitSolve(), and NonlinSysEvaluator().

◆ m_bottomSlope

Array<OneD, Array<OneD, NekDouble> > Nektar::ShallowWaterSystem::m_bottomSlope

protected

Definition at line 93 of file ShallowWaterSystem.h.

Referenced by Nektar::NonlinearSWE::AddVariableDepth(), and v_InitObject().

◆ m_constantDepth

bool Nektar::ShallowWaterSystem::m_constantDepth

protected

Indicates if constant depth case.

Definition at line 87 of file ShallowWaterSystem.h.

Referenced by IsConstantDepth(), Nektar::NonlinearPeregrine::v_DoOdeRhs(), Nektar::NonlinearSWE::v_DoOdeRhs(), v_GenerateSummary(), Nektar::LinearSWE::v_InitObject(), and v_InitObject().

◆ m_coriolis

Array<OneD, NekDouble> Nektar::ShallowWaterSystem::m_coriolis

protected

Coriolis force.

Definition at line 95 of file ShallowWaterSystem.h.

Referenced by AddCoriolis(), EvaluateCoriolis(), Nektar::LinearSWE::v_DoOdeRhs(), Nektar::NonlinearPeregrine::v_DoOdeRhs(), and Nektar::NonlinearSWE::v_DoOdeRhs().

◆ m_depth

Array<OneD, NekDouble> Nektar::ShallowWaterSystem::m_depth

protected

Still water depth.

Definition at line 91 of file ShallowWaterSystem.h.

Referenced by ConservativeToPrimitive(), EvaluateWaterDepth(), GetDepth(), Nektar::LinearSWE::GetFluxVector(), PrimitiveToConservative(), Nektar::LinearSWE::v_InitObject(), and v_InitObject().

◆ m_diffusion

SolverUtils::DiffusionSharedPtr Nektar::ShallowWaterSystem::m_diffusion

protected

Definition at line 73 of file ShallowWaterSystem.h.

◆ m_g

NekDouble Nektar::ShallowWaterSystem::m_g

protected

Acceleration of gravity.

Definition at line 89 of file ShallowWaterSystem.h.

Referenced by Nektar::NonlinearSWE::AddVariableDepth(), Nektar::LinearSWE::GetFluxVector(), Nektar::NonlinearSWE::GetFluxVector(), GetGravity(), Nektar::NonlinearPeregrine::LaitoneSolitaryWave(), and v_InitObject().

◆ m_inArrayNorm

NekDouble Nektar::ShallowWaterSystem::m_inArrayNorm = -1.0

protected

Definition at line 82 of file ShallowWaterSystem.h.

Referenced by CalcRefValues(), DoImplicitSolve1D(), and MatrixMultiplyMatrixFree().

◆ m_jacobiFreeEps

NekDouble Nektar::ShallowWaterSystem::m_jacobiFreeEps = 5.0E-08

protected

Definition at line 79 of file ShallowWaterSystem.h.

Referenced by InitialiseNonlinSysSolver(), and MatrixMultiplyMatrixFree().

◆ m_nonlinsol

LibUtilities::NekNonlinSysIterSharedPtr Nektar::ShallowWaterSystem::m_nonlinsol

protected

Definition at line 84 of file ShallowWaterSystem.h.

Referenced by DoImplicitSolve1D(), InitialiseNonlinSysSolver(), MatrixMultiplyMatrixFree(), and NonlinSysEvaluator().

◆ m_riemannSolver

SolverUtils::RiemannSolverSharedPtr Nektar::ShallowWaterSystem::m_riemannSolver

protected

Definition at line 71 of file ShallowWaterSystem.h.

Referenced by Nektar::LinearSWE::v_InitObject(), and Nektar::NonlinearSWE::v_InitObject().

◆ m_TimeIntegLambda

NekDouble Nektar::ShallowWaterSystem::m_TimeIntegLambda = 0.0

protected

Definition at line 81 of file ShallowWaterSystem.h.

Referenced by DoImplicitSolve(), and NonlinSysEvaluator().

◆ m_TotImpStages

int Nektar::ShallowWaterSystem::m_TotImpStages = 0

protected

Definition at line 78 of file ShallowWaterSystem.h.

Referenced by DoImplicitSolve1D().

◆ m_TotLinIts

int Nektar::ShallowWaterSystem::m_TotLinIts = 0

protected

Definition at line 77 of file ShallowWaterSystem.h.

Referenced by DoImplicitSolve1D().

◆ m_TotNewtonIts

int Nektar::ShallowWaterSystem::m_TotNewtonIts = 0

protected

Definition at line 76 of file ShallowWaterSystem.h.

Referenced by DoImplicitSolve1D().

◆ m_vecLocs

Array<OneD, Array<OneD, NekDouble> > Nektar::ShallowWaterSystem::m_vecLocs

protected

Definition at line 97 of file ShallowWaterSystem.h.

Referenced by GetVecLocs(), and v_InitObject().

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ShallowWaterSystem()

◆ ShallowWaterSystem()

Member Function Documentation

◆ AddCoriolis()

◆ CalcRefValues()

◆ ConservativeToPrimitive()

◆ create()

◆ DoImplicitSolve()

◆ DoImplicitSolve1D()

◆ DoNullPrecon()

◆ DoOdeProjection()

◆ EvaluateCoriolis()

◆ EvaluateWaterDepth()

◆ GetDepth()

◆ GetGravity()

◆ GetNormals()

◆ GetVecLocs()

◆ InitialiseNonlinSysSolver()

◆ IsConstantDepth()

◆ MatrixMultiplyMatrixFree()

◆ NonlinSysEvaluator()

◆ NonlinSysEvaluator1D()

◆ PrimitiveToConservative()

◆ SetBoundaryConditions()

◆ v_DoOdeRhs()

◆ v_GenerateSummary()

◆ v_InitObject()

◆ WallBoundary2D()

Friends And Related Function Documentation

◆ MemoryManager< ShallowWaterSystem >

Member Data Documentation

◆ className

◆ m_advection

◆ m_bndEvaluateTime

◆ m_bottomSlope

◆ m_constantDepth

◆ m_coriolis

◆ m_depth

◆ m_diffusion

◆ m_g

◆ m_inArrayNorm

◆ m_jacobiFreeEps

◆ m_nonlinsol

◆ m_riemannSolver

◆ m_TimeIntegLambda

◆ m_TotImpStages

◆ m_TotLinIts

◆ m_TotNewtonIts

◆ m_vecLocs