#include <NonlinearPeregrine.h>

Inheritance diagram for Nektar::NonlinearPeregrine:

Public Member Functions
virtual	~NonlinearPeregrine ()
	problem type selector More...

Public Member Functions inherited from Nektar::ShallowWaterSystem
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 Member Functions inherited from Nektar::ShallowWaterSystem
static SolverUtils::EquationSystemSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
	Creates an instance of this class. More...

Public Attributes
ProblemType	m_problemType

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

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

Static Public Attributes inherited from Nektar::ShallowWaterSystem
static std::string	className
	Name of class. More...

Protected Member Functions
	NonlinearPeregrine (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)

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

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

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

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

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

virtual void	v_PrimitiveToConservative ()

virtual void	v_ConservativeToPrimitive ()

virtual void	v_SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
	Set the initial conditions. More...

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)
	Initialises UnsteadySystem class members. More...

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

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_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
StdRegions::ConstFactorMap	m_factors

Array< OneD, NekDouble >	m_dFwd
	Still water depth traces. More...

Array< OneD, NekDouble >	m_dBwd

Protected Attributes inherited from Nektar::ShallowWaterSystem
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	NumericalFlux1D (Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &numfluxX)

void	NumericalFlux2D (Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &numfluxX, Array< OneD, Array< OneD, NekDouble > > &numfluxY)

void	LaitoneSolitaryWave (NekDouble amp, NekDouble d, NekDouble time, NekDouble x_offset)

void	SetBoundaryConditions (Array< OneD, Array< OneD, NekDouble > > &physarray, NekDouble time)

void	WallBoundary2D (int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &Fwd, Array< OneD, Array< OneD, NekDouble > > &physarray)

void	WallBoundary (int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &Fwd, Array< OneD, Array< OneD, NekDouble > > &physarray)
	Wall boundary condition. More...

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

void	AddVariableDepth (const Array< OneD, const Array< OneD, NekDouble > > &physarray, Array< OneD, Array< OneD, NekDouble > > &outarray)

void	ConservativeToPrimitive (const Array< OneD, const Array< OneD, NekDouble > > &physin, Array< OneD, Array< OneD, NekDouble > > &physout)

void	PrimitiveToConservative (const Array< OneD, const Array< OneD, NekDouble > > &physin, Array< OneD, Array< OneD, NekDouble > > &physout)

void	GetVelocityVector (const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &velocity)
	Compute the velocity field \( \mathbf{v} \) given the momentum \( h\mathbf{v} \). More...

void	WCESolve (Array< OneD, NekDouble > &fce, NekDouble lambda)

void	NumericalFluxForcing (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, NekDouble > &numfluxX, Array< OneD, NekDouble > &numfluxY)

void	SetBoundaryConditionsForcing (Array< OneD, Array< OneD, NekDouble > > &inarray, NekDouble time)

void	WallBoundaryForcing (int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &inarray)

void	SetBoundaryConditionsContVariables (Array< OneD, NekDouble > &inarray, NekDouble time)

void	WallBoundaryContVariables (int bcRegion, int cnt, Array< OneD, NekDouble > &inarray)

void	NumericalFluxConsVariables (Array< OneD, NekDouble > &physfield, Array< OneD, NekDouble > &outX, Array< OneD, NekDouble > &outY)

Private Attributes
NekDouble	m_const_depth

Friends
class	MemoryManager< NonlinearPeregrine >

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

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

Detailed Description

Definition at line 58 of file NonlinearPeregrine.h.

Constructor & Destructor Documentation

◆ ~NonlinearPeregrine()

Nektar::NonlinearPeregrine::~NonlinearPeregrine ( )

virtual

problem type selector

Definition at line 169 of file NonlinearPeregrine.cpp.

 {
 
 }

◆ NonlinearPeregrine()

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

protected

Definition at line 55 of file NonlinearPeregrine.cpp.

References Nektar::StdRegions::eFactorLambda, Nektar::StdRegions::eFactorTau, and m_factors.

     : ShallowWaterSystem(pSession, pGraph), m_factors()
 {
     m_factors[StdRegions::eFactorLambda] = 0.0;
     m_factors[StdRegions::eFactorTau] = 1000000.0;
     // note: eFactorTau = 1.0 becomes unstable...
     // we need to investigate the behaviuor w.r.t. tau
 }

Member Function Documentation

◆ AddCoriolis()

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

private

Definition at line 175 of file NonlinearPeregrine.cpp.

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

