#include <extravol.h>

Public Types
typedef TDomain	domain_type
	type of the domain

typedef TDomain::grid_type	grid_type
	type of the grid (typically Multigrid)

typedef Grid::VertexAttachmentAccessor< t_aFlag >	t_aaFlag
	type of the attachment accessor for the flag

typedef Grid::VertexAttachmentAccessor< t_aVector2 >	t_aaVector2
	type of the attachment accessor for the parts of the flux

typedef ABool	t_aFlag
	type of the attachment for the flags

typedef AVector2	t_aVector2
	type of the attachment for the stiffness and the mass parts of the stabilization

Public Member Functions
void	activate_flags ()
	allocate the attachments for the flags, set the activity flag

void	activate_flux ()
	allocate the attachments for the flux, set the activity flag

bool	flag (const Vertex *vrt)
	get the flag

bool	flags_are_active ()
	whether the flags are active

	FlowVolStabData (SmartPtr< domain_type > dom)
	class constructor

bool	flux_is_active ()
	whether the flux computations are active

number &	mass (const Vertex *vrt)
	access to the mass part

void	reset_flags ()
	clear the flags

void	reset_flux ()
	clear the flux data

void	set_flag (const Vertex *vrt, bool v)
	set the flag

number &	stiff (const Vertex *vrt)
	access to the stiffness part

MathVector< 2 > &	value (const Vertex *vrt)
	access both the parts

Private Attributes
t_aaVector2	m_aExtraVol
	the accessor

t_aaFlag	m_aFlags
	the accessor

bool	m_bFlagsActive
	whether the outflow flags are active, i.e. the attachment for the flags is allocated

bool	m_bFluxActive
	whether flux computations are active, i.e. the attachments for the flux is allocated

t_aVector2	m_extraVol
	the attachment

t_aFlag	m_flags
	the attachment

SmartPtr< domain_type >	m_spDomain
	domain

Detailed Description

template<typename TDomain>
class ug::d3f::FlowVolStabData< TDomain >

A class for accumulating the "volume extension" for the flow equation.

Member Typedef Documentation

◆ domain_type

template<typename TDomain >

typedef TDomain ug::d3f::FlowVolStabData< TDomain >::domain_type

type of the domain

◆ grid_type

template<typename TDomain >

typedef TDomain::grid_type ug::d3f::FlowVolStabData< TDomain >::grid_type

type of the grid (typically Multigrid)

◆ t_aaFlag

template<typename TDomain >

typedef Grid::VertexAttachmentAccessor<t_aFlag> ug::d3f::FlowVolStabData< TDomain >::t_aaFlag

type of the attachment accessor for the flag

◆ t_aaVector2

template<typename TDomain >

typedef Grid::VertexAttachmentAccessor<t_aVector2> ug::d3f::FlowVolStabData< TDomain >::t_aaVector2

type of the attachment accessor for the parts of the flux

◆ t_aFlag

template<typename TDomain >

typedef ABool ug::d3f::FlowVolStabData< TDomain >::t_aFlag

type of the attachment for the flags

◆ t_aVector2

template<typename TDomain >

typedef AVector2 ug::d3f::FlowVolStabData< TDomain >::t_aVector2

type of the attachment for the stiffness and the mass parts of the stabilization

Constructor & Destructor Documentation

◆ FlowVolStabData()

template<typename TDomain >

ug::d3f::FlowVolStabData< TDomain >::FlowVolStabData ( SmartPtr< domain_type > dom )

inline

class constructor

Member Function Documentation

◆ activate_flags()

template<typename TDomain >

void ug::d3f::FlowVolStabData< TDomain >::activate_flags ( )

inline

allocate the attachments for the flags, set the activity flag

References ug::Grid::AttachmentAccessor< class TElem, class TAttachment >::access(), grid(), ug::d3f::FlowVolStabData< TDomain >::m_aFlags, ug::d3f::FlowVolStabData< TDomain >::m_bFlagsActive, ug::d3f::FlowVolStabData< TDomain >::m_flags, and ug::d3f::FlowVolStabData< TDomain >::m_spDomain.

◆ activate_flux()

template<typename TDomain >

void ug::d3f::FlowVolStabData< TDomain >::activate_flux ( )

inline

allocate the attachments for the flux, set the activity flag

References ug::Grid::AttachmentAccessor< class TElem, class TAttachment >::access(), grid(), ug::d3f::FlowVolStabData< TDomain >::m_aExtraVol, ug::d3f::FlowVolStabData< TDomain >::m_bFluxActive, ug::d3f::FlowVolStabData< TDomain >::m_extraVol, and ug::d3f::FlowVolStabData< TDomain >::m_spDomain.

◆ flag()

template<typename TDomain >

bool ug::d3f::FlowVolStabData< TDomain >::flag ( const Vertex * vrt )

inline

get the flag

References ug::d3f::FlowVolStabData< TDomain >::m_aFlags.

◆ flags_are_active()

template<typename TDomain >

bool ug::d3f::FlowVolStabData< TDomain >::flags_are_active ( )

inline

whether the flags are active

References ug::d3f::FlowVolStabData< TDomain >::m_bFlagsActive.

◆ flux_is_active()

template<typename TDomain >

bool ug::d3f::FlowVolStabData< TDomain >::flux_is_active ( )

inline

whether the flux computations are active

References ug::d3f::FlowVolStabData< TDomain >::m_bFluxActive.

◆ mass()

