Nektar++
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
Nektar::NonlinearPeregrine Class Reference

#include <NonlinearPeregrine.h>

Inheritance diagram for Nektar::NonlinearPeregrine:
[legend]

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...
 
SOLVER_UTILS_EXPORT void SteadyStateResidual (int step, Array< OneD, NekDouble > &L2)
 
SOLVER_UTILS_EXPORT LibUtilities::TimeIntegrationSchemeSharedPtr & GetTimeIntegrationScheme ()
 Returns the time integration scheme. More...
 
SOLVER_UTILS_EXPORT LibUtilities::TimeIntegrationSchemeOperators & GetTimeIntegrationSchemeOperators ()
 Returns the time integration scheme operators. More...
 
- Public Member Functions inherited from Nektar::SolverUtils::EquationSystem
virtual SOLVER_UTILS_EXPORT ~EquationSystem ()
 Destructor. More...
 
SOLVER_UTILS_EXPORT void InitObject (bool DeclareField=true)
 Initialises the members of this object. More...
 
SOLVER_UTILS_EXPORT void DoInitialise (bool dumpInitialConditions=true)
 Perform any initialisation necessary before solving the problem. More...
 
SOLVER_UTILS_EXPORT void DoSolve ()
 Solve the problem. More...
 
SOLVER_UTILS_EXPORT void TransCoeffToPhys ()
 Transform from coefficient to physical space. More...
 
SOLVER_UTILS_EXPORT void TransPhysToCoeff ()
 Transform from physical to coefficient space. More...
 
SOLVER_UTILS_EXPORT void Output ()
 Perform output operations after solve. More...
 
SOLVER_UTILS_EXPORT std::string GetSessionName ()
 Get Session name. More...
 
template<class T >
std::shared_ptr< T > as ()
 
SOLVER_UTILS_EXPORT void ResetSessionName (std::string newname)
 Reset Session name. More...
 
SOLVER_UTILS_EXPORT LibUtilities::SessionReaderSharedPtr GetSession ()
 Get Session name. More...
 
SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr GetPressure ()
 Get pressure field if available. More...
 
SOLVER_UTILS_EXPORT void ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
 
SOLVER_UTILS_EXPORT void PrintSummary (std::ostream &out)
 Print a summary of parameters and solver characteristics. More...
 
SOLVER_UTILS_EXPORT void SetLambda (NekDouble lambda)
 Set parameter m_lambda. More...
 
SOLVER_UTILS_EXPORT SessionFunctionSharedPtr GetFunction (std::string name, const MultiRegions::ExpListSharedPtr &field=MultiRegions::NullExpListSharedPtr, bool cache=false)
 Get a SessionFunction by name. More...
 
SOLVER_UTILS_EXPORT void SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
 Initialise the data in the dependent fields. More...
 
SOLVER_UTILS_EXPORT void EvaluateExactSolution (int field, Array< OneD, NekDouble > &outfield, const NekDouble time)
 Evaluates an exact solution. More...
 
SOLVER_UTILS_EXPORT NekDouble L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln, bool Normalised=false)
 Compute the L2 error between fields and a given exact solution. More...
 
SOLVER_UTILS_EXPORT NekDouble L2Error (unsigned int field, bool Normalised=false)
 Compute the L2 error of the fields. More...
 
SOLVER_UTILS_EXPORT NekDouble LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
 Linf error computation. More...
 
SOLVER_UTILS_EXPORT Array< OneD, NekDouble > ErrorExtraPoints (unsigned int field)
 Compute error (L2 and L_inf) over an larger set of quadrature points return [L2 Linf]. More...
 
SOLVER_UTILS_EXPORT void Checkpoint_Output (const int n)
 Write checkpoint file of m_fields. More...
 
SOLVER_UTILS_EXPORT void Checkpoint_Output (const int n, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
 Write checkpoint file of custom data fields. More...
 
SOLVER_UTILS_EXPORT void Checkpoint_BaseFlow (const int n)
 Write base flow file of m_fields. More...
 
SOLVER_UTILS_EXPORT void WriteFld (const std::string &outname)
 Write field data to the given filename. More...
 
SOLVER_UTILS_EXPORT void WriteFld (const std::string &outname, MultiRegions::ExpListSharedPtr &field, std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
 Write input fields to the given filename. More...
 
SOLVER_UTILS_EXPORT void ImportFld (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields)
 Input field data from the given file. More...
 
SOLVER_UTILS_EXPORT void ImportFldToMultiDomains (const std::string &infile, Array< OneD, MultiRegions::ExpListSharedPtr > &pFields, const int ndomains)
 Input field data from the given file to multiple domains. More...
 
SOLVER_UTILS_EXPORT void ImportFld (const std::string &infile, std::vector< std::string > &fieldStr, Array< OneD, Array< OneD, NekDouble > > &coeffs)
 Output a field. Input field data into array from the given file. More...
 
SOLVER_UTILS_EXPORT void ImportFld (const std::string &infile, MultiRegions::ExpListSharedPtr &pField, std::string &pFieldName)
 Output a field. Input field data into ExpList from the given file. More...
 
SOLVER_UTILS_EXPORT void SessionSummary (SummaryList &vSummary)
 Write out a session summary. More...
 
SOLVER_UTILS_EXPORT Array< OneD, MultiRegions::ExpListSharedPtr > & UpdateFields ()
 
SOLVER_UTILS_EXPORT LibUtilities::FieldMetaDataMap & UpdateFieldMetaDataMap ()
 Get hold of FieldInfoMap so it can be updated. More...
 
SOLVER_UTILS_EXPORT NekDouble 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, const Array< OneD, const NekDouble > &input)
 
SOLVER_UTILS_EXPORT void SetSteps (const int steps)
 
SOLVER_UTILS_EXPORT void ZeroPhysFields ()
 
SOLVER_UTILS_EXPORT void FwdTransFields ()
 
SOLVER_UTILS_EXPORT void SetModifiedBasis (const bool modbasis)
 
SOLVER_UTILS_EXPORT int GetCheckpointNumber ()
 
SOLVER_UTILS_EXPORT void SetCheckpointNumber (int num)
 
SOLVER_UTILS_EXPORT int GetCheckpointSteps ()
 
SOLVER_UTILS_EXPORT void SetCheckpointSteps (int num)
 
SOLVER_UTILS_EXPORT int GetInfoSteps ()
 
SOLVER_UTILS_EXPORT void SetInfoSteps (int num)
 
SOLVER_UTILS_EXPORT void SetIterationNumberPIT (int num)
 
SOLVER_UTILS_EXPORT void SetWindowNumberPIT (int num)
 
SOLVER_UTILS_EXPORT Array< OneD, const Array< OneD, NekDouble > > GetTraceNormals ()
 
SOLVER_UTILS_EXPORT void SetTime (const NekDouble time)
 
SOLVER_UTILS_EXPORT void SetTimeStep (const NekDouble timestep)
 
SOLVER_UTILS_EXPORT void SetInitialStep (const int step)
 
SOLVER_UTILS_EXPORT void SetBoundaryConditions (NekDouble time)
 Evaluates the boundary conditions at the given time. More...
 
SOLVER_UTILS_EXPORT bool NegatedOp ()
 Identify if operator is negated in DoSolve. More...
 
SOLVER_UTILS_EXPORT bool ParallelInTime ()
 Check if solver use Parallel-in-Time. 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
 

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...
 
- Static Public Attributes inherited from Nektar::SolverUtils::UnsteadySystem
static std::string cmdSetStartTime
 
static std::string cmdSetStartChkNum
 

Protected Member Functions

 NonlinearPeregrine (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
 
virtual void v_InitObject (bool DeclareFields=true) override
 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) override
 Print a summary of time stepping parameters. More...
 
virtual void v_PrimitiveToConservative () override
 
virtual void v_ConservativeToPrimitive () override
 
virtual void v_SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0) override
 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...
 
virtual void v_InitObject (bool DeclareFields=true) override
 Init object for UnsteadySystem class. More...
 
virtual void v_GenerateSummary (SolverUtils::SummaryList &s) override
 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...
 
virtual SOLVER_UTILS_EXPORT void v_InitObject (bool DeclareField=true) override
 Init object for UnsteadySystem class. More...
 
virtual SOLVER_UTILS_EXPORT void v_DoSolve () override
 Solves an unsteady problem. More...
 
virtual SOLVER_UTILS_EXPORT void v_PrintStatusInformation (const int step, const NekDouble cpuTime)
 Print Status Information. More...
 
virtual SOLVER_UTILS_EXPORT void v_PrintSummaryStatistics (const NekDouble intTime)
 Print Summary Statistics. More...
 
virtual SOLVER_UTILS_EXPORT void v_DoInitialise (bool dumpInitialConditions=true) override
 Sets up initial conditions. More...
 
virtual SOLVER_UTILS_EXPORT void v_GenerateSummary (SummaryList &s) override
 Print a summary of time stepping parameters. More...
 
virtual SOLVER_UTILS_EXPORT NekDouble v_GetTimeStep (const Array< OneD, const Array< OneD, NekDouble > > &inarray)
 Return the timestep to be used for the next step in the time-marching loop. More...
 
virtual SOLVER_UTILS_EXPORT bool v_PreIntegrate (int step)
 
virtual SOLVER_UTILS_EXPORT bool v_PostIntegrate (int step)
 
virtual SOLVER_UTILS_EXPORT bool v_RequireFwdTrans ()
 
virtual SOLVER_UTILS_EXPORT void v_SteadyStateResidual (int step, Array< OneD, NekDouble > &L2)
 
virtual SOLVER_UTILS_EXPORT bool v_UpdateTimeStepCheck ()
 
SOLVER_UTILS_EXPORT NekDouble MaxTimeStepEstimator ()
 Get the maximum timestep estimator for cfl control. More...
 
SOLVER_UTILS_EXPORT void CheckForRestartTime (NekDouble &time, int &nchk)
 
