zoneGeneratorList Class Reference

List of zoneGenerators. More...

Inheritance diagram for zoneGeneratorList:
Collaboration diagram for zoneGeneratorList:

Public Member Functions

 zoneGeneratorList (const polyMesh &mesh)
 Construct from mesh. More...
 
 zoneGeneratorList (const polyMesh &mesh, const dictionary &dict, const bool topLevel=false)
 Construct from mesh and dictionary. More...
 
 zoneGeneratorList (const polyMesh &mesh, const dictionary &dict, const word &zoneName, const word &zonesName)
 Construct from mesh and dictionary and sub-dictionary names. More...
 
 zoneGeneratorList (const zoneGeneratorList &)=delete
 Disallow default bitwise copy construction. More...
 
bool moveUpdate () const
 Return true if any of the zoneGenerators updates any of the zones. More...
 
void generate ()
 Generate and register the zones. More...
 
void movePoints ()
 Update the zones following mesh point movement. More...
 
void operator= (const zoneGeneratorList &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from PtrListDictionary< zoneGenerator >
 PtrListDictionary (const label size)
 Construct given initial list size. More...
 
 PtrListDictionary (const PtrListDictionary &)
 Copy constructor. More...
 
 PtrListDictionary (PtrListDictionary &&)
 Move constructor. More...
 
 PtrListDictionary (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrListDictionary (Istream &)
 Construct from Istream. More...
 
label findIndex (const word &key) const
 Return the index of the given the key or -1 if not found. More...
 
List< labelfindIndices (const wordRe &key) const
 Return the indices for all matches. More...
 
void append (const word &key, zoneGenerator *)
 Append an element at the end of the list. More...
 
void append (const word &key, const autoPtr< zoneGenerator > &)
 Append an element at the end of the list. More...
 
void append (const word &key, const tmp< zoneGenerator > &)
 Append an element at the end of the list. More...
 
void append (zoneGenerator *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< zoneGenerator > &)
 Append an element at the end of the list. More...
 
void append (const tmp< zoneGenerator > &)
 Append an element at the end of the list. More...
 
autoPtr< zoneGeneratorset (const label, const word &key, zoneGenerator *)
 Set element to pointer provided and return old element. More...
 
autoPtr< zoneGeneratorset (const label, const word &key, const autoPtr< zoneGenerator > &)
 Set element to autoPtr value provided and return old element. More...
 
autoPtr< zoneGeneratorset (const label, const word &key, const tmp< zoneGenerator > &)
 Set element to tmp value provided and return old element. More...
 
autoPtr< zoneGeneratorset (const label, zoneGenerator *)
 Set element to pointer provided and return old element. More...
 
autoPtr< zoneGeneratorset (const label, const autoPtr< zoneGenerator > &)
 Set element to autoPtr value provided and return old element. More...
 
autoPtr< zoneGeneratorset (const label, const tmp< zoneGenerator > &)
 Set element to tmp value provided and return old element. More...
 
autoPtr< zoneGeneratorremove (const word &key)
 Remove an entry from the list and return. More...
 
UPtrListDictionary< T2 > convert ()
 Convert to list of different type. More...
 
Foam::UPtrListDictionary< T2 > convert ()
 
UPtrListDictionary< T2 > lookupType ()
 Lookup and return the sub-list of the given type. More...
 
UPtrListDictionary< const T2 > lookupType () const
 Lookup and return the sub-list of the given type. More...
 
Foam::UPtrListDictionary< T2 > lookupType ()
 
Foam::UPtrListDictionary< const T2 > lookupType () const
 
const zoneGeneratoroperator[] (const word &key) const
 Find and return entry. More...
 
zoneGeneratoroperator[] (const word &key)
 Find and return entry. More...
 
- Public Member Functions inherited from DictionaryBase< IDLListType, T >
 DictionaryBase (const label size=128)
 Construct given initial table size. More...
 
 DictionaryBase (const DictionaryBase &)
 Copy constructor. More...
 
 DictionaryBase (DictionaryBase &&)
 Move constructor. More...
 
template<class INew >
 DictionaryBase (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 DictionaryBase (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
bool found (const word &) const
 Search DictionaryBase for given keyword. More...
 
const TlookupPtr (const word &) const
 Find and return an entry if present, otherwise return nullptr. More...
 
TlookupPtr (const word &)
 Find and return an entry if present, otherwise return nullptr. More...
 
const Tlookup (const word &) const
 Find and return entry. More...
 
Tlookup (const word &)
 Find and return entry. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the table of contents as a sorted list. More...
 
void insert (const word &, T *)
 Add at head of dictionary. More...
 
void append (const word &, T *)
 Add at tail of dictionary. More...
 
Tremove (const word &)
 Remove and return entry specified by keyword. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (DictionaryBase< IDLListType, T > &)
 Transfer the contents of the argument into this DictionaryBase. More...
 
void operator= (const DictionaryBase &)
 
const Toperator[] (const word &key) const
 Find and return entry. More...
 
Toperator[] (const word &key)
 Find and return entry. More...
 

Protected Member Functions

void read (const dictionary &dict, const bool topLevel=false)
 
- Protected Member Functions inherited from DictionaryBase< IDLListType, T >
void addEntries ()
 

Protected Attributes

const polyMeshmesh_
 Reference to the polyMesh. More...
 
- Protected Attributes inherited from DictionaryBase< IDLListType, T >
HashTable< T * > hashedTs_
 HashTable of the entries held on the IDLListType for quick lookup. More...
 

Detailed Description

List of zoneGenerators.

Used by Foam::zonesGenerator to generate and store the zones and also by the zoneGenerators::Union, zoneGenerators::difference and zoneGenerators::intersection zoneGenerators to construct the list of zones they combine.

See also
zonesGenerator zoneGenerator zoneSet
Source files

Definition at line 59 of file zoneGeneratorList.H.

Constructor & Destructor Documentation

◆ zoneGeneratorList() [1/4]

zoneGeneratorList ( const polyMesh mesh)

Construct from mesh.

Definition at line 172 of file zoneGeneratorList.C.

◆ zoneGeneratorList() [2/4]

zoneGeneratorList ( const polyMesh mesh,
const dictionary dict,
const bool  topLevel = false 
)

Construct from mesh and dictionary.

Definition at line 179 of file zoneGeneratorList.C.

References dict, and zoneGeneratorList::read().

Here is the call graph for this function:

◆ zoneGeneratorList() [3/4]

zoneGeneratorList ( const polyMesh mesh,
const dictionary dict,
const word zoneName,
const word zonesName 
)

Construct from mesh and dictionary and sub-dictionary names.

Definition at line 192 of file zoneGeneratorList.C.

References PtrListDictionary< zoneGenerator >::append(), dict, dictionary::entries(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstream::lineNumber(), mesh, zoneGeneratorList::mesh_, Foam::name(), zoneGenerator::New(), and zoneGeneratorList::read().

Here is the call graph for this function:

◆ zoneGeneratorList() [4/4]

zoneGeneratorList ( const zoneGeneratorList )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ read()

void read ( const dictionary dict,
const bool  topLevel = false 
)
protected

◆ moveUpdate()

bool moveUpdate ( ) const

Return true if any of the zoneGenerators updates any of the zones.

following mesh point motion

Definition at line 257 of file zoneGeneratorList.C.

References forAll.

Referenced by intersection::intersection().

Here is the caller graph for this function:

◆ generate()

void generate ( )

Generate and register the zones.

Definition at line 273 of file zoneGeneratorList.C.

References forAll.

◆ movePoints()

void movePoints ( )

Update the zones following mesh point movement.

Definition at line 284 of file zoneGeneratorList.C.

References forAll.

Referenced by zonesGenerator::movePoints().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const zoneGeneratorList )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ mesh_

const polyMesh& mesh_
protected

Reference to the polyMesh.

Definition at line 68 of file zoneGeneratorList.H.

Referenced by zoneGeneratorList::read(), and zoneGeneratorList::zoneGeneratorList().


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