Referenced by DoOdeRhs().

 {
 
     int ncoeffs = GetNcoeffs();
     int nq = GetTotPoints();
 
     Array<OneD, NekDouble> tmp(nq);
     Array<OneD, NekDouble> mod(ncoeffs);
 
     switch (m_projectionType)
     {
         case MultiRegions::eDiscontinuous:
         {
             // add to hu 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 hv 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:
         case MultiRegions::eMixed_CG_Discontinuous:
         {
             // add to hu 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 hv 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;
     }
 
 }

◆ AddVariableDepth()

void Nektar::NonlinearPeregrine::AddVariableDepth	(	const Array< OneD, const Array< OneD, NekDouble > > &	physarray,
		Array< OneD, Array< OneD, NekDouble > > &	outarray
	)

private

Definition at line 227 of file NonlinearPeregrine.cpp.

References ASSERTL0, Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, Nektar::MultiRegions::eMixed_CG_Discontinuous, Nektar::SolverUtils::EquationSystem::GetNcoeffs(), Nektar::SolverUtils::EquationSystem::GetTotPoints(), Nektar::ShallowWaterSystem::m_bottomSlope, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::ShallowWaterSystem::m_g, Nektar::SolverUtils::EquationSystem::m_projectionType, Nektar::SolverUtils::EquationSystem::m_spacedim, Vmath::Smul(), Vmath::Vadd(), and Vmath::Vmul().

 {
 
     int ncoeffs = GetNcoeffs();
     int nq = GetTotPoints();
 
     Array<OneD, NekDouble> tmp(nq);
     Array<OneD, NekDouble> mod(ncoeffs);
 
     switch (m_projectionType)
     {
         case MultiRegions::eDiscontinuous:
         {
             for (int i = 0; i < m_spacedim; ++i)
             {
                 Vmath::Vmul(nq, m_bottomSlope[i], 1, physarray[0], 1, tmp, 1);
                 Vmath::Smul(nq, m_g, tmp, 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[i + 1], 1, outarray[i + 1], 1);
             }
             break;
         }
         case MultiRegions::eGalerkin:
         case MultiRegions::eMixed_CG_Discontinuous:
         {
             for (int i = 0; i < m_spacedim; ++i)
             {
                 Vmath::Vmul(nq, m_bottomSlope[i], 1, physarray[0], 1, tmp, 1);
                 Vmath::Smul(nq, m_g, tmp, 1, tmp, 1);
                 Vmath::Vadd(nq, tmp, 1, outarray[i + 1], 1, outarray[i + 1], 1);
             }
             break;
         }
         default:
             ASSERTL0(false, "Unknown projection scheme for the NonlinearSWE");
             break;
     }
 
 }

◆ ConservativeToPrimitive()

void Nektar::NonlinearPeregrine::ConservativeToPrimitive	(	const Array< OneD, const Array< OneD, NekDouble > > &	physin,
		Array< OneD, Array< OneD, NekDouble > > &	physout
	)

private

Definition at line 753 of file NonlinearPeregrine.cpp.

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

 {
     int nq = GetTotPoints();
 
     if (physin.get() == physout.get())
     {
         // copy indata and work with tmp array
         Array<OneD, Array<OneD, NekDouble> > tmp(3);
         for (int i = 0; i < 3; ++i)
         {
             // deep copy
             tmp[i] = Array<OneD, NekDouble>(nq);
             Vmath::Vcopy(nq, physin[i], 1, tmp[i], 1);
         }
 
         // \eta = h - d
         Vmath::Vsub(nq, tmp[0], 1, m_depth, 1, physout[0], 1);
 
         // u = hu/h
         Vmath::Vdiv(nq, tmp[1], 1, tmp[0], 1, physout[1], 1);
 
         // v = hv/ v
         Vmath::Vdiv(nq, tmp[2], 1, tmp[0], 1, physout[2], 1);
     }
     else
     {
         // \eta = h - d
         Vmath::Vsub(nq, physin[0], 1, m_depth, 1, physout[0], 1);
 
         // u = hu/h
         Vmath::Vdiv(nq, physin[1], 1, physin[0], 1, physout[1], 1);
 
         // v = hv/ v
         Vmath::Vdiv(nq, physin[2], 1, physin[0], 1, physout[2], 1);
     }
 }

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 64 of file NonlinearPeregrine.h.

References CellMLToNektar.cellml_metadata::p.

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

◆ DoOdeProjection()

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

protected

Definition at line 494 of file NonlinearPeregrine.cpp.

References ASSERTL0, Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, Nektar::MultiRegions::eMixed_CG_Discontinuous, 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 v_InitObject().

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

◆ DoOdeRhs()

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

protected

Definition at line 271 of file NonlinearPeregrine.cpp.

References AddCoriolis(), ASSERTL0, Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, Nektar::MultiRegions::eMixed_CG_Discontinuous, Nektar::SolverUtils::EquationSystem::GetNcoeffs(), Nektar::SolverUtils::EquationSystem::GetTotPoints(), Nektar::SolverUtils::EquationSystem::GetTraceTotPoints(), Nektar::ShallowWaterSystem::m_advection, m_const_depth, Nektar::ShallowWaterSystem::m_constantDepth, Nektar::ShallowWaterSystem::m_coriolis, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_projectionType, Vmath::Neg(), NumericalFluxConsVariables(), NumericalFluxForcing(), SetBoundaryConditionsContVariables(), SetBoundaryConditionsForcing(), Vmath::Smul(), Vmath::Vadd(), Vmath::Vcopy(), and WCESolve().

Referenced by v_InitObject().

 {
     int i;
     int nvariables = inarray.num_elements();
     int ncoeffs = GetNcoeffs();
     int nq = GetTotPoints();
 
     switch (m_projectionType)
     {
         case MultiRegions::eDiscontinuous:
         {
 
             //-------------------------------------------------------
             //inarray in physical space
 
             Array<OneD, Array<OneD, NekDouble> > modarray(nvariables);
             for (i = 0; i < nvariables; ++i)
             {
                 modarray[i] = Array<OneD, NekDouble>(ncoeffs, 0.0);
             }
             //-------------------------------------------------------
 
             //-------------------------------------------------------
             // Compute the DG advection including the numerical flux
             // by using SolverUtils/Advection
             // Input and output in physical space
             Array<OneD, Array<OneD, NekDouble> > advVel;
 
             m_advection->Advect(nvariables - 1, m_fields, advVel, inarray,
                     outarray, time);
             //-------------------------------------------------------
 
             //-------------------------------------------------------
             // negate the outarray since moving terms to the rhs
             for (i = 0; i < nvariables - 1; ++i)
             {
                 Vmath::Neg(nq, outarray[i], 1);
             }
             //-------------------------------------------------------
 
             //-------------------------------------------------
             // Add "source terms"
             // Input and output in physical space
 
             // Coriolis forcing
             if (m_coriolis.num_elements() != 0)
             {
                 AddCoriolis(inarray, outarray);
             }
 
             // Variable Depth
             if (m_constantDepth != true)
             {
                 ASSERTL0(false,
                         "Variable depth not supported for the Peregrine "
                         "equations");
             }
 
             //-------------------------------------------------
 
             //---------------------------------------
             // As no more terms is required for the
             // continuity equation and we have aleady evaluated
             //  the values for h_t we are done for h
             //---------------------------------------
 
             //-------------------------------------------------
             // go to modal space
             m_fields[0]->IProductWRTBase(outarray[1], modarray[1]);
             m_fields[0]->IProductWRTBase(outarray[2], modarray[2]);
 
             // store f1 and f2 for later use (modal space)
             Array<OneD, NekDouble> f1(ncoeffs);
             Array<OneD, NekDouble> f2(ncoeffs);
 
             Vmath::Vcopy(ncoeffs, modarray[1], 1, f1, 1); // f1
             Vmath::Vcopy(ncoeffs, modarray[2], 1, f2, 1); // f2
 
             // Solve the remaining block-diagonal systems
             m_fields[0]->MultiplyByElmtInvMass(modarray[1], modarray[1]);
             m_fields[0]->MultiplyByElmtInvMass(modarray[2], modarray[2]);
             //---------------------------------------------
 
             //---------------------------------------------
 
             //-------------------------------------------------
             // create tmp fields to be used during
             // the dispersive section
 
             Array<OneD, Array<OneD, NekDouble> > coeffsfield(2);
             Array<OneD, Array<OneD, NekDouble> > physfield(2);
 
             for (i = 0; i < 2; ++i)
             {
                 coeffsfield[i] = Array<OneD, NekDouble>(ncoeffs);
                 physfield[i] = Array<OneD, NekDouble>(nq);
             }
             //---------------------------------------------
 
             //---------------------------------------------
             // Go from modal to physical space
             Vmath::Vcopy(nq, outarray[1], 1, physfield[0], 1);
             Vmath::Vcopy(nq, outarray[2], 1, physfield[1], 1);
             //---------------------------------------
 
             //---------------------------------------
             // Start for solve of mixed dispersive terms
             // using the 'WCE method'
             // (Eskilsson & Sherwin, JCP 2006)
 
             // constant depth case
             // \nabla \cdot (\nabla z) - invgamma z
             //    = - invgamma (\nabla \cdot {\bf f}_(2,3)
 
             NekDouble gamma = (m_const_depth * m_const_depth) * (1.0 / 3.0);
             NekDouble invgamma = 1.0 / gamma;
 
             int nTraceNumPoints = GetTraceTotPoints();
             Array<OneD, Array<OneD, NekDouble> > upwindX(1);
             Array<OneD, Array<OneD, NekDouble> > upwindY(1);
             upwindX[0] = Array<OneD, NekDouble>(nTraceNumPoints);
             upwindY[0] = Array<OneD, NekDouble>(nTraceNumPoints);
             //--------------------------------------------
 
             //--------------------------------------------
             // Compute the forcing function for the
             // wave continuity equation
 
             // Set boundary condidtions for z
             SetBoundaryConditionsForcing(physfield, time);
 
             // \nabla \phi \cdot f_{2,3}
             m_fields[0]->IProductWRTDerivBase(0, physfield[0], coeffsfield[0]);
             m_fields[0]->IProductWRTDerivBase(1, physfield[1], coeffsfield[1]);
             Vmath::Vadd(ncoeffs, coeffsfield[0], 1, coeffsfield[1], 1,
                                  coeffsfield[0], 1);
             Vmath::Neg(ncoeffs, coeffsfield[0], 1);
 
             // Evaluate  upwind numerical flux (physical space)
             NumericalFluxForcing(physfield, upwindX[0], upwindY[0]);
 
             m_fields[0]->AddTraceIntegral(upwindX[0], upwindY[0],
                                           coeffsfield[0]);
             m_fields[0]->MultiplyByElmtInvMass(coeffsfield[0], coeffsfield[0]);
             m_fields[0]->BwdTrans(coeffsfield[0], physfield[0]);
 
             Vmath::Smul(nq, -invgamma, physfield[0], 1, physfield[0], 1);
 
             // ok: forcing function for HelmSolve... done!
             //--------------------------------------
 
             //--------------------------------------
             // Solve the Helmhotz-type equation
             // for the wave continuity equation
             // (missing slope terms...)
 
             // note: this is just valid for the constant depth case:
 
             // as of now we need not to specify any
             // BC routine for the WCE: periodic
             // and zero Neumann (for walls)
 
             WCESolve(physfield[0], invgamma);
 
             Vmath::Vcopy(nq, physfield[0], 1, outarray[3], 1); // store z
 
             // ok: Wave Continuity Equation... done!
             //------------------------------------
 
             //------------------------------------
             // Return to the primary variables
 
             // (h {\bf u})_t = gamma \nabla z + {\bf f}_{2,3}
 
             Vmath::Smul(nq, gamma, physfield[0], 1, physfield[0], 1);
 
             // Set boundary conditions
             SetBoundaryConditionsContVariables(physfield[0], time);
 
             m_fields[0]->IProductWRTDerivBase(0, physfield[0], coeffsfield[0]);
             m_fields[1]->IProductWRTDerivBase(1, physfield[0], coeffsfield[1]);
 
             Vmath::Neg(ncoeffs, coeffsfield[0], 1);
             Vmath::Neg(ncoeffs, coeffsfield[1], 1);
 
             // Evaluate  upwind numerical flux (physical space)
             NumericalFluxConsVariables(physfield[0], upwindX[0], upwindY[0]);
 
             {
                 Array<OneD, NekDouble> uptemp(nTraceNumPoints, 0.0);
 
                 m_fields[0]->AddTraceIntegral(upwindX[0], uptemp,
                                               coeffsfield[0]);
                 m_fields[0]->AddTraceIntegral(uptemp, upwindY[0],
                                               coeffsfield[1]);
             }
 
             Vmath::Vadd(ncoeffs, f1, 1, coeffsfield[0], 1, modarray[1], 1);
             Vmath::Vadd(ncoeffs, f2, 1, coeffsfield[1], 1, modarray[2], 1);
 
             m_fields[1]->MultiplyByElmtInvMass(modarray[1], modarray[1]);
             m_fields[2]->MultiplyByElmtInvMass(modarray[2], modarray[2]);
 
             m_fields[1]->BwdTrans(modarray[1], outarray[1]);
             m_fields[2]->BwdTrans(modarray[2], outarray[2]);
 
             // ok: returned to conservative variables... done!
             //---------------------
 
             break;
         }
         case MultiRegions::eGalerkin:
         case MultiRegions::eMixed_CG_Discontinuous:
             ASSERTL0(false, "Unknown projection scheme for the Peregrine");
             break;
         default:
             ASSERTL0(false, "Unknown projection scheme for the NonlinearSWE");
             break;
     }
 }

◆ GetDepthBwd()

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

inlineprotected

Definition at line 122 of file NonlinearPeregrine.h.

References m_dBwd.

     {
         return m_dBwd;
     }

◆ GetDepthFwd()

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

inlineprotected

Definition at line 118 of file NonlinearPeregrine.h.

References m_dFwd.

     {
         return m_dFwd;
     }

◆ GetFluxVector()

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

protected

Definition at line 714 of file NonlinearPeregrine.cpp.

References GetVelocityVector(), Nektar::SolverUtils::EquationSystem::m_fields, Nektar::ShallowWaterSystem::m_g, Nektar::SolverUtils::EquationSystem::m_spacedim, Vmath::Smul(), Vmath::Vadd(), Vmath::Vcopy(), and Vmath::Vmul().

Referenced by v_InitObject().

 {
     int i, j;
     int nq = m_fields[0]->GetTotPoints();
 
     NekDouble g = m_g;
     Array<OneD, Array<OneD, NekDouble> > velocity(m_spacedim);
 
     // Flux vector for the mass equation
     for (i = 0; i < m_spacedim; ++i)
     {
         velocity[i] = Array<OneD, NekDouble>(nq);
         Vmath::Vcopy(nq, physfield[i + 1], 1, flux[0][i], 1);
     }
 
     GetVelocityVector(physfield, velocity);
 
     // Put (0.5 g h h) in tmp
     Array<OneD, NekDouble> tmp(nq);
     Vmath::Vmul(nq, physfield[0], 1, physfield[0], 1, tmp, 1);
     Vmath::Smul(nq, 0.5 * g, tmp, 1, tmp, 1);
 
     // Flux vector for the momentum equations
     for (i = 0; i < m_spacedim; ++i)
     {
         for (j = 0; j < m_spacedim; ++j)
         {
             Vmath::Vmul(nq, velocity[j],    1, physfield[i + 1], 1,
                             flux[i + 1][j], 1);
         }
 
         // Add (0.5 g h h) to appropriate field
         Vmath::Vadd(nq, flux[i + 1][i], 1, tmp, 1, flux[i + 1][i], 1);
     }
 
 }

◆ GetVelocityVector()

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

private

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

Parameters

physfield	Momentum field.
velocity	Velocity field.

Definition at line 876 of file NonlinearPeregrine.cpp.

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

Referenced by GetFluxVector().

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

◆ LaitoneSolitaryWave()

void Nektar::NonlinearPeregrine::LaitoneSolitaryWave	(	NekDouble	amp,
		NekDouble	d,
		NekDouble	time,
		NekDouble	x_offset
	)

private

Definition at line 1168 of file NonlinearPeregrine.cpp.

References Nektar::SolverUtils::EquationSystem::GetTotPoints(), Nektar::SolverUtils::EquationSystem::m_fields, Nektar::ShallowWaterSystem::m_g, Vmath::Sadd(), Vmath::Vcopy(), and Vmath::Vmul().

Referenced by v_SetInitialConditions().

 {
     int nq = GetTotPoints();
 
     NekDouble A = 1.0;
     NekDouble C = sqrt(m_g * d) * (1.0 + 0.5 * (amp / d));
 
     Array<OneD, NekDouble> x0(nq);
     Array<OneD, NekDouble> x1(nq);
     Array<OneD, NekDouble> zeros(nq, 0.0);
 
     // get the coordinates (assuming all fields have the same
     // discretisation)
     m_fields[0]->GetCoords(x0, x1);
 
     for (int i = 0; i < nq; i++)
     {
         (m_fields[0]->UpdatePhys())[i] = amp * pow((1.0 / cosh(
                                 sqrt(0.75 * (amp / (d * d * d))) *
                                 (A * (x0[i] + x_offset) - C * time))), 2.0);
         (m_fields[1]->UpdatePhys())[i] = (amp / d) * pow((1.0 / cosh(
                                     sqrt(0.75 * (amp / (d * d * d))) *
                                     (A * (x0[i] + x_offset) - C * time)
                                 )), 2.0) * sqrt(m_g * d);
     }
 
     Vmath::Sadd(nq, d, m_fields[0]->GetPhys(), 1, m_fields[0]->UpdatePhys(), 1);
     Vmath::Vmul(nq,    m_fields[0]->GetPhys(), 1, m_fields[1]->GetPhys(),    1,
                                                   m_fields[1]->UpdatePhys(), 1);
     Vmath::Vcopy(nq, zeros, 1, m_fields[2]->UpdatePhys(), 1);
     Vmath::Vcopy(nq, zeros, 1, m_fields[3]->UpdatePhys(), 1);
 
     // Forward transform to fill the coefficient space
     for (int i = 0; i < 4; ++i)
     {
         m_fields[i]->SetPhysState(true);
         m_fields[i]->FwdTrans(m_fields[i]->GetPhys(),
                               m_fields[i]->UpdateCoeffs());
     }
 
 }

◆ NumericalFlux1D()

void Nektar::NonlinearPeregrine::NumericalFlux1D	(	Array< OneD, Array< OneD, NekDouble > > &	physfield,
		Array< OneD, Array< OneD, NekDouble > > &	numfluxX
	)

private

◆ NumericalFlux2D()

void Nektar::NonlinearPeregrine::NumericalFlux2D	(	Array< OneD, Array< OneD, NekDouble > > &	physfield,
		Array< OneD, Array< OneD, NekDouble > > &	numfluxX,
		Array< OneD, Array< OneD, NekDouble > > &	numfluxY
	)

private

◆ NumericalFluxConsVariables()

void Nektar::NonlinearPeregrine::NumericalFluxConsVariables	(	Array< OneD, NekDouble > &	physfield,
		Array< OneD, NekDouble > &	outX,
		Array< OneD, NekDouble > &	outY
	)

private

Definition at line 1134 of file NonlinearPeregrine.cpp.

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

Referenced by DoOdeRhs().

 {
     int i;
     int nTraceNumPoints = GetTraceTotPoints();
 
     //-----------------------------------------------------
     // get temporary arrays
     Array<OneD, Array<OneD, NekDouble> > Fwd(1);
     Array<OneD, Array<OneD, NekDouble> > Bwd(1);
 
     Fwd[0] = Array<OneD, NekDouble>(nTraceNumPoints);
     Bwd[0] = Array<OneD, NekDouble>(nTraceNumPoints);
     //-----------------------------------------------------
 
     //-----------------------------------------------------
     // get the physical values at the trace
     // (we have put any time-dependent BC in field[1])
 
     m_fields[1]->GetFwdBwdTracePhys(physfield, Fwd[0], Bwd[0]);
     //-----------------------------------------------------
 
     //-----------------------------------------------------
     // use centred fluxes for the numerical flux
     for (i = 0; i < nTraceNumPoints; ++i)
     {
         outX[i] = 0.5 * (Fwd[0][i] + Bwd[0][i]);
         outY[i] = 0.5 * (Fwd[0][i] + Bwd[0][i]);
     }
     //-----------------------------------------------------
 }

◆ NumericalFluxForcing()

void Nektar::NonlinearPeregrine::NumericalFluxForcing	(	const Array< OneD, const Array< OneD, NekDouble > > &	inarray,
		Array< OneD, NekDouble > &	numfluxX,
		Array< OneD, NekDouble > &	numfluxY
	)

private

Definition at line 924 of file NonlinearPeregrine.cpp.

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

Referenced by DoOdeRhs().

 {
     int i;
     int nTraceNumPoints = GetTraceTotPoints();
 
     //-----------------------------------------------------
     // get temporary arrays
     Array<OneD, Array<OneD, NekDouble> > Fwd(2);
     Array<OneD, Array<OneD, NekDouble> > Bwd(2);
 
     for (i = 0; i < 2; ++i)
     {
         Fwd[i] = Array<OneD, NekDouble>(nTraceNumPoints);
         Bwd[i] = Array<OneD, NekDouble>(nTraceNumPoints);
     }
     //-----------------------------------------------------
 
     //-----------------------------------------------------
     // get the physical values at the trace
     // (any time-dependent BC previuosly put in fields[1] and [2]
 
     m_fields[1]->GetFwdBwdTracePhys(inarray[0], Fwd[0], Bwd[0]);
     m_fields[2]->GetFwdBwdTracePhys(inarray[1], Fwd[1], Bwd[1]);
     //-----------------------------------------------------
 
     //-----------------------------------------------------
     // use centred fluxes for the numerical flux
     for (i = 0; i < nTraceNumPoints; ++i)
     {
         numfluxX[i] = 0.5 * (Fwd[0][i] + Bwd[0][i]);
         numfluxY[i] = 0.5 * (Fwd[1][i] + Bwd[1][i]);
     }
     //-----------------------------------------------------
 }

◆ PrimitiveToConservative()

void Nektar::NonlinearPeregrine::PrimitiveToConservative	(	const Array< OneD, const Array< OneD, NekDouble > > &	physin,
		Array< OneD, Array< OneD, NekDouble > > &	physout
	)

private

Definition at line 809 of file NonlinearPeregrine.cpp.

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

 {
 
     int nq = GetTotPoints();
 
     if (physin.get() == physout.get())
     {
         // copy indata and work with tmp array
         Array<OneD, Array<OneD, NekDouble> > tmp(3);
         for (int i = 0; i < 3; ++i)
         {
             // deep copy
             tmp[i] = Array<OneD, NekDouble>(nq);
             Vmath::Vcopy(nq, physin[i], 1, tmp[i], 1);
         }
 
         // h = \eta + d
         Vmath::Vadd(nq, tmp[0],     1, m_depth, 1, physout[0], 1);
 
         // hu = h * u
         Vmath::Vmul(nq, physout[0], 1, tmp[1],  1, physout[1], 1);
 
         // hv = h * v
         Vmath::Vmul(nq, physout[0], 1, tmp[2],  1, physout[2], 1);
 
     }
     else
     {
         // h = \eta + d
         Vmath::Vadd(nq, physin[0],  1, m_depth,   1, physout[0], 1);
 
         // hu = h * u
         Vmath::Vmul(nq, physout[0], 1, physin[1], 1, physout[1], 1);
 
         // hv = h * v
         Vmath::Vmul(nq, physout[0], 1, physin[2], 1, physout[2], 1);
 
     }
 
 }

◆ SetBoundaryConditions()

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

private

Definition at line 539 of file NonlinearPeregrine.cpp.

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

Referenced by DoOdeProjection().

 {
 
     int nvariables = m_fields.num_elements();
     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().num_elements(); ++n)
     {
 
         // Wall Boundary Condition
         if (boost::iequals(m_fields[0]->GetBndConditions()[n]->GetUserDefined(),"Wall"))
         {
             WallBoundary2D(n, cnt, Fwd, inarray);
         }
 
         // Time Dependent Boundary Condition (specified in meshfile)
         if (m_fields[0]->GetBndConditions()[n]->IsTimeDependent())
         {
             for (int i = 0; i < nvariables; ++i)
             {
                 m_fields[i]->EvaluateBoundaryConditions(time);
             }
         }
         cnt += m_fields[0]->GetBndCondExpansions()[n]->GetExpSize();
     }
 }

◆ SetBoundaryConditionsContVariables()

void Nektar::NonlinearPeregrine::SetBoundaryConditionsContVariables	(	Array< OneD, NekDouble > &	inarray,
		NekDouble	time
	)

private

Definition at line 1075 of file NonlinearPeregrine.cpp.

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

Referenced by DoOdeRhs().

 {
     boost::ignore_unused(time);
 
     int cnt = 0;
 
     // loop over Boundary Regions
     for (int n = 0; n < m_fields[0]->GetBndConditions().num_elements(); ++n)
     {
         // Use wall for all
         // Wall Boundary Condition
         if(boost::iequals(m_fields[0]->GetBndConditions()[n]->GetUserDefined(),"Wall"))
         {
             WallBoundaryContVariables(n, cnt, inarray);
         }
 
         if (m_fields[0]->GetBndConditions()[n]->IsTimeDependent())
         {
             WallBoundaryContVariables(n, cnt, inarray);
         }
 
         cnt += m_fields[0]->GetBndCondExpansions()[n]->GetExpSize() - 1;
     }
 }

◆ SetBoundaryConditionsForcing()

void Nektar::NonlinearPeregrine::SetBoundaryConditionsForcing	(	Array< OneD, Array< OneD, NekDouble > > &	inarray,
		NekDouble	time
	)

private

Definition at line 962 of file NonlinearPeregrine.cpp.

References ASSERTL0, Nektar::SolverUtils::EquationSystem::m_fields, and WallBoundaryForcing().

Referenced by DoOdeRhs().

 {
     boost::ignore_unused(time);
 
     int cnt = 0;
 
     // loop over Boundary Regions
     for (int n = 0; n < m_fields[0]->GetBndConditions().num_elements(); ++n)
     {
         // Use wall for all BC...
         // Wall Boundary Condition
         if (boost::iequals(m_fields[0]->GetBndConditions()[n]->GetUserDefined(),"Wall"))
         {
             WallBoundaryForcing(n, cnt, inarray);
         }
 
         //Timedependent Boundary Condition
         if (m_fields[0]->GetBndConditions()[n]->IsTimeDependent())
         {
             ASSERTL0(false, "time-dependent BC not implemented for Boussinesq");
         }
         cnt += m_fields[0]->GetBndCondExpansions()[n]->GetExpSize();
     }
 }

◆ v_ConservativeToPrimitive()

void Nektar::NonlinearPeregrine::v_ConservativeToPrimitive ( )

protectedvirtual

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 792 of file NonlinearPeregrine.cpp.

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

 {
     int nq = GetTotPoints();
 
     // 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);
 
     // \eta = h - d
     Vmath::Vsub(nq, m_fields[0]->GetPhys(),    1, m_depth, 1,
                     m_fields[0]->UpdatePhys(), 1);
 }

◆ v_GenerateSummary()

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

protectedvirtual

Print a summary of time stepping parameters.

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 888 of file NonlinearPeregrine.cpp.

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

 {
     ShallowWaterSystem::v_GenerateSummary(s);
     SolverUtils::AddSummaryItem(s, "Variables", "h  should be in field[0]");
     SolverUtils::AddSummaryItem(s, "", "hu should be in field[1]");
     SolverUtils::AddSummaryItem(s, "", "hv should be in field[2]");
     SolverUtils::AddSummaryItem(s, "", "z  should be in field[3]");
 }

◆ v_InitObject()

void Nektar::NonlinearPeregrine::v_InitObject ( )

protectedvirtual

Init object for UnsteadySystem class.

Initialization object for UnsteadySystem class.

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 66 of file NonlinearPeregrine.cpp.

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineOdeRhs(), Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineProjection(), DoOdeProjection(), DoOdeRhs(), Nektar::MultiRegions::eDiscontinuous, Nektar::MultiRegions::eGalerkin, Nektar::SolverUtils::GetAdvectionFactory(), Nektar::ShallowWaterSystem::GetDepth(), GetFluxVector(), Nektar::ShallowWaterSystem::GetGravity(), Nektar::ShallowWaterSystem::GetNormals(), Nektar::SolverUtils::GetRiemannSolverFactory(), Nektar::ShallowWaterSystem::GetVecLocs(), Nektar::ShallowWaterSystem::m_advection, m_const_depth, Nektar::SolverUtils::UnsteadySystem::m_explicitAdvection, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::UnsteadySystem::m_ode, m_problemType, Nektar::SolverUtils::EquationSystem::m_projectionType, Nektar::ShallowWaterSystem::m_riemannSolver, Nektar::SolverUtils::EquationSystem::m_session, Nektar::ProblemTypeMap, Nektar::SIZE_ProblemType, and Nektar::ShallowWaterSystem::v_InitObject().

 {
     ShallowWaterSystem::v_InitObject();
 
     if (m_session->DefinesSolverInfo("PROBLEMTYPE"))
     {
         int i;
         std::string ProblemTypeStr = m_session->GetSolverInfo("PROBLEMTYPE");
         for (i = 0; i < (int) SIZE_ProblemType; ++i)
         {
             if (boost::iequals(ProblemTypeMap[i], ProblemTypeStr))
             {
                 m_problemType = (ProblemType) i;
                 break;
             }
         }
     }
     else
     {
         m_problemType = (ProblemType) 0;
     }
 
     if (m_explicitAdvection)
     {
         m_ode.DefineOdeRhs(&NonlinearPeregrine::DoOdeRhs, this);
         m_ode.DefineProjection(&NonlinearPeregrine::DoOdeProjection, this);
     }
     else
     {
         ASSERTL0(false, "Implicit Peregrine not set up.");
     }
 
     // NB! At the moment only the constant depth case is
     // supported for the Peregrine eq.
     if (m_session->DefinesParameter("ConstDepth"))
     {
         m_const_depth = m_session->GetParameter("ConstDepth");
     }
     else
     {
         ASSERTL0(false, "Constant Depth not specified");
     }
 
     // Type of advection class to be used
     switch (m_projectionType)
     {
         // Continuous field
         case MultiRegions::eGalerkin:
         {
             ASSERTL0(false,
                     "Continuous projection type not supported for Peregrine.");
             break;
         }
         // Discontinuous field
         case MultiRegions::eDiscontinuous:
         {
             string advName;
             string diffName;
             string riemName;
 
             //---------------------------------------------------------------
             // Setting up advection and diffusion operators
             // NB: diffusion not set up for SWE at the moment
             //     but kept here for future use ...
             m_session->LoadSolverInfo("AdvectionType", advName, "WeakDG");
             // m_session->LoadSolverInfo("DiffusionType", diffName, "LDG");
             m_advection = SolverUtils::GetAdvectionFactory().CreateInstance(
                     advName, advName);
 
             m_advection->SetFluxVector(&NonlinearPeregrine::GetFluxVector,
                     this);
 
             // Setting up Riemann solver for advection operator
             m_session->LoadSolverInfo("UpwindType", riemName, "NoSolver");
 
             m_riemannSolver =
                     SolverUtils::GetRiemannSolverFactory().CreateInstance(
                             riemName, m_session);
 
             // Setting up parameters for advection operator Riemann solver
             m_riemannSolver->SetParam("gravity",
                     &NonlinearPeregrine::GetGravity, this);
             m_riemannSolver->SetAuxVec("vecLocs",
                     &NonlinearPeregrine::GetVecLocs, this);
             m_riemannSolver->SetVector("N", &NonlinearPeregrine::GetNormals,
                     this);
             m_riemannSolver->SetScalar("depth", &NonlinearPeregrine::GetDepth,
                     this);
 
             // Concluding initialisation of advection / diffusion operators
             m_advection->SetRiemannSolver(m_riemannSolver);
             m_advection->InitObject(m_session, m_fields);
             break;
         }
         default:
         {
             ASSERTL0(false, "Unsupported projection type.");
             break;
         }
     }
 
 }

◆ v_PrimitiveToConservative()

void Nektar::NonlinearPeregrine::v_PrimitiveToConservative ( )

protectedvirtual

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 852 of file NonlinearPeregrine.cpp.

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

 {
     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);
 }