SOLVER_UTILS_EXPORT void SVVVarDiffCoeff (const Array< OneD, Array< OneD, NekDouble > > vel, StdRegions::VarCoeffMap &varCoeffMap)
 Evaluate the SVV diffusion coefficient according to Moura's paper where it should proportional to h time velocity. More...
 
SOLVER_UTILS_EXPORT void DoDummyProjection (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
 Perform dummy projection. More...
 
- Protected Member Functions inherited from Nektar::SolverUtils::EquationSystem
SOLVER_UTILS_EXPORT EquationSystem (const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
 Initialises EquationSystem class members. More...
 
virtual SOLVER_UTILS_EXPORT void v_InitObject (bool DeclareFeld=true)
 Initialisation object for EquationSystem. More...
 
virtual SOLVER_UTILS_EXPORT void v_DoInitialise (bool dumpInitialConditions=true)
 Virtual function for initialisation implementation. More...
 
virtual SOLVER_UTILS_EXPORT void v_DoSolve ()
 Virtual function for solve implementation. More...
 
virtual SOLVER_UTILS_EXPORT NekDouble v_LinfError (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray)
 Virtual function for the L_inf error computation between fields and a given exact solution. More...
 
virtual SOLVER_UTILS_EXPORT NekDouble v_L2Error (unsigned int field, const Array< OneD, NekDouble > &exactsoln=NullNekDouble1DArray, bool Normalised=false)
 Virtual function for the L_2 error computation between fields and a given exact solution. More...
 
virtual SOLVER_UTILS_EXPORT void v_TransCoeffToPhys ()
 Virtual function for transformation to physical space. More...
 
virtual SOLVER_UTILS_EXPORT void v_TransPhysToCoeff ()
 Virtual function for transformation to coefficient space. More...
 
virtual SOLVER_UTILS_EXPORT void v_GenerateSummary (SummaryList &l)
 Virtual function for generating summary information. More...
 
virtual SOLVER_UTILS_EXPORT void v_SetInitialConditions (NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
 
virtual SOLVER_UTILS_EXPORT void v_EvaluateExactSolution (unsigned int field, Array< OneD, NekDouble > &outfield, const NekDouble time)
 
virtual SOLVER_UTILS_EXPORT void v_Output (void)
 
virtual SOLVER_UTILS_EXPORT MultiRegions::ExpListSharedPtr v_GetPressure (void)
 
virtual SOLVER_UTILS_EXPORT bool v_NegatedOp (void)
 Virtual function to identify if operator is negated in DoSolve. More...
 
virtual SOLVER_UTILS_EXPORT void v_ExtraFldOutput (std::vector< Array< OneD, NekDouble > > &fieldcoeffs, std::vector< std::string > &variables)
 

Protected Attributes

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
LibUtilities::TimeIntegrationSchemeSharedPtr m_intScheme
 Wrapper to the time integration scheme. More...
 
LibUtilities::TimeIntegrationSchemeOperators m_ode
 The time integration scheme operators to use. More...
 
Array< OneD, Array< OneD, NekDouble > > m_previousSolution
 Storage for previous solution for steady-state check. More...
 
std::vector< int > m_intVariables
 
NekDouble m_cflSafetyFactor
 CFL safety factor (comprise between 0 to 1). More...
 
NekDouble m_CFLGrowth
 CFL growth rate. More...
 
NekDouble m_CFLEnd
 Maximun cfl in cfl growth. More...
 
int m_abortSteps
 Number of steps between checks for abort conditions. More...
 
bool m_explicitDiffusion
 Indicates if explicit or implicit treatment of diffusion is used. More...
 
bool m_explicitAdvection
 Indicates if explicit or implicit treatment of advection is used. More...
 
bool m_explicitReaction
 Indicates if explicit or implicit treatment of reaction is used. More...
 
int m_steadyStateSteps
 Check for steady state at step interval. More...
 
NekDouble m_steadyStateTol
 Tolerance to which steady state should be evaluated at. More...
 
int m_filtersInfosteps
 Number of time steps between outputting filters information. More...
 
std::vector< std::pair< std::string, FilterSharedPtr > > m_filters
 
bool m_homoInitialFwd
 Flag to determine if simulation should start in homogeneous forward transformed state. More...
 
std::ofstream m_errFile
 
NekDouble m_epsilon
 Diffusion coefficient. More...
 
- Protected Attributes inherited from Nektar::SolverUtils::EquationSystem
LibUtilities::CommSharedPtr m_comm
 Communicator. More...
 
bool m_verbose
 
LibUtilities::SessionReaderSharedPtr m_session
 The session reader. More...
 
std::map< std::string, SolverUtils::SessionFunctionSharedPtr > m_sessionFunctions
 Map of known SessionFunctions. More...
 
LibUtilities::FieldIOSharedPtr m_fld
 Field input/output. More...
 
Array< OneD, MultiRegions::ExpListSharedPtr > m_fields
 Array holding all dependent variables. More...
 
SpatialDomains::BoundaryConditionsSharedPtr m_boundaryConditions
 Pointer to boundary conditions object. More...
 
SpatialDomains::MeshGraphSharedPtr m_graph
 Pointer to graph defining mesh. More...
 
std::string m_sessionName
 Name of the session. More...
 
NekDouble m_time
 Current time of simulation. More...
 
int m_initialStep
 Number of the step where the simulation should begin. More...
 
NekDouble m_fintime
 Finish time of the simulation. More...
 
NekDouble m_timestep
 Time step size. More...
 
NekDouble m_lambda
 Lambda constant in real system if one required. More...
 
NekDouble m_checktime
 Time between checkpoints. More...
 
NekDouble m_lastCheckTime
 
NekDouble m_TimeIncrementFactor
 
int m_nchk
 Number of checkpoints written so far. More...
 
int m_steps
 Number of steps to take. More...
 
int m_checksteps
 Number of steps between checkpoints. More...
 
int m_infosteps
 Number of time steps between outputting status information. More...
 
int m_iterPIT = 0
 Number of parallel-in-time time iteration. More...
 
int m_windowPIT = 0
 Index of windows for parallel-in-time time iteration. More...
 
int m_spacedim
 Spatial dimension (>= expansion dim). More...
 
int m_expdim
 Expansion dimension. More...
 
bool m_singleMode
 Flag to determine if single homogeneous mode is used. More...
 
bool m_halfMode
 Flag to determine if half homogeneous mode is used. More...
 
bool m_multipleModes
 Flag to determine if use multiple homogenenous modes are used. More...
 
bool m_useFFT
 Flag to determine if FFT is used for homogeneous transform. More...
 
bool m_homogen_dealiasing
 Flag to determine if dealiasing is used for homogeneous simulations. More...
 
bool m_specHP_dealiasing
 Flag to determine if dealisising is usde for the Spectral/hp element discretisation. More...
 
enum MultiRegions::ProjectionType m_projectionType
 Type of projection; e.g continuous or discontinuous. More...
 
Array< OneD, Array< OneD, NekDouble > > m_traceNormals
 Array holding trace normals for DG simulations in the forwards direction. More...
 
Array< OneD, bool > m_checkIfSystemSingular
 Flag to indicate if the fields should be checked for singularity. More...
 
LibUtilities::FieldMetaDataMap m_fieldMetaDataMap
 Map to identify relevant solver info to dump in output fields. More...
 
Array< OneD, NekDouble > m_movingFrameVelsxyz
 Moving frame of reference velocities. More...
 
Array< OneD, NekDouble > m_movingFrameTheta
 Moving frame of reference angles with respect to the. More...
 
boost::numeric::ublas::matrix< NekDouble > m_movingFrameProjMat
 Projection matrix for transformation between inertial and moving. 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 []
 
static std::string projectionTypeLookupIds []
 

Detailed Description

Definition at line 58 of file NonlinearPeregrine.h.

Constructor & Destructor Documentation

◆ ~NonlinearPeregrine()

Nektar::NonlinearPeregrine::~NonlinearPeregrine ( )
virtual

problem type selector

Definition at line 168 of file NonlinearPeregrine.cpp.

169{
170}

◆ NonlinearPeregrine()

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

Definition at line 55 of file NonlinearPeregrine.cpp.

58 : ShallowWaterSystem(pSession, pGraph), m_factors()
59{
60 m_factors[StdRegions::eFactorLambda] = 0.0;
61 m_factors[StdRegions::eFactorTau] = 1000000.0;
62 // note: eFactorTau = 1.0 becomes unstable...
63 // we need to investigate the behaviuor w.r.t. tau
64}
Nektar::NonlinearPeregrine::m_factors
StdRegions::ConstFactorMap m_factors
Definition: NonlinearPeregrine.h:83
Nektar::ShallowWaterSystem::ShallowWaterSystem
ShallowWaterSystem(const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
Initialises UnsteadySystem class members.
Definition: ShallowWaterSystem.cpp:67

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

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 173 of file NonlinearPeregrine.cpp.

176{
177
178 int ncoeffs = GetNcoeffs();
179 int nq = GetTotPoints();
180
181 Array<OneD, NekDouble> tmp(nq);
182 Array<OneD, NekDouble> mod(ncoeffs);
183
184 switch (m_projectionType)
185 {
186 case MultiRegions::eDiscontinuous:
187 {
188 // add to hu equation
189 Vmath::Vmul(nq, m_coriolis, 1, physarray[2], 1, tmp, 1);
190 m_fields[0]->IProductWRTBase(tmp, mod);
191 m_fields[0]->MultiplyByElmtInvMass(mod, mod);
192 m_fields[0]->BwdTrans(mod, tmp);
193 Vmath::Vadd(nq, tmp, 1, outarray[1], 1, outarray[1], 1);
194
195 // add to hv equation
196 Vmath::Vmul(nq, m_coriolis, 1, physarray[1], 1, tmp, 1);
197 Vmath::Neg(nq, tmp, 1);
198 m_fields[0]->IProductWRTBase(tmp, mod);
199 m_fields[0]->MultiplyByElmtInvMass(mod, mod);
200 m_fields[0]->BwdTrans(mod, tmp);
201 Vmath::Vadd(nq, tmp, 1, outarray[2], 1, outarray[2], 1);
202 break;
203 }
204 case MultiRegions::eGalerkin:
205 case MultiRegions::eMixed_CG_Discontinuous:
206 {
207 // add to hu equation
208 Vmath::Vmul(nq, m_coriolis, 1, physarray[2], 1, tmp, 1);
209 Vmath::Vadd(nq, tmp, 1, outarray[1], 1, outarray[1], 1);
210
211 // add to hv equation
212 Vmath::Vmul(nq, m_coriolis, 1, physarray[1], 1, tmp, 1);
213 Vmath::Neg(nq, tmp, 1);
214 Vmath::Vadd(nq, tmp, 1, outarray[2], 1, outarray[2], 1);
215 break;
216 }
217 default:
218 ASSERTL0(false, "Unknown projection scheme for the NonlinearSWE");
219 break;
220 }
221}
ASSERTL0
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:215
Nektar::ShallowWaterSystem::m_coriolis
Array< OneD, NekDouble > m_coriolis
Coriolis force.
Definition: ShallowWaterSystem.h:84
Nektar::SolverUtils::EquationSystem::m_fields
Array< OneD, MultiRegions::ExpListSharedPtr > m_fields
Array holding all dependent variables.
Definition: EquationSystem.h:363
Nektar::SolverUtils::EquationSystem::GetNcoeffs
SOLVER_UTILS_EXPORT int GetNcoeffs()
Definition: EquationSystem.h:707
Nektar::SolverUtils::EquationSystem::m_projectionType
enum MultiRegions::ProjectionType m_projectionType
Type of projection; e.g continuous or discontinuous.
Definition: EquationSystem.h:422
Nektar::SolverUtils::EquationSystem::GetTotPoints
SOLVER_UTILS_EXPORT int GetTotPoints()
Definition: EquationSystem.h:765
Vmath::Vmul
void Vmul(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Multiply vector z = x*y.
Definition: Vmath.cpp:207
Vmath::Neg
void Neg(int n, T *x, const int incx)
Negate x = -x.
Definition: Vmath.cpp:513
Vmath::Vadd
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.cpp:354

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

◆ AddVariableDepth()

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

Definition at line 224 of file NonlinearPeregrine.cpp.

227{
228
229 int ncoeffs = GetNcoeffs();
230 int nq = GetTotPoints();
231
232 Array<OneD, NekDouble> tmp(nq);
233 Array<OneD, NekDouble> mod(ncoeffs);
234
235 switch (m_projectionType)
236 {
237 case MultiRegions::eDiscontinuous:
238 {
239 for (int i = 0; i < m_spacedim; ++i)
240 {
241 Vmath::Vmul(nq, m_bottomSlope[i], 1, physarray[0], 1, tmp, 1);
242 Vmath::Smul(nq, m_g, tmp, 1, tmp, 1);
243 m_fields[0]->IProductWRTBase(tmp, mod);
244 m_fields[0]->MultiplyByElmtInvMass(mod, mod);
245 m_fields[0]->BwdTrans(mod, tmp);
246 Vmath::Vadd(nq, tmp, 1, outarray[i + 1], 1, outarray[i + 1], 1);
247 }
248 break;
249 }
250 case MultiRegions::eGalerkin:
251 case MultiRegions::eMixed_CG_Discontinuous:
252 {
253 for (int i = 0; i < m_spacedim; ++i)
254 {
255 Vmath::Vmul(nq, m_bottomSlope[i], 1, physarray[0], 1, tmp, 1);
256 Vmath::Smul(nq, m_g, tmp, 1, tmp, 1);
257 Vmath::Vadd(nq, tmp, 1, outarray[i + 1], 1, outarray[i + 1], 1);
258 }
259 break;
260 }
261 default:
262 ASSERTL0(false, "Unknown projection scheme for the NonlinearSWE");
263 break;
264 }
265}
Nektar::ShallowWaterSystem::m_g
NekDouble m_g
Acceleration of gravity.
Definition: ShallowWaterSystem.h:78
Nektar::ShallowWaterSystem::m_bottomSlope
Array< OneD, Array< OneD, NekDouble > > m_bottomSlope
Definition: ShallowWaterSystem.h:82
Nektar::SolverUtils::EquationSystem::m_spacedim
int m_spacedim
Spatial dimension (>= expansion dim).
Definition: EquationSystem.h:400
Vmath::Smul
void Smul(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Scalar multiply y = alpha*x.
Definition: Vmath.cpp:245

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

◆ ConservativeToPrimitive()

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

Definition at line 745 of file NonlinearPeregrine.cpp.

748{
749 int nq = GetTotPoints();
750
751 if (physin.get() == physout.get())
752 {
753 // copy indata and work with tmp array
754 Array<OneD, Array<OneD, NekDouble>> tmp(3);
755 for (int i = 0; i < 3; ++i)
756 {
757 // deep copy
758 tmp[i] = Array<OneD, NekDouble>(nq);
759 Vmath::Vcopy(nq, physin[i], 1, tmp[i], 1);
760 }
761
762 // \eta = h - d
763 Vmath::Vsub(nq, tmp[0], 1, m_depth, 1, physout[0], 1);
764
765 // u = hu/h
766 Vmath::Vdiv(nq, tmp[1], 1, tmp[0], 1, physout[1], 1);
767
768 // v = hv/ v
769 Vmath::Vdiv(nq, tmp[2], 1, tmp[0], 1, physout[2], 1);
770 }
771 else
772 {
773 // \eta = h - d
774 Vmath::Vsub(nq, physin[0], 1, m_depth, 1, physout[0], 1);
775
776 // u = hu/h
777 Vmath::Vdiv(nq, physin[1], 1, physin[0], 1, physout[1], 1);
778
779 // v = hv/ v
780 Vmath::Vdiv(nq, physin[2], 1, physin[0], 1, physout[2], 1);
781 }
782}
Nektar::ShallowWaterSystem::m_depth
Array< OneD, NekDouble > m_depth
Still water depth.
Definition: ShallowWaterSystem.h:80
Vmath::Vdiv
void Vdiv(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Multiply vector z = x/y.
Definition: Vmath.cpp:280
Vmath::Vcopy
void Vcopy(int n, const T *x, const int incx, T *y, const int incy)
Definition: Vmath.cpp:1191
Vmath::Vsub
void Vsub(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Subtract vector z = x-y.
Definition: Vmath.cpp:414

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

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

67 {
68 SolverUtils::EquationSystemSharedPtr p =
69 MemoryManager<NonlinearPeregrine>::AllocateSharedPtr(pSession,
70 pGraph);
71 p->InitObject();
72 return p;
73 }
Nektar::MemoryManager::AllocateSharedPtr
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
Definition: NekMemoryManager.hpp:168
CellMLToNektar.cellml_metadata.p
p
Definition: cellml_metadata.py:350
Nektar::SolverUtils::EquationSystemSharedPtr
std::shared_ptr< EquationSystem > EquationSystemSharedPtr
A shared pointer to an EquationSystem object.
Definition: EquationSystem.h:66

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::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 490 of file NonlinearPeregrine.cpp.

493{
494 int i;
495 int nvariables = inarray.size();
496
497 switch (m_projectionType)
498 {
499 case MultiRegions::eDiscontinuous:
500 {
501
502 // Just copy over array
503 if (inarray != outarray)
504 {
505 int npoints = GetNpoints();
506
507 for (i = 0; i < nvariables; ++i)
508 {
509 Vmath::Vcopy(npoints, inarray[i], 1, outarray[i], 1);
510 }
511 }
512
513 SetBoundaryConditions(outarray, time);
514 break;
515 }
516 case MultiRegions::eGalerkin:
517 case MultiRegions::eMixed_CG_Discontinuous:
518 {
519
520 EquationSystem::SetBoundaryConditions(time);
521 Array<OneD, NekDouble> coeffs(m_fields[0]->GetNcoeffs(), 0.0);
522
523 for (i = 0; i < nvariables; ++i)
524 {
525 m_fields[i]->FwdTrans(inarray[i], coeffs);
526 m_fields[i]->BwdTrans(coeffs, outarray[i]);
527 }
528 break;
529 }
530 default:
531 ASSERTL0(false, "Unknown projection scheme");
532 break;
533 }
534}
Nektar::NonlinearPeregrine::SetBoundaryConditions
void SetBoundaryConditions(Array< OneD, Array< OneD, NekDouble > > &physarray, NekDouble time)
Definition: NonlinearPeregrine.cpp:537
Nektar::SolverUtils::EquationSystem::GetNpoints
SOLVER_UTILS_EXPORT int GetNpoints()
Definition: EquationSystem.h:775
Nektar::SolverUtils::EquationSystem::SetBoundaryConditions
SOLVER_UTILS_EXPORT void SetBoundaryConditions(NekDouble time)
Evaluates the boundary conditions at the given time.
Definition: EquationSystem.cpp:771

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

◆ 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 267 of file NonlinearPeregrine.cpp.

270{
271 int i;
272 int nvariables = inarray.size();
273 int ncoeffs = GetNcoeffs();
274 int nq = GetTotPoints();
275
276 switch (m_projectionType)
277 {
278 case MultiRegions::eDiscontinuous:
279 {
280
281 //-------------------------------------------------------
282 // inarray in physical space
283
284 Array<OneD, Array<OneD, NekDouble>> modarray(nvariables);
285 for (i = 0; i < nvariables; ++i)
286 {
287 modarray[i] = Array<OneD, NekDouble>(ncoeffs, 0.0);
288 }
289 //-------------------------------------------------------
290
291 //-------------------------------------------------------
292 // Compute the DG advection including the numerical flux
293 // by using SolverUtils/Advection
294 // Input and output in physical space
295 Array<OneD, Array<OneD, NekDouble>> advVel;
296
297 m_advection->Advect(nvariables - 1, m_fields, advVel, inarray,
298 outarray, time);
299 //-------------------------------------------------------
300
301 //-------------------------------------------------------
302 // negate the outarray since moving terms to the rhs
303 for (i = 0; i < nvariables - 1; ++i)
304 {
305 Vmath::Neg(nq, outarray[i], 1);
306 }
307 //-------------------------------------------------------
308
309 //-------------------------------------------------
310 // Add "source terms"
311 // Input and output in physical space
312
313 // Coriolis forcing
314 if (m_coriolis.size() != 0)
315 {
316 AddCoriolis(inarray, outarray);
317 }
318
319 // Variable Depth
320 if (m_constantDepth != true)
321 {
322 ASSERTL0(false,
323 "Variable depth not supported for the Peregrine "
324 "equations");
325 }
326
327 //-------------------------------------------------
328
329 //---------------------------------------
330 // As no more terms is required for the
331 // continuity equation and we have aleady evaluated
332 // the values for h_t we are done for h
333 //---------------------------------------
334
335 //-------------------------------------------------
336 // go to modal space
337 m_fields[0]->IProductWRTBase(outarray[1], modarray[1]);
338 m_fields[0]->IProductWRTBase(outarray[2], modarray[2]);
339
340 // store f1 and f2 for later use (modal space)
341 Array<OneD, NekDouble> f1(ncoeffs);
342 Array<OneD, NekDouble> f2(ncoeffs);
343
344 Vmath::Vcopy(ncoeffs, modarray[1], 1, f1, 1); // f1
345 Vmath::Vcopy(ncoeffs, modarray[2], 1, f2, 1); // f2
346
347 // Solve the remaining block-diagonal systems
348 m_fields[0]->MultiplyByElmtInvMass(modarray[1], modarray[1]);
349 m_fields[0]->MultiplyByElmtInvMass(modarray[2], modarray[2]);
350 //---------------------------------------------
351
352 //---------------------------------------------
353
354 //-------------------------------------------------
355 // create tmp fields to be used during
356 // the dispersive section
357
358 Array<OneD, Array<OneD, NekDouble>> coeffsfield(2);
359 Array<OneD, Array<OneD, NekDouble>> physfield(2);
360
361 for (i = 0; i < 2; ++i)
362 {
363 coeffsfield[i] = Array<OneD, NekDouble>(ncoeffs);
364 physfield[i] = Array<OneD, NekDouble>(nq);
365 }
366 //---------------------------------------------
367
368 //---------------------------------------------
369 // Go from modal to physical space
370 Vmath::Vcopy(nq, outarray[1], 1, physfield[0], 1);
371 Vmath::Vcopy(nq, outarray[2], 1, physfield[1], 1);
372 //---------------------------------------
373
374 //---------------------------------------
375 // Start for solve of mixed dispersive terms
376 // using the 'WCE method'
377 // (Eskilsson & Sherwin, JCP 2006)
378
379 // constant depth case
380 // \nabla \cdot (\nabla z) - invgamma z
381 // = - invgamma (\nabla \cdot {\bf f}_(2,3)
382
383 NekDouble gamma = (m_const_depth * m_const_depth) * (1.0 / 3.0);
384 NekDouble invgamma = 1.0 / gamma;
385
386 int nTraceNumPoints = GetTraceTotPoints();
387 Array<OneD, NekDouble> upwindX(nTraceNumPoints);
388 Array<OneD, NekDouble> upwindY(nTraceNumPoints);
389 //--------------------------------------------
390
391 //--------------------------------------------
392 // Compute the forcing function for the
393 // wave continuity equation
394
395 // Set boundary condidtions for z
396 SetBoundaryConditionsForcing(physfield, time);
397
398 // \nabla \phi \cdot f_{2,3}
399 m_fields[0]->IProductWRTDerivBase(0, physfield[0], coeffsfield[0]);
400 m_fields[0]->IProductWRTDerivBase(1, physfield[1], coeffsfield[1]);
401 Vmath::Vadd(ncoeffs, coeffsfield[0], 1, coeffsfield[1], 1,
402 coeffsfield[0], 1);
403 Vmath::Neg(ncoeffs, coeffsfield[0], 1);
404
405 // Evaluate upwind numerical flux (physical space)
406 NumericalFluxForcing(physfield, upwindX, upwindY);
407 Array<OneD, NekDouble> normflux(nTraceNumPoints);
408 Vmath::Vvtvvtp(nTraceNumPoints, upwindX, 1, m_traceNormals[0], 1,
409 upwindY, 1, m_traceNormals[1], 1, normflux, 1);
410 m_fields[0]->AddTraceIntegral(normflux, coeffsfield[0]);
411 m_fields[0]->MultiplyByElmtInvMass(coeffsfield[0], coeffsfield[0]);
412 m_fields[0]->BwdTrans(coeffsfield[0], physfield[0]);
413
414 Vmath::Smul(nq, -invgamma, physfield[0], 1, physfield[0], 1);
415
416 // ok: forcing function for HelmSolve... done!
417 //--------------------------------------
418
419 //--------------------------------------
420 // Solve the Helmhotz-type equation
421 // for the wave continuity equation
422 // (missing slope terms...)
423
424 // note: this is just valid for the constant depth case:
425
426 // as of now we need not to specify any
427 // BC routine for the WCE: periodic
428 // and zero Neumann (for walls)
429
430 WCESolve(physfield[0], invgamma);
431
432 Vmath::Vcopy(nq, physfield[0], 1, outarray[3], 1); // store z
433
434 // ok: Wave Continuity Equation... done!
435 //------------------------------------
436
437 //------------------------------------
438 // Return to the primary variables
439
440 // (h {\bf u})_t = gamma \nabla z + {\bf f}_{2,3}
441
442 Vmath::Smul(nq, gamma, physfield[0], 1, physfield[0], 1);
443
444 // Set boundary conditions
445 SetBoundaryConditionsContVariables(physfield[0], time);
446
447 m_fields[0]->IProductWRTDerivBase(0, physfield[0], coeffsfield[0]);
448 m_fields[1]->IProductWRTDerivBase(1, physfield[0], coeffsfield[1]);
449
450 Vmath::Neg(ncoeffs, coeffsfield[0], 1);
451 Vmath::Neg(ncoeffs, coeffsfield[1], 1);
452
453 // Evaluate upwind numerical flux (physical space)
454 NumericalFluxConsVariables(physfield[0], upwindX, upwindY);
455
456 {
457 Array<OneD, NekDouble> uptemp(nTraceNumPoints, 0.0);
458 Vmath::Vvtvvtp(nTraceNumPoints, upwindX, 1, m_traceNormals[0],
459 1, uptemp, 1, m_traceNormals[1], 1, normflux, 1);
460 m_fields[0]->AddTraceIntegral(normflux, coeffsfield[0]);
461 Vmath::Vvtvvtp(nTraceNumPoints, uptemp, 1, m_traceNormals[0], 1,
462 upwindY, 1, m_traceNormals[1], 1, normflux, 1);
463 m_fields[0]->AddTraceIntegral(normflux, coeffsfield[1]);
464 }
465
466 Vmath::Vadd(ncoeffs, f1, 1, coeffsfield[0], 1, modarray[1], 1);
467 Vmath::Vadd(ncoeffs, f2, 1, coeffsfield[1], 1, modarray[2], 1);
468
469 m_fields[1]->MultiplyByElmtInvMass(modarray[1], modarray[1]);
470 m_fields[2]->MultiplyByElmtInvMass(modarray[2], modarray[2]);
471
472 m_fields[1]->BwdTrans(modarray[1], outarray[1]);
473 m_fields[2]->BwdTrans(modarray[2], outarray[2]);
474
475 // ok: returned to conservative variables... done!
476 //---------------------
477
478 break;
479 }
480 case MultiRegions::eGalerkin:
481 case MultiRegions::eMixed_CG_Discontinuous:
482 ASSERTL0(false, "Unknown projection scheme for the Peregrine");
483 break;
484 default:
485 ASSERTL0(false, "Unknown projection scheme for the NonlinearSWE");
486 break;
487 }
488}
Nektar::NonlinearPeregrine::SetBoundaryConditionsForcing
void SetBoundaryConditionsForcing(Array< OneD, Array< OneD, NekDouble > > &inarray, NekDouble time)
Definition: NonlinearPeregrine.cpp:946
Nektar::NonlinearPeregrine::NumericalFluxForcing
void NumericalFluxForcing(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, NekDouble > &numfluxX, Array< OneD, NekDouble > &numfluxY)
Definition: NonlinearPeregrine.cpp:909
Nektar::NonlinearPeregrine::SetBoundaryConditionsContVariables
void SetBoundaryConditionsContVariables(Array< OneD, NekDouble > &inarray, NekDouble time)
Definition: NonlinearPeregrine.cpp:1056
Nektar::NonlinearPeregrine::AddCoriolis
void AddCoriolis(const Array< OneD, const Array< OneD, NekDouble > > &physarray, Array< OneD, Array< OneD, NekDouble > > &outarray)
Definition: NonlinearPeregrine.cpp:173
Nektar::NonlinearPeregrine::NumericalFluxConsVariables
void NumericalFluxConsVariables(Array< OneD, NekDouble > &physfield, Array< OneD, NekDouble > &outX, Array< OneD, NekDouble > &outY)
Definition: NonlinearPeregrine.cpp:1112
Nektar::NonlinearPeregrine::WCESolve
void WCESolve(Array< OneD, NekDouble > &fce, NekDouble lambda)
Definition: NonlinearPeregrine.cpp:886
Nektar::ShallowWaterSystem::m_advection
SolverUtils::AdvectionSharedPtr m_advection
Definition: ShallowWaterSystem.h:70
Nektar::ShallowWaterSystem::m_constantDepth
bool m_constantDepth
Indicates if constant depth case.
Definition: ShallowWaterSystem.h:76
Nektar::SolverUtils::EquationSystem::GetTraceTotPoints
SOLVER_UTILS_EXPORT int GetTraceTotPoints()
Definition: EquationSystem.h:740
Nektar::SolverUtils::EquationSystem::m_traceNormals
Array< OneD, Array< OneD, NekDouble > > m_traceNormals
Array holding trace normals for DG simulations in the forwards direction.
Definition: EquationSystem.h:425
Nektar::NekDouble
double NekDouble
Definition: NektarUnivTypeDefs.hpp:43
Vmath::Vvtvvtp
void Vvtvvtp(int n, const T *v, int incv, const T *w, int incw, const T *x, int incx, const T *y, int incy, T *z, int incz)
vvtvvtp (vector times vector plus vector times vector):
Definition: Vmath.cpp:687

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, Nektar::SolverUtils::EquationSystem::m_traceNormals, Vmath::Neg(), NumericalFluxConsVariables(), NumericalFluxForcing(), SetBoundaryConditionsContVariables(), SetBoundaryConditionsForcing(), Vmath::Smul(), Vmath::Vadd(), Vmath::Vcopy(), Vmath::Vvtvvtp(), and WCESolve().

Referenced by v_InitObject().

◆ GetDepthBwd()

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

Definition at line 120 of file NonlinearPeregrine.h.

121 {
122 return m_dBwd;
123 }
Nektar::NonlinearPeregrine::m_dBwd
Array< OneD, NekDouble > m_dBwd
Definition: NonlinearPeregrine.h:92

References m_dBwd.

◆ GetDepthFwd()

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

Definition at line 116 of file NonlinearPeregrine.h.

117 {
118 return m_dFwd;
119 }
Nektar::NonlinearPeregrine::m_dFwd
Array< OneD, NekDouble > m_dFwd
Still water depth traces.
Definition: NonlinearPeregrine.h:91

References 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 707 of file NonlinearPeregrine.cpp.

710{
711 int i, j;
712 int nq = m_fields[0]->GetTotPoints();
713
714 NekDouble g = m_g;
715 Array<OneD, Array<OneD, NekDouble>> velocity(m_spacedim);
716
717 // Flux vector for the mass equation
718 for (i = 0; i < m_spacedim; ++i)
719 {
720 velocity[i] = Array<OneD, NekDouble>(nq);
721 Vmath::Vcopy(nq, physfield[i + 1], 1, flux[0][i], 1);
722 }
723
724 GetVelocityVector(physfield, velocity);
725
726 // Put (0.5 g h h) in tmp
727 Array<OneD, NekDouble> tmp(nq);
728 Vmath::Vmul(nq, physfield[0], 1, physfield[0], 1, tmp, 1);
729 Vmath::Smul(nq, 0.5 * g, tmp, 1, tmp, 1);
730
731 // Flux vector for the momentum equations
732 for (i = 0; i < m_spacedim; ++i)
733 {
734 for (j = 0; j < m_spacedim; ++j)
735 {
736 Vmath::Vmul(nq, velocity[j], 1, physfield[i + 1], 1, flux[i + 1][j],
737 1);
738 }
739
740 // Add (0.5 g h h) to appropriate field
741 Vmath::Vadd(nq, flux[i + 1][i], 1, tmp, 1, flux[i + 1][i], 1);
742 }
743}
Nektar::NonlinearPeregrine::GetVelocityVector
void GetVelocityVector(const Array< OneD, Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, NekDouble > > &velocity)
Compute the velocity field given the momentum .
Definition: NonlinearPeregrine.cpp:865

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

◆ 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
physfieldMomentum field.
velocityVelocity field.

Definition at line 865 of file NonlinearPeregrine.cpp.

868{
869 const int npts = physfield[0].size();
870
871 for (int i = 0; i < m_spacedim; ++i)
872 {
873 Vmath::Vdiv(npts, physfield[1 + i], 1, physfield[0], 1, velocity[i], 1);
874 }
875}

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

Referenced by GetFluxVector().

◆ LaitoneSolitaryWave()

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

Definition at line 1146 of file NonlinearPeregrine.cpp.

1148{
1149 int nq = GetTotPoints();
1150
1151 NekDouble A = 1.0;
1152 NekDouble C = sqrt(m_g * d) * (1.0 + 0.5 * (amp / d));
1153
1154 Array<OneD, NekDouble> x0(nq);
1155 Array<OneD, NekDouble> x1(nq);
1156 Array<OneD, NekDouble> zeros(nq, 0.0);
1157
1158 // get the coordinates (assuming all fields have the same
1159 // discretisation)
1160 m_fields[0]->GetCoords(x0, x1);
1161
1162 for (int i = 0; i < nq; i++)
1163 {
1164 (m_fields[0]->UpdatePhys())[i] =
1165 amp * pow((1.0 / cosh(sqrt(0.75 * (amp / (d * d * d))) *
1166 (A * (x0[i] + x_offset) - C * time))),
1167 2.0);
1168 (m_fields[1]->UpdatePhys())[i] =
1169 (amp / d) *
1170 pow((1.0 / cosh(sqrt(0.75 * (amp / (d * d * d))) *
1171 (A * (x0[i] + x_offset) - C * time))),
1172 2.0) *
1173 sqrt(m_g * d);
1174 }
1175
1176 Vmath::Sadd(nq, d, m_fields[0]->GetPhys(), 1, m_fields[0]->UpdatePhys(), 1);
1177 Vmath::Vmul(nq, m_fields[0]->GetPhys(), 1, m_fields[1]->GetPhys(), 1,
1178 m_fields[1]->UpdatePhys(), 1);
1179 Vmath::Vcopy(nq, zeros, 1, m_fields[2]->UpdatePhys(), 1);
1180 Vmath::Vcopy(nq, zeros, 1, m_fields[3]->UpdatePhys(), 1);
1181
1182 // Forward transform to fill the coefficient space
1183 for (int i = 0; i < 4; ++i)
1184 {
1185 m_fields[i]->SetPhysState(true);
1186 m_fields[i]->FwdTrans(m_fields[i]->GetPhys(),
1187 m_fields[i]->UpdateCoeffs());
1188 }
1189}
Nektar::UnitTests::d
std::vector< double > d(NPUPPER *NPUPPER)
Vmath::Sadd
void Sadd(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Add scalar y = alpha + x.
Definition: Vmath.cpp:379
tinysimd::sqrt
scalarT< T > sqrt(scalarT< T > in)
Definition: scalar.hpp:294

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

Referenced by v_SetInitialConditions().

◆ 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 1112 of file NonlinearPeregrine.cpp.

1115{
1116 int i;
1117 int nTraceNumPoints = GetTraceTotPoints();
1118
1119 //-----------------------------------------------------
1120 // get temporary arrays
1121 Array<OneD, Array<OneD, NekDouble>> Fwd(1);
1122 Array<OneD, Array<OneD, NekDouble>> Bwd(1);
1123
1124 Fwd[0] = Array<OneD, NekDouble>(nTraceNumPoints);
1125 Bwd[0] = Array<OneD, NekDouble>(nTraceNumPoints);
1126 //-----------------------------------------------------
1127
1128 //-----------------------------------------------------
1129 // get the physical values at the trace
1130 // (we have put any time-dependent BC in field[1])
1131
1132 m_fields[1]->GetFwdBwdTracePhys(physfield, Fwd[0], Bwd[0]);
1133 //-----------------------------------------------------
1134
1135 //-----------------------------------------------------
1136 // use centred fluxes for the numerical flux
1137 for (i = 0; i < nTraceNumPoints; ++i)
1138 {
1139 outX[i] = 0.5 * (Fwd[0][i] + Bwd[0][i]);
1140 outY[i] = 0.5 * (Fwd[0][i] + Bwd[0][i]);
1141 }
1142 //-----------------------------------------------------
1143}

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

Referenced by DoOdeRhs().

◆ 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 909 of file NonlinearPeregrine.cpp.

912{
913 int i;
914 int nTraceNumPoints = GetTraceTotPoints();
915
916 //-----------------------------------------------------
917 // get temporary arrays
918 Array<OneD, Array<OneD, NekDouble>> Fwd(2);
919 Array<OneD, Array<OneD, NekDouble>> Bwd(2);
920
921 for (i = 0; i < 2; ++i)
922 {
923 Fwd[i] = Array<OneD, NekDouble>(nTraceNumPoints);
924 Bwd[i] = Array<OneD, NekDouble>(nTraceNumPoints);
925 }
926 //-----------------------------------------------------
927
928 //-----------------------------------------------------
929 // get the physical values at the trace
930 // (any time-dependent BC previuosly put in fields[1] and [2]
931
932 m_fields[1]->GetFwdBwdTracePhys(inarray[0], Fwd[0], Bwd[0]);
933 m_fields[2]->GetFwdBwdTracePhys(inarray[1], Fwd[1], Bwd[1]);
934 //-----------------------------------------------------
935
936 //-----------------------------------------------------
937 // use centred fluxes for the numerical flux
938 for (i = 0; i < nTraceNumPoints; ++i)
939 {
940 numfluxX[i] = 0.5 * (Fwd[0][i] + Bwd[0][i]);
941 numfluxY[i] = 0.5 * (Fwd[1][i] + Bwd[1][i]);
942 }
943 //-----------------------------------------------------
944}

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

Referenced by DoOdeRhs().

◆ PrimitiveToConservative()

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

Definition at line 801 of file NonlinearPeregrine.cpp.

804{
805
806 int nq = GetTotPoints();
807
808 if (physin.get() == physout.get())
809 {
810 // copy indata and work with tmp array
811 Array<OneD, Array<OneD, NekDouble>> tmp(3);
812 for (int i = 0; i < 3; ++i)
813 {
814 // deep copy
815 tmp[i] = Array<OneD, NekDouble>(nq);
816 Vmath::Vcopy(nq, physin[i], 1, tmp[i], 1);
817 }
818
819 // h = \eta + d
820 Vmath::Vadd(nq, tmp[0], 1, m_depth, 1, physout[0], 1);
821
822 // hu = h * u
823 Vmath::Vmul(nq, physout[0], 1, tmp[1], 1, physout[1], 1);
824
825 // hv = h * v
826 Vmath::Vmul(nq, physout[0], 1, tmp[2], 1, physout[2], 1);
827 }
828 else
829 {
830 // h = \eta + d
831 Vmath::Vadd(nq, physin[0], 1, m_depth, 1, physout[0], 1);
832
833 // hu = h * u
834 Vmath::Vmul(nq, physout[0], 1, physin[1], 1, physout[1], 1);
835
836 // hv = h * v
837 Vmath::Vmul(nq, physout[0], 1, physin[2], 1, physout[2], 1);
838 }
839}

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

◆ SetBoundaryConditions()

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

Definition at line 537 of file NonlinearPeregrine.cpp.

539{
540
541 int nvariables = m_fields.size();
542 int cnt = 0;
543 int nTracePts = GetTraceTotPoints();
544
545 // Extract trace for boundaries. Needs to be done on all processors to avoid
546 // deadlock.
547 Array<OneD, Array<OneD, NekDouble>> Fwd(nvariables);
548 for (int i = 0; i < nvariables; ++i)
549 {
550 Fwd[i] = Array<OneD, NekDouble>(nTracePts);
551 m_fields[i]->ExtractTracePhys(inarray[i], Fwd[i]);
552 }
553
554 // loop over Boundary Regions
555 for (int n = 0; n < m_fields[0]->GetBndConditions().size(); ++n)
556 {
557
558 // Wall Boundary Condition
559 if (boost::iequals(m_fields[0]->GetBndConditions()[n]->GetUserDefined(),
560 "Wall"))
561 {
562 WallBoundary2D(n, cnt, Fwd, inarray);
563 }
564
565 // Time Dependent Boundary Condition (specified in meshfile)
566 if (m_fields[0]->GetBndConditions()[n]->IsTimeDependent())
567 {
568 for (int i = 0; i < nvariables; ++i)
569 {
570 m_fields[i]->EvaluateBoundaryConditions(time);
571 }
572 }
573 cnt += m_fields[0]->GetBndCondExpansions()[n]->GetExpSize();
574 }
575}
Nektar::NonlinearPeregrine::WallBoundary2D
void WallBoundary2D(int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &Fwd, Array< OneD, Array< OneD, NekDouble > > &physarray)
Definition: NonlinearPeregrine.cpp:629

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

Referenced by DoOdeProjection().

◆ SetBoundaryConditionsContVariables()

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

Definition at line 1056 of file NonlinearPeregrine.cpp.

1058{
1059 boost::ignore_unused(time);
1060
1061 int cnt = 0;
1062
1063 // loop over Boundary Regions
1064 for (int n = 0; n < m_fields[0]->GetBndConditions().size(); ++n)
1065 {
1066 // Use wall for all
1067 // Wall Boundary Condition
1068 if (boost::iequals(m_fields[0]->GetBndConditions()[n]->GetUserDefined(),
1069 "Wall"))
1070 {
1071 WallBoundaryContVariables(n, cnt, inarray);
1072 }
1073
1074 if (m_fields[0]->GetBndConditions()[n]->IsTimeDependent())
1075 {
1076 WallBoundaryContVariables(n, cnt, inarray);
1077 }
1078
1079 cnt += m_fields[0]->GetBndCondExpansions()[n]->GetExpSize() - 1;
1080 }
1081}
Nektar::NonlinearPeregrine::WallBoundaryContVariables
void WallBoundaryContVariables(int bcRegion, int cnt, Array< OneD, NekDouble > &inarray)
Definition: NonlinearPeregrine.cpp:1083

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

Referenced by DoOdeRhs().

◆ SetBoundaryConditionsForcing()

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

Definition at line 946 of file NonlinearPeregrine.cpp.

948{
949 boost::ignore_unused(time);
950
951 int cnt = 0;
952
953 // loop over Boundary Regions
954 for (int n = 0; n < m_fields[0]->GetBndConditions().size(); ++n)
955 {
956 // Use wall for all BC...
957 // Wall Boundary Condition
958 if (boost::iequals(m_fields[0]->GetBndConditions()[n]->GetUserDefined(),
959 "Wall"))
960 {
961 WallBoundaryForcing(n, cnt, inarray);
962 }
963
964 // Timedependent Boundary Condition
965 if (m_fields[0]->GetBndConditions()[n]->IsTimeDependent())
966 {
967 ASSERTL0(false, "time-dependent BC not implemented for Boussinesq");
968 }
969 cnt += m_fields[0]->GetBndCondExpansions()[n]->GetExpSize();
970 }
971}
Nektar::NonlinearPeregrine::WallBoundaryForcing
void WallBoundaryForcing(int bcRegion, int cnt, Array< OneD, Array< OneD, NekDouble > > &inarray)
Definition: NonlinearPeregrine.cpp:974

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

Referenced by DoOdeRhs().

◆ v_ConservativeToPrimitive()

void Nektar::NonlinearPeregrine::v_ConservativeToPrimitive ( )
overrideprotectedvirtual

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 784 of file NonlinearPeregrine.cpp.

785{
786 int nq = GetTotPoints();
787
788 // u = hu/h
789 Vmath::Vdiv(nq, m_fields[1]->GetPhys(), 1, m_fields[0]->GetPhys(), 1,
790 m_fields[1]->UpdatePhys(), 1);
791
792 // v = hv/ v
793 Vmath::Vdiv(nq, m_fields[2]->GetPhys(), 1, m_fields[0]->GetPhys(), 1,
794 m_fields[2]->UpdatePhys(), 1);
795
796 // \eta = h - d
797 Vmath::Vsub(nq, m_fields[0]->GetPhys(), 1, m_depth, 1,
798 m_fields[0]->UpdatePhys(), 1);
799}

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

◆ v_GenerateSummary()

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

Print a summary of time stepping parameters.

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 877 of file NonlinearPeregrine.cpp.

878{
879 ShallowWaterSystem::v_GenerateSummary(s);
880 SolverUtils::AddSummaryItem(s, "Variables", "h should be in field[0]");
881 SolverUtils::AddSummaryItem(s, "", "hu should be in field[1]");
882 SolverUtils::AddSummaryItem(s, "", "hv should be in field[2]");
883 SolverUtils::AddSummaryItem(s, "", "z should be in field[3]");
884}
Nektar::ShallowWaterSystem::v_GenerateSummary
virtual void v_GenerateSummary(SolverUtils::SummaryList &s) override
Print a summary of time stepping parameters.
Definition: ShallowWaterSystem.cpp:139
Nektar::SolverUtils::AddSummaryItem
void AddSummaryItem(SummaryList &l, const std::string &name, const std::string &value)
Adds a summary item to the summary info list.
Definition: Misc.cpp:49

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

◆ v_InitObject()

void Nektar::NonlinearPeregrine::v_InitObject ( bool  DeclareField = true)
overrideprotectedvirtual

Init object for UnsteadySystem class.

Initialization object for UnsteadySystem class.

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 66 of file NonlinearPeregrine.cpp.

67{
68 ShallowWaterSystem::v_InitObject(DeclareFields);
69
70 if (m_session->DefinesSolverInfo("PROBLEMTYPE"))
71 {
72 int i;
73 std::string ProblemTypeStr = m_session->GetSolverInfo("PROBLEMTYPE");
74 for (i = 0; i < (int)SIZE_ProblemType; ++i)
75 {
76 if (boost::iequals(ProblemTypeMap[i], ProblemTypeStr))
77 {
78 m_problemType = (ProblemType)i;
79 break;
80 }
81 }
82 }
83 else
84 {
85 m_problemType = (ProblemType)0;
86 }
87
88 if (m_explicitAdvection)
89 {
90 m_ode.DefineOdeRhs(&NonlinearPeregrine::DoOdeRhs, this);
91 m_ode.DefineProjection(&NonlinearPeregrine::DoOdeProjection, this);
92 }
93 else
94 {
95 ASSERTL0(false, "Implicit Peregrine not set up.");
96 }
97
98 // NB! At the moment only the constant depth case is
99 // supported for the Peregrine eq.
100 if (m_session->DefinesParameter("ConstDepth"))
101 {
102 m_const_depth = m_session->GetParameter("ConstDepth");
103 }
104 else
105 {
106 ASSERTL0(false, "Constant Depth not specified");
107 }
108
109 // Type of advection class to be used
110 switch (m_projectionType)
111 {
112 // Continuous field
113 case MultiRegions::eGalerkin:
114 {
115 ASSERTL0(false,
116 "Continuous projection type not supported for Peregrine.");
117 break;
118 }
119 // Discontinuous field
120 case MultiRegions::eDiscontinuous:
121 {
122 string advName;
123 string diffName;
124 string riemName;
125
126 //---------------------------------------------------------------
127 // Setting up advection and diffusion operators
128 // NB: diffusion not set up for SWE at the moment
129 // but kept here for future use ...
130 m_session->LoadSolverInfo("AdvectionType", advName, "WeakDG");
131 // m_session->LoadSolverInfo("DiffusionType", diffName, "LDG");
132 m_advection = SolverUtils::GetAdvectionFactory().CreateInstance(
133 advName, advName);
134
135 m_advection->SetFluxVector(&NonlinearPeregrine::GetFluxVector,
136 this);
137
138 // Setting up Riemann solver for advection operator
139 m_session->LoadSolverInfo("UpwindType", riemName, "NoSolver");
140
141 m_riemannSolver =
142 SolverUtils::GetRiemannSolverFactory().CreateInstance(
143 riemName, m_session);
144
145 // Setting up parameters for advection operator Riemann solver
146 m_riemannSolver->SetParam("gravity",
147 &NonlinearPeregrine::GetGravity, this);
148 m_riemannSolver->SetAuxVec("vecLocs",
149 &NonlinearPeregrine::GetVecLocs, this);
150 m_riemannSolver->SetVector("N", &NonlinearPeregrine::GetNormals,
151 this);
152 m_riemannSolver->SetScalar("depth", &NonlinearPeregrine::GetDepth,
153 this);
154
155 // Concluding initialisation of advection / diffusion operators
156 m_advection->SetRiemannSolver(m_riemannSolver);
157 m_advection->InitObject(m_session, m_fields);
158 break;
159 }
160 default:
161 {
162 ASSERTL0(false, "Unsupported projection type.");
163 break;
164 }
165 }
166}
Nektar::LibUtilities::NekFactory::CreateInstance
tBaseSharedPtr CreateInstance(tKey idKey, tParam... args)
Create an instance of the class referred to by idKey.
Definition: NekFactory.hpp:144
Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineProjection
void DefineProjection(FuncPointerT func, ObjectPointerT obj)
Definition: TimeIntegrationSchemeOperators.h:96
Nektar::LibUtilities::TimeIntegrationSchemeOperators::DefineOdeRhs
void DefineOdeRhs(FuncPointerT func, ObjectPointerT obj)
Definition: TimeIntegrationSchemeOperators.h:88
Nektar::NonlinearPeregrine::DoOdeRhs
void DoOdeRhs(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
Definition: NonlinearPeregrine.cpp:267
Nektar::NonlinearPeregrine::DoOdeProjection
void DoOdeProjection(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
Definition: NonlinearPeregrine.cpp:490
Nektar::NonlinearPeregrine::GetFluxVector
void GetFluxVector(const Array< OneD, const Array< OneD, NekDouble > > &physfield, Array< OneD, Array< OneD, Array< OneD, NekDouble > > > &flux)
Definition: NonlinearPeregrine.cpp:707
Nektar::ShallowWaterSystem::m_riemannSolver
SolverUtils::RiemannSolverSharedPtr m_riemannSolver
Definition: ShallowWaterSystem.h:68
Nektar::ShallowWaterSystem::GetDepth
const Array< OneD, NekDouble > & GetDepth()
Definition: ShallowWaterSystem.h:123
Nektar::ShallowWaterSystem::v_InitObject
virtual void v_InitObject(bool DeclareFields=true) override
Init object for UnsteadySystem class.
Definition: ShallowWaterSystem.cpp:74
Nektar::ShallowWaterSystem::GetNormals
const Array< OneD, const Array< OneD, NekDouble > > & GetNormals()
Definition: ShallowWaterSystem.h:118
Nektar::ShallowWaterSystem::GetVecLocs
const Array< OneD, const Array< OneD, NekDouble > > & GetVecLocs()
Definition: ShallowWaterSystem.h:113
Nektar::SolverUtils::EquationSystem::m_session
LibUtilities::SessionReaderSharedPtr m_session
The session reader.
Definition: EquationSystem.h:356
Nektar::SolverUtils::UnsteadySystem::m_ode
LibUtilities::TimeIntegrationSchemeOperators m_ode
The time integration scheme operators to use.
Definition: UnsteadySystem.h:79
Nektar::SolverUtils::UnsteadySystem::m_explicitAdvection
bool m_explicitAdvection
Indicates if explicit or implicit treatment of advection is used.
Definition: UnsteadySystem.h:99
Nektar::SolverUtils::GetAdvectionFactory
AdvectionFactory & GetAdvectionFactory()
Gets the factory for initialising advection objects.
Definition: Advection.cpp:47
Nektar::SolverUtils::GetRiemannSolverFactory
RiemannSolverFactory & GetRiemannSolverFactory()
Definition: RiemannSolver.cpp:67
Nektar::ProblemTypeMap
const char *const ProblemTypeMap[]
Definition: NonlinearPeregrine.h:51
Nektar::SIZE_ProblemType
@ SIZE_ProblemType
Length of enum list.
Definition: NonlinearPeregrine.h:48

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

◆ v_PrimitiveToConservative()

void Nektar::NonlinearPeregrine::v_PrimitiveToConservative ( )
overrideprotectedvirtual

Reimplemented from Nektar::ShallowWaterSystem.

Definition at line 841 of file NonlinearPeregrine.cpp.

842{
843 int nq = GetTotPoints();
844
845 // h = \eta + d
846 Vmath::Vadd(nq, m_fields[0]->GetPhys(), 1, m_depth, 1,
847 m_fields[0]->UpdatePhys(), 1);
848
849 // hu = h * u
850 Vmath::Vmul(nq, m_fields[0]->GetPhys(), 1, m_fields[1]->GetPhys(), 1,
851 m_fields[1]->UpdatePhys(), 1);
852
853 // hv = h * v
854 Vmath::Vmul(nq, m_fields[0]->GetPhys(), 1, m_fields[2]->GetPhys(), 1,
855 m_fields[2]->UpdatePhys(), 1);
856}

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

◆ v_SetInitialConditions()

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

Set the initial conditions.

Reimplemented from Nektar::SolverUtils::EquationSystem.

Definition at line 1194 of file NonlinearPeregrine.cpp.

1197{
1198 boost::ignore_unused(domain);
1199
1200 switch (m_problemType)
1201 {
1202 case eSolitaryWave:
1203 {
1204 LaitoneSolitaryWave(0.1, m_const_depth, 0.0, 0.0);
1205 m_nchk++;
1206 break;
1207 }
1208 default:
1209 {
1210 EquationSystem::v_SetInitialConditions(initialtime, false);
1211 break;
1212 }
1213 }
1214
1215 if (dumpInitialConditions)
1216 {
1217 // Dump initial conditions to file
1218 Checkpoint_Output(0);
1219 }
1220}
Nektar::NonlinearPeregrine::LaitoneSolitaryWave
void LaitoneSolitaryWave(NekDouble amp, NekDouble d, NekDouble time, NekDouble x_offset)
Definition: NonlinearPeregrine.cpp:1146
Nektar::SolverUtils::EquationSystem::v_SetInitialConditions
virtual SOLVER_UTILS_EXPORT void v_SetInitialConditions(NekDouble initialtime=0.0, bool dumpInitialConditions=true, const int domain=0)
Definition: EquationSystem.cpp:982
Nektar::SolverUtils::EquationSystem::Checkpoint_Output
SOLVER_UTILS_EXPORT void Checkpoint_Output(const int n)
Write checkpoint file of m_fields.
Definition: EquationSystem.cpp:1176
Nektar::SolverUtils::EquationSystem::m_nchk
int m_nchk
Number of checkpoints written so far.
Definition: EquationSystem.h:388
Nektar::eSolitaryWave
@ eSolitaryWave
First order Laitone solitary wave.
Definition: NonlinearPeregrine.h:47

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

◆ 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 581 of file NonlinearPeregrine.cpp.

584{
585 int i;
586 int nvariables = physarray.size();
587
588 // Adjust the physical values of the trace to take
589 // user defined boundaries into account
590 int e, id1, id2, npts;
591 MultiRegions::ExpListSharedPtr bcexp =
592 m_fields[0]->GetBndCondExpansions()[bcRegion];
593 for (e = 0; e < bcexp->GetExpSize(); ++e)
594 {
595 npts = bcexp->GetExp(e)->GetTotPoints();
596 id1 = bcexp->GetPhys_Offset(e);
597 id2 = m_fields[0]->GetTrace()->GetPhys_Offset(
598 m_fields[0]->GetTraceMap()->GetBndCondIDToGlobalTraceID(cnt + e));
599
600 // For 2D/3D, define: v* = v - 2(v.n)n
601 Array<OneD, NekDouble> tmp(npts, 0.0);
602
603 // Calculate (v.n)
604 for (i = 0; i < m_spacedim; ++i)
605 {
606 Vmath::Vvtvp(npts, &Fwd[1 + i][id2], 1, &m_traceNormals[i][id2], 1,
607 &tmp[0], 1, &tmp[0], 1);
608 }
609
610 // Calculate 2.0(v.n)
611 Vmath::Smul(npts, -2.0, &tmp[0], 1, &tmp[0], 1);
612
613 // Calculate v* = v - 2.0(v.n)n
614 for (i = 0; i < m_spacedim; ++i)
615 {
616 Vmath::Vvtvp(npts, &tmp[0], 1, &m_traceNormals[i][id2], 1,
617 &Fwd[1 + i][id2], 1, &Fwd[1 + i][id2], 1);
618 }
619
620 // copy boundary adjusted values into the boundary expansion
621 for (i = 0; i < nvariables; ++i)
622 {
623 bcexp = m_fields[i]->GetBndCondExpansions()[bcRegion];
624 Vmath::Vcopy(npts, &Fwd[i][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
625 }
626 }
627}
Nektar::MultiRegions::ExpListSharedPtr
std::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
Definition: LocTraceToTraceMap.h:56
Vmath::Vvtvp
void Vvtvp(int n, const T *w, const int incw, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
vvtvp (vector times vector plus vector): z = w*x + y
Definition: Vmath.cpp:569

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

◆ 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 629 of file NonlinearPeregrine.cpp.

632{
633 boost::ignore_unused(physarray);
634
635 int i;
636 int nvariables = 3;
637
638 // Adjust the physical values of the trace to take
639 // user defined boundaries into account
640 int e, id1, id2, npts;
641 MultiRegions::ExpListSharedPtr bcexp =
642 m_fields[0]->GetBndCondExpansions()[bcRegion];
643
644 for (e = 0; e < bcexp->GetExpSize(); ++e)
645 {
646 npts = bcexp->GetExp(e)->GetNumPoints(0);
647 id1 = bcexp->GetPhys_Offset(e);
648 id2 = m_fields[0]->GetTrace()->GetPhys_Offset(
649 m_fields[0]->GetTraceMap()->GetBndCondIDToGlobalTraceID(cnt + e));
650
651 switch (m_expdim)
652 {
653 case 1:
654 {
655 // negate the forward flux
656 Vmath::Neg(npts, &Fwd[1][id2], 1);
657 break;
658 }
659 case 2:
660 {
661 Array<OneD, NekDouble> tmp_n(npts);
662 Array<OneD, NekDouble> tmp_t(npts);
663
664 Vmath::Vmul(npts, &Fwd[1][id2], 1, &m_traceNormals[0][id2], 1,
665 &tmp_n[0], 1);
666 Vmath::Vvtvp(npts, &Fwd[2][id2], 1, &m_traceNormals[1][id2], 1,
667 &tmp_n[0], 1, &tmp_n[0], 1);
668
669 Vmath::Vmul(npts, &Fwd[1][id2], 1, &m_traceNormals[1][id2], 1,
670 &tmp_t[0], 1);
671 Vmath::Vvtvm(npts, &Fwd[2][id2], 1, &m_traceNormals[0][id2], 1,
672 &tmp_t[0], 1, &tmp_t[0], 1);
673
674 // negate the normal flux
675 Vmath::Neg(npts, tmp_n, 1);
676
677 // rotate back to Cartesian
678 Vmath::Vmul(npts, &tmp_t[0], 1, &m_traceNormals[1][id2], 1,
679 &Fwd[1][id2], 1);
680 Vmath::Vvtvm(npts, &tmp_n[0], 1, &m_traceNormals[0][id2], 1,
681 &Fwd[1][id2], 1, &Fwd[1][id2], 1);
682
683 Vmath::Vmul(npts, &tmp_t[0], 1, &m_traceNormals[0][id2], 1,
684 &Fwd[2][id2], 1);
685 Vmath::Vvtvp(npts, &tmp_n[0], 1, &m_traceNormals[1][id2], 1,
686 &Fwd[2][id2], 1, &Fwd[2][id2], 1);
687 break;
688 }
689 case 3:
690 ASSERTL0(false,
691 "3D not implemented for Shallow Water Equations");
692 break;
693 default:
694 ASSERTL0(false, "Illegal expansion dimension");
695 }
696
697 // copy boundary adjusted values into the boundary expansion
698 for (i = 0; i < nvariables; ++i)
699 {
700 bcexp = m_fields[i]->GetBndCondExpansions()[bcRegion];
701 Vmath::Vcopy(npts, &Fwd[i][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
702 }
703 }
704}
Nektar::SolverUtils::EquationSystem::m_expdim
int m_expdim
Expansion dimension.
Definition: EquationSystem.h:402
Vmath::Vvtvm
void Vvtvm(int n, const T *w, const int incw, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
vvtvm (vector times vector minus vector): z = w*x - y
Definition: Vmath.cpp:593

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

◆ WallBoundaryContVariables()

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

Definition at line 1083 of file NonlinearPeregrine.cpp.

1085{
1086 int nTraceNumPoints = GetTraceTotPoints();
1087
1088 // get physical values of z for the forward trace
1089 Array<OneD, NekDouble> z(nTraceNumPoints);
1090 m_fields[0]->ExtractTracePhys(inarray, z);
1091
1092 // Adjust the physical values of the trace to take
1093 // user defined boundaries into account
1094 int e, id1, id2, npts;
1095 MultiRegions::ExpListSharedPtr bcexp =
1096 m_fields[0]->GetBndCondExpansions()[bcRegion];
1097
1098 for (e = 0; e < bcexp->GetExpSize(); ++e)
1099 {
1100 npts = bcexp->GetExp(e)->GetTotPoints();
1101 id1 = bcexp->GetPhys_Offset(e);
1102 id2 = m_fields[0]->GetTrace()->GetPhys_Offset(
1103 m_fields[0]->GetTraceMap()->GetBndCondIDToGlobalTraceID(cnt + e));
1104
1105 // copy boundary adjusted values into the boundary expansion
1106 // field[1] and field[2]
1107 bcexp = m_fields[1]->GetBndCondExpansions()[bcRegion];
1108 Vmath::Vcopy(npts, &z[id2], 1, &(bcexp->UpdatePhys())[id1], 1);
1109 }
1110}
Nektar::UnitTests::z
std::vector< double > z(NPUPPER)

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

Referenced by SetBoundaryConditionsContVariables().

◆ WallBoundaryForcing()

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

Definition at line 974 of file NonlinearPeregrine.cpp.

976{
977
978 // std::cout << " WallBoundaryForcing" << std::endl;
979
980 int nTraceNumPoints = GetTraceTotPoints();
981 int nvariables = 2;
982
983 // get physical values of f1 and f2 for the forward trace
984 Array<OneD, Array<OneD, NekDouble>> Fwd(nvariables);
985 for (int i = 0; i < nvariables; ++i)
986 {
987 Fwd[i] = Array<OneD, NekDouble>(nTraceNumPoints);
988 m_fields[i]->ExtractTracePhys(inarray[i], Fwd[i]);
989 }
990
991 // Adjust the physical values of the trace to take
992 // user defined boundaries into account
993 int e, id1, id2, npts;
994 MultiRegions::ExpListSharedPtr bcexp =
995 m_fields[0]->GetBndCondExpansions()[bcRegion];
996 for (e = 0; e < bcexp->GetExpSize(); ++e)
997 {
998 npts = bcexp->GetExp(e)->GetTotPoints();
999 id1 = bcexp->GetPhys_Offset(e);
1000 id2 = m_fields[0]->GetTrace()->GetPhys_Offset(
1001 m_fields[0]->GetTraceMap()->GetBndCondIDToGlobalTraceID(cnt + e));
1002
1003 switch (m_expdim)
1004 {
1005 case 1:
1006 {
1007 ASSERTL0(false, "1D not yet implemented for Boussinesq");
1008 break;
1009 }
1010 case 2:
1011 {
1012 Array<OneD, NekDouble> tmp_n(npts);
1013 Array<OneD, NekDouble> tmp_t(npts);
1014
1015 Vmath::Vmul(npts, &Fwd[0][id2], 1, &m_traceNormals[0][id2], 1,
1016 &tmp_n[0], 1);
1017 Vmath::Vvtvp(npts, &Fwd[1][id2], 1, &m_traceNormals[1][id2], 1,
1018 &tmp_n[0], 1, &tmp_n[0], 1);
1019
1020 Vmath::Vmul(npts, &Fwd[0][id2], 1, &m_traceNormals[1][id2], 1,
1021 &tmp_t[0], 1);
1022 Vmath::Vvtvm(npts, &Fwd[1][id2], 1, &m_traceNormals[0][id2], 1,
1023 &tmp_t[0], 1, &tmp_t[0], 1);
1024
1025 // negate the normal flux
1026 Vmath::Neg(npts, tmp_n, 1);
1027
1028 // rotate back to Cartesian
1029 Vmath::Vmul(npts, &tmp_t[0], 1, &m_traceNormals[1][id2], 1,
1030 &Fwd[0][id2], 1);
1031 Vmath::Vvtvm(npts, &tmp_n[0], 1, &m_traceNormals[0][id2], 1,
1032 &Fwd[0][id2], 1, &Fwd[0][id2], 1);
1033
1034 Vmath::Vmul(npts, &tmp_t[0], 1, &m_traceNormals[0][id2], 1,
1035 &Fwd[1][id2], 1);
1036 Vmath::Vvtvp(npts, &tmp_n[0], 1, &m_traceNormals[1][id2], 1,
1037 &Fwd[1][id2], 1, &Fwd[1][id2], 1);
1038 break;
1039 }
1040 case 3:
1041 ASSERTL0(false, "3D not implemented for Boussinesq equations");
1042 break;
1043 default:
1044 ASSERTL0(false, "Illegal expansion dimension");
1045 }
1046
1047 // copy boundary adjusted values into the boundary expansion
1048 bcexp = m_fields[1]->GetBndCondExpansions()[bcRegion];
1049 Vmath::Vcopy(npts, &Fwd[0][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
1050
1051 bcexp = m_fields[2]->GetBndCondExpansions()[bcRegion];
1052 Vmath::Vcopy(npts, &Fwd[1][id2], 1, &(bcexp->UpdatePhys())[id1], 1);
1053 }
1054}

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

◆ WCESolve()

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

Definition at line 886 of file NonlinearPeregrine.cpp.

887{
888 int nq = GetTotPoints();
889
890 m_factors[StdRegions::eFactorLambda] = lambda;
891
892 for (int j = 0; j < nq; j++)
893 {
894 (m_fields[3]->UpdatePhys())[j] = fce[j];
895 }
896
897 m_fields[3]->SetPhysState(true);
898
899 m_fields[3]->HelmSolve(m_fields[3]->GetPhys(), m_fields[3]->UpdateCoeffs(),
900 m_factors);
901
902 m_fields[3]->BwdTrans(m_fields[3]->GetCoeffs(), m_fields[3]->UpdatePhys());
903
904 m_fields[3]->SetPhysState(true);
905
906 Vmath::Vcopy(nq, m_fields[3]->GetPhys(), 1, fce, 1);
907}

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

Referenced by DoOdeRhs().

Friends And Related Function Documentation

◆ MemoryManager< NonlinearPeregrine >

friend class MemoryManager< NonlinearPeregrine >
friend

Definition at line 51 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.")
Nektar::LibUtilities::NekFactory::RegisterCreatorFunction
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
Nektar::NonlinearPeregrine::create
static SolverUtils::EquationSystemSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
Creates an instance of this class.
Definition: NonlinearPeregrine.h:64
Nektar::SolverUtils::GetEquationSystemFactory
EquationSystemFactory & GetEquationSystemFactory()
Definition: EquationSystem.cpp:103

Name of class.

Definition at line 75 of file NonlinearPeregrine.h.

◆ m_const_depth

NekDouble Nektar::NonlinearPeregrine::m_const_depth
private

Definition at line 126 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 92 of file NonlinearPeregrine.h.

Referenced by GetDepthBwd().

◆ m_dFwd

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

Still water depth traces.

Definition at line 91 of file NonlinearPeregrine.h.

Referenced by GetDepthFwd().

◆ m_factors

StdRegions::ConstFactorMap Nektar::NonlinearPeregrine::m_factors
protected

Definition at line 83 of file NonlinearPeregrine.h.

Referenced by NonlinearPeregrine(), and WCESolve().

◆ m_problemType

ProblemType Nektar::NonlinearPeregrine::m_problemType

Definition at line 80 of file NonlinearPeregrine.h.

Referenced by v_InitObject(), and v_SetInitialConditions().

Generated on Wed Jan 31 2024 08:26:53 for Nektar++ by doxygen 1.9.4