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 ()
	Construct null. More...
	boundaryRegion (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant")
	Construct read from registry, name. instance. More...
	~boundaryRegion ()
	Destructor. More...
label	append (const dictionary &)
	Append to the end, return index. More...
label	findIndex (const word &name) const
	Return index corresponding to patch 'name'. More...
Map< word >	names () const
	Return a Map of (id => name) More...
Map< word >	names (const UList< wordRe > &patterns) const
	Return a Map of (id => names) selected by patterns. More...
Map< word >	boundaryTypes () const
	Return a Map of (id => type) More...
word	boundaryType (const word &name) const
	Return BoundaryType corresponding to patch 'name'. More...
void	readDict (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant")
	Read constant/boundaryRegion. More...
void	writeDict (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant") const
	Write constant/boundaryRegion for later reuse. More...
void	operator= (const boundaryRegion &)
	Assignment. More...
void	operator= (const Map< dictionary > &)
	Assign from Map<dictionary> More...
void	rename (const dictionary &)
	Rename regions. More...
Public Member Functions inherited from Map< dictionary >
	Map (const label size=128)
	Construct given initial size. More...
	Map (Istream &is)
	Construct from Istream. More...
	Map (const Map< T > &map)
	Construct as copy. More...
	Map (const Xfer< Map< T > > &map)
	Construct by transferring the parameter contents. More...
	Map (const Xfer< HashTable< T, label, Hash< label > > > &map)
	Construct by transferring the parameter contents. More...

Private Member Functions
	boundaryRegion (const boundaryRegion &)
	Disallow default bitwise copy construct. More...

Additional Inherited Members
Public Types inherited from Map< dictionary >
typedef HashTable< T, label, Hash< label > >::iterator	iterator
typedef HashTable< T, label, Hash< label > >::const_iterator	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 70 of file boundaryRegion.H.

Constructor & Destructor Documentation

boundaryRegion() [1/3]

boundaryRegion ( const boundaryRegion &  )

private

Disallow default bitwise copy construct.

boundaryRegion() [2/3]

boundaryRegion

(

)

Construct null.

Definition at line 33 of file boundaryRegion.C.

boundaryRegion() [3/3]

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

Construct read from registry, name. instance.

Definition at line 40 of file boundaryRegion.C.

References Foam::name().

Here is the call graph for this function:

~boundaryRegion()

~boundaryRegion

(

)

Destructor.

Definition at line 54 of file boundaryRegion.C.

Member Function Documentation

append()

Foam::label append

(

const dictionary &

dict

)

Append to the end, return index.

Definition at line 60 of file boundaryRegion.C.

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

Here is the call graph for this function:

findIndex()

Foam::label findIndex

(

const word &

name

)

const

Return index corresponding to patch 'name'.

returns -1 if not found

Definition at line 139 of file boundaryRegion.C.

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

Here is the call graph for this function:

names() [1/2]

Foam::Map< Foam::word > names

(

)

const

Return a Map of (id => name)

Definition at line 76 of file boundaryRegion.C.

References forAllConstIter(), lookup(), and Foam::name().

Here is the call graph for this function:

names() [2/2]

Foam::Map< Foam::word > names

(

const UList< wordRe > &

patterns

)

const

Return a Map of (id => names) selected by patterns.

Definition at line 98 of file boundaryRegion.C.

References Foam::findStrings(), forAllConstIter(), lookup(), and Foam::name().

Here is the call graph for this function:

boundaryTypes()

Foam::Map< Foam::word > boundaryTypes

(

)

const

Return a Map of (id => type)

Definition at line 122 of file boundaryRegion.C.

References forAllConstIter(), and lookup().

Here is the call graph for this function:

boundaryType()

Foam::word boundaryType

(

const word &

name

)

const

Return BoundaryType corresponding to patch 'name'.

Definition at line 158 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"
	)

Read constant/boundaryRegion.

Definition at line 173 of file boundaryRegion.C.

References clear(), Foam::endl(), IOobject::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

Write constant/boundaryRegion for later reuse.

Definition at line 207 of file boundaryRegion.C.

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

Here is the call graph for this function:

operator=() [1/2]

void operator=

(

const boundaryRegion &

rhs

)

Assignment.

Definition at line 240 of file boundaryRegion.C.

operator=() [2/2]

void operator=

(

const Map< dictionary > &

rhs

)

Assign from Map<dictionary>

Definition at line 246 of file boundaryRegion.C.

rename()

void rename

(

const dictionary &

mapDict

)

Rename regions.

each dictionary entry is a single word:

    newPatchName    originalName;

Definition at line 254 of file boundaryRegion.C.

References dict, Foam::findIndex(), forAllConstIter(), Foam::Info, dictionary::lookup(), 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/meshTables/boundaryRegion.H
• src/conversion/meshTables/boundaryRegion.C