Linker for the Bingham viscosity. More...

#include <bingham_viscosity_linker.h>

Inheritance diagram for ug::BinghamViscosityLinker< dim >:

Public Member Functions
	BinghamViscosityLinker ()

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

void	set_density (number val)

void	set_density (SmartPtr< CplUserData< number, dim > > data)
	set density import

void	set_velocity_gradient (SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > > data)
	set velocity gradient import

void	set_viscosity (number val)

void	set_viscosity (SmartPtr< CplUserData< number, dim > > data)
	set viscosity import

void	set_yield_stress (number val)

void	set_yield_stress (SmartPtr< CplUserData< number, dim > > data)
	set density import

Public Member Functions inherited from ug::StdDataLinker< BinghamViscosityLinker< dim >, number, dim >
virtual void	check_setup () const
	returns if data is ok

virtual void	compute (LocalVector u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
	compute values (and derivatives iff compDeriv == true)

virtual void	compute (LocalVectorTimeSeries u, GridObject elem, const MathVector< dim > vCornerCoords[], bool bDeriv=false)
	compute values (and derivatives iff compDeriv == true, but only for the 'current' time point)

virtual bool	continuous () const
	returns if provided data is continuous over geometric object boundaries

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

virtual SmartPtr< ICplUserData< dim > >	needed_data (size_t i)
	return needed data

virtual size_t	num_input () const
	number of inputs

virtual size_t	num_needed_data () const
	number of other Data this data depends on

virtual void	operator() (number &value, const MathVector< dim > &globIP, number time, int si) const
	returns value for a global position

virtual void	operator() (number vValue[], const MathVector< dim > vGlobIP[], number time, int si, const size_t nip) const
	returns value for global positions

virtual bool	requires_grid_fct () const
	returns that a grid function is needed for evaluation

virtual void	set_function_pattern (ConstSmartPtr< FunctionPattern > fctPatt)
	updates the function group

virtual void	set_input (size_t i, SmartPtr< ICplUserData< dim > > input, SmartPtr< UserDataInfo > info)
	sets an input

void	set_num_input (size_t num)
	sets the number of inputs

virtual bool	zero_derivative () const
	returns if derivative is zero

bool	zero_derivative (size_t i) const
	returns if the derivative of the i'th input is zero

Public Member Functions inherited from ug::StdUserData< TImpl, TData, dim, TRet, TBase >
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< 3 > vLocIP[], const size_t nip, LocalVector u, const MathMatrix< 3, dim > *vJT=NULL) const

Public Member Functions inherited from ug::CplUserData< TData, dim, TRet >
bool	defined (size_t s, size_t ip) const
	returns flag, if data is evaluated (for conditional data)

size_t	num_ip (size_t s) const
	returns the number of integration points

size_t	num_series () const
	explicitly forward some functions

void	register_storage_callback (DataImport< TData, dim > obj, void(DataImport< TData, dim >::func)())
	register external callback, invoked when data storage changed

void	unregister_storage_callback (DataImport< TData, dim > *obj)
	register all callbacks registered by class

TData &	value (size_t s, size_t ip)
	returns the value at ip

const TData &	value (size_t s, size_t ip) const
	returns the value at ip

TData *	values (size_t s)
	returns all values for a series

const TData *	values (size_t s) const
	returns all values for a series

	~CplUserData ()
	destructor

Public Member Functions inherited from ug::ICplUserData< dim >
bool	at_current_time (size_t s) const
	returns true iff the time point specification is equal to the current one, or not specified

void	clear ()
	clear all data

virtual bool	constant () const
	returns if data is constant

int	dim_local_ips () const
	returns current local ip dimension

	ICplUserData ()
	default constructor

const MathVector< dim > &	ip (size_t s, size_t ip) const
	returns global ip

const MathVector< dim > *	ips (size_t s) const
	returns global ips

template<int ldim>
const MathVector< ldim > &	local_ip (size_t s, size_t ip) const
	returns local ip

template<int ldim>
const MathVector< ldim > *	local_ips (size_t s) const
	returns local ips

size_t	num_ip (size_t s) const
	returns the number of integration points

size_t	num_series () const
	returns the number of ip series

template<int ldim>
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, bool bMayChange=true)
	set local positions without the specification of the time point, returns series id

