MultiRegionRefs< Region > Class Template Reference

Class to wrap a UPtrList of of region-associated objects (meshes, solvers, domainDecompositions, ...). Access will return a wrapped reference and will set the Info prefix to the region name. The prefix will remain until the wrapped reference goes out of scope. More...

Inheritance diagram for MultiRegionRefs< Region >:

Public Member Functions
	MultiRegionRefs (UPtrList< Region > &regions)
	Construct from a list of region pointers. More...
	~MultiRegionRefs ()
	Destructor. More...
label	size () const
	Return the size. More...
RegionRef< const Region >	operator[] (const label regioni) const
	Const-access a region. More...
RegionRef< Region >	operator[] (const label regioni)
	Access a region. More...
RegionRef< const Region >	operator[] (const word &regionName) const
	Const-access a region. More...
RegionRef< Region >	operator[] (const word &regionName)
	Access a region. More...

Friends
class	RegionRef< Region >
	Declare friendship with region-reference class. More...
class	RegionRef< const Region >
	Declare friendship with const-region-reference class. More...

Detailed Description

template<class Region>
class Foam::MultiRegionRefs< Region >

Class to wrap a UPtrList of of region-associated objects (meshes, solvers, domainDecompositions, ...). Access will return a wrapped reference and will set the Info prefix to the region name. The prefix will remain until the wrapped reference goes out of scope.

Definition at line 110 of file MultiRegionRefs.H.

Constructor & Destructor Documentation

MultiRegionRefs()

MultiRegionRefs

(

UPtrList< Region > &

regions

)

Construct from a list of region pointers.

Definition at line 91 of file MultiRegionRefs.C.

References forAll, word::null, prefixOSstream::prefix(), Foam::regionName(), and Foam::Sout.

Here is the call graph for this function:

~MultiRegionRefs()

~MultiRegionRefs

Destructor.

Definition at line 126 of file MultiRegionRefs.C.

References prefixOSstream::prefix(), and Foam::Sout.

Here is the call graph for this function:

Member Function Documentation

size()

Foam::label size

Return the size.

Definition at line 135 of file MultiRegionRefs.C.

operator[]() [1/4]

Foam::RegionRef< const Region > operator[]

(

const label

regioni

)

const

Const-access a region.

Definition at line 158 of file MultiRegionRefs.C.

operator[]() [2/4]

Foam::RegionRef< Region > operator[]

(

const label

regioni

)

Access a region.

Definition at line 168 of file MultiRegionRefs.C.

operator[]() [3/4]

Foam::RegionRef< const Region > operator[]

(

const word &

regionName

)

const

Const-access a region.

Definition at line 178 of file MultiRegionRefs.C.

References Foam::regionName().

Here is the call graph for this function:

operator[]() [4/4]

Foam::RegionRef< Region > operator[]

(

const word &

regionName

)

Access a region.

Definition at line 188 of file MultiRegionRefs.C.

References Foam::regionName().

Here is the call graph for this function:

Friends And Related Function Documentation

RegionRef< Region >

friend class RegionRef< Region >

friend

Declare friendship with region-reference class.

Definition at line 130 of file MultiRegionRefs.H.

RegionRef< const Region >

friend class RegionRef< const Region >

friend

Declare friendship with const-region-reference class.

Definition at line 130 of file MultiRegionRefs.H.

---

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

• src/OpenFOAM/meshes/multiRegion/MultiRegionRefs.H
• src/OpenFOAM/meshes/multiRegion/MultiRegionRefs.C