ug::d3f::ManningRoughness1d< dim > Class Template Reference

Calculates the river bottom friction (reaction rate) using Manning's formula. More...

#include <manning_roughness_1d.h>

Inheritance diagram for ug::d3f::ManningRoughness1d< dim >:

Public Types
enum	inputs { _h_ = 0 , _v_ , _n_ }
Public Types inherited from ug::CplUserData< typename TData, int dim, typename TRet >
typedef ICplUserData< dim >	base_type
Public Types inherited from ug::UserData< typename TData, int dim, typename TRet >
typedef TData	data_type
typedef TRet	return_type

Public Member Functions
template<int refDim>
void	eval_and_deriv (number vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< refDim > vLocIP[], const size_t nip, LocalVector *u, bool bDeriv, int s, std::vector< std::vector< number > > vvvDeriv[], const MathMatrix< refDim, dim > *vJT=NULL) const
	Evaluates the value AND the Jacobian (derivatives w.r.t h, v, n) for the Newton solver.
void	evaluate (number &value, const MathVector< dim > &globIP, number time, int si) const
template<int refDim>
void	evaluate (number vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< refDim > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< refDim, dim > *vJT=NULL) const
	Evaluates the Manning roughness reaction rate at local integration points.
number	evaluate_dh (const number v, const number n, const number h, const number g) const
number	evaluate_dn (const number v, const number n, const number h, const number g) const
number	evaluate_dv (const number v, const number n, const number h, const number g) const
	ManningRoughness1d ()
bool	requires_grid_fct () const
void	set_gravity (number gin)
void	set_h (SmartPtr< TNumberData > h)
void	set_hmin (number h)
void	set_manning_coefficient (SmartPtr< TNumberData > n)
void	set_v (SmartPtr< TNumberData > v)
Public Member Functions inherited from ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >
virtual void	check_setup () const
virtual void	compute (LocalVector *u, GridObject *elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
virtual void	compute (LocalVectorTimeSeries *u, GridObject *elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
virtual bool	continuous () const
void	evaluate (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< refDim > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< refDim, dim > *vJT=NULL) const
virtual SmartPtr< ICplUserData< dim > >	needed_data (size_t i)
virtual size_t	num_input () const
virtual size_t	num_needed_data () const
virtual void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si) const
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, const size_t nip) const
virtual void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)
virtual void	set_input (size_t i, SmartPtr< ICplUserData< dim > > input, SmartPtr< UserDataInfo > info)
void	set_num_input (size_t num)
virtual bool	zero_derivative () const
bool	zero_derivative (size_t i) const
Public Member Functions inherited from ug::StdUserData< StdDataLinker< TImpl, TData, dim >, TData, dim, void, DependentUserData< TData, dim > >
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< 1, dim > *vJT=NULL) const
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< 1, dim > *vJT=NULL) const
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< 2, dim > *vJT=NULL) const
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< 2, dim > *vJT=NULL) const
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< 3, dim > *vJT=NULL) const
virtual void	operator() (TData vValue[], const MathVector< dim > vGlobIP[], number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > vLocIP[], const size_t nip, LocalVector *u, const MathMatrix< 3, dim > *vJT=NULL) const
Public Member Functions inherited from ug::CplUserData< typename TData, int dim, typename TRet >
bool	defined (size_t s, size_t ip) const
size_t	num_ip (size_t s) const
size_t	num_series () const
void	register_storage_callback (DataImport< TData, dim > *obj, void(DataImport< TData, dim >::*func)())
void	unregister_storage_callback (DataImport< TData, dim > *obj)
TData &	value (size_t s, size_t ip)
const TData &	value (size_t s, size_t ip) const
TData *	values (size_t s)
const TData *	values (size_t s) const
	~CplUserData ()
Public Member Functions inherited from ug::ICplUserData< int dim >
bool	at_current_time (size_t s) const
void	clear ()
virtual bool	constant () const
int	dim_local_ips () const
	ICplUserData ()
