fe_wet_dry_wrapper.c File Reference

#include "adh.h"

Functions
double	fe_sw2_wet_dry_factor (SVECT *x, double *h, double djac)
	Returns the wet-dry integration factor :: essentially a stripped down version of fe_sw2_wet_dry_wrapper. More...
double	fe_sw2_wet_dry_wrapper (double *elem_rhs, SVECT *x, double *h, SVECT2D *grad_phi, SVECT2D *v, SVECT2D *v_wet_dry, double *f, double *f_wet_dry, double djac, int redistribute_flag, int DEBUG, double *vars, void(*fe_sw_func)(SVECT *elem_nds, double *elem_head, SVECT2D *grad_phi, SVECT2D *v, SVECT2D *v_wet_dry, double *f, double *f_wet_dry, double djac, double *vars, double *elem_rhs))
	Wet/Dry wrapper for the 2D depth-averaged continuity equation temporal integral. More...
double	fe_sw2_wet_dry_wrapper_1d (double *elem_rhs, SVECT *x, double *h, SVECT2D *nrml, SVECT2D *v, SVECT2D *v_wet_dry, double *f, double *f_wet_dry, double djac, int redistribute_flag, int DEBUG, double *vars, void(*fe_sw_func)(SVECT *elem_nds, double *elem_head, SVECT2D *grad_phi, SVECT2D *v, SVECT2D *v_wet_dry, double *f, double *f_wet_dry, double djac, double *vars, double *elem_rhs))
	Wet/Dry wrapper for the 2D depth-averaged continuity equation temporal integral. More...

Detailed Description

This file collects the 2D shallow water wet/dry wrapper. All function arguements assumed to be consistent with function prototype.

Function Documentation

fe_sw2_wet_dry_factor()

double fe_sw2_wet_dry_factor	(	SVECT *	x,
		double *	h,
		double	djac
	)

Returns the wet-dry integration factor :: essentially a stripped down version of fe_sw2_wet_dry_wrapper.

Author

Charlie Berger, Ph.D.

Gary Brown

Gaurav Savant, Ph.D.

Corey Trahan, Ph.D.

Date

October, 2017

Bug:

none

Warning

none

Copyright

AdH

Parameters

[in]	(required)	x the 2d element nodal coordinates
[in]	(required)	h the 2d element nodal depths - this is wet-dry averaged
[in]	(required)	djac the 2d element area

fe_sw2_wet_dry_wrapper()

double fe_sw2_wet_dry_wrapper	(	double *	elem_rhs,
		SVECT *	x,
		double *	h,
		SVECT2D *	grad_phi,
		SVECT2D *	v,
		SVECT2D *	v_wet_dry,
		double *	f,
		double *	f_wet_dry,
		double	djac,
		int	redistribute_flag,
		int	DEBUG,
		double *	vars,
		void(*)(SVECT *elem_nds, double *elem_head, SVECT2D *grad_phi, SVECT2D *v, SVECT2D *v_wet_dry, double *f, double *f_wet_dry, double djac, double *vars, double *elem_rhs)	fe_sw_func
	)

Wet/Dry wrapper for the 2D depth-averaged continuity equation temporal integral.

Author

Charlie Berger, Ph.D.

Gary Brown

Gaurav Savant, Ph.D.

Corey Trahan, Ph.D.

Date

October, 2017

Bug:

none

Warning

none

Copyright

AdH

Parameters

[in,out]	elem_rhs	the 2D elemental residual array contribution with wet/dry inclusion
[in]	(required)	x the 2d element nodal coordinates
[in]	(required)	h the 2d element nodal depths - this is wet-dry averaged
[in]	(optional)	grad_phi the elemental shape function gradients in configuration space, NULL if not included
[in]	(optional)	v the element nodal velocities, NULL if not included
[in]	(optional)	grad_z the elemental bathymetry gradients, NULL if not included
[in]	(optional)	f generic scalar function which is integrated over the whole element
[in]	(optional)	f_wet_dry a generic scalar function which is wet-dry integrated
[in]	(required)	djac the 2d element area
[in]	(required)	dt timestep
[in]	(required)	c an integration constant
[in]	(required)	void(*fe_sw_func) a function that performs the consisitent mass integration

Note

CJT :: only handles triangles right now

fe_sw2_wet_dry_wrapper_1d()

double fe_sw2_wet_dry_wrapper_1d	(	double *	elem_rhs,
		SVECT *	x,
		double *	h,
		SVECT2D *	nrml,
		SVECT2D *	v,
		SVECT2D *	v_wet_dry,
		double *	f,
		double *	f_wet_dry,
		double	djac,
		int	redistribute_flag,
		int	DEBUG,
		double *	vars,
		void(*)(SVECT *elem_nds, double *elem_head, SVECT2D *grad_phi, SVECT2D *v, SVECT2D *v_wet_dry, double *f, double *f_wet_dry, double djac, double *vars, double *elem_rhs)	fe_sw_func
	)

Wet/Dry wrapper for the 2D depth-averaged continuity equation temporal integral.

Author

Mark Loveland

Parameters

[in,out]	elem_rhs	the 2D elemental residual array contribution with wet/dry inclusion
[in]	(required)	x the 2d element nodal coordinates
[in]	(required)	h the 2d element nodal depths - this is wet-dry averaged
[in]	(optional)	grad_phi the elemental shape function gradients in configuration space, NULL if not included
[in]	(optional)	v the element nodal velocities, NULL if not included
[in]	(optional)	grad_z the elemental bathymetry gradients, NULL if not included
[in]	(optional)	f generic scalar function which is integrated over the whole element
[in]	(optional)	f_wet_dry a generic scalar function which is wet-dry integrated
[in]	(required)	djac the 2d element area
[in]	(required)	dt timestep
[in]	(required)	c an integration constant
[in]	(required)	void(*fe_sw_func) a function that performs the consisitent mass integration