#include <agglomeration_accessor.h>

Public Types
using	AgglomerationContainer

Public Member Functions
void	get_dof_indices (std::vector< types::global_dof_index > &) const

unsigned int	n_faces () const

unsigned int	n_agglomerated_faces () const

const AgglomerationIterator< dim, spacedim >	neighbor (const unsigned int f) const

unsigned int	neighbor_of_agglomerated_neighbor (const unsigned int f) const

bool	at_boundary (const unsigned int f) const

const std::vector< typename Triangulation< dim >::active_face_iterator > &	polytope_boundary () const

double	volume () const

double	diameter () const

AgglomerationContainer	get_agglomerate () const

const BoundingBox< dim > &	get_bounding_box () const

types::global_cell_index	index () const

DoFHandler< dim, spacedim >::active_cell_iterator	as_dof_handler_iterator (const DoFHandler< dim, spacedim > &dof_handler) const

unsigned int	n_background_cells () const

bool	is_locally_owned () const

CellId	id () const

types::subdomain_id	subdomain_id () const

const std::vector< types::global_cell_index > &	children () const

const FiniteElement< dim, spacedim > &	get_fe () const

void	set_active_fe_index (const types::fe_index index) const

types::fe_index	active_fe_index () const

Private Member Functions
	AgglomerationAccessor ()

	AgglomerationAccessor (const typename Triangulation< dim, spacedim >::active_cell_iterator &master_cell, const AgglomerationHandler< dim, spacedim > *ah)

	AgglomerationAccessor (const typename Triangulation< dim, spacedim >::active_cell_iterator &cell, const CellId &cell_id, const AgglomerationHandler< dim, spacedim > *ah)

	~AgglomerationAccessor ()=default

bool	operator== (const AgglomerationAccessor< dim, spacedim > &other) const

bool	operator!= (const AgglomerationAccessor< dim, spacedim > &other) const

void	next ()

void	prev ()

const AgglomerationContainer &	get_slaves () const

unsigned int	n_agglomerated_faces_per_cell (const typename Triangulation< dim, spacedim >::active_cell_iterator &cell) const

Private Attributes
Triangulation< dim, spacedim >::active_cell_iterator	master_cell

types::global_cell_index	present_index

CellId	present_id

types::subdomain_id	present_subdomain_id

AgglomerationHandler< dim, spacedim > *	handler

Friends
template<int, int>
class	AgglomerationIterator

Detailed Description

template<int dim, int spacedim = dim>
class AgglomerationAccessor< dim, spacedim >

Accessor class used by AgglomerationIterator to access agglomeration data.

Definition at line 42 of file agglomeration_accessor.h.

Member Typedef Documentation

◆ AgglomerationContainer

template<int dim, int spacedim = dim>

using AgglomerationAccessor< dim, spacedim >::AgglomerationContainer

Initial value:

std::vector<typename Triangulation<dim, spacedim>::active_cell_iterator>

Type for storing the polygons in an agglomerate.

Definition at line 48 of file agglomeration_accessor.h.

Constructor & Destructor Documentation

◆ AgglomerationAccessor() [1/3]

template<int dim, int spacedim>

AgglomerationAccessor< dim, spacedim >::AgglomerationAccessor ( )

inlineprivate

Private default constructor. This is not supposed to be used and hence will throw.

Definition at line 486 of file agglomeration_accessor.h.

Referenced by operator!=(), and operator==().

◆ AgglomerationAccessor() [2/3]

template<int dim, int spacedim>

AgglomerationAccessor< dim, spacedim >::AgglomerationAccessor	(	const typename Triangulation< dim, spacedim >::active_cell_iterator &	master_cell,
		const AgglomerationHandler< dim, spacedim > *	ah )

inlineprivate

Private constructor for an agglomerate. This is meant to be invoked by the AgglomerationIterator class. It takes as input the master cell of the agglomerate and a pointer to the handler.

Definition at line 492 of file agglomeration_accessor.h.

