Base class for unsteady solvers. More...

#include <ShallowWaterSystem.h>

Inheritance diagram for Nektar::ShallowWaterSystem:

Public Member Functions
virtual	~ShallowWaterSystem ()
	Destructor. More...

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

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

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

SOLVER_UTILS_EXPORT void	SetUpTraceNormals (void)

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

SOLVER_UTILS_EXPORT void	DoInitialise ()
	Perform any initialisation necessary before solving the problem. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SOLVER_UTILS_EXPORT int	GetNcoeffs ()

SOLVER_UTILS_EXPORT int	GetNcoeffs (const int eid)

SOLVER_UTILS_EXPORT int	GetNumExpModes ()

SOLVER_UTILS_EXPORT const Array< OneD, int >	GetNumExpModesPerExp ()

SOLVER_UTILS_EXPORT int	GetNvariables ()

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

SOLVER_UTILS_EXPORT int	GetTraceTotPoints ()

SOLVER_UTILS_EXPORT int	GetTraceNpoints ()

SOLVER_UTILS_EXPORT int	GetExpSize ()

SOLVER_UTILS_EXPORT int	GetPhys_Offset (int n)

SOLVER_UTILS_EXPORT int	GetCoeff_Offset (int n)

SOLVER_UTILS_EXPORT int	GetTotPoints ()

SOLVER_UTILS_EXPORT int	GetTotPoints (int n)

SOLVER_UTILS_EXPORT int	GetNpoints ()

SOLVER_UTILS_EXPORT int	GetSteps ()

SOLVER_UTILS_EXPORT NekDouble	GetTimeStep ()

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

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

SOLVER_UTILS_EXPORT void	SetSteps (const int steps)

SOLVER_UTILS_EXPORT void	ZeroPhysFields ()

SOLVER_UTILS_EXPORT void	FwdTransFields ()

SOLVER_UTILS_EXPORT void	SetModifiedBasis (const bool modbasis)

SOLVER_UTILS_EXPORT int	GetCheckpointNumber ()

SOLVER_UTILS_EXPORT void	SetCheckpointNumber (int num)

SOLVER_UTILS_EXPORT int	GetCheckpointSteps ()

SOLVER_UTILS_EXPORT void	SetCheckpointSteps (int num)

SOLVER_UTILS_EXPORT void	SetTime (const NekDouble time)

SOLVER_UTILS_EXPORT void	SetInitialStep (const int step)

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

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

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

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

virtual void	v_InitObject ()
	Init object for UnsteadySystem class. More...

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

void	PrimitiveToConservative ()

virtual void	v_PrimitiveToConservative ()

void	ConservativeToPrimitive ()

virtual void	v_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 ()

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

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

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

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

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

virtual SOLVER_UTILS_EXPORT void	v_AppendOutput1D (Array< OneD, Array< OneD, NekDouble >> &solution1D)
	Print the solution at each solution point in a txt file. More...

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

virtual SOLVER_UTILS_EXPORT bool	v_PreIntegrate (int step)

virtual SOLVER_UTILS_EXPORT bool	v_PostIntegrate (int step)

virtual SOLVER_UTILS_EXPORT bool	v_RequireFwdTrans ()

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

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

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

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

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

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

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

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

virtual SOLVER_UTILS_EXPORT void	v_Output (void)

virtual SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr	v_GetPressure (void)

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

Protected Attributes
SolverUtils::RiemannSolverSharedPtr	m_riemannSolver

SolverUtils::RiemannSolverSharedPtr	m_riemannSolverLDG

SolverUtils::AdvectionSharedPtr	m_advection

SolverUtils::DiffusionSharedPtr	m_diffusion

bool	m_primitive
	Indicates if variables are primitive or conservative. More...

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

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

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

int	m_nanSteps

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

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

LibUtilities::TimeIntegrationSolutionSharedPtr	m_intSoln

NekDouble	m_epsilon

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

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

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

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

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

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

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

std::ofstream	m_errFile

std::vector< int >	m_intVariables

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

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

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

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

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

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

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

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

int	m_expdim
	Expansion dimension. More...

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

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

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

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

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

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

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

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

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

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

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

enum HomogeneousType	m_HomogeneousType

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

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

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

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

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

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

int	m_HomoDirec
	number of homogenous directions More...

Private Member Functions
void	EvaluateWaterDepth (void)

void	EvaluateCoriolis (void)

Friends
class	MemoryManager< ShallowWaterSystem >

Additional Inherited Members
Public Attributes inherited from Nektar::SolverUtils::UnsteadySystem
NekDouble	m_cflSafetyFactor
	CFL safety factor (comprise between 0 to 1). More...

Protected Types inherited from Nektar::SolverUtils::EquationSystem
enum	HomogeneousType { eHomogeneous1D, eHomogeneous2D, eHomogeneous3D, eNotHomogeneous }
	Parameter for homogeneous expansions. More...

