Reference documentation for deal.II version Git 0491297983 2019-09-23 09:31:59 +0200
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Protected Attributes | List of all members
IteratorFilters::MaterialIdEqualTo Class Reference

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

Public Member Functions

 MaterialIdEqualTo (const types::material_id material_id, const bool only_locally_owned=false)
 
 MaterialIdEqualTo (const std::set< types::material_id > &material_ids, const bool only_locally_owned=false)
 
template<class Iterator >
bool operator() (const Iterator &i) const
 

Protected Attributes

const std::set< types::material_idmaterial_ids
 
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 a material id.

Author
Jean-Paul Pelteret, Denis Davydov, 2015

Definition at line 232 of file filtered_iterator.h.

Constructor & Destructor Documentation

◆ MaterialIdEqualTo() [1/2]

IteratorFilters::MaterialIdEqualTo::MaterialIdEqualTo ( const types::material_id  material_id,
const bool  only_locally_owned = false 
)
inline

Constructor. Store the material id which iterators shall have to be evaluated to true and state if the iterator must be locally owned.

Definition at line 1246 of file filtered_iterator.h.

◆ MaterialIdEqualTo() [2/2]

IteratorFilters::MaterialIdEqualTo::MaterialIdEqualTo ( const std::set< types::material_id > &  material_ids,
const bool  only_locally_owned = false 
)
inline

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

Definition at line 1255 of file filtered_iterator.h.

Member Function Documentation

◆ operator()()

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

Evaluation operator. Returns true if the material id 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 1266 of file filtered_iterator.h.

Member Data Documentation

◆ material_ids

const std::set<types::material_id> IteratorFilters::MaterialIdEqualTo::material_ids
protected

Stored value to compare the material id with.

Definition at line 263 of file filtered_iterator.h.

◆ only_locally_owned

const bool IteratorFilters::MaterialIdEqualTo::only_locally_owned
protected

Flag stating whether only locally owned cells must return true.

Definition at line 267 of file filtered_iterator.h.


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