ug::d3f::StVenantParameters< dim > Struct Template Reference

Configuration parameters for the St. Venant submodule. More...

#include <st_venant_submodule.h>

Public Types
typedef SmartPtr< CplUserData< number, dim > >	TSPNumberData
typedef SmartPtr< CplUserData< MathVector< dim >, dim > >	TSPVectorData

Public Member Functions
	StVenantParameters ()
	Initializes parameters with standard default values.

Public Attributes
TSPNumberData	b
	River width [m].
number	diffusion
	Numerical diffusion coefficient.
number	dirichlet_A
	Dirichlet value for wetted area at inflow/outflow.
number	dirichlet_v
	Dirichlet value for velocity at inflow/outflow.
number	gravity
	Acceleration due to gravity [m/s^2].
std::string	interface_subset
	Name of the subset in the 3D domain for exchange.
TSPNumberData	ks
	Manning coefficient (roughness)
TSPNumberData	qr
	Lateral source/sink term [m^2/s].
std::string	river_subset
	Name of the subset in the 1D domain.

Detailed Description

template<int dim>
struct ug::d3f::StVenantParameters< dim >

Configuration parameters for the St. Venant submodule.

Member Typedef Documentation

TSPNumberData

template<int dim>

typedef SmartPtr<CplUserData<number, dim> > ug::d3f::StVenantParameters< dim >::TSPNumberData

TSPVectorData

template<int dim>

typedef SmartPtr<CplUserData<MathVector<dim>, dim> > ug::d3f::StVenantParameters< dim >::TSPVectorData

Constructor & Destructor Documentation

StVenantParameters()

template<int dim>

ug::d3f::StVenantParameters< dim >::StVenantParameters ( )

inline

Initializes parameters with standard default values.

< Default width: 1.0 m

< Gravity: 9.81 m/s^2

< Artificial diffusion for stability

< Default Manning-Strickler ks

< Lateral inflow rate

< Boundary condition for Area

< Boundary condition for Velocity

< Subsurface subset for coupling

< 1D grid subset name

References ug::d3f::StVenantParameters< dim >::b, ug::d3f::StVenantParameters< dim >::diffusion, ug::d3f::StVenantParameters< dim >::dirichlet_A, ug::d3f::StVenantParameters< dim >::dirichlet_v, ug::d3f::StVenantParameters< dim >::gravity, ug::d3f::StVenantParameters< dim >::interface_subset, ug::d3f::StVenantParameters< dim >::ks, make_sp(), ug::d3f::StVenantParameters< dim >::qr, and ug::d3f::StVenantParameters< dim >::river_subset.

Member Data Documentation

b

template<int dim>

TSPNumberData ug::d3f::StVenantParameters< dim >::b

River width [m].

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

diffusion

template<int dim>

number ug::d3f::StVenantParameters< dim >::diffusion

Numerical diffusion coefficient.

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

dirichlet_A

template<int dim>

number ug::d3f::StVenantParameters< dim >::dirichlet_A

Dirichlet value for wetted area at inflow/outflow.

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

dirichlet_v

template<int dim>

number ug::d3f::StVenantParameters< dim >::dirichlet_v

Dirichlet value for velocity at inflow/outflow.

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

gravity

template<int dim>

number ug::d3f::StVenantParameters< dim >::gravity

Acceleration due to gravity [m/s^2].

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

interface_subset

template<int dim>

std::string ug::d3f::StVenantParameters< dim >::interface_subset

Name of the subset in the 3D domain for exchange.

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

ks

template<int dim>

TSPNumberData ug::d3f::StVenantParameters< dim >::ks

Manning coefficient (roughness)

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

qr

template<int dim>

TSPNumberData ug::d3f::StVenantParameters< dim >::qr

Lateral source/sink term [m^2/s].

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

river_subset

template<int dim>

std::string ug::d3f::StVenantParameters< dim >::river_subset

Name of the subset in the 1D domain.

Referenced by ug::d3f::StVenantParameters< dim >::StVenantParameters().

---

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

• /home/runner/work/docs/docs/ug4/plugins/d3f/river_networks/st_venant_submodule/st_venant_submodule.h