template<int ldim>
size_t	register_local_ip_series (const MathVector< ldim > *vPos, const size_t numIP, const int timePointSpec, bool bMayChange=true)
	set local positions, returns series id

void	set_global_ips (size_t s, const MathVector< dim > *vPos, size_t numIP)
	set global positions

template<int ldim>
void	set_local_ips (const size_t seriesId, const MathVector< ldim > *vPos, const size_t numIP)
	sets new local ip positions for a local ip series

void	set_subset (int si)
	set the subset of evaluation

void	set_time_point (const size_t seriesId, const int timePointSpec)
	sets a new time point for a local ip series

void	set_time_point (size_t timePoint)
	sets the current time point

void	set_times (const std::vector< number > &vTime)
	set evaluation time

int	subset () const
	returns the subset of evaluation

number	time () const
	get the current evaluation time

number	time (size_t s) const
	get the specified evaluation time

size_t	time_point ()
	returns the current time point

size_t	time_point (size_t s) const
	returns the time point specification (in particular, the current one, if the own one not specified)

int	time_point_specification (size_t s) const
	returns the time point specification (note: it may be -1, i.e. not specified)

virtual void	update_dof_sizes (const LocalIndices &ind)
	resize arrays

virtual	~ICplUserData ()
	virtual desctructor

Public Member Functions inherited from ug::UserDataInfo
const FunctionGroup &	function_group () const
	Function Group of functions.

const FunctionIndexMapping &	map () const
	get function mapping

size_t	num_fct () const
	number of functions this export depends on

const char *	obj_name ()
	gets the name of the object (s. the field m_objName)

void	set_obj_name (const char *name)
	sets the name of the object (s. the field m_objName)

virtual	~UserDataInfo ()
	virtual destructor

Public Member Functions inherited from ug::UserData< TData, dim, TRet >
int	get_dim () const
	returns dimension

virtual void	operator() (TData &value, const MathVector< dim > &globIP, number time, int si, Vertex *vrt) const
	returns a value at a vertex

std::string	type () const
	returns type of data as string (e.g. "Number", "Vector", "Matrix")

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< 3 > &locIP, LocalVector u) const

Protected Attributes
SmartPtr< DependentUserData< number, dim > >	m_spDDensity

SmartPtr< CplUserData< number, dim > >	m_spDensity

SmartPtr< DependentUserData< MathMatrix< dim, dim >, dim > >	m_spDVelocityGrad

SmartPtr< DependentUserData< number, dim > >	m_spDViscosity

SmartPtr< DependentUserData< number, dim > >	m_spDYieldStress

SmartPtr< CplUserData< MathMatrix< dim, dim >, dim > >	m_spVelocityGrad

SmartPtr< CplUserData< number, dim > >	m_spViscosity

SmartPtr< CplUserData< number, dim > >	m_spYieldStress

Protected Attributes inherited from ug::StdDataLinker< BinghamViscosityLinker< dim >, number, dim >
std::vector< FunctionIndexMapping >	m_vMap
	Function mapping for each input relative to common FunctionGroup.

std::vector< SmartPtr< ICplUserData< dim > > >	m_vspICplUserData
	data input

std::vector< SmartPtr< UserDataInfo > >	m_vspUserDataInfo
	data input casted to IDependend data

std::vector< std::vector< size_t > >	m_vvSeriesID
	series id the linker uses to get data from input

Protected Attributes inherited from ug::ICplUserData< dim >
int	m_defaultTimePoint
	default time point (or -1 if not specified)

int	m_locPosDim
	dimension of local position (-1 indicates no dim set)

std::vector< const MathVector< 1 > * >	m_pvLocIP1d
	local ips of dimension 1d-3d

std::vector< const MathVector< 2 > * >	m_pvLocIP2d

std::vector< const MathVector< 3 > * >	m_pvLocIP3d

int	m_si
	subset for evaluation

size_t	m_timePoint
	current time point (used if no explicit specification for series)

std::vector< bool >	m_vMayChange
	flags if local ips may change

std::vector< size_t >	m_vNumIP
	number of evaluation points (-1 indicates no ips set)

std::vector< number >	m_vTime
	time for evaluation

std::vector< int >	m_vTimePoint
	time points for the series

std::vector< const MathVector< dim > * >	m_vvGlobPos
	global ips