◆ v_SetInitialConditions()

void Nektar::NonlinearPeregrine::v_SetInitialConditions	(	NekDouble	initialtime = `0.0`,
		bool	dumpInitialConditions = `true`,
		const int	domain = `0`
	)

protectedvirtual

Set the initial conditions.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Definition at line 1217 of file NonlinearPeregrine.cpp.

References Nektar::SolverUtils::EquationSystem::Checkpoint_Output(), Nektar::eSolitaryWave, LaitoneSolitaryWave(), m_const_depth, m_problemType, and Nektar::SolverUtils::EquationSystem::v_SetInitialConditions().

 {
     boost::ignore_unused(domain);
 
     switch (m_problemType)
     {
         case eSolitaryWave:
         {
             LaitoneSolitaryWave(0.1, m_const_depth, 0.0, 0.0);
             break;
         }
         default:
         {
             EquationSystem::v_SetInitialConditions(initialtime, false);
             break;
         }
     }
 
     if (dumpInitialConditions)
     {
         // Dump initial conditions to file
         Checkpoint_Output(0);
     }
 }

◆ WallBoundary()

void Nektar::NonlinearPeregrine::WallBoundary	(	int	bcRegion,
		int	cnt,
		Array< OneD, Array< OneD, NekDouble > > &	Fwd,
		Array< OneD, Array< OneD, NekDouble > > &	physarray
	)

