Reference documentation for deal.II version 9.5.0
\(\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\}}\)
No Matches
Public Member Functions | Protected Attributes | List of all members
IteratorFilters::SubdomainEqualTo Class Reference

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

Public Member Functions

 SubdomainEqualTo (const types::subdomain_id subdomain_id)
template<class Iterator >
bool operator() (const Iterator &i) const

Protected Attributes

const types::subdomain_id subdomain_id

Detailed Description

Filter for iterators that evaluates to true if either the iterator is past the end or the subdomain id of the object pointed to is equal to a value given to the constructor, assuming that the iterator allows querying for a subdomain id.

Definition at line 157 of file filtered_iterator.h.

Constructor & Destructor Documentation

◆ SubdomainEqualTo()

IteratorFilters::SubdomainEqualTo::SubdomainEqualTo ( const types::subdomain_id  subdomain_id)

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

Definition at line 1436 of file filtered_iterator.h.

Member Function Documentation

◆ operator()()

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

Evaluation operator. Returns true if either the subdomain of the object pointed to is equal to the stored value or the iterator is past the end.

Definition at line 1445 of file filtered_iterator.h.

Member Data Documentation

◆ subdomain_id

const types::subdomain_id IteratorFilters::SubdomainEqualTo::subdomain_id

Stored value to compare the subdomain with.

Definition at line 179 of file filtered_iterator.h.

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