Class for the computation of the enhanced version ('Frolkovic-type') of the consistent gravity. More...

#include <consistent_gravity.h>

Inheritance diagram for ug::StdLinConsistentGravityX< refDim >:

Public Member Functions
template<int dim>
void	compute (MathVector< dim > &ConsistentGravity, const MathVector< refDim > &LocalCoord, const MathMatrix< dim, refDim > &JTInv, const MathVector< refDim > vLocalGrad, const MathVector< refDim > vConsGravity)
	computation of the consistent gravity at a given point

void	prepare (MathVector< 2 > vConsGravity, const int n_co, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	spacialization of the method for faces (reference dimension 2)

void	prepare (MathVector< 3 > vConsGravity, const int n_co, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	spacialization of the method for volumes (reference dimension 3)

template<int dim>
void	prepare (MathVector< refDim > vConsGravity, const int n_co, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners, cf. the specializations

	StdLinConsistentGravityX ()
	constructor

Public Member Functions inherited from ug::StdLinConsistentGravity< refDim >
template<int dim>
void	compute (MathVector< dim > &ConsistentGravity, const MathVector< refDim > &LocalCoord, const MathMatrix< dim, refDim > &JTInv, const MathVector< refDim > vLocalGrad, const MathVector< refDim > vConsGravity)
	computation of the consistent gravity at a given point

void	prepare (MathVector< 1 > vConsGravity, const int n_co, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	spacialization of the method for edges (reference dimension 1)

void	prepare (MathVector< 2 > vConsGravity, const int n_co, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	spacialization of the method for faces (reference dimension 2)

void	prepare (MathVector< 3 > vConsGravity, const int n_co, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	spacialization of the method for volumes (reference dimension 3)

template<int dim>
void	prepare (MathVector< refDim > vConsGravity, const int n_co, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners, cf. the specializations

	StdLinConsistentGravity ()
	constructor (sets the 'not init.' flag)

Protected Member Functions
template<typename refElem , int dim>
void	prepare_simplex (MathVector< refDim > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the extended version of the corner consistent gravity for simplices (only in full dimension!)

Protected Member Functions inherited from ug::StdLinConsistentGravity< refDim >
template<int dim>
void	prepare_edge (MathVector< 1 > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners of an edge

template<int dim>
void	prepare_hexahedron (MathVector< 3 > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners of a hexahedron

template<int dim>
void	prepare_prism (MathVector< 3 > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners of a prism

template<int dim>
void	prepare_pyramid (MathVector< 3 > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners of a pyramid

template<int dim>
void	prepare_quadrilateral (MathVector< 2 > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners of a quadrilateral

template<int dim>
void	prepare_tetrahedron (MathVector< 3 > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners of a tetrahedron

template<int dim>
void	prepare_triangle (MathVector< 2 > vConsGravity, const MathVector< dim > vCorners, const number *vDensity, const MathVector< dim > &PhysicalGravity)
	computation of the primary function for the consistent gravity at corners of a triangle

Private Types
typedef StdLinConsistentGravity< refDim >	base_type

Additional Inherited Members
Protected Attributes inherited from ug::StdLinConsistentGravity< refDim >
int	m_nCo
	number of corners of the element for which the object is init. (0 if not init)

Detailed Description

template<int refDim>
class ug::StdLinConsistentGravityX< refDim >

Class for the computation of the enhanced version ('Frolkovic-type') of the consistent gravity.

Implementation of the enhanced ('Frolkovic-type') version of the consistent gravity for simplices (triangles and tetrahedra) in the case of the gravity force parallel to the z-axis. For all other elements and other gravities, the same method as in StdLinConsistentGravity is used.

See also: StdLinConsistentGravity

References:

P. Frolkovic, Consistent velocity approximation for density driven flow and transport, In: Advanced Computational Methods in Engineering, Part 2: Contributed papers; (R. Van Keer at al., eds.), Shaker Publishing, Maastricht, 1998, p. 603-611

Template Parameters

refDim dimensionality of the reference element (e.g. 2 for triangles, 3 for tetrahedra)

Member Typedef Documentation

◆ base_type

template<int refDim>

typedef StdLinConsistentGravity<refDim> ug::StdLinConsistentGravityX< refDim >::base_type

private

Constructor & Destructor Documentation

◆ StdLinConsistentGravityX()

template<int refDim>

ug::StdLinConsistentGravityX< refDim >::StdLinConsistentGravityX ( )

inline

constructor

Member Function Documentation

◆ compute()

template<int refDim>

template<int dim>

void ug::StdLinConsistentGravityX< refDim >::compute	(	MathVector< dim > &	ConsistentGravity,
		const MathVector< refDim > &	LocalCoord,
		const MathMatrix< dim, refDim > &	JTInv,
		const MathVector< refDim > *	vLocalGrad,
		const MathVector< refDim > *	vConsGravity
	)

inline

computation of the consistent gravity at a given point

Parameters

ConsistentGravity	where to save the vector
LocalCoord	local coordinates of the point
JTInv	inverse transposed Jacobian
vLocalGrad	gradients of the shape functions at the given point
vConsGravity	primary function of the consistent gravity at corners

References ug::MatVecMult(), UG_ASSERT, and ug::VecSet().

◆ prepare() [1/3]

void ug::StdLinConsistentGravityX< 2 >::prepare	(	MathVector< 2 > *	vConsGravity,
		const int	n_co,
		const MathVector< dim > *	vCorners,
		const number *	vDensity,
		const MathVector< dim > &	PhysicalGravity
	)

spacialization of the method for faces (reference dimension 2)

Parameters

vConsGravity	where to save the values (n_co vectors)
n_co	number of corners of the element
vCorners	(global) coordinates of the corners (n_co vectors)
vDensity	corner density (n_co scalar values)
PhysicalGravity	the gravity vector

◆ prepare() [2/3]

void ug::StdLinConsistentGravityX< 3 >::prepare	(	MathVector< 3 > *	vConsGravity,
		const int	n_co,
		const MathVector< dim > *	vCorners,
		const number *	vDensity,
		const MathVector< dim > &	PhysicalGravity
	)

spacialization of the method for volumes (reference dimension 3)

Parameters

vConsGravity	where to save the values (n_co vectors)
n_co	number of corners of the element
vCorners	(global) coordinates of the corners (n_co vectors)
vDensity	corner density (n_co scalar values)
PhysicalGravity	the gravity vector

◆ prepare() [3/3]

template<int refDim>

template<int dim>

void ug::StdLinConsistentGravityX< refDim >::prepare	(	MathVector< refDim > *	vConsGravity,
		const int	n_co,
		const MathVector< dim > *	vCorners,
		const number *	vDensity,
		const MathVector< dim > &	PhysicalGravity
	)

inline

computation of the primary function for the consistent gravity at corners, cf. the specializations

Parameters

vConsGravity	where to save the values (n_co vectors)
n_co	number of corners of the element
vCorners	(global) coordinates of the corners (n_co vectors)
vDensity	corner density (n_co scalar values)
PhysicalGravity	the gravity vector

◆ prepare_simplex()

template<int refDim>

template<typename refElem , int dim>

void ug::StdLinConsistentGravityX< refDim >::prepare_simplex	(	MathVector< refDim > *	vConsGravity,
		const MathVector< dim > *	vCorners,
		const number *	vDensity,
		const MathVector< dim > &	PhysicalGravity
	)

inlineprotected

computation of the extended version of the corner consistent gravity for simplices (only in full dimension!)

Parameters

vConsGravity	where to save the values (dim+1 vectors)
vCorners	(global) coordinates of the corners (dim+1 vectors)
vDensity	corner density (dim+1 scalar values)
PhysicalGravity	the gravity vector (MUST BE (0, ..., 0, g))

References ug::ReferenceMapping< TRefElem, TWorldDim >::jacobian_transposed_inverse(), ug::TransposedMatVecMult(), ug::ReferenceMapping< TRefElem, TWorldDim >::update(), and ug::VecSubtract().

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

ugbase/lib_disc/spatial_disc/disc_util/consistent_gravity.h

Public Member Functions

Protected Member Functions

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base_type

Constructor & Destructor Documentation

◆ StdLinConsistentGravityX()

Member Function Documentation

◆ compute()

◆ prepare() [1/3]

◆ prepare() [2/3]

◆ prepare() [3/3]

◆ prepare_simplex()