References handler, numbers::invalid_subdomain_id, master_cell, present_id, present_index, and present_subdomain_id.

◆ AgglomerationAccessor() [3/3]

template<int dim, int spacedim>

AgglomerationAccessor< dim, spacedim >::AgglomerationAccessor	(	const typename Triangulation< dim, spacedim >::active_cell_iterator &	cell,
		const CellId &	cell_id,
		const AgglomerationHandler< dim, spacedim > *	ah )

inlineprivate

Same as above, but needed when the argument cells is a ghost cell.

Definition at line 516 of file agglomeration_accessor.h.

References handler, numbers::invalid_unsigned_int, master_cell, present_id, present_index, and present_subdomain_id.

◆ ~AgglomerationAccessor()

template<int dim, int spacedim = dim>

AgglomerationAccessor< dim, spacedim >::~AgglomerationAccessor ( )

privatedefault

Default destructor.

Member Function Documentation

◆ active_fe_index()

template<int dim, int spacedim>

types::fe_index AgglomerationAccessor< dim, spacedim >::active_fe_index ( ) const

inline

Returns the index of the active finite element. When using hp::FECollection, this function retrieves the index of the finite element assigned to the current polytope.

Definition at line 835 of file agglomeration_accessor.h.

References handler, and master_cell.

◆ as_dof_handler_iterator()

template<int dim, int spacedim>

DoFHandler< dim, spacedim >::active_cell_iterator AgglomerationAccessor< dim, spacedim >::as_dof_handler_iterator ( const DoFHandler< dim, spacedim > & dof_handler ) const

Returns an active cell iterator for the dof_handler, matching the polytope referenced by the input iterator. The type of the returned object is a DoFHandler::active_cell_iterator which can be used to initialize FiniteElement data.

Definition at line 694 of file agglomeration_accessor.h.

References master_cell.

Referenced by AgglomerationHandler< dim, spacedim >::reinit(), AgglomerationHandler< dim, spacedim >::reinit(), and AgglomerationHandler< dim, spacedim >::reinit_interface().

◆ at_boundary()

template<int dim, int spacedim>

bool AgglomerationAccessor< dim, spacedim >::at_boundary ( const unsigned int f ) const

inline

This function generalizes the behaviour of cell->face(f)->at_boundary() in the case where f is an index out of the range [0,..., n_faces). In practice, if you call this function with a standard deal.II cell, you have precisely the same result as calling cell->face(f)->at_boundary(). Otherwise, if the cell is a master one, you have a boolean returning true is that face for the agglomeration is on the boundary or not.

Definition at line 738 of file agglomeration_accessor.h.

References handler, master_cell, and present_id.

Referenced by neighbor(), and neighbor_of_agglomerated_neighbor().

◆ children()

template<int dim, int spacedim>

const std::vector< types::global_cell_index > & AgglomerationAccessor< dim, spacedim >::children ( ) const

inline

Returns a vector of indices identifying the children polytopes.

Definition at line 803 of file agglomeration_accessor.h.

References handler, and present_index.

◆ diameter()

template<int dim, int spacedim>

double AgglomerationAccessor< dim, spacedim >::diameter ( ) const

inline

Return the diameter of the present polytopal element.

Definition at line 584 of file agglomeration_accessor.h.

References handler, master_cell, and present_index.

◆ get_agglomerate()

template<int dim, int spacedim>

AgglomerationAccessor< dim, spacedim >::AgglomerationContainer AgglomerationAccessor< dim, spacedim >::get_agglomerate ( ) const

inline

Returns the deal.II cells that build the agglomerate.

Definition at line 564 of file agglomeration_accessor.h.

References get_slaves(), and master_cell.

Referenced by n_agglomerated_faces(), n_background_cells(), and AgglomerationHandler< dim, spacedim >::reinit().

◆ get_bounding_box()

template<int dim, int spacedim>

const BoundingBox< dim > & AgglomerationAccessor< dim, spacedim >::get_bounding_box ( ) const

inline

