ShallowWater1D Struct Reference

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

#include <shallowwater1d.h>

Data Fields
double	g
int	bt_type
int	topo_flag
double *	b
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 1D Shallow Water equations. This structure contains the physical parameters, variables, and function pointers specific to the 1D ShallowWater equations.

Definition at line 137 of file shallowwater1d.h.

Field Documentation

double g

Acceleration due to gravity

Definition at line 138 of file shallowwater1d.h.

int bt_type

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

Definition at line 139 of file shallowwater1d.h.

int topo_flag

Flag to indicate if topography file was provided

Definition at line 139 of file shallowwater1d.h.

double* b

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

Definition at line 141 of file shallowwater1d.h.

char upw_choice[_MAX_STRING_SIZE_]

Choice of upwinding scheme.

See Also

_ROE_, _LLF_

Definition at line 142 of file shallowwater1d.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 150 of file shallowwater1d.h.

---

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

• include/physicalmodels/shallowwater1d.h