Associates different projectors with individual subsets. More...

#include <projection_handler.h>

Inheritance diagram for ug::ProjectionHandler:

Public Member Functions
void	clear ()

SPRefinementProjector	default_projector ()

ConstSmartPtr< RefinementProjector >	default_projector () const

virtual number	new_vertex (Vertex vrt, Edge parent)
	called when a new vertex was created from an old edge.

virtual number	new_vertex (Vertex vrt, Face parent)
	called when a new vertex was created from an old face.

virtual number	new_vertex (Vertex vrt, Vertex parent)
	called when a new vertex was created from an old vertex.

virtual number	new_vertex (Vertex vrt, Volume parent)
	called when a new vertex was created from an old volume.

size_t	num_projectors () const

	ProjectionHandler ()

template<class TGeomProvider >
	ProjectionHandler (const TGeomProvider &geometry, SmartPtr< ISubsetHandler > psh)

	ProjectionHandler (ISubsetHandler *psh)

	ProjectionHandler (SmartPtr< ISubsetHandler > psh)

	ProjectionHandler (SPIGeometry3d geometry, ISubsetHandler *psh)

SPRefinementProjector	projector (size_t i)

ConstSmartPtr< RefinementProjector >	projector (size_t i) const

virtual void	refinement_begins (const ISubGrid *psg)
	prepares associated projectors for refinement

virtual bool	refinement_begins_requires_subgrid () const

virtual void	refinement_ends ()
	called when refinement is done

void	set_default_projector (SPRefinementProjector projector)

virtual void	set_geometry (SPIGeometry3d geometry)

virtual void	set_geometry_all (SPIGeometry3d geometry)
	Sets the geometry of the ProjectionHandler and of all associated projectors.

void	set_projector (const char *subsetName, SPRefinementProjector projector)
	associate a projector with a subset of the given name.

void	set_projector (int subsetIndex, SPRefinementProjector projector)
	associate a projector with a given subsetIndex. Note that '-1' is a valid index, too.

void	set_subset_handler (ISubsetHandler *psh)

void	set_subset_handler (SmartPtr< ISubsetHandler > psh)

const ISubsetHandler *	subset_handler () const
	return the subset handler that the projection handler is based on

virtual	~ProjectionHandler ()

Public Member Functions inherited from ug::RefinementProjector
virtual SPIGeometry3d	geometry () const

	RefinementProjector ()

	RefinementProjector (SPElementCallback cb)

	RefinementProjector (SPIGeometry3d geometry)

	RefinementProjector (SPIGeometry3d geometry, SPElementCallback concernedElems)

virtual void	set_concerned_elements (SPElementCallback cb)

virtual	~RefinementProjector ()

Private Member Functions
template<class TParent >
number	handle_new_vertex (Vertex vrt, TParent parent)

void	projector_required (int index)

Private Attributes
SmartPtr< RefinementProjector >	m_defaultProjector

std::vector< SmartPtr< RefinementProjector > >	m_projectors

ISubsetHandler *	m_sh

SmartPtr< ISubsetHandler >	m_spSH

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Member Functions inherited from ug::RefinementProjector
IGeometry3d &	geom ()

const IGeometry3d &	geom () const

template<class TElem >
bool	is_concerned (TElem *e)

vector3	pos (Vertex *v) const

void	set_pos (Vertex *v, const vector3 &p)

Detailed Description

Associates different projectors with individual subsets.

In many cases it is useful to use different RefinementProjectors on different parts of a grid. To do so one may use a SubsetHandler to partition the grid into different parts. This SubsetHandler can then be passed to the ProjectionHandler and different RefinementProjectors can be associated with each subset through 'set_projector'.

Constructor & Destructor Documentation

◆ ProjectionHandler() [1/5]

ug::ProjectionHandler::ProjectionHandler ( )

References m_defaultProjector, and make_sp().

◆ ProjectionHandler() [2/5]

ug::ProjectionHandler::ProjectionHandler ( ISubsetHandler * psh )

Please makre sure that the given subset-handler outlives the ProjectionHandler. Please note that an alternative constructor taking a smart-pointer to a SubsetHandler exists.

See also: ug::RefinementProjector::RefinementProjector

References m_defaultProjector, and make_sp().