Return the BoundingBox which bounds the present polytope. In case the present polytope is not locally owned, it returns the BoundingBox of that ghosted polytope.

Definition at line 607 of file agglomeration_accessor.h.

References handler, is_locally_owned(), present_id, present_index, and present_subdomain_id.

◆ get_dof_indices()

template<int dim, int spacedim>

void AgglomerationAccessor< dim, spacedim >::get_dof_indices ( std::vector< types::global_dof_index > & dof_indices ) const

inline

Get the DoFs indices associated to the agglomerate.

Definition at line 536 of file agglomeration_accessor.h.

References handler, is_locally_owned(), master_cell, present_id, and present_subdomain_id.

◆ get_fe()

template<int dim, int spacedim>

const FiniteElement< dim, spacedim > & AgglomerationAccessor< dim, spacedim >::get_fe ( ) const

inline

Returns the FiniteElement object used by the current polytope. This function should only be called after the corresponding agglomeration handler has invoked distribute_agglomerated_dofs().

Definition at line 812 of file agglomeration_accessor.h.

References DoFHandler< int dim, int spacedim >::get_fe(), handler, and master_cell.

Referenced by AgglomerationHandler< dim, spacedim >::reinit().

◆ get_slaves()

template<int dim, int spacedim>

const AgglomerationAccessor< dim, spacedim >::AgglomerationContainer & AgglomerationAccessor< dim, spacedim >::get_slaves ( ) const

inlineprivate

Returns the slaves of the present agglomeration.

Definition at line 706 of file agglomeration_accessor.h.

References handler, and master_cell.

Referenced by get_agglomerate().

◆ id()

template<int dim, int spacedim>

CellId AgglomerationAccessor< dim, spacedim >::id ( ) const

inline

The polytopal analogue of CellAccessor::id(). It provides a way to uniquely identify cells in a parallel Triangulation such as a parallel::distributed::Triangulation.

Definition at line 787 of file agglomeration_accessor.h.

References present_id.

Referenced by AgglomerationHandler< dim, spacedim >::reinit_interface().

◆ index()

template<int dim, int spacedim>

types::global_cell_index AgglomerationAccessor< dim, spacedim >::index ( ) const

inline

Return the index of the present polytope.

Definition at line 685 of file agglomeration_accessor.h.

References present_index.

Referenced by set_active_fe_index().

◆ is_locally_owned()

template<int dim, int spacedim>

bool AgglomerationAccessor< dim, spacedim >::is_locally_owned ( ) const

inline

Definition at line 778 of file agglomeration_accessor.h.

References master_cell.

Referenced by get_bounding_box(), get_dof_indices(), and AgglomerationHandler< dim, spacedim >::reinit_interface().

◆ n_agglomerated_faces()

template<int dim, int spacedim>

unsigned int AgglomerationAccessor< dim, spacedim >::n_agglomerated_faces ( ) const

Return the number of deal.II faces that is building a polygon face.

Definition at line 725 of file agglomeration_accessor.h.

References get_agglomerate(), and n_agglomerated_faces_per_cell().

◆ n_agglomerated_faces_per_cell()

template<int dim, int spacedim>

unsigned int AgglomerationAccessor< dim, spacedim >::n_agglomerated_faces_per_cell ( const typename Triangulation< dim, spacedim >::active_cell_iterator & cell ) const

private

Definition at line 305 of file agglomeration_accessor.h.

References handler.

Referenced by n_agglomerated_faces().

◆ n_background_cells()

template<int dim, int spacedim>

unsigned int AgglomerationAccessor< dim, spacedim >::n_background_cells ( ) const

inline

Returns the number of classical deal.II cells that are building the present polygon.

Definition at line 715 of file agglomeration_accessor.h.

References get_agglomerate().

◆ n_faces()

template<int dim, int spacedim>

unsigned int AgglomerationAccessor< dim, spacedim >::n_faces ( ) const

Return, for a cell, the number of faces. In case the cell is a standard cell, then the number of faces is the classical one. If it's a master cell, then it returns the number of faces of the agglomeration identified by the master cell itself.

