DUNE PDELab (git)

Dune::PDELab::PartitionViewEntitySet< GV, P > Class Template Reference

Partition view (or entity set) of a grid view. More...

#include <dune/pdelab/common/partitionviewentityset.hh>

Public Member Functions

const IndexSet & indexSet () const
 Returns the IndexSet of this EntitySet.
 
const BaseIndexSet & baseIndexSet () const
 Returns the IndexSet of the underlying GridView.
 
size_type overlapSize (dim_type codim) const
 Returns the overlap size of this EntitySet, which depends on its PartitionSet.
 
size_type ghostSize (dim_type codim) const
 Returns the ghost size of this EntitySet, which depends on its PartitionSet.
 
const GridView & gridView () const
 Returns the underlying GridView.
 
void reset ()
 Reset this EntitySet, which removes all entities from it.
 
void addCodim (dim_type codim)
 Add all entities of the given codim to this EntitySet.
 
void removeCodim (dim_type codim)
 Remove all entities of the given codim from this EntitySet.
 
bool needsUpdate () const
 Returns true if you need to call update on this EntitySet before using it.
 
bool update (bool force=false)
 Update the internal state of this EntitySet. More...
 
bool operator== (const PartitionViewEntitySet &other) const
 Compare to another partition view. More...
 
bool operator!= (const PartitionViewEntitySet &other) const
 Compare to another partition view.
 

Detailed Description

template<typename GV, typename P>
class Dune::PDELab::PartitionViewEntitySet< GV, P >

Partition view (or entity set) of a grid view.

The partition view creates an index set for the given partition which allows to exclude unused codimensions. Additionally, it allows to retreive a unique index for every entity contained in the index set (Similar to the MCMG mapper functionality). This is particularly useful when working with Local Finite Elements that do not attach DOFs to all codimensions.

Note
A copy of this class is a shallow copy on the underlying index set
Template Parameters
GVGrid view
PPartitionSet to restrict view of the entity set

Member Function Documentation

◆ operator==()

template<typename GV , typename P >
bool Dune::PDELab::PartitionViewEntitySet< GV, P >::operator== ( const PartitionViewEntitySet< GV, P > &  other) const
inline

Compare to another partition view.

This check only succeeds for copies of this class

Parameters
otherAnother partition view
Returns
true if other shares the same index set as this
false otherwise

◆ update()

template<typename GV , typename P >
bool Dune::PDELab::PartitionViewEntitySet< GV, P >::update ( bool  force = false)
inline

Update the internal state of this EntitySet.

Parameters
forceIf true, forces an update even if the EntitySet parameters have not changed. This is e.g. required if the underlying grid has changed due to adaptivity.
Returns
Returns true if the state of the EntitySet was changed by this method.

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 23, 23:29, 2024)