Protected Attributes inherited from ug::UserDataInfo
FunctionGroup	m_fctGrp
	functions the data depends on

FunctionIndexMapping	m_map
	Mapping for import fct.

SmartPtr< char >	m_objName
	This field is used mainly for debugging: One can assign a name to the object to identify it when running.

Static Protected Attributes
static const size_t	_DV_ = 3
	import for velocity gradient

static const size_t	_ETA_ = 1
	import for viscosity

static const size_t	_RHO_ = 0
	import for density

static const size_t	_TAU_ = 2
	import for yield stress

Private Types
typedef StdDataLinker< BinghamViscosityLinker< dim >, number, dim >	base_type

Additional Inherited Members
Public Types inherited from ug::CplUserData< TData, dim, TRet >
typedef ICplUserData< dim >	base_type
	type of base class

Public Types inherited from ug::UserData< TData, dim, TRet >
typedef TData	data_type

typedef TRet	return_type

Protected Member Functions inherited from ug::StdDataLinker< BinghamViscosityLinker< 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)

BinghamViscosityLinker< dim > &	getImpl ()
	access to implementation

const BinghamViscosityLinker< dim > &	getImpl () const
	const access to implementation

virtual void	global_ips_changed (const size_t seriesID, const MathVector< dim > *vPos, const size_t numIP)
	forwards the global positions to the data inputs

size_t	input_common_fct (size_t i, size_t fct) const
	returns the number in the common FctGrp for a fct of an input

size_t	input_num_fct (size_t i) const
	returns number of functions the input depends on

virtual void	local_ip_series_added (const size_t seriesID)
	requests series id's from input data

virtual void	local_ip_series_to_be_cleared ()
	requests cleaning of the ip series in the data inputs

virtual void	local_ips_changed (const size_t seriesID, const size_t newNumIP)
	forwards the local positions to the data inputs

size_t	series_id (size_t i, size_t s) const
	returns the series id set for the i'th input

Protected Member Functions inherited from ug::StdUserData< TImpl, TData, dim, TRet, TBase >
TImpl &	getImpl ()
	access to implementation

const TImpl &	getImpl () const
	const access to implementation

Protected Member Functions inherited from ug::CplUserData< TData, dim, TRet >
void	call_storage_callback () const
	calls are registered external storage callbacks

void	check_series (size_t s) const
	checks in debug mode the correct index

void	check_series_ip (size_t s, size_t ip) const
	checks in debug mode the correct index

virtual void	value_storage_changed (const size_t seriesID)
	callback, invoked when storage of data has changed for a series

Protected Member Functions inherited from ug::ICplUserData< dim >
void	check_s (size_t s) const
	checks in debug mode the correct usage of indices

void	check_s_ip (size_t s, size_t ip) const
	checks in debug mode the correct usage of indices

std::vector< const MathVector< 1 > * > &	get_local_ips (Int2Type< 1 >)
	help function to get local ips

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

Detailed Description

template<int dim>
class ug::BinghamViscosityLinker< dim >

Linker for the Bingham viscosity.

This linker computes the Bingham viscosity \( \mathbf{q} = - \frac{\mathbf{K}}{\mu} ( \nabla p - \rho \mathbf{g} ) \), where

\( \mathbf{K} \) permeability
\( \mu \) viscosity
\( \rho \) density
\( \mathbf{g} \) gravity
\( \nabla p \) pressure gradient

are input parameters.

Member Typedef Documentation

◆ base_type

template<int dim>

typedef StdDataLinker< BinghamViscosityLinker<dim>, number, dim> ug::BinghamViscosityLinker< dim >::base_type

private

Constructor & Destructor Documentation

◆ BinghamViscosityLinker()

template<int dim>

ug::BinghamViscosityLinker< dim >::BinghamViscosityLinker ( )

inline

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

Member Function Documentation

◆ eval_and_deriv()

template<int dim>

template<int refDim>

void ug::BinghamViscosityLinker< 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

◆ evaluate() [1/2]

template<int dim>

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

inline

References ug::ICplUserData< dim >::time(), UG_LOG, and ug::CplUserData< TData, dim, TRet >::value().

◆ evaluate() [2/2]

template<int dim>

template<int refDim>

void ug::BinghamViscosityLinker< 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