◆ ProjectionHandler() [3/5]

ug::ProjectionHandler::ProjectionHandler ( SmartPtr< ISubsetHandler > psh )

See also: ug::RefinementProjector::RefinementProjector

References m_defaultProjector, and make_sp().

◆ ProjectionHandler() [4/5]

ug::ProjectionHandler::ProjectionHandler	(	SPIGeometry3d	geometry,
		ISubsetHandler *	psh
	)

Please makre sure that the given subset-handler outlives the ProjectionHandler. Please note that an alternative constructor taking a smart-pointer to a SubsetHandler exists.

See also: ug::RefinementProjector::RefinementProjector

References m_defaultProjector, and make_sp().

◆ ProjectionHandler() [5/5]

template<class TGeomProvider >

ug::ProjectionHandler::ProjectionHandler	(	const TGeomProvider &	geometry,
		SmartPtr< ISubsetHandler >	psh
	)

inline

See also: ug::RefinementProjector::RefinementProjector

References m_defaultProjector, and make_sp().

◆ ~ProjectionHandler()

ug::ProjectionHandler::~ProjectionHandler ( )

virtual

Member Function Documentation

◆ clear()

void ug::ProjectionHandler::clear ( )

References m_defaultProjector, m_projectors, and make_sp().

Referenced by ug::DeserializeProjectionHandler().

◆ default_projector() [1/2]

SPRefinementProjector ug::ProjectionHandler::default_projector ( )

inline

References m_defaultProjector.

Referenced by ug::GridWriterUGX::add_projection_handler(), ug::IDomain< TGrid, TSubsetHandler >::broadcast_refinement_projector(), and ug::SerializeProjectionHandler().

◆ default_projector() [2/2]

ConstSmartPtr< RefinementProjector > ug::ProjectionHandler::default_projector ( ) const

inline

References m_defaultProjector.

◆ handle_new_vertex()

template<class TParent >

number ug::ProjectionHandler::handle_new_vertex	(	Vertex *	vrt,
		TParent *	parent
	)

private

References ug::ISubsetHandler::get_subset_index(), m_defaultProjector, m_projectors, m_sh, p, ug::RefinementProjector::pos(), ug::RefinementProjector::set_pos(), and UG_ASSERT.

Referenced by new_vertex(), new_vertex(), new_vertex(), and new_vertex().

◆ new_vertex() [1/4]

number ug::ProjectionHandler::new_vertex	(	Vertex *	vrt,
		Edge *	parent
	)

virtual

called when a new vertex was created from an old edge.

Reimplemented from ug::RefinementProjector.

References handle_new_vertex().

◆ new_vertex() [2/4]

number ug::ProjectionHandler::new_vertex	(	Vertex *	vrt,
		Face *	parent
	)

virtual

called when a new vertex was created from an old face.

Reimplemented from ug::RefinementProjector.

References handle_new_vertex().

◆ new_vertex() [3/4]

number ug::ProjectionHandler::new_vertex	(	Vertex *	vrt,
		Vertex *	parent
	)

virtual

called when a new vertex was created from an old vertex.

Reimplemented from ug::RefinementProjector.

References handle_new_vertex().

◆ new_vertex() [4/4]

number ug::ProjectionHandler::new_vertex	(	Vertex *	vrt,
		Volume *	parent
	)

virtual

called when a new vertex was created from an old volume.

Reimplemented from ug::RefinementProjector.

References handle_new_vertex().

◆ num_projectors()

size_t ug::ProjectionHandler::num_projectors ( ) const

inline

References m_projectors.

Referenced by ug::GridWriterUGX::add_projection_handler(), ug::IDomain< TGrid, TSubsetHandler >::broadcast_refinement_projector(), and ug::SerializeProjectionHandler().

◆ projector() [1/2]

SPRefinementProjector ug::ProjectionHandler::projector ( size_t i )

inline

References m_projectors, and projector_required().

Referenced by ug::GridWriterUGX::add_projection_handler(), ug::IDomain< TGrid, TSubsetHandler >::broadcast_refinement_projector(), ug::SerializeProjectionHandler(), set_default_projector(), set_projector(), and set_projector().

◆ projector() [2/2]