Static Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
static std::string	equationSystemTypeLookupIds []

Detailed Description

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

virtual

Destructor.

Definition at line 137 of file ShallowWaterSystem.cpp.

138 {

139 }

◆ ShallowWaterSystem()

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

protected

Initialises UnsteadySystem class members.

Definition at line 68 of file ShallowWaterSystem.cpp.

         : UnsteadySystem(pSession, pGraph)
     {
     }

Member Function Documentation

◆ ConservativeToPrimitive()

void Nektar::ShallowWaterSystem::ConservativeToPrimitive ( void )

inlineprotected

Definition at line 102 of file ShallowWaterSystem.h.

References v_ConservativeToPrimitive().

Referenced by Nektar::LinearSWE::GetDepthBwd().

     {
       v_ConservativeToPrimitive();
     }

◆ CopyBoundaryTrace()

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

protected

Definition at line 178 of file ShallowWaterSystem.cpp.

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

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

   {
 
     int cnt = 0;
     // loop over Boundary Regions
     for(int bcRegion = 0; bcRegion < m_fields[0]->GetBndConditions().num_elements(); ++bcRegion)
       { 
         if (m_fields[0]->GetBndConditions()[bcRegion]->GetBoundaryConditionType()
             == SpatialDomains::ePeriodic)
         {
             continue;
         }
 
     // Copy the forward trace of the field to the backward trace
         int e, id2, npts;
         
         for (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()->
                                     GetBndCondCoeffsToGlobalCoeffsMap(cnt+e));
     
         Vmath::Vcopy(npts, &Fwd[id2], 1, &Bwd[id2], 1);
     }
 
     cnt +=m_fields[0]->GetBndCondExpansions()[bcRegion]->GetExpSize();
       }
   }

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

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

         {
             return MemoryManager<ShallowWaterSystem>::AllocateSharedPtr(
                 pSession, pGraph);
         }

◆ EvaluateCoriolis()

void Nektar::ShallowWaterSystem::EvaluateCoriolis ( void )

private

Definition at line 173 of file ShallowWaterSystem.cpp.

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

Referenced by IsConstantDepth(), and v_InitObject().

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

◆ EvaluateWaterDepth()

void Nektar::ShallowWaterSystem::EvaluateWaterDepth ( void )

private

Definition at line 167 of file ShallowWaterSystem.cpp.

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

Referenced by IsConstantDepth(), and v_InitObject().

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

◆ GetDepth()

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

inlineprotected

Definition at line 124 of file ShallowWaterSystem.h.

References m_depth.

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

         {
             return m_depth;
         }

◆ GetGravity()

NekDouble Nektar::ShallowWaterSystem::GetGravity ( )

inlineprotected

Definition at line 109 of file ShallowWaterSystem.h.

References m_g.

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

         {
             return m_g;
         }

◆ GetNormals()

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

inlineprotected

Definition at line 119 of file ShallowWaterSystem.h.

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

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

         {
             return m_traceNormals;
         }

◆ GetVecLocs()

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

inlineprotected

Definition at line 114 of file ShallowWaterSystem.h.

References m_vecLocs.

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

         {
             return m_vecLocs;
         }

◆ IsConstantDepth()

bool Nektar::ShallowWaterSystem::IsConstantDepth ( )

inlineprotected

Definition at line 129 of file ShallowWaterSystem.h.

References CopyBoundaryTrace(), EvaluateCoriolis(), EvaluateWaterDepth(), and m_constantDepth.

     {
       return m_constantDepth;
     }

◆ PrimitiveToConservative()

void Nektar::ShallowWaterSystem::PrimitiveToConservative ( void )

inlineprotected

Definition at line 96 of file ShallowWaterSystem.h.

References v_PrimitiveToConservative().

Referenced by Nektar::LinearSWE::GetDepthBwd().

     {
       v_PrimitiveToConservative();
     }

◆ v_ConservativeToPrimitive()

void Nektar::ShallowWaterSystem::v_ConservativeToPrimitive ( )

protectedvirtual

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

Definition at line 162 of file ShallowWaterSystem.cpp.

References ASSERTL0.

Referenced by ConservativeToPrimitive().

   {
     ASSERTL0(false, "This function is not implemented for this equation.");
   }

◆ v_GenerateSummary()

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

protectedvirtual

Print a summary of time stepping parameters.

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

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

Definition at line 142 of file ShallowWaterSystem.cpp.

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

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

     {
         UnsteadySystem::v_GenerateSummary(s);
     if (m_constantDepth == true)
       {
         SolverUtils::AddSummaryItem(s, "Depth", "constant");
       }
     else
       {
         SolverUtils::AddSummaryItem(s, "Depth", "variable");
       }
 
     
     }

◆ v_InitObject()

void Nektar::ShallowWaterSystem::v_InitObject ( )

protectedvirtual

Init object for UnsteadySystem class.

Initialization object for UnsteadySystem class.

