boundaryRegion Class Reference

The boundaryRegion persistent data saved as a Map<dictionary>. More...

Inheritance diagram for boundaryRegion:

Collaboration diagram for boundaryRegion:

Public Member Functions
	boundaryRegion ()
	boundaryRegion (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant")
	~boundaryRegion ()=default
label	append (const dictionary &)
label	findIndex (const word &name) const
Map< word >	names () const
Map< word >	names (const wordRes &patterns) const
Map< word >	boundaryTypes () const
word	boundaryType (const word &name) const
void	readDict (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant")
void	writeDict (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant") const
void	operator= (const boundaryRegion &)
void	operator= (const Map< dictionary > &)
void	rename (const dictionary &)
Public Member Functions inherited from Map< dictionary >
	Map ()
	Map (const label size)
	Map (Istream &is)
	Map (const this_type &map)
	Map (this_type &&map)
	Map (std::initializer_list< std::pair< label, T >> map)
void	operator= (const this_type &rhs)
void	operator= (this_type &&rhs)
void	operator= (const this_type &rhs)
void	operator= (std::initializer_list< std::pair< Key, T >> rhs)
void	operator= (this_type &&rhs)

Additional Inherited Members
Public Types inherited from Map< dictionary >
typedef Map< T >	this_type
typedef HashTable< T, label, Hash< label > >	parent_type
using	iterator = typename parent_type::iterator
using	const_iterator = typename parent_type::const_iterator

Detailed Description

The boundaryRegion persistent data saved as a Map<dictionary>.

The meshReader supports boundaryRegion information.

The constant/boundaryRegion file is an IOMap<dictionary> that is used to save the information persistently. It contains the boundaryRegion information of the following form:

    (
        INT
        {
            BoundaryType    WORD;
            Label           WORD;
        }
        ...
    )

Source files

• boundaryRegion.H
• boundaryRegion.C

Definition at line 68 of file boundaryRegion.H.

Constructor & Destructor Documentation

boundaryRegion() [1/2]

boundaryRegion

(

)

Definition at line 28 of file boundaryRegion.C.

boundaryRegion() [2/2]

boundaryRegion	(	const objectRegistry &	registry,
		const word &	name = "boundaryRegion",
		const fileName &	instance = "constant"
	)

Definition at line 35 of file boundaryRegion.C.

References Foam::name().

Here is the call graph for this function:

~boundaryRegion()

~boundaryRegion ( )

default

Member Function Documentation

append()

Foam::label append

(

const dictionary &

dict

)

Definition at line 49 of file boundaryRegion.C.

References dict, forAllConstIters(), and insert().

Here is the call graph for this function:

findIndex()

Foam::label findIndex

(

const word &

name

)

const

Definition at line 128 of file boundaryRegion.C.

References forAllConstIters(), Foam::name(), and word::null.

Here is the call graph for this function:

names() [1/2]

Foam::Map< Foam::word > names

(

)

const

Definition at line 65 of file boundaryRegion.C.

References forAllConstIters(), and Foam::name().

Here is the call graph for this function:

names() [2/2]

Foam::Map< Foam::word > names

(

const wordRes &

patterns

)

const

Definition at line 87 of file boundaryRegion.C.

References forAllConstIters(), wordRes::match(), and Foam::name().

Here is the call graph for this function:

boundaryTypes()

Foam::Map< Foam::word > boundaryTypes

(

)

const

Definition at line 111 of file boundaryRegion.C.

References forAllConstIters().

Here is the call graph for this function:

boundaryType()

Foam::word boundaryType

(

const word &

name

)

const

Definition at line 147 of file boundaryRegion.C.

References Foam::findIndex().

Here is the call graph for this function:

readDict()

void readDict	(	const objectRegistry &	registry,
		const word &	name = "boundaryRegion",
		const fileName &	instance = "constant"
	)

Definition at line 162 of file boundaryRegion.C.

References clear(), Foam::endl(), regIOobject::headerOk(), Foam::Info, Foam::name(), IOobject::NO_WRITE, and IOobject::READ_IF_PRESENT.

Here is the call graph for this function:

writeDict()

void writeDict	(	const objectRegistry &	registry,
		const word &	name = "boundaryRegion",
		const fileName &	instance = "constant"
	)		const

Definition at line 196 of file boundaryRegion.C.

References Foam::endl(), Foam::Info, Foam::name(), IOobject::name(), IOobject::NO_READ, IOobject::NO_WRITE, IOobject::note(), IOobject::objectPath(), os(), and IOobject::writeHeader().

Here is the call graph for this function:

operator=() [1/2]

void operator=

(

const boundaryRegion &

rhs

)

Definition at line 229 of file boundaryRegion.C.

References Map::operator=().

Here is the call graph for this function:

operator=() [2/2]

void operator=

(

const Map< dictionary > &

rhs

)

Definition at line 235 of file boundaryRegion.C.

References Map::operator=().

Here is the call graph for this function:

rename()

void rename

(

const dictionary &

mapDict

)

Definition at line 243 of file boundaryRegion.C.

References dict, Foam::findIndex(), forAllConstIters(), dictionary::get(), Foam::Info, Foam::nl, and dictionary::set().

Here is the call graph for this function:

---

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

• src/conversion/common/tables/boundaryRegion.H
• src/conversion/common/tables/boundaryRegion.C