boundaryRegion Class Reference

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

Inheritance diagram for boundaryRegion:

[legend]

Collaboration diagram for boundaryRegion:

[legend]

List of all members.

Public Member Functions
	boundaryRegion ()
	Construct null.
	boundaryRegion (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant")
	Construct read from registry, name. instance.
	~boundaryRegion ()
	Destructor.
label	append (const dictionary &)
	Append to the end, return index.
label	findIndex (const word &name) const
	Return index corresponding to patch 'name'.
Map< word >	names () const
	Return a Map of (id => name).
Map< word >	names (const List< wordRe > &patterns) const
	Return a Map of (id => names) selected by patterns.
Map< word >	boundaryTypes () const
	Return a Map of (id => type).
word	boundaryType (const word &name) const
	Return BoundaryType corresponding to patch 'name'.
void	readDict (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant")
	Read constant/boundaryRegion.
void	writeDict (const objectRegistry &, const word &name="boundaryRegion", const fileName &instance="constant") const
	Write constant/boundaryRegion for later reuse.
void	operator= (const boundaryRegion &)
	Assignment.
void	operator= (const Map< dictionary > &)
	Assign from Map<dictionary>.
void	rename (const dictionary &)
	Rename regions.

---

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 66 of file boundaryRegion.H.

---

Constructor & Destructor Documentation

boundaryRegion

(

)

Construct null.

Definition at line 25 of file boundaryRegion.C.

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

Construct read from registry, name. instance.

Definition at line 32 of file boundaryRegion.C.

~boundaryRegion

(

)

Destructor.

Definition at line 46 of file boundaryRegion.C.

---

Member Function Documentation

Foam::label append

(

const dictionary &

dict

)

Append to the end, return index.

Definition at line 52 of file boundaryRegion.C.

Foam::label findIndex

(

const word &

name

)

const

Return index corresponding to patch 'name'.

returns -1 if not found

Definition at line 131 of file boundaryRegion.C.

Foam::Map< Foam::word > names

(

)

const

Return a Map of (id => name).

Definition at line 68 of file boundaryRegion.C.

Foam::Map< Foam::word > names

(

const List< wordRe > &

patterns

)

const

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

Definition at line 90 of file boundaryRegion.C.

Foam::Map< Foam::word > boundaryTypes

(

)

const

Return a Map of (id => type).

Definition at line 114 of file boundaryRegion.C.

Foam::word boundaryType

(

const word &

name

)

const

Return BoundaryType corresponding to patch 'name'.

Definition at line 150 of file boundaryRegion.C.

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

Read constant/boundaryRegion.

Definition at line 165 of file boundaryRegion.C.

References HashTable< dictionary, label, Hash< label > >::operator[](), and dictionary::readIfPresent().

Here is the call graph for this function:

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

Write constant/boundaryRegion for later reuse.

Definition at line 199 of file boundaryRegion.C.

void operator=

(

const boundaryRegion &

rhs

)

Assignment.

Definition at line 232 of file boundaryRegion.C.

Referenced by boundaryRegion::operator=(), and boundaryRegion::rename().

Here is the caller graph for this function:

void operator=

(

const Map< dictionary > &

rhs

)

Assign from Map<dictionary>.

Definition at line 238 of file boundaryRegion.C.

References boundaryRegion::operator=().

Here is the call graph for this function:

void rename

(

const dictionary &

mapDict

)

Rename regions.

each dictionary entry is a single word:

    newPatchName    originalName;

Definition at line 246 of file boundaryRegion.C.

References boundaryRegion::operator=().

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