const MathVector< dim > &	ip (size_t s, size_t ip) const
const MathVector< dim > *	ips (size_t s) const
const MathVector< ldim > &	local_ip (size_t s, size_t ip) const
const MathVector< ldim > *	local_ips (size_t s) const
size_t	num_ip (size_t s) const
size_t	num_series () const
virtual void	prepare_element (GridObject *e, const MathVector< dim > vCornerCoords[])
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, bool bMayChange=true)
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, const int timePointSpec, bool bMayChange=true)
void	set_global_ips (size_t s, const MathVector< dim > *vPos, size_t numIP)
void	set_local_ips (const size_t seriesId, const MathVector< ldim > *vPos, const size_t numIP)
void	set_subset (int si)
void	set_time_point (const size_t seriesId, const int timePointSpec)
void	set_time_point (size_t timePoint)
void	set_times (const std::vector< number > &vTime)
int	subset () const
number	time () const
number	time (size_t s) const
size_t	time_point ()
size_t	time_point (size_t s) const
int	time_point_specification (size_t s) const
virtual void	update_dof_sizes (const LocalIndices &ind)
virtual	~ICplUserData ()
Public Member Functions inherited from ug::UserDataInfo
const FunctionGroup &	function_group () const
const FunctionIndexMapping &	map () const
size_t	num_fct () const
const char *	obj_name ()
void	set_obj_name (const char *name)
virtual	~UserDataInfo ()
Public Member Functions inherited from ug::UserData< typename TData, int dim, typename TRet >
int	get_dim () const
TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > &locIP, LocalVector *u) const
TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 1 > &locIP, LocalVector *u) const
TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > &locIP, LocalVector *u) const
TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 2 > &locIP, LocalVector *u) const
TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > &locIP, LocalVector *u) const
TRet	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, GridObject *elem, const MathVector< dim > vCornerCoords[], const MathVector< 3 > &locIP, LocalVector *u) const
virtual void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, Vertex *vrt) const
std::string	type () const

Private Types
typedef DependentUserData< number, dim >	TDNumberData
typedef DependentUserData< MathVector< dim >, dim >	TDVectorData
typedef CplUserData< number, dim >	TNumberData
typedef CplUserData< MathVector< dim >, dim >	TVectorData

Private Attributes
SmartPtr< TDNumberData >	m_dh
SmartPtr< TDNumberData >	m_dn
SmartPtr< TDNumberData >	m_dv
number	m_g = 9.81 * 60.0 * 60.0
SmartPtr< TNumberData >	m_h
number	m_hmin = 1e-6
SmartPtr< TNumberData >	m_n
SmartPtr< TNumberData >	m_v
number	m_vmin = 1e-6

Additional Inherited Members
Protected Member Functions inherited from ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >
void	eval_deriv (LocalVector *u, GridObject *elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
void	eval_deriv (LocalVectorTimeSeries *u, GridObject *elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
TImpl &	getImpl ()
const TImpl &	getImpl () const
virtual void	global_ips_changed (const size_t seriesID, const MathVector< dim > *vPos, const size_t numIP)
size_t	input_common_fct (size_t i, size_t fct) const
size_t	input_num_fct (size_t i) const
virtual void	local_ip_series_added (const size_t seriesID)
virtual void	local_ip_series_to_be_cleared ()
virtual void	local_ips_changed (const size_t seriesID, const size_t newNumIP)
size_t	series_id (size_t i, size_t s) const
Protected Member Functions inherited from ug::StdUserData< StdDataLinker< TImpl, TData, dim >, TData, dim, void, DependentUserData< TData, dim > >
TImpl &	getImpl ()
const TImpl &	getImpl () const
Protected Member Functions inherited from ug::CplUserData< typename TData, int dim, typename TRet >
void	call_storage_callback () const
void	check_series (size_t s) const
void	check_series_ip (size_t s, size_t ip) const
virtual void	value_storage_changed (const size_t seriesID)
Protected Member Functions inherited from ug::ICplUserData< int dim >
void	check_s (size_t s) const
void	check_s_ip (size_t s, size_t ip) const
std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >)
const std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >) const
std::vector< const MathVector< 2 > * > &	get_local_ips (Int2Type< 2 >)
const std::vector< const MathVector< 2 > * > &	get_local_ips (Int2Type< 2 >) const
std::vector< const MathVector< 3 > * > &	get_local_ips (Int2Type< 3 >)
const std::vector< const MathVector< 3 > * > &	get_local_ips (Int2Type< 3 >) const
Protected Attributes inherited from ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >
std::vector< FunctionIndexMapping >	m_vMap
std::vector< SmartPtr< ICplUserData< dim > > >	m_vspICplUserData
std::vector< SmartPtr< UserDataInfo > >	m_vspUserDataInfo
std::vector< std::vector< size_t > >	m_vvSeriesID
Protected Attributes inherited from ug::ICplUserData< int dim >
int	m_defaultTimePoint
int	m_locPosDim
std::vector< const MathVector< 1 > * >	m_pvLocIP1d
std::vector< const MathVector< 2 > * >	m_pvLocIP2d
std::vector< const MathVector< 3 > * >	m_pvLocIP3d
int	m_si
size_t	m_timePoint
std::vector< bool >	m_vMayChange
std::vector< size_t >	m_vNumIP
std::vector< number >	m_vTime
std::vector< int >	m_vTimePoint
std::vector< const MathVector< dim > * >	m_vvGlobPos
Protected Attributes inherited from ug::UserDataInfo
FunctionGroup	m_fctGrp
FunctionIndexMapping	m_map
SmartPtr< char >	m_objName

