class for data for all the river sources and sinks More...

#include <d3f_sss.h>

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

Public Member Functions
number	bottom_thickness () const
	returns bottom thickness

void	compute (const MathVector< dim > &x, number time, int si)
	computes the data from the user data object

number	concentration ()
	returns the concentration

number &	exchange_flux ()
	reference to exchange flux

Edge *	get_edge () const

number	intensity ()
	returns the intensity

number	matrix_permeability () const

number	relative_bottom_permeability ()
	returns the relative bottom permeability

	river_sss_data ()
	class construction (there must exist a 'dummy' constructor!)

void	set (LuaFunctionHandle func)
	set as a LUA function

void	set (number intens, number c, number perm, number width=1.0, number thickness=1.0)
	sets the data

void	set (SmartPtr< UserData< MathVector< 3 >, dim > > spData)
	sets the data by an object

void	set_edge (Edge *edge)

void	set_matrix_permeability (number k)

number	width () const
	returns width

Private Attributes
number	m_bottom_thickness

Edge *	m_edge

number	m_exchange_flux

number	m_matrix_permeability

SmartPtr< UserData< MathVector< 3 >, dim > >	m_spData
	an alternative method to specify the data

MathVector< 3 >	m_values

number	m_width

Detailed Description

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

class for data for all the river sources and sinks

Constructor & Destructor Documentation

◆ river_sss_data()

template<int dim>

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

inline

class construction (there must exist a 'dummy' constructor!)

References ug::d3f::river_sss_data< dim >::m_values.

Member Function Documentation

◆ bottom_thickness()

template<int dim>

number ug::d3f::river_sss_data< dim >::bottom_thickness ( ) const

inline

returns bottom thickness

References ug::d3f::river_sss_data< dim >::m_bottom_thickness.

◆ compute()

template<int dim>

void ug::d3f::river_sss_data< dim >::compute	(	const MathVector< dim > &	x,
		number	time,
		int	si
	)

inline

computes the data from the user data object

Parameters

x	point where to evaluate
time	time argument for the evaluation
si	subset where to evaluate

References ug::d3f::river_sss_data< dim >::m_spData, and ug::d3f::river_sss_data< dim >::m_values.

◆ concentration()

template<int dim>

number ug::d3f::river_sss_data< dim >::concentration ( )

inline

returns the concentration

References ug::d3f::river_sss_data< dim >::m_values.

◆ exchange_flux()

template<int dim>

number & ug::d3f::river_sss_data< dim >::exchange_flux ( )

inline

reference to exchange flux

References ug::d3f::river_sss_data< dim >::m_exchange_flux.

◆ get_edge()

template<int dim>

Edge * ug::d3f::river_sss_data< dim >::get_edge ( ) const

inline

References ug::d3f::river_sss_data< dim >::m_edge.

◆ intensity()

template<int dim>

number ug::d3f::river_sss_data< dim >::intensity ( )

inline

returns the intensity

References ug::d3f::river_sss_data< dim >::m_values.

◆ matrix_permeability()

template<int dim>

number ug::d3f::river_sss_data< dim >::matrix_permeability ( ) const

inline

References ug::d3f::river_sss_data< dim >::m_matrix_permeability.

◆ relative_bottom_permeability()

template<int dim>

number ug::d3f::river_sss_data< dim >::relative_bottom_permeability ( )

inline

returns the relative bottom permeability

References ug::d3f::river_sss_data< dim >::m_values.

◆ set() [1/3]

template<int dim>

void ug::d3f::river_sss_data< dim >::set ( LuaFunctionHandle func )

inline

set as a LUA function

References ug::d3f::river_sss_data< dim >::m_spData, and make_sp().

◆ set() [2/3]

template<int dim>

void ug::d3f::river_sss_data< dim >::set	(	number	intens,
		number	c,
		number	perm,
		number	width = `1.0`,
		number	thickness = `1.0`
	)

inline

sets the data

