ug::GeomProvider< TGeom > Class Template Reference

Geom Provider, holding a single instance of a geometry. More...

#include <geom_provider.h>

Classes
struct	LFEIDandQuadOrder
	struct to sort keys More...

Public Types
typedef TGeom	Type
	type of provided object

Static Public Member Functions
static void	clear ()
	clears all singletons
static TGeom &	get ()
	returns a singleton based on the identifier
static TGeom &	get (const LFEID lfeID, const int quadOrder)
	returns a singleton based on the identifier

Static Public Attributes
static const bool	staticLocalData = TGeom::staticLocalData
	flag indicating if local data may change

Protected Types
typedef std::map< LFEIDandQuadOrder, TGeom * >	MapType
	vector holding instances

Protected Member Functions
	GeomProvider ()
	private constructor
	~GeomProvider ()
	destructor

Static Protected Member Functions
static void	clear_geoms ()
	clears all instances
static TGeom &	get_class (const LFEID lfeID, const int quadOrder)
	returns class based on identifier
static GeomProvider< TGeom > &	inst ()
	singleton provider

Static Protected Attributes
static MapType	m_mLFEIDandOrder = std::map<typename GeomProvider<TGeom>::LFEIDandQuadOrder, TGeom*>()

Detailed Description

template<typename TGeom>
class ug::GeomProvider< TGeom >

Geom Provider, holding a single instance of a geometry.

This class is used to wrap an object into a singleton-like provider, such that construction computations is avoided, if the object is used several times.

In addition, the object can be shared between unrelated code parts, if the same object is intended to be used, but no passing is possible or wanted.

Member Typedef Documentation

MapType

template<typename TGeom >

typedef std::map<LFEIDandQuadOrder, TGeom*> ug::GeomProvider< TGeom >::MapType

protected

vector holding instances

Type

template<typename TGeom >

typedef TGeom ug::GeomProvider< TGeom >::Type

type of provided object

Constructor & Destructor Documentation

GeomProvider()

template<typename TGeom >

ug::GeomProvider< TGeom >::GeomProvider ( )

inlineprotected

private constructor

References ug::GeomProvider< TGeom >::m_mLFEIDandOrder.

~GeomProvider()

template<typename TGeom >

ug::GeomProvider< TGeom >::~GeomProvider ( )

inlineprotected

destructor

References ug::GeomProvider< TGeom >::clear_geoms().

Member Function Documentation

clear()

template<typename TGeom >

static void ug::GeomProvider< TGeom >::clear ( )

inlinestatic

clears all singletons

References ug::GeomProvider< TGeom >::inst().

clear_geoms()

template<typename TGeom >

static void ug::GeomProvider< TGeom >::clear_geoms ( )

inlinestaticprotected

clears all instances

References ug::GeomProvider< TGeom >::m_mLFEIDandOrder.

Referenced by ug::GeomProvider< TGeom >::~GeomProvider().

get() [1/2]

template<typename TGeom >

static TGeom & ug::GeomProvider< TGeom >::get ( )

inlinestatic

returns a singleton based on the identifier

References ug::GeomProvider< TGeom >::inst(), ug::GeomProvider< TGeom >::staticLocalData, and UG_THROW.

Referenced by ug::FV1InnerBoundaryElemDisc< TImpl, TDomain >::add_def_A_elem(), ug::FV1InnerBoundaryElemDisc< TImpl, TDomain >::add_jac_A_elem(), ug::NeumannBoundaryFE< TDomain >::add_rhs_elem(), ug::NeumannBoundaryFV< TDomain >::add_rhs_elem(), ug::NeumannBoundaryFV1< TDomain >::add_rhs_elem(), ug::NeumannBoundaryFE< TDomain >::finish_elem_loop(), ug::NeumannBoundaryFV< TDomain >::finish_elem_loop(), ug::NeumannBoundaryFV1< TDomain >::fsh_elem_loop(), ug::GeomProvider< TGeom >::get(), ug::NeumannBoundaryFE< TDomain >::NumberData::lin_def(), ug::NeumannBoundaryFV< TDomain >::NumberData::lin_def(), ug::NeumannBoundaryFV1< TDomain >::NumberData::lin_def(), ug::FV1InnerBoundaryElemDisc< TImpl, TDomain >::prep_elem(), ug::NeumannBoundaryFE< TDomain >::prep_elem(), ug::NeumannBoundaryFV< TDomain >::prep_elem(), ug::NeumannBoundaryFV1< TDomain >::prep_elem(), ug::FV1InnerBoundaryElemDisc< TImpl, TDomain >::prep_elem_loop(), ug::NeumannBoundaryFE< TDomain >::prep_elem_loop(), ug::NeumannBoundaryFV< TDomain >::prep_elem_loop(), and ug::NeumannBoundaryFV1< TDomain >::prep_elem_loop().

get() [2/2]

template<typename TGeom >

static TGeom & ug::GeomProvider< TGeom >::get ( const LFEID  lfeID, const int  quadOrder  )

inlinestatic

returns a singleton based on the identifier

References ug::GeomProvider< TGeom >::get(), ug::GeomProvider< TGeom >::inst(), and ug::GeomProvider< TGeom >::staticLocalData.

get_class()

template<typename TGeom >

static TGeom & ug::GeomProvider< TGeom >::get_class ( const LFEID  lfeID, const int  quadOrder  )

inlinestaticprotected

returns class based on identifier

References ug::GeomProvider< TGeom >::m_mLFEIDandOrder, and UG_THROW.

inst()

template<typename TGeom >

static GeomProvider< TGeom > & ug::GeomProvider< TGeom >::inst ( )

inlinestaticprotected

singleton provider

References ug::GeomProvider< TGeom >::inst().

Referenced by ug::GeomProvider< TGeom >::clear(), ug::GeomProvider< TGeom >::get(), ug::GeomProvider< TGeom >::get(), and ug::GeomProvider< TGeom >::inst().

Member Data Documentation

m_mLFEIDandOrder

template<typename TGeom >

std::map< typename GeomProvider< TGeom >::LFEIDandQuadOrder, TGeom * > ug::GeomProvider< TGeom >::m_mLFEIDandOrder = std::map<typename GeomProvider<TGeom>::LFEIDandQuadOrder, TGeom*>()

staticprotected

Referenced by ug::GeomProvider< TGeom >::clear_geoms(), ug::GeomProvider< TGeom >::GeomProvider(), and ug::GeomProvider< TGeom >::get_class().

staticLocalData

template<typename TGeom >

const bool ug::GeomProvider< TGeom >::staticLocalData = TGeom::staticLocalData

static

flag indicating if local data may change

If the local data may change due to run-time setting of trial space or quadrature order, we must store one object for each type. In such a case we must store each combination in some data structure and return the correct one based on the identifier.

Referenced by ug::GeomProvider< TGeom >::get(), and ug::GeomProvider< TGeom >::get().

---

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

• ugbase/lib_disc/spatial_disc/disc_util/geom_provider.h