Definition at line 326 of file agglomeration_accessor.h.

References handler, master_cell, and present_index.

◆ neighbor()

template<int dim, int spacedim>

const AgglomerationIterator< dim, spacedim > AgglomerationAccessor< dim, spacedim >::neighbor ( const unsigned int f ) const

Return the agglomerate which shares face f.

Definition at line 337 of file agglomeration_accessor.h.

References at_boundary(), handler, master_cell, and present_id.

Referenced by neighbor_of_agglomerated_neighbor(), and dealii::internal::AgglomerationHandlerImplementation< dim, spacedim >::reinit_master().

◆ neighbor_of_agglomerated_neighbor()

template<int dim, int spacedim>

unsigned int AgglomerationAccessor< dim, spacedim >::neighbor_of_agglomerated_neighbor ( const unsigned int f ) const

Return the present index (seen from the neighboring agglomerate) of the present face f.

Definition at line 428 of file agglomeration_accessor.h.

References at_boundary(), handler, numbers::invalid_unsigned_int, neighbor(), present_id, and IteratorState::valid.

◆ next()

template<int dim, int spacedim>

void AgglomerationAccessor< dim, spacedim >::next ( )

inlineprivate

Move to the next cell in the polytopal mesh.

Definition at line 638 of file agglomeration_accessor.h.

References handler, master_cell, present_id, present_index, and present_subdomain_id.

◆ operator!=()

template<int dim, int spacedim>

bool AgglomerationAccessor< dim, spacedim >::operator!= ( const AgglomerationAccessor< dim, spacedim > & other ) const

inlineprivate

Compare for inequality.

Definition at line 675 of file agglomeration_accessor.h.

References AgglomerationAccessor().

◆ operator==()

template<int dim, int spacedim>

bool AgglomerationAccessor< dim, spacedim >::operator== ( const AgglomerationAccessor< dim, spacedim > & other ) const

inlineprivate

Comparison operator for Accessor. Two accessors are equal if they refer to the same polytopal element.

Definition at line 667 of file agglomeration_accessor.h.

References AgglomerationAccessor(), and present_index.

◆ polytope_boundary()

template<int dim, int spacedim>

const std::vector< typename Triangulation< dim >::active_face_iterator > & AgglomerationAccessor< dim, spacedim >::polytope_boundary ( ) const

inline

Return a vector of face iterators describing the boundary of agglomerate.

Definition at line 575 of file agglomeration_accessor.h.

References handler, and master_cell.

◆ prev()

template<int dim, int spacedim>

void AgglomerationAccessor< dim, spacedim >::prev ( )

inlineprivate

Move to the previous cell in the polytopal mesh.

Definition at line 656 of file agglomeration_accessor.h.

References handler, master_cell, present_id, and present_index.

◆ set_active_fe_index()

template<int dim, int spacedim>

void AgglomerationAccessor< dim, spacedim >::set_active_fe_index ( const types::fe_index index ) const

inline

Sets the active finite element index. This function should be called when using hp::FECollection to specify which finite element in the collection is assigned to the current polytope.

Definition at line 822 of file agglomeration_accessor.h.

References handler, index(), and master_cell.

◆ subdomain_id()

template<int dim, int spacedim>

types::subdomain_id AgglomerationAccessor< dim, spacedim >::subdomain_id ( ) const

inline

The polytopal analogue of CellAccessor::subdomain_id(). In case of a serial Triangulation, it returns the numbers::invalid_subdomain_id.

Definition at line 796 of file agglomeration_accessor.h.

References present_subdomain_id.

Referenced by AgglomerationHandler< dim, spacedim >::reinit_interface().

◆ volume()

template<int dim, int spacedim>

double AgglomerationAccessor< dim, spacedim >::volume ( ) const

inline

Return the volume of a polytope.

Definition at line 619 of file agglomeration_accessor.h.

References handler, master_cell, and present_index.

Friends And Related Symbol Documentation

◆ AgglomerationIterator