ConstSmartPtr< RefinementProjector > ug::ProjectionHandler::projector ( size_t i ) const

inline

References m_projectors.

◆ projector_required()

void ug::ProjectionHandler::projector_required ( int index )

private

References m_projectors.

Referenced by projector(), refinement_begins(), and set_projector().

◆ refinement_begins()

void ug::ProjectionHandler::refinement_begins ( const ISubGrid * psg )

virtual

prepares associated projectors for refinement

If an associated projector hasn't got an associated geometry, the geometry of the ProjectionHandler will automatically be assigned.

Reimplemented from ug::RefinementProjector.

References ug::Selector::assign_grid(), ug::Selector::clear(), ug::RefinementProjector::geom(), ug::RefinementProjector::geometry(), ug::Selector::get_grid_objects(), ug::ISubsetHandler::get_grid_objects_in_subset(), ug::ISubsetHandler::get_subset_index(), ug::ISubGrid::goc(), ug::ISelector::grid(), ug::ISubGrid::is_contained(), lg_end_for, lg_for_each_const, m_defaultProjector, m_projectors, m_sh, make_sp(), ug::GridObjectCollection::num_edges(), ug::GridObjectCollection::num_faces(), ug::ISubsetHandler::num_subsets(), ug::GridObjectCollection::num_vertices(), ug::GridObjectCollection::num_volumes(), projector_required(), ug::RefinementProjector::refinement_begins(), ug::RefinementProjector::refinement_begins_requires_subgrid(), ug::ISelector::select(), ug::RefinementProjector::set_concerned_elements(), ug::RefinementProjector::set_geometry(), UG_COND_THROW, and SmartPtr< T, FreePolicy >::valid().

◆ refinement_begins_requires_subgrid()

bool ug::ProjectionHandler::refinement_begins_requires_subgrid ( ) const

virtual

returns 'true' if a specialized projector requires the subgrid during its 'refinement_begins' method.

Note: Implementers of derived classes should overload this method and return 'true' if their 'refinement_begins' method requires a subgrid. Please have a look at the documentation of 'RefinementProjector::refinement_begins' for more information.

Reimplemented from ug::RefinementProjector.

References m_projectors, and refinement_begins_requires_subgrid().

Referenced by refinement_begins_requires_subgrid().

◆ refinement_ends()

void ug::ProjectionHandler::refinement_ends ( )

virtual

called when refinement is done

Reimplemented from ug::RefinementProjector.

References m_projectors, and ug::RefinementProjector::refinement_ends().

◆ set_default_projector()

void ug::ProjectionHandler::set_default_projector ( SPRefinementProjector projector )

References m_defaultProjector, and projector().

Referenced by ug::IDomain< TGrid, TSubsetHandler >::broadcast_refinement_projector(), ug::DeserializeProjectionHandler(), and ug::GridReaderUGX::projection_handler().

◆ set_geometry()

void ug::ProjectionHandler::set_geometry ( SPIGeometry3d geometry )

virtual

Reimplemented from ug::RefinementProjector.

References ug::RefinementProjector::geometry(), m_defaultProjector, and ug::RefinementProjector::set_geometry().

Referenced by set_geometry_all(), and set_projector().

◆ set_geometry_all()

void ug::ProjectionHandler::set_geometry_all ( SPIGeometry3d geometry )

virtual

Sets the geometry of the ProjectionHandler and of all associated projectors.

Note: If you'd like to change the geometry of the ProjectionHandler only, please use 'set_geometry' instead.

References ug::RefinementProjector::geometry(), m_defaultProjector, m_projectors, and set_geometry().

◆ set_projector() [1/2]

void ug::ProjectionHandler::set_projector	(	const char *	subsetName,
		SPRefinementProjector	projector
	)

associate a projector with a subset of the given name.

Note: a valid subset-handler has to be set to ProjectionHandler before a subset can be specified by a name. Note that it is possible to specify a subset by index before setting a SubsetHandler.; if no geometry-object was set to the ProjectionHandler and if the given projector has an associated geometry-object, the handler will copy the geometry-object of the projector for its own use.

References ug::ISubsetHandler::get_subset_index(), m_sh, projector(), set_projector(), and UG_COND_THROW.

◆ set_projector() [2/2]

