HyPar  1.0
Finite-Difference Hyperbolic-Parabolic PDE Solver on Cartesian Grids
ShallowWater1DFunctions.c File Reference

Miscellaneous functions for the 1D shallow water equations. More...

#include <math.h>
#include <basic.h>
#include <physicalmodels/shallowwater1d.h>

Go to the source code of this file.

Functions

int ShallowWater1DRoeAverage (double *uavg, double *uL, double *uR, void *p)
 

Detailed Description

Miscellaneous functions for the 1D shallow water equations.

Author
Debojyoti Ghosh

Definition in file ShallowWater1DFunctions.c.

Function Documentation

◆ ShallowWater1DRoeAverage()

int ShallowWater1DRoeAverage ( double *  uavg,
double *  uL,
double *  uR,
void *  p 
)

Compute the Roe-averaged state for the 1D shallow water equations. This function just calls the macro _ShallowWater1DRoeAverage_ and is not used by any functions within the 1D shallow water module. However, it's necessary to define it and provide it to the the solver object (HyPar) so that it can then send it to interpolation functions for a characteristic-based reconstruction.

Parameters
uavgThe computed Roe-averaged state
uLLeft state (conserved variables)
uRRight state (conserved variables)
pObject of type ShallowWater1D with physics-related variables

Definition at line 16 of file ShallowWater1DFunctions.c.

22 {
23  ShallowWater1D *param = (ShallowWater1D*) p;
24  _ShallowWater1DRoeAverage_(uavg,uL,uR,param);
25  return(0);
26 }
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.
#define _ShallowWater1DRoeAverage_(uavg, uL, uR, p)