Detailed Description

template<int dim>
class ug::d3f::ManningRoughness1d< dim >

Calculates the river bottom friction (reaction rate) using Manning's formula.

For a convection-diffusion formulation where the friction term is -R * v, this linker calculates the coefficient R: $$R = \frac{g \cdot n^2 \cdot |v|}{\max(h, h_{min})^{4/3}}$$

Member Typedef Documentation

TDNumberData

template<int dim>

typedef DependentUserData<number, dim> ug::d3f::ManningRoughness1d< dim >::TDNumberData

private

TDVectorData

template<int dim>

typedef DependentUserData<MathVector<dim>, dim> ug::d3f::ManningRoughness1d< dim >::TDVectorData

private

TNumberData

template<int dim>

typedef CplUserData<number, dim> ug::d3f::ManningRoughness1d< dim >::TNumberData

private

TVectorData

template<int dim>

typedef CplUserData<MathVector<dim>, dim> ug::d3f::ManningRoughness1d< dim >::TVectorData

private

Member Enumeration Documentation

inputs

template<int dim>

enum ug::d3f::ManningRoughness1d::inputs

Enumerator
_h_
_v_
_n_

Constructor & Destructor Documentation

ManningRoughness1d()

template<int dim>

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

inline

References ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >::set_num_input().

Member Function Documentation

eval_and_deriv()

template<int dim>

template<int refDim>

void ug::d3f::ManningRoughness1d< dim >::eval_and_deriv ( number  vValue[], const MathVector< dim >  vGlobIP[], number  time, int  si, GridObject *  elem, const MathVector< dim >  vCornerCoords[], const MathVector< refDim >  vLocIP[], const size_t  nip, LocalVector *  u, bool  bDeriv, int  s, std::vector< std::vector< number > >  vvvDeriv[], const MathMatrix< refDim, dim > *  vJT = NULL  ) const

inline

Evaluates the value AND the Jacobian (derivatives w.r.t h, v, n) for the Newton solver.

References ug::d3f::ManningRoughness1d< dim >::_h_, ug::d3f::ManningRoughness1d< dim >::_n_, ug::d3f::ManningRoughness1d< dim >::_v_, ug::d3f::ManningRoughness1d< dim >::evaluate_dh(), ug::d3f::ManningRoughness1d< dim >::evaluate_dn(), ug::d3f::ManningRoughness1d< dim >::evaluate_dv(), ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >::input_common_fct(), ug::ICplUserData< int dim >::ip(), ug::d3f::ManningRoughness1d< dim >::m_dh, ug::d3f::ManningRoughness1d< dim >::m_dn, ug::d3f::ManningRoughness1d< dim >::m_dv, ug::d3f::ManningRoughness1d< dim >::m_g, ug::d3f::ManningRoughness1d< dim >::m_n, ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >::series_id(), ug::ICplUserData< int dim >::time(), and ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >::zero_derivative().

evaluate() [1/2]

template<int dim>

void ug::d3f::ManningRoughness1d< dim >::evaluate ( number &  value, const MathVector< dim > &  globIP, number  time, int  si  ) const

inline

References UG_THROW.

evaluate() [2/2]

template<int dim>

template<int refDim>

void ug::d3f::ManningRoughness1d< dim >::evaluate ( number  vValue[], const MathVector< dim >  vGlobIP[], number  time, int  si, GridObject *  elem, const MathVector< dim >  vCornerCoords[], const MathVector< refDim >  vLocIP[], const size_t  nip, LocalVector *  u, const MathMatrix< refDim, dim > *  vJT = NULL  ) const

inline

Evaluates the Manning roughness reaction rate at local integration points.

References ug::ICplUserData< int dim >::ip(), ug::d3f::ManningRoughness1d< dim >::m_g, ug::d3f::ManningRoughness1d< dim >::m_hmin, ug::d3f::ManningRoughness1d< dim >::m_vmin, and ug::ICplUserData< int dim >::time().

evaluate_dh()

template<int dim>

number ug::d3f::ManningRoughness1d< dim >::evaluate_dh ( const number  v, const number  n, const number  h, const number  g  ) const

inline

References ug::d3f::ManningRoughness1d< dim >::m_hmin.

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv().

evaluate_dn()

template<int dim>

number ug::d3f::ManningRoughness1d< dim >::evaluate_dn ( const number  v, const number  n, const number  h, const number  g  ) const