void ug::ProjectionHandler::set_projector	(	int	subsetIndex,
		SPRefinementProjector	projector
	)

associate a projector with a given subsetIndex. Note that '-1' is a valid index, too.

Note: if no geometry-object was set to the ProjectionHandler and if the given projector has an associated geometry-object, the handler will copy the geometry-object of the projector for its own use.

References ug::RefinementProjector::geometry(), m_projectors, projector(), projector_required(), set_geometry(), UG_COND_THROW, and SmartPtr< T, FreePolicy >::valid().

Referenced by ug::IDomain< TGrid, TSubsetHandler >::broadcast_refinement_projector(), ug::DeserializeProjectionHandler(), ug::GridReaderUGX::projection_handler(), and set_projector().

◆ set_subset_handler() [1/2]

void ug::ProjectionHandler::set_subset_handler ( ISubsetHandler * psh )

Please make sure that the given subset-handler outlives the ProjectionHandler. Please note that an alternative 'set_subset_handler' exists, which takes a smart-pointer to a SubsetHandler.

References m_sh, and m_spSH.

◆ set_subset_handler() [2/2]

void ug::ProjectionHandler::set_subset_handler ( SmartPtr< ISubsetHandler > psh )

References SmartPtr< T, FreePolicy >::get(), m_sh, and m_spSH.

◆ subset_handler()

const ISubsetHandler * ug::ProjectionHandler::subset_handler ( ) const

inline

return the subset handler that the projection handler is based on

References m_sh.

Referenced by ug::GridWriterUGX::add_projection_handler(), ug::IDomain< TGrid, TSubsetHandler >::broadcast_refinement_projector(), and ug::SaveGridToLGB().

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Member Data Documentation

◆ m_defaultProjector

SmartPtr<RefinementProjector> ug::ProjectionHandler::m_defaultProjector

private

Referenced by clear(), default_projector(), default_projector(), handle_new_vertex(), ProjectionHandler(), ProjectionHandler(), ProjectionHandler(), ProjectionHandler(), ProjectionHandler(), refinement_begins(), set_default_projector(), set_geometry(), and set_geometry_all().

◆ m_projectors

std::vector<SmartPtr<RefinementProjector> > ug::ProjectionHandler::m_projectors

private

Referenced by clear(), handle_new_vertex(), num_projectors(), projector(), projector(), projector_required(), refinement_begins(), refinement_begins_requires_subgrid(), refinement_ends(), set_geometry_all(), and set_projector().

◆ m_sh

ISubsetHandler* ug::ProjectionHandler::m_sh

private

Referenced by handle_new_vertex(), refinement_begins(), set_projector(), set_subset_handler(), set_subset_handler(), and subset_handler().

◆ m_spSH

SmartPtr<ISubsetHandler> ug::ProjectionHandler::m_spSH

private

Referenced by set_subset_handler(), and set_subset_handler().

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

ugbase/lib_grid/refinement/projectors/projection_handler.h
ugbase/lib_grid/refinement/projectors/projection_handler.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProjectionHandler() [1/5]

◆ ProjectionHandler() [2/5]

◆ ProjectionHandler() [3/5]

◆ ProjectionHandler() [4/5]

◆ ProjectionHandler() [5/5]

◆ ~ProjectionHandler()

Member Function Documentation

◆ clear()

◆ default_projector() [1/2]

◆ default_projector() [2/2]

◆ handle_new_vertex()

◆ new_vertex() [1/4]

◆ new_vertex() [2/4]

◆ new_vertex() [3/4]

◆ new_vertex() [4/4]

◆ num_projectors()

◆ projector() [1/2]

◆ projector() [2/2]

◆ projector_required()

◆ refinement_begins()

◆ refinement_begins_requires_subgrid()

◆ refinement_ends()

◆ set_default_projector()

◆ set_geometry()

◆ set_geometry_all()

◆ set_projector() [1/2]

◆ set_projector() [2/2]

◆ set_subset_handler() [1/2]

◆ set_subset_handler() [2/2]

◆ subset_handler()

Friends And Related Symbol Documentation

◆ boost::serialization::access

Member Data Documentation

◆ m_defaultProjector

◆ m_projectors

◆ m_sh

◆ m_spSH