Spatial linker that exposes exchange fluxes stored on 1D edges. More...

#include <add_river_sss.h>

Inheritance diagram for ug::d3f::ExfiltrationFlux< TDomain >:

Public Types
typedef TGrid::template EdgeAttachmentAccessor< ANumber >	accessor_type

typedef TDomain::grid_type	TGrid

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

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
	Retrieves the flux value for a given 1D edge element.

	ExfiltrationFlux (accessor_type &acc)

bool	requires_grid_fct () const

Public Member Functions inherited from ug::StdDataLinker< ExfiltrationFlux< TDomain >, number, TDomain::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

Static Public Attributes
static const int	dim = TDomain::dim

Private Attributes
accessor_type &	m_acc

Additional Inherited Members
Protected Member Functions inherited from ug::StdDataLinker< ExfiltrationFlux< TDomain >, number, TDomain::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< ExfiltrationFlux< TDomain >, number, TDomain::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<typename TDomain>
class ug::d3f::ExfiltrationFlux< TDomain >

Spatial linker that exposes exchange fluxes stored on 1D edges.

This class allows the 1D St. Venant solver to "read" the exchange fluxes that were computed during the 3D subsurface assembly. The fluxes are retrieved from an EdgeAttachment.

Template Parameters

TDomain The 1D domain type.

Member Typedef Documentation

◆ accessor_type

template<typename TDomain >

typedef TGrid::template EdgeAttachmentAccessor<ANumber> ug::d3f::ExfiltrationFlux< TDomain >::accessor_type

◆ TGrid

template<typename TDomain >

typedef TDomain::grid_type ug::d3f::ExfiltrationFlux< TDomain >::TGrid

Constructor & Destructor Documentation

◆ ExfiltrationFlux()

template<typename TDomain >

ug::d3f::ExfiltrationFlux< TDomain >::ExfiltrationFlux ( accessor_type & acc )

inlineexplicit

Member Function Documentation

◆ eval_and_deriv()

template<typename TDomain >

template<int refDim>

void ug::d3f::ExfiltrationFlux< TDomain >::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

References ug::ICplUserData< int dim >::time().

◆ evaluate() [1/2]

template<typename TDomain >

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

inline

References UG_THROW.

◆ evaluate() [2/2]

template<typename TDomain >

template<int refDim>

void ug::d3f::ExfiltrationFlux< TDomain >::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

Retrieves the flux value for a given 1D edge element.

References ug::ICplUserData< int dim >::ip(), and ug::d3f::ExfiltrationFlux< TDomain >::m_acc.

◆ requires_grid_fct()

template<typename TDomain >

bool ug::d3f::ExfiltrationFlux< TDomain >::requires_grid_fct ( ) const

inlinevirtual

Reimplemented from ug::StdDataLinker< ExfiltrationFlux< TDomain >, number, TDomain::dim >.

Member Data Documentation

◆ dim

template<typename TDomain >

const int ug::d3f::ExfiltrationFlux< TDomain >::dim = TDomain::dim

static

◆ m_acc

template<typename TDomain >

accessor_type& ug::d3f::ExfiltrationFlux< TDomain >::m_acc

private

Referenced by ug::d3f::ExfiltrationFlux< TDomain >::evaluate().

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

/home/runner/work/docs/docs/ug4/plugins/d3f/river_networks/add_river_sss.h

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ accessor_type

◆ TGrid

Constructor & Destructor Documentation

◆ ExfiltrationFlux()

Member Function Documentation

◆ eval_and_deriv()

◆ evaluate() [1/2]

◆ evaluate() [2/2]

◆ requires_grid_fct()

Member Data Documentation

◆ dim

◆ m_acc