References ug::d3f::river_sss_data< dim >::m_bottom_thickness, ug::d3f::river_sss_data< dim >::m_spData, ug::d3f::river_sss_data< dim >::m_values, ug::d3f::river_sss_data< dim >::m_width, SPNULL, and ug::d3f::river_sss_data< dim >::width().

◆ set() [3/3]

template<int dim>

void ug::d3f::river_sss_data< dim >::set ( SmartPtr< UserData< MathVector< 3 >, dim > > spData )

inline

sets the data by an object

References ug::d3f::river_sss_data< dim >::m_spData.

◆ set_edge()

template<int dim>

void ug::d3f::river_sss_data< dim >::set_edge ( Edge * edge )

inline

References ug::d3f::river_sss_data< dim >::m_edge.

◆ set_matrix_permeability()

template<int dim>

void ug::d3f::river_sss_data< dim >::set_matrix_permeability ( number k )

inline

References ug::d3f::river_sss_data< dim >::m_matrix_permeability.

◆ width()

template<int dim>

number ug::d3f::river_sss_data< dim >::width ( ) const

inline

returns width

References ug::d3f::river_sss_data< dim >::m_width.

Referenced by ug::d3f::river_sss_data< dim >::set().

Member Data Documentation

◆ m_bottom_thickness

template<int dim>

number ug::d3f::river_sss_data< dim >::m_bottom_thickness

private

Referenced by ug::d3f::river_sss_data< dim >::bottom_thickness(), and ug::d3f::river_sss_data< dim >::set().

◆ m_edge

template<int dim>

Edge* ug::d3f::river_sss_data< dim >::m_edge

private

Referenced by ug::d3f::river_sss_data< dim >::get_edge(), and ug::d3f::river_sss_data< dim >::set_edge().

◆ m_exchange_flux

template<int dim>

number ug::d3f::river_sss_data< dim >::m_exchange_flux

private

Referenced by ug::d3f::river_sss_data< dim >::exchange_flux().

◆ m_matrix_permeability

template<int dim>

number ug::d3f::river_sss_data< dim >::m_matrix_permeability

private

Referenced by ug::d3f::river_sss_data< dim >::matrix_permeability(), and ug::d3f::river_sss_data< dim >::set_matrix_permeability().

◆ m_spData

template<int dim>

SmartPtr<UserData<MathVector<3>, dim> > ug::d3f::river_sss_data< dim >::m_spData

private

an alternative method to specify the data

Referenced by ug::d3f::river_sss_data< dim >::compute(), ug::d3f::river_sss_data< dim >::set(), ug::d3f::river_sss_data< dim >::set(), and ug::d3f::river_sss_data< dim >::set().

◆ m_values

template<int dim>

MathVector<3> ug::d3f::river_sss_data< dim >::m_values

private

the data for the source/sink: [0]: river water column [1]: concentration of the salt in the source (used only if intensity > 0) [2]: bottom layer permeability

Referenced by ug::d3f::river_sss_data< dim >::compute(), ug::d3f::river_sss_data< dim >::concentration(), ug::d3f::river_sss_data< dim >::intensity(), ug::d3f::river_sss_data< dim >::relative_bottom_permeability(), ug::d3f::river_sss_data< dim >::river_sss_data(), and ug::d3f::river_sss_data< dim >::set().

◆ m_width

template<int dim>

number ug::d3f::river_sss_data< dim >::m_width

private

Referenced by ug::d3f::river_sss_data< dim >::set(), and ug::d3f::river_sss_data< dim >::width().

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

/home/runner/work/docs/docs/ug4/plugins/d3f/d3f_sss.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ river_sss_data()

Member Function Documentation

◆ bottom_thickness()

◆ compute()

◆ concentration()

◆ exchange_flux()

◆ get_edge()

◆ intensity()

◆ matrix_permeability()

◆ relative_bottom_permeability()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ set_edge()

◆ set_matrix_permeability()

◆ width()

Member Data Documentation

◆ m_bottom_thickness

◆ m_edge

◆ m_exchange_flux

◆ m_matrix_permeability

◆ m_spData

◆ m_values

◆ m_width