private

Wall boundary condition.

Definition at line 583 of file NonlinearPeregrine.cpp.

References Nektar::SolverUtils::EquationSystem::m_fields, Nektar::SolverUtils::EquationSystem::m_spacedim, Nektar::SolverUtils::EquationSystem::m_traceNormals, Vmath::Smul(), Vmath::Vcopy(), and Vmath::Vvtvp().

 {
     int i;
     int nvariables = physarray.num_elements();
 
     // Adjust the physical values of the trace to take
     // user defined boundaries into account
     int e, id1, id2, npts;
     MultiRegions::ExpListSharedPtr bcexp =
                                 m_fields[0]->GetBndCondExpansions()[bcRegion];
     for (e = 0; e < bcexp->GetExpSize(); ++e)
     {
         npts = bcexp->GetExp(e)->GetTotPoints();
         id1  = bcexp->GetPhys_Offset(e);
         id2  = m_fields[0]->GetTrace()->GetPhys_Offset(
                m_fields[0]->GetTraceMap()->GetBndCondCoeffsToGlobalCoeffsMap(
                                                                     cnt + e));
 
         // For 2D/3D, define: v* = v - 2(v.n)n
         Array<OneD, NekDouble> tmp(npts, 0.0);
 
         // Calculate (v.n)
         for (i = 0; i < m_spacedim; ++i)
         {
             Vmath::Vvtvp(npts, &Fwd[1 + i][id2], 1, &m_traceNormals[i][id2], 1,
                                &tmp[0],          1, &tmp[0],                 1);
         }
 
         // Calculate 2.0(v.n)
         Vmath::Smul(npts, -2.0, &tmp[0], 1, &tmp[0], 1);
 
         // Calculate v* = v - 2.0(v.n)n
         for (i = 0; i < m_spacedim; ++i)
         {
             Vmath::Vvtvp(npts, &tmp[0],          1, &m_traceNormals[i][id2], 1,
                                &Fwd[1 + i][id2], 1, &Fwd[1 + i][id2],        1);
         }
 
         // copy boundary adjusted values into the boundary expansion
         for (i = 0; i < nvariables; ++i)
         {
             bcexp = m_fields[i]->GetBndCondExpansions()[bcRegion];
             Vmath::Vcopy(npts, &Fwd[i][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
         }
     }
 }

◆ WallBoundary2D()

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

private

Definition at line 632 of file NonlinearPeregrine.cpp.

References ASSERTL0, 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().

 {
     boost::ignore_unused(physarray);
 
     int i;
     int nvariables = 3;
 
     // Adjust the physical values of the trace to take
     // user defined boundaries into account
     int e, id1, id2, npts;
     MultiRegions::ExpListSharedPtr bcexp =
                                 m_fields[0]->GetBndCondExpansions()[bcRegion];
 
     for (e = 0; e < bcexp->GetExpSize();
             ++e)
     {
         npts = bcexp->GetExp(e)->GetNumPoints(0);
         id1  = bcexp->GetPhys_Offset(e);
         id2  = m_fields[0]->GetTrace()->GetPhys_Offset(
                m_fields[0]->GetTraceMap()->GetBndCondCoeffsToGlobalCoeffsMap(
                                                                    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 (i = 0; i < nvariables; ++i)
         {
             bcexp = m_fields[i]->GetBndCondExpansions()[bcRegion];
             Vmath::Vcopy(npts, &Fwd[i][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
         }
     }
 }

◆ WallBoundaryContVariables()

void Nektar::NonlinearPeregrine::WallBoundaryContVariables	(	int	bcRegion,
		int	cnt,
		Array< OneD, NekDouble > &	inarray
	)

private

Definition at line 1102 of file NonlinearPeregrine.cpp.

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

Referenced by SetBoundaryConditionsContVariables().

 {
     int nTraceNumPoints = GetTraceTotPoints();
 
     // get physical values of z for the forward trace
     Array<OneD, NekDouble> z(nTraceNumPoints);
     m_fields[0]->ExtractTracePhys(inarray, z);
 
     // Adjust the physical values of the trace to take
     // user defined boundaries into account
     int e, id1, id2, npts;
     MultiRegions::ExpListSharedPtr bcexp =
                                 m_fields[0]->GetBndCondExpansions()[bcRegion];
 
     for (e = 0; e < bcexp->GetExpSize(); ++e)
     {
         npts = bcexp->GetExp(e)->GetTotPoints();
         id1  = bcexp->GetPhys_Offset(e);
         id2  = m_fields[0]->GetTrace()->GetPhys_Offset(
                m_fields[0]->GetTraceMap()->GetBndCondCoeffsToGlobalCoeffsMap(
                                                                    cnt + e));
 
         // copy boundary adjusted values into the boundary expansion field[1] and field[2]
         bcexp = m_fields[1]->GetBndCondExpansions()[bcRegion];
         Vmath::Vcopy(npts, &z[id2], 1, &(bcexp->UpdatePhys())[id1], 1);
 
     }
 }

◆ WallBoundaryForcing()

void Nektar::NonlinearPeregrine::WallBoundaryForcing	(	int	bcRegion,
		int	cnt,
		Array< OneD, Array< OneD, NekDouble > > &	inarray
	)

private

Definition at line 990 of file NonlinearPeregrine.cpp.

References ASSERTL0, Nektar::SolverUtils::EquationSystem::GetTraceTotPoints(), 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 SetBoundaryConditionsForcing().

 {
 
     //std::cout << " WallBoundaryForcing" << std::endl;
 
     int nTraceNumPoints = GetTraceTotPoints();
     int nvariables = 2;
 
     // get physical values of f1 and f2 for the forward trace
     Array<OneD, Array<OneD, NekDouble> > Fwd(nvariables);
     for (int i = 0; i < nvariables; ++i)
     {
         Fwd[i] = Array<OneD, NekDouble>(nTraceNumPoints);
         m_fields[i]->ExtractTracePhys(inarray[i], Fwd[i]);
     }
 
     // Adjust the physical values of the trace to take
     // user defined boundaries into account
     int e, id1, id2, npts;
     MultiRegions::ExpListSharedPtr bcexp =
                                 m_fields[0]->GetBndCondExpansions()[bcRegion];
     for (e = 0; e < bcexp->GetExpSize(); ++e)
     {
         npts = bcexp->GetExp(e)->GetTotPoints();
         id1  = bcexp->GetPhys_Offset(e);
         id2  = m_fields[0]->GetTrace()->GetPhys_Offset(
                m_fields[0]->GetTraceMap()->GetBndCondCoeffsToGlobalCoeffsMap(
                                                                    cnt + e));
 
         switch (m_expdim)
         {
             case 1:
             {
                 ASSERTL0(false, "1D not yet implemented for Boussinesq");
                 break;
             }
             case 2:
             {
                 Array<OneD, NekDouble> tmp_n(npts);
                 Array<OneD, NekDouble> tmp_t(npts);
 
                 Vmath::Vmul (npts, &Fwd[0][id2], 1, &m_traceNormals[0][id2], 1,
                                    &tmp_n[0],    1);
                 Vmath::Vvtvp(npts, &Fwd[1][id2], 1, &m_traceNormals[1][id2], 1,
                                    &tmp_n[0],    1, &tmp_n[0],               1);
 
                 Vmath::Vmul (npts, &Fwd[0][id2], 1, &m_traceNormals[1][id2], 1,
                                    &tmp_t[0],    1);
                 Vmath::Vvtvm(npts, &Fwd[1][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[0][id2], 1);
                 Vmath::Vvtvm(npts, &tmp_n[0],    1, &m_traceNormals[0][id2], 1,
                                    &Fwd[0][id2], 1, &Fwd[0][id2],            1);
 
                 Vmath::Vmul (npts, &tmp_t[0],    1, &m_traceNormals[0][id2], 1,
                                    &Fwd[1][id2], 1);
                 Vmath::Vvtvp(npts, &tmp_n[0],    1, &m_traceNormals[1][id2], 1,
                                    &Fwd[1][id2], 1, &Fwd[1][id2],            1);
                 break;
             }
             case 3:
                 ASSERTL0(false, "3D not implemented for Boussinesq equations");
                 break;
             default:
                 ASSERTL0(false, "Illegal expansion dimension");
         }
 
         // copy boundary adjusted values into the boundary expansion
         bcexp = m_fields[1]->GetBndCondExpansions()[bcRegion];
         Vmath::Vcopy(npts, &Fwd[0][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
 
         bcexp = m_fields[2]->GetBndCondExpansions()[bcRegion];
         Vmath::Vcopy(npts, &Fwd[1][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
     }
 }

◆ WCESolve()

void Nektar::NonlinearPeregrine::WCESolve	(	Array< OneD, NekDouble > &	fce,
		NekDouble	lambda
	)

private

Definition at line 897 of file NonlinearPeregrine.cpp.

References Nektar::StdRegions::eFactorLambda, Nektar::SolverUtils::EquationSystem::GetTotPoints(), m_factors, Nektar::SolverUtils::EquationSystem::m_fields, Nektar::NullFlagList, and Vmath::Vcopy().

Referenced by DoOdeRhs().

 {
     int nq = GetTotPoints();
 
     m_factors[StdRegions::eFactorLambda] = lambda;
 
     for (int j = 0; j < nq; j++)
     {
         (m_fields[3]->UpdatePhys())[j] = fce[j];
     }
 
     m_fields[3]->SetPhysState(true);
 
     m_fields[3]->HelmSolve(m_fields[3]->GetPhys(),
                            m_fields[3]->UpdateCoeffs(),
                            NullFlagList,
                            m_factors);
 
     m_fields[3]->BwdTrans(m_fields[3]->GetCoeffs(), m_fields[3]->UpdatePhys());
 
     m_fields[3]->SetPhysState(true);
 
     Vmath::Vcopy(nq, m_fields[3]->GetPhys(), 1, fce, 1);
 }

Friends And Related Function Documentation

◆ MemoryManager< NonlinearPeregrine >

friend class MemoryManager< NonlinearPeregrine >

friend

Definition at line 61 of file NonlinearPeregrine.h.

Member Data Documentation

◆ className

string Nektar::NonlinearPeregrine::className

static

Initial value:

=
        SolverUtils::GetEquationSystemFactory().RegisterCreatorFunction(
                "NonlinearPeregrine", NonlinearPeregrine::create,
                "Nonlinear Peregrine equations in conservative variables.")

Name of class.

Definition at line 74 of file NonlinearPeregrine.h.

◆ m_const_depth

NekDouble Nektar::NonlinearPeregrine::m_const_depth

private

Definition at line 128 of file NonlinearPeregrine.h.

Referenced by DoOdeRhs(), v_InitObject(), and v_SetInitialConditions().

◆ m_dBwd

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

protected

Definition at line 91 of file NonlinearPeregrine.h.

Referenced by GetDepthBwd().

◆ m_dFwd

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

protected

Still water depth traces.

Definition at line 90 of file NonlinearPeregrine.h.

Referenced by GetDepthFwd().

◆ m_factors

StdRegions::ConstFactorMap Nektar::NonlinearPeregrine::m_factors

protected

Definition at line 82 of file NonlinearPeregrine.h.

Referenced by NonlinearPeregrine(), and WCESolve().

◆ m_problemType

ProblemType Nektar::NonlinearPeregrine::m_problemType

Definition at line 79 of file NonlinearPeregrine.h.

Referenced by v_InitObject(), and v_SetInitialConditions().

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~NonlinearPeregrine()

◆ NonlinearPeregrine()

Member Function Documentation

◆ AddCoriolis()

◆ AddVariableDepth()

◆ ConservativeToPrimitive()

◆ create()

◆ DoOdeProjection()

◆ DoOdeRhs()

◆ GetDepthBwd()

◆ GetDepthFwd()

◆ GetFluxVector()

◆ GetVelocityVector()

◆ LaitoneSolitaryWave()

◆ NumericalFlux1D()

◆ NumericalFlux2D()

◆ NumericalFluxConsVariables()

◆ NumericalFluxForcing()

◆ PrimitiveToConservative()

◆ SetBoundaryConditions()

◆ SetBoundaryConditionsContVariables()

◆ SetBoundaryConditionsForcing()

◆ v_ConservativeToPrimitive()

◆ v_GenerateSummary()

◆ v_InitObject()

◆ v_PrimitiveToConservative()

◆ v_SetInitialConditions()

◆ WallBoundary()

◆ WallBoundary2D()

◆ WallBoundaryContVariables()

◆ WallBoundaryForcing()

◆ WCESolve()

Friends And Related Function Documentation

◆ MemoryManager< NonlinearPeregrine >

Member Data Documentation

◆ className

◆ m_const_depth

◆ m_dBwd

◆ m_dFwd

◆ m_factors

◆ m_problemType