template<typename TDomain >

number & ug::d3f::FlowVolStabData< TDomain >::mass ( const Vertex * vrt )

inline

access to the mass part

References ug::d3f::FlowVolStabData< TDomain >::m_aExtraVol.

◆ reset_flags()

template<typename TDomain >

void ug::d3f::FlowVolStabData< TDomain >::reset_flags ( )

inline

clear the flags

References grid(), ug::d3f::FlowVolStabData< TDomain >::m_aFlags, ug::d3f::FlowVolStabData< TDomain >::m_bFlagsActive, ug::d3f::FlowVolStabData< TDomain >::m_spDomain, and ug::SetAttachmentValues().

◆ reset_flux()

template<typename TDomain >

void ug::d3f::FlowVolStabData< TDomain >::reset_flux ( )

inline

clear the flux data

References grid(), ug::d3f::FlowVolStabData< TDomain >::m_aExtraVol, ug::d3f::FlowVolStabData< TDomain >::m_bFluxActive, ug::d3f::FlowVolStabData< TDomain >::m_spDomain, and ug::SetAttachmentValues().

◆ set_flag()

template<typename TDomain >

void ug::d3f::FlowVolStabData< TDomain >::set_flag	(	const Vertex *	vrt,
		bool	v
	)

inline

set the flag

References ug::d3f::FlowVolStabData< TDomain >::m_aFlags.

◆ stiff()

template<typename TDomain >

number & ug::d3f::FlowVolStabData< TDomain >::stiff ( const Vertex * vrt )

inline

access to the stiffness part

References ug::d3f::FlowVolStabData< TDomain >::m_aExtraVol.

◆ value()

template<typename TDomain >

MathVector< 2 > & ug::d3f::FlowVolStabData< TDomain >::value ( const Vertex * vrt )

inline

access both the parts

References ug::d3f::FlowVolStabData< TDomain >::m_aExtraVol.

Member Data Documentation

◆ m_aExtraVol

template<typename TDomain >

t_aaVector2 ug::d3f::FlowVolStabData< TDomain >::m_aExtraVol

private

the accessor

Referenced by ug::d3f::FlowVolStabData< TDomain >::activate_flux(), ug::d3f::FlowVolStabData< TDomain >::mass(), ug::d3f::FlowVolStabData< TDomain >::reset_flux(), ug::d3f::FlowVolStabData< TDomain >::stiff(), and ug::d3f::FlowVolStabData< TDomain >::value().

◆ m_aFlags

template<typename TDomain >

t_aaFlag ug::d3f::FlowVolStabData< TDomain >::m_aFlags

private

the accessor

Referenced by ug::d3f::FlowVolStabData< TDomain >::activate_flags(), ug::d3f::FlowVolStabData< TDomain >::flag(), ug::d3f::FlowVolStabData< TDomain >::reset_flags(), and ug::d3f::FlowVolStabData< TDomain >::set_flag().

◆ m_bFlagsActive

template<typename TDomain >

bool ug::d3f::FlowVolStabData< TDomain >::m_bFlagsActive

private

whether the outflow flags are active, i.e. the attachment for the flags is allocated

Referenced by ug::d3f::FlowVolStabData< TDomain >::activate_flags(), ug::d3f::FlowVolStabData< TDomain >::flags_are_active(), and ug::d3f::FlowVolStabData< TDomain >::reset_flags().

◆ m_bFluxActive

template<typename TDomain >

bool ug::d3f::FlowVolStabData< TDomain >::m_bFluxActive

private

whether flux computations are active, i.e. the attachments for the flux is allocated

Referenced by ug::d3f::FlowVolStabData< TDomain >::activate_flux(), ug::d3f::FlowVolStabData< TDomain >::flux_is_active(), and ug::d3f::FlowVolStabData< TDomain >::reset_flux().

◆ m_extraVol

template<typename TDomain >

t_aVector2 ug::d3f::FlowVolStabData< TDomain >::m_extraVol

private

the attachment

Referenced by ug::d3f::FlowVolStabData< TDomain >::activate_flux().

◆ m_flags

template<typename TDomain >

t_aFlag ug::d3f::FlowVolStabData< TDomain >::m_flags

private

the attachment

Referenced by ug::d3f::FlowVolStabData< TDomain >::activate_flags().

◆ m_spDomain

template<typename TDomain >

SmartPtr<domain_type> ug::d3f::FlowVolStabData< TDomain >::m_spDomain

private

domain

Referenced by ug::d3f::FlowVolStabData< TDomain >::activate_flags(), ug::d3f::FlowVolStabData< TDomain >::activate_flux(), ug::d3f::FlowVolStabData< TDomain >::reset_flags(), and ug::d3f::FlowVolStabData< TDomain >::reset_flux().

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

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ domain_type

◆ grid_type

◆ t_aaFlag

◆ t_aaVector2

◆ t_aFlag

◆ t_aVector2

Constructor & Destructor Documentation

◆ FlowVolStabData()

Member Function Documentation

◆ activate_flags()

◆ activate_flux()

◆ flag()

◆ flags_are_active()

◆ flux_is_active()

◆ mass()

◆ reset_flags()

◆ reset_flux()

◆ set_flag()

◆ stiff()

◆ value()

Member Data Documentation

◆ m_aExtraVol

◆ m_aFlags

◆ m_bFlagsActive

◆ m_bFluxActive

◆ m_extraVol

◆ m_flags

◆ m_spDomain