template<int dim, int spacedim = dim>

template<int, int>

friend class AgglomerationIterator

friend

Definition at line 298 of file agglomeration_accessor.h.

Member Data Documentation

◆ handler

template<int dim, int spacedim = dim>

AgglomerationHandler<dim, spacedim>* AgglomerationAccessor< dim, spacedim >::handler

private

A pointer to the Handler.

Definition at line 259 of file agglomeration_accessor.h.

Referenced by active_fe_index(), AgglomerationAccessor(), AgglomerationAccessor(), at_boundary(), children(), diameter(), get_bounding_box(), get_dof_indices(), get_fe(), get_slaves(), n_agglomerated_faces_per_cell(), n_faces(), neighbor(), neighbor_of_agglomerated_neighbor(), next(), polytope_boundary(), prev(), set_active_fe_index(), and volume().

◆ master_cell

template<int dim, int spacedim = dim>

Triangulation<dim,spacedim>::active_cell_iterator AgglomerationAccessor< dim, spacedim >::master_cell

private

The unique deal.II cell associated to the present polytope.

Definition at line 239 of file agglomeration_accessor.h.

Referenced by active_fe_index(), AgglomerationAccessor(), AgglomerationAccessor(), as_dof_handler_iterator(), at_boundary(), diameter(), get_agglomerate(), get_dof_indices(), get_fe(), get_slaves(), is_locally_owned(), n_faces(), neighbor(), next(), polytope_boundary(), prev(), set_active_fe_index(), and volume().

◆ present_id

template<int dim, int spacedim = dim>

CellId AgglomerationAccessor< dim, spacedim >::present_id

private

The index of the present polytope.

Definition at line 249 of file agglomeration_accessor.h.

Referenced by AgglomerationAccessor(), AgglomerationAccessor(), at_boundary(), get_bounding_box(), get_dof_indices(), id(), neighbor(), neighbor_of_agglomerated_neighbor(), next(), and prev().

◆ present_index

template<int dim, int spacedim = dim>

types::global_cell_index AgglomerationAccessor< dim, spacedim >::present_index

private

The index of the present polytope.

Definition at line 244 of file agglomeration_accessor.h.

Referenced by AgglomerationAccessor(), AgglomerationAccessor(), children(), diameter(), get_bounding_box(), index(), n_faces(), next(), operator==(), prev(), and volume().

◆ present_subdomain_id

template<int dim, int spacedim = dim>

types::subdomain_id AgglomerationAccessor< dim, spacedim >::present_subdomain_id

private

The rank owning of the present polytope.

Definition at line 254 of file agglomeration_accessor.h.

Referenced by AgglomerationAccessor(), AgglomerationAccessor(), get_bounding_box(), get_dof_indices(), next(), and subdomain_id().

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

/github/workspace/include/agglomeration_accessor.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ AgglomerationContainer

Constructor & Destructor Documentation

◆ AgglomerationAccessor() [1/3]

◆ AgglomerationAccessor() [2/3]

◆ AgglomerationAccessor() [3/3]

◆ ~AgglomerationAccessor()

Member Function Documentation

◆ active_fe_index()

◆ as_dof_handler_iterator()

◆ at_boundary()

◆ children()

◆ diameter()

◆ get_agglomerate()

◆ get_bounding_box()

◆ get_dof_indices()

◆ get_fe()

◆ get_slaves()

◆ id()

◆ index()

◆ is_locally_owned()

◆ n_agglomerated_faces()

◆ n_agglomerated_faces_per_cell()

◆ n_background_cells()

◆ n_faces()

◆ neighbor()

◆ neighbor_of_agglomerated_neighbor()

◆ next()

◆ operator!=()

◆ operator==()

◆ polytope_boundary()

◆ prev()

◆ set_active_fe_index()

◆ subdomain_id()

◆ volume()

Friends And Related Symbol Documentation

◆ AgglomerationIterator

Member Data Documentation

◆ handler

◆ master_cell

◆ present_id

◆ present_index

◆ present_subdomain_id