inline

References ug::d3f::ManningRoughness1d< dim >::m_hmin.

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv().

evaluate_dv()

template<int dim>

number ug::d3f::ManningRoughness1d< dim >::evaluate_dv ( const number  v, const number  n, const number  h, const number  g  ) const

inline

References ug::d3f::ManningRoughness1d< dim >::m_hmin, and ug::SMALL_SQ.

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv().

requires_grid_fct()

template<int dim>

bool ug::d3f::ManningRoughness1d< dim >::requires_grid_fct ( ) const

inlinevirtual

Reimplemented from ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >.

set_gravity()

template<int dim>

void ug::d3f::ManningRoughness1d< dim >::set_gravity ( number  gin )

inline

References ug::d3f::ManningRoughness1d< dim >::m_g.

set_h()

template<int dim>

void ug::d3f::ManningRoughness1d< dim >::set_h ( SmartPtr< TNumberData >  h )

inline

References ug::d3f::ManningRoughness1d< dim >::_h_, ug::d3f::ManningRoughness1d< dim >::m_dh, ug::d3f::ManningRoughness1d< dim >::m_h, and ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >::set_input().

set_hmin()

template<int dim>

void ug::d3f::ManningRoughness1d< dim >::set_hmin ( number  h )

inline

References ug::d3f::ManningRoughness1d< dim >::m_hmin.

set_manning_coefficient()

template<int dim>

void ug::d3f::ManningRoughness1d< dim >::set_manning_coefficient ( SmartPtr< TNumberData >  n )

inline

References ug::d3f::ManningRoughness1d< dim >::_n_, ug::d3f::ManningRoughness1d< dim >::m_dn, ug::d3f::ManningRoughness1d< dim >::m_n, and ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >::set_input().

set_v()

template<int dim>

void ug::d3f::ManningRoughness1d< dim >::set_v ( SmartPtr< TNumberData >  v )

inline

References ug::d3f::ManningRoughness1d< dim >::_v_, ug::d3f::ManningRoughness1d< dim >::m_dv, ug::d3f::ManningRoughness1d< dim >::m_v, and ug::StdDataLinker< ManningRoughness1d< dim >, number, dim >::set_input().

Member Data Documentation

m_dh

template<int dim>

SmartPtr<TDNumberData> ug::d3f::ManningRoughness1d< dim >::m_dh

private

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv(), and ug::d3f::ManningRoughness1d< dim >::set_h().

m_dn

template<int dim>

SmartPtr<TDNumberData> ug::d3f::ManningRoughness1d< dim >::m_dn

private

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv(), and ug::d3f::ManningRoughness1d< dim >::set_manning_coefficient().

m_dv

template<int dim>

SmartPtr<TDNumberData> ug::d3f::ManningRoughness1d< dim >::m_dv

private

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv(), and ug::d3f::ManningRoughness1d< dim >::set_v().

m_g

template<int dim>

number ug::d3f::ManningRoughness1d< dim >::m_g = 9.81 * 60.0 * 60.0

private

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv(), ug::d3f::ManningRoughness1d< dim >::evaluate(), and ug::d3f::ManningRoughness1d< dim >::set_gravity().

m_h

template<int dim>

SmartPtr<TNumberData> ug::d3f::ManningRoughness1d< dim >::m_h

private

Referenced by ug::d3f::ManningRoughness1d< dim >::set_h().

m_hmin

template<int dim>

number ug::d3f::ManningRoughness1d< dim >::m_hmin = 1e-6

private

Referenced by ug::d3f::ManningRoughness1d< dim >::evaluate(), ug::d3f::ManningRoughness1d< dim >::evaluate_dh(), ug::d3f::ManningRoughness1d< dim >::evaluate_dn(), ug::d3f::ManningRoughness1d< dim >::evaluate_dv(), and ug::d3f::ManningRoughness1d< dim >::set_hmin().

m_n

template<int dim>

SmartPtr<TNumberData> ug::d3f::ManningRoughness1d< dim >::m_n

private

Referenced by ug::d3f::ManningRoughness1d< dim >::eval_and_deriv(), and ug::d3f::ManningRoughness1d< dim >::set_manning_coefficient().

m_v

template<int dim>

SmartPtr<TNumberData> ug::d3f::ManningRoughness1d< dim >::m_v

private

Referenced by ug::d3f::ManningRoughness1d< dim >::set_v().

m_vmin

template<int dim>

number ug::d3f::ManningRoughness1d< dim >::m_vmin = 1e-6

private

Referenced by ug::d3f::ManningRoughness1d< dim >::evaluate().

---

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

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