FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

boundaryRegion Class Reference

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

#include <conversion/boundaryRegion.H>


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
{
BoundaryTypeWORD;
Label   WORD;
}
...
)
Source files

Definition at line 71 of file boundaryRegion.H.

Inheritance diagram for boundaryRegion:
Collaboration diagram for boundaryRegion:

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.

Constructor & Destructor Documentation

Construct null.

Definition at line 33 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 40 of file boundaryRegion.C.

Destructor.

Definition at line 54 of file boundaryRegion.C.


Member Function Documentation

Foam::label append ( const dictionary &   dict  )

Append to the end, return index.

Definition at line 60 of file boundaryRegion.C.

References forAllConstIter, and insert().

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, and word::null.

Foam::Map< Foam::word > names (  ) const

Return a Map of (id => name)

Definition at line 76 of file boundaryRegion.C.

References forAllConstIter, HashTable< T, label, Hash< label > >::insert(), and Foam::name().

Foam::Map< Foam::word > names ( const List< wordRe > &   patterns  ) const

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

Definition at line 98 of file boundaryRegion.C.

References Foam::findStrings(), forAllConstIter, HashTable< T, label, Hash< label > >::insert(), and Foam::name().

Foam::Map< Foam::word > boundaryTypes (  ) const

Return a Map of (id => type)

Definition at line 122 of file boundaryRegion.C.

References forAllConstIter, and HashTable< T, label, Hash< label > >::insert().

Foam::word boundaryType ( const word &   name  ) const

Return BoundaryType corresponding to patch 'name'.

Definition at line 158 of file boundaryRegion.C.

References Foam::findIndex().

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, IOobject::NO_WRITE, and IOobject::READ_IF_PRESENT.

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, IOobject::name(), IOobject::NO_READ, IOobject::NO_WRITE, IOobject::note(), IOobject::objectPath(), and IOobject::writeHeader().

void operator= ( const boundaryRegion &   rhs  )

Assignment.

Definition at line 240 of file boundaryRegion.C.

References HashTable< T, label, Hash< label > >::operator=().

void operator= ( const Map< dictionary > &   rhs  )

Assign from Map<dictionary>

Definition at line 246 of file boundaryRegion.C.

References HashTable< T, label, Hash< label > >::operator=().

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 DLListBase::empty(), Foam::findIndex(), forAllConstIter, Foam::Info, HashTable< T, label, Hash< label > >::insert(), dictionary::lookup(), Foam::nl, and dictionary::set().


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