Reference documentation for deal.II version GIT 204c5e6f02 2022-07-06 01:00:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Protected Attributes | List of all members
IteratorFilters::BoundaryIdEqualTo Class Reference

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

Public Member Functions

 BoundaryIdEqualTo (const types::boundary_id boundary_id)
 
 BoundaryIdEqualTo (const std::set< types::boundary_id > &boundary_ids)
 
template<class Iterator >
bool operator() (const Iterator &i) const
 

Protected Attributes

const std::set< types::boundary_idboundary_ids
 

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 boundary id.

Definition at line 340 of file filtered_iterator.h.

Constructor & Destructor Documentation

◆ BoundaryIdEqualTo() [1/2]

IteratorFilters::BoundaryIdEqualTo::BoundaryIdEqualTo ( const types::boundary_id  boundary_id)
inline

Constructor. Store the boundary id which iterators shall have to be evaluated to true.

Definition at line 1523 of file filtered_iterator.h.

◆ BoundaryIdEqualTo() [2/2]

IteratorFilters::BoundaryIdEqualTo::BoundaryIdEqualTo ( const std::set< types::boundary_id > &  boundary_ids)
inline

Constructor. Store a collection of boundary ids which iterators shall have to be evaluated to true.

Definition at line 1530 of file filtered_iterator.h.

Member Function Documentation

◆ operator()()

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

Evaluation operator. Returns true if the boundary id of the object pointed to is equal within the stored set of value allowable values.

Definition at line 1539 of file filtered_iterator.h.

Member Data Documentation

◆ boundary_ids

const std::set<types::boundary_id> IteratorFilters::BoundaryIdEqualTo::boundary_ids
protected

Stored value to compare the material id with.

Definition at line 367 of file filtered_iterator.h.


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