Reference documentation for deal.II version 9.1.0-pre
Public Member Functions | Protected Attributes | List of all members
IteratorFilters::ActiveFEIndexEqualTo Class Reference

#include <deal.II/grid/filtered_iterator.h>

Public Member Functions

 ActiveFEIndexEqualTo (const unsigned int active_fe_index, const bool only_locally_owned=false)
 
 ActiveFEIndexEqualTo (const std::set< unsigned int > &active_fe_indices, const bool only_locally_owned=false)
 
template<class Iterator >
bool operator() (const Iterator &i) const
 

Protected Attributes

const std::set< unsigned int > active_fe_indices
 
const bool only_locally_owned
 

Detailed Description

Filter for iterators that evaluates to true if the iterator of the object pointed to is equal to a value or set of values given to the constructor, assuming that the iterator allows querying for an active FE index.

Author
Jean-Paul Pelteret, Denis Davydov, 2015

Definition at line 279 of file filtered_iterator.h.

Constructor & Destructor Documentation

IteratorFilters::ActiveFEIndexEqualTo::ActiveFEIndexEqualTo ( const unsigned int  active_fe_index,
const bool  only_locally_owned = false 
)
inline

Constructor. Store the active FE index which iterators shall have to be evaluated to true and state if the iterator must be locally owned.

Definition at line 1290 of file filtered_iterator.h.

IteratorFilters::ActiveFEIndexEqualTo::ActiveFEIndexEqualTo ( const std::set< unsigned int > &  active_fe_indices,
const bool  only_locally_owned = false 
)
inline

Constructor. Store a collection of active FE indices which iterators shall have to be evaluated to true and state if the iterator must be locally owned.

Definition at line 1299 of file filtered_iterator.h.

Member Function Documentation

template<class Iterator >
bool IteratorFilters::ActiveFEIndexEqualTo::operator() ( const Iterator &  i) const
inline

Evaluation operator. Returns true if the active FE index of the object pointed to is equal within the stored set of value allowable values and, if required, if the cell is locally owned.

Definition at line 1310 of file filtered_iterator.h.

Member Data Documentation

const std::set<unsigned int> IteratorFilters::ActiveFEIndexEqualTo::active_fe_indices
protected

Stored value to compare the material id with.

Definition at line 310 of file filtered_iterator.h.

const bool IteratorFilters::ActiveFEIndexEqualTo::only_locally_owned
protected

Flag stating whether only locally owned cells must return true.

Definition at line 314 of file filtered_iterator.h.


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