Flow123d  DF_patch_fe_data_tables-da7858b
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
RegionIdx Class Reference

#include <region.hh>

Inheritance diagram for RegionIdx:
Inheritance graph
[legend]

Public Member Functions

 RegionIdx ()
 Default region is undefined/invalid. More...
 
bool is_boundary () const
 Returns true if it is a Boundary region and false if it is a Bulk region. More...
 
bool is_valid () const
 Returns false if the region has undefined/invalid value. More...
 
unsigned int idx () const
 Returns a global index of the region. More...
 
unsigned int boundary_idx () const
 Returns index of the region in the boundary set. More...
 
unsigned int bulk_idx () const
 Returns index of the region in the bulk set. More...
 
bool operator== (const RegionIdx &other) const
 Equality comparison operators for regions. More...
 
bool operator!= (const RegionIdx &other) const
 Equality comparison operators for regions. More...
 

Protected Member Functions

 RegionIdx (unsigned int index)
 

Protected Attributes

unsigned int idx_
 

Static Protected Attributes

static const unsigned int undefined =0xffffffff
 index for undefined region More...
 

Friends

class Region
 

Detailed Description

Base class that contains information about region: 1) contains integer value that specifies region 2) detects if region is valid 3) detects if the region is the bulk or boundary 4) detects boundary index of boundary region or bulk index of bulk region

Definition at line 66 of file region.hh.

Constructor & Destructor Documentation

◆ RegionIdx() [1/2]

RegionIdx::RegionIdx ( )
inline

Default region is undefined/invalid.

Definition at line 70 of file region.hh.

Here is the caller graph for this function:

◆ RegionIdx() [2/2]

RegionIdx::RegionIdx ( unsigned int  index)
inlineprotected

Create accessor from the index. Should be private since implementation specific. We need some way how to iterate over: all regions, boundary regions, bulk regions - solution: have specific RegionSets for these three cases.

Definition at line 109 of file region.hh.

Member Function Documentation

◆ boundary_idx()

unsigned int RegionIdx::boundary_idx ( ) const
inline

Returns index of the region in the boundary set.

Definition at line 85 of file region.hh.

Here is the caller graph for this function:

◆ bulk_idx()

unsigned int RegionIdx::bulk_idx ( ) const
inline

Returns index of the region in the bulk set.

Definition at line 90 of file region.hh.

Here is the caller graph for this function:

◆ idx()

unsigned int RegionIdx::idx ( ) const
inline

Returns a global index of the region.

Definition at line 81 of file region.hh.

Here is the caller graph for this function:

◆ is_boundary()

bool RegionIdx::is_boundary ( ) const
inline

Returns true if it is a Boundary region and false if it is a Bulk region.

Definition at line 73 of file region.hh.

Here is the caller graph for this function:

◆ is_valid()

bool RegionIdx::is_valid ( ) const
inline

Returns false if the region has undefined/invalid value.

Definition at line 77 of file region.hh.

Here is the caller graph for this function:

◆ operator!=()

bool RegionIdx::operator!= ( const RegionIdx other) const
inline

Equality comparison operators for regions.

Definition at line 99 of file region.hh.

◆ operator==()

bool RegionIdx::operator== ( const RegionIdx other) const
inline

Equality comparison operators for regions.

Definition at line 95 of file region.hh.

Friends And Related Function Documentation

◆ Region

friend class Region
friend

Definition at line 120 of file region.hh.

Member Data Documentation

◆ idx_

unsigned int RegionIdx::idx_
protected

Internal region index. Regions of one RegionDB (corresponding to one mesh) forms more or less continuous sequence.

Definition at line 115 of file region.hh.

◆ undefined

const unsigned int RegionIdx::undefined =0xffffffff
staticprotected

index for undefined region

Definition at line 118 of file region.hh.


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