Reimplemented from Nektar::SolverUtils::UnsteadySystem.

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

Definition at line 75 of file ShallowWaterSystem.cpp.

References ASSERTL0, Nektar::MultiRegions::DirCartesianMap, Nektar::MultiRegions::eDiscontinuous, EvaluateCoriolis(), EvaluateWaterDepth(), Nektar::SolverUtils::EquationSystem::GetTotPoints(), m_bottomSlope, m_constantDepth, m_depth, Nektar::SolverUtils::EquationSystem::m_fields, m_g, Nektar::SolverUtils::UnsteadySystem::m_infosteps, m_primitive, Nektar::SolverUtils::EquationSystem::m_projectionType, 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(), Nektar::NonlinearSWE::v_InitObject(), and Nektar::NonlinearPeregrine::v_InitObject().

     {
         UnsteadySystem::v_InitObject();
 
         // if discontinuous Galerkin determine numerical flux to use
     if (m_projectionType == MultiRegions::eDiscontinuous)
       {
         ASSERTL0(m_session->DefinesSolverInfo("UPWINDTYPE"),
              "No UPWINDTYPE defined in session.");
       }
            
      // 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 generic input parameters
         m_session->LoadParameter("IO_InfoSteps", m_infosteps, 0);
 
     // Load acceleration of gravity
     m_session->LoadParameter("Gravity", m_g, 9.81);
 
     // input/output in primitive variables
     m_primitive = true;
 
         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();
 
     }

◆ v_PrimitiveToConservative()

void Nektar::ShallowWaterSystem::v_PrimitiveToConservative ( )

protectedvirtual

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

Definition at line 157 of file ShallowWaterSystem.cpp.

References ASSERTL0.

Referenced by PrimitiveToConservative().

   {
     ASSERTL0(false, "This function is not implemented for this equation.");
   }

Friends And Related Function Documentation

◆ MemoryManager< ShallowWaterSystem >

friend class MemoryManager< ShallowWaterSystem >

friend

Definition at line 50 of file ShallowWaterSystem.h.

Member Data Documentation

◆ className

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 62 of file ShallowWaterSystem.h.

◆ m_advection

SolverUtils::AdvectionSharedPtr Nektar::ShallowWaterSystem::m_advection

protected

Definition at line 70 of file ShallowWaterSystem.h.

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

◆ m_bottomSlope

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

protected

Definition at line 82 of file ShallowWaterSystem.h.

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

◆ m_constantDepth

bool Nektar::ShallowWaterSystem::m_constantDepth

protected

Indicates if constant depth case.

Definition at line 76 of file ShallowWaterSystem.h.

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

◆ m_coriolis

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

protected

Coriolis force.

Definition at line 84 of file ShallowWaterSystem.h.

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

◆ m_depth

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

protected

Still water depth.

Definition at line 80 of file ShallowWaterSystem.h.

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

◆ m_diffusion

SolverUtils::DiffusionSharedPtr Nektar::ShallowWaterSystem::m_diffusion

protected

Definition at line 71 of file ShallowWaterSystem.h.

◆ m_g

NekDouble Nektar::ShallowWaterSystem::m_g

protected

Acceleration of gravity.

Definition at line 78 of file ShallowWaterSystem.h.

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

◆ m_primitive

bool Nektar::ShallowWaterSystem::m_primitive

protected

Indicates if variables are primitive or conservative.

Definition at line 74 of file ShallowWaterSystem.h.

Referenced by v_InitObject().

◆ m_riemannSolver

SolverUtils::RiemannSolverSharedPtr Nektar::ShallowWaterSystem::m_riemannSolver

protected

Definition at line 68 of file ShallowWaterSystem.h.

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

◆ m_riemannSolverLDG

SolverUtils::RiemannSolverSharedPtr Nektar::ShallowWaterSystem::m_riemannSolverLDG

protected

Definition at line 69 of file ShallowWaterSystem.h.

◆ m_vecLocs

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

protected

Definition at line 86 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

◆ ConservativeToPrimitive()

◆ CopyBoundaryTrace()

◆ create()

◆ EvaluateCoriolis()

◆ EvaluateWaterDepth()

◆ GetDepth()

◆ GetGravity()

◆ GetNormals()

◆ GetVecLocs()

◆ IsConstantDepth()

◆ PrimitiveToConservative()

◆ v_ConservativeToPrimitive()

◆ v_GenerateSummary()

◆ v_InitObject()

◆ v_PrimitiveToConservative()

Friends And Related Function Documentation

◆ MemoryManager< ShallowWaterSystem >

Member Data Documentation

◆ className

◆ m_advection

◆ m_bottomSlope

◆ m_constantDepth

◆ m_coriolis

◆ m_depth

◆ m_diffusion

◆ m_g

◆ m_primitive

◆ m_riemannSolver

◆ m_riemannSolverLDG

◆ m_vecLocs