HyPar  1.0
Finite-Difference Hyperbolic-Parabolic PDE Solver on Cartesian Grids
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Fields
ShallowWater2D Struct Reference

Structure containing variables and parameters specific to the 2D Shallow Water equations. This structure contains the physical parameters, variables, and function pointers specific to the 2D ShallowWater equations. More...

#include <shallowwater2d.h>

Data Fields

int bt_type
 
int topo_flag
 
double g
 
double * b
 
double fhat
 
double beta
 
double D
 
char upw_choice [_MAX_STRING_SIZE_]
 
int(* SourceUpwind )(double *, double *, double *, double *, int, void *, double)
 

Detailed Description

Structure containing variables and parameters specific to the 2D Shallow Water equations. This structure contains the physical parameters, variables, and function pointers specific to the 2D ShallowWater equations.

Definition at line 240 of file shallowwater2d.h.

Field Documentation

int bt_type

1 -> bottom topography is periodic, 0 -> bottom topography is not periodic

Definition at line 241 of file shallowwater2d.h.

int topo_flag

Flag to indicate if topography file was provided

Definition at line 241 of file shallowwater2d.h.

double g

Acceleration due to gravity

Definition at line 243 of file shallowwater2d.h.

double * b

Array to store the bottom topography \(b(x,y)\)

Definition at line 243 of file shallowwater2d.h.

double fhat

Coriolis parameter

Definition at line 243 of file shallowwater2d.h.

double beta

beta-plane approximation parameter for Coriolis force

Definition at line 243 of file shallowwater2d.h.

double D

Channel width for Coriolis force calculation

Definition at line 243 of file shallowwater2d.h.

char upw_choice[_MAX_STRING_SIZE_]

Choice of upwinding scheme.

See Also
_ROE_, _LLF_

Definition at line 248 of file shallowwater2d.h.

int(* SourceUpwind)(double *, double *, double *, double *, int, void *, double)

Function pointer to the function that computes the "upwinding" step in source term computation. To understand the implementation of the gravitational source terms, see:

  • Xing, Y., Shu, C.-W., "High order finite difference WENO schemes with the exact conservation property for the shallow water equations", Journal of Computational Physics, 208, 2005, pp. 206-227. http://dx.doi.org/10.1016/j.jcp.2005.02.006

Definition at line 256 of file shallowwater2d.h.

The documentation for this struct was generated from the following file: