dune-pdelab  2.5-dev
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Dune::PDELab::PartitionViewEntitySet< GV, P > Class Template Reference

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

Inheritance diagram for Dune::PDELab::PartitionViewEntitySet< GV, P >:
Inheritance graph

Public Types

using Traits = PartitionViewEntitySetTraits< GV, P >
 
using Partitions = typename Traits::Partitions
 
using Grid = typename Traits::Grid
 
using GridView = typename Traits::GridView
 
using IndexSet = typename Traits::IndexSet
 
using BaseIndexSet = typename Traits::BaseIndexSet
 
using Element = typename Traits::Element
 
using Intersection = typename Traits::Intersection
 
using IntersectionIterator = typename Traits::IntersectionIterator
 
using CollectiveCommunication = typename Traits::CollectiveCommunication
 
using CodimMask = typename Traits::CodimMask
 
using CoordinateField = typename Traits::CoordinateField
 
using size_type = typename Traits::size_type
 
using dim_type = typename Traits::dim_type
 
using ctype = CoordinateField
 
template<dim_type codim>
using Codim = typename Traits::template Codim< codim >
 

Public Member Functions

const Grid & grid () const
 
const IndexSet & indexSet () const
 Returns the IndexSet of this EntitySet. More...
 
const BaseIndexSet & baseIndexSet () const
 Returns the IndexSet of the underlying GridView. More...
 
template<dim_type codim>
Codim< codim >::Iterator begin () const
 
template<dim_type codim>
Codim< codim >::Iterator end () const
 
template<dim_type codim, PartitionIteratorType pitype>
GV::template Codim< codim >::template Partition< pitype >::Iterator begin () const
 
template<dim_type codim, PartitionIteratorType pitype>
GV::template Codim< codim >::template Partition< pitype >::Iterator end () const
 
size_type size (dim_type codim) const
 
size_type size (const GeometryType &gt) const
 
template<typename Entity >
bool contains (const Entity &e) const
 
bool contains (dim_type codim) const
 
bool contains (const GeometryType &gt) const
 
IntersectionIterator ibegin (const typename Codim< 0 >::Entity &entity) const
 
IntersectionIterator iend (const typename Codim< 0 >::Entity &entity) const
 
const CollectiveCommunication & comm () const
 
size_type overlapSize (dim_type codim) const
 Returns the overlap size of this EntitySet, which depends on its PartitionSet. More...
 
size_type ghostSize (dim_type codim) const
 Returns the ghost size of this EntitySet, which depends on its PartitionSet. More...
 
template<typename DataHandle >
void communicate (DataHandle &data, InterfaceType iftype, CommunicationDirection dir) const
 
const GridView & gridView () const
 Returns the underlying GridView. More...
 
 PartitionViewEntitySet (const GridView &gv, CodimMask supported_codims)
 
 PartitionViewEntitySet (const GridView &gv, bool initialize=true)
 
void reset ()
 Reset this EntitySet, which removes all entities from it. More...
 
void addCodim (dim_type codim)
 Add all entities of the given codim to this EntitySet. More...
 
void removeCodim (dim_type codim)
 Remove all entities of the given codim from this EntitySet. More...
 
bool needsUpdate () const
 Returns true if you need to call update on this EntitySet before using it. More...
 
bool update (bool force=false)
 Update the internal state of this EntitySet. More...
 

Static Public Member Functions

constexpr static Partitions partitions ()
 
constexpr static CodimMask allCodims ()
 

Static Public Attributes

static const bool conforming = Traits::conforming
 
static const dim_type dimension = Traits::dimension
 
static const dim_type dimensionworld = Traits::dimensionworld
 

Member Typedef Documentation

◆ BaseIndexSet

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::BaseIndexSet = typename Traits::BaseIndexSet

◆ Codim

template<typename GV , typename P >
template<dim_type codim>
using Dune::PDELab::PartitionViewEntitySet< GV, P >::Codim = typename Traits::template Codim<codim>

◆ CodimMask

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::CodimMask = typename Traits::CodimMask

◆ CollectiveCommunication

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::CollectiveCommunication = typename Traits::CollectiveCommunication

◆ CoordinateField

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::CoordinateField = typename Traits::CoordinateField

◆ ctype

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::ctype = CoordinateField

◆ dim_type

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::dim_type = typename Traits::dim_type

◆ Element

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::Element = typename Traits::Element

◆ Grid

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::Grid = typename Traits::Grid

◆ GridView

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::GridView = typename Traits::GridView

◆ IndexSet

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::IndexSet = typename Traits::IndexSet

◆ Intersection

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::Intersection = typename Traits::Intersection

◆ IntersectionIterator

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::IntersectionIterator = typename Traits::IntersectionIterator

◆ Partitions

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::Partitions = typename Traits::Partitions

◆ size_type

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::size_type = typename Traits::size_type

◆ Traits

template<typename GV , typename P >
using Dune::PDELab::PartitionViewEntitySet< GV, P >::Traits = PartitionViewEntitySetTraits<GV,P>

Constructor & Destructor Documentation

◆ PartitionViewEntitySet() [1/2]

template<typename GV , typename P >
Dune::PDELab::PartitionViewEntitySet< GV, P >::PartitionViewEntitySet ( const GridView &  gv,
CodimMask  supported_codims 
)
inline

◆ PartitionViewEntitySet() [2/2]

template<typename GV , typename P >
Dune::PDELab::PartitionViewEntitySet< GV, P >::PartitionViewEntitySet ( const GridView &  gv,
bool  initialize = true 
)
inlineexplicit

Member Function Documentation

◆ addCodim()

template<typename GV , typename P >
void Dune::PDELab::PartitionViewEntitySet< GV, P >::addCodim ( dim_type  codim)
inline

Add all entities of the given codim to this EntitySet.

◆ allCodims()

template<typename GV , typename P >
constexpr static CodimMask Dune::PDELab::PartitionViewEntitySet< GV, P >::allCodims ( )
inlinestaticconstexpr

◆ baseIndexSet()

template<typename GV , typename P >
const BaseIndexSet& Dune::PDELab::PartitionViewEntitySet< GV, P >::baseIndexSet ( ) const
inline

Returns the IndexSet of the underlying GridView.

◆ begin() [1/2]

template<typename GV , typename P >
template<dim_type codim>
Codim<codim>::Iterator Dune::PDELab::PartitionViewEntitySet< GV, P >::begin ( ) const
inline

◆ begin() [2/2]

template<typename GV , typename P >
template<dim_type codim, PartitionIteratorType pitype>
GV::template Codim<codim>::template Partition<pitype>::Iterator Dune::PDELab::PartitionViewEntitySet< GV, P >::begin ( ) const
inline

◆ comm()

template<typename GV , typename P >
const CollectiveCommunication& Dune::PDELab::PartitionViewEntitySet< GV, P >::comm ( ) const
inline

◆ communicate()

template<typename GV , typename P >
template<typename DataHandle >
void Dune::PDELab::PartitionViewEntitySet< GV, P >::communicate ( DataHandle &  data,
InterfaceType  iftype,
CommunicationDirection  dir 
) const
inline

◆ contains() [1/3]

template<typename GV , typename P >
template<typename Entity >
bool Dune::PDELab::PartitionViewEntitySet< GV, P >::contains ( const Entity &  e) const
inline

◆ contains() [2/3]

template<typename GV , typename P >
bool Dune::PDELab::PartitionViewEntitySet< GV, P >::contains ( const GeometryType &  gt) const
inline

◆ contains() [3/3]

template<typename GV , typename P >
bool Dune::PDELab::PartitionViewEntitySet< GV, P >::contains ( dim_type  codim) const
inline

◆ end() [1/2]

template<typename GV , typename P >
template<dim_type codim>
Codim<codim>::Iterator Dune::PDELab::PartitionViewEntitySet< GV, P >::end ( ) const
inline

◆ end() [2/2]

template<typename GV , typename P >
template<dim_type codim, PartitionIteratorType pitype>
GV::template Codim<codim>::template Partition<pitype>::Iterator Dune::PDELab::PartitionViewEntitySet< GV, P >::end ( ) const
inline

◆ ghostSize()

template<typename GV , typename P >
size_type Dune::PDELab::PartitionViewEntitySet< GV, P >::ghostSize ( dim_type  codim) const
inline

Returns the ghost size of this EntitySet, which depends on its PartitionSet.

◆ grid()

template<typename GV , typename P >
const Grid& Dune::PDELab::PartitionViewEntitySet< GV, P >::grid ( ) const
inline

◆ gridView()

template<typename GV , typename P >
const GridView& Dune::PDELab::PartitionViewEntitySet< GV, P >::gridView ( ) const
inline

Returns the underlying GridView.

◆ ibegin()

template<typename GV , typename P >
IntersectionIterator Dune::PDELab::PartitionViewEntitySet< GV, P >::ibegin ( const typename Codim< 0 >::Entity &  entity) const
inline

◆ iend()

template<typename GV , typename P >
IntersectionIterator Dune::PDELab::PartitionViewEntitySet< GV, P >::iend ( const typename Codim< 0 >::Entity &  entity) const
inline

◆ indexSet()

template<typename GV , typename P >
const IndexSet& Dune::PDELab::PartitionViewEntitySet< GV, P >::indexSet ( ) const
inline

Returns the IndexSet of this EntitySet.

◆ needsUpdate()

template<typename GV , typename P >
bool Dune::PDELab::PartitionViewEntitySet< GV, P >::needsUpdate ( ) const
inline

Returns true if you need to call update on this EntitySet before using it.

◆ overlapSize()

template<typename GV , typename P >
size_type Dune::PDELab::PartitionViewEntitySet< GV, P >::overlapSize ( dim_type  codim) const
inline

Returns the overlap size of this EntitySet, which depends on its PartitionSet.

◆ partitions()

template<typename GV , typename P >
constexpr static Partitions Dune::PDELab::PartitionViewEntitySet< GV, P >::partitions ( )
inlinestaticconstexpr

◆ removeCodim()

template<typename GV , typename P >
void Dune::PDELab::PartitionViewEntitySet< GV, P >::removeCodim ( dim_type  codim)
inline

Remove all entities of the given codim from this EntitySet.

◆ reset()

template<typename GV , typename P >
void Dune::PDELab::PartitionViewEntitySet< GV, P >::reset ( )
inline

Reset this EntitySet, which removes all entities from it.

◆ size() [1/2]

template<typename GV , typename P >
size_type Dune::PDELab::PartitionViewEntitySet< GV, P >::size ( const GeometryType &  gt) const
inline

◆ size() [2/2]

template<typename GV , typename P >
size_type Dune::PDELab::PartitionViewEntitySet< GV, P >::size ( dim_type  codim) const
inline

◆ 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.

Member Data Documentation

◆ conforming

template<typename GV , typename P >
const bool Dune::PDELab::PartitionViewEntitySet< GV, P >::conforming = Traits::conforming
static

◆ dimension

template<typename GV , typename P >
const dim_type Dune::PDELab::PartitionViewEntitySet< GV, P >::dimension = Traits::dimension
static

◆ dimensionworld

template<typename GV , typename P >
const dim_type Dune::PDELab::PartitionViewEntitySet< GV, P >::dimensionworld = Traits::dimensionworld
static
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17