A list of mesh zones. More...
#include <ZoneMesh.H>
Public Types | |
| typedef MeshType | mesh_type |
| The referenced mesh type. | |
| typedef ZoneType | zone_type |
| The zone type. Same as PtrList<ZoneType>::value_type. | |
| Public Types inherited from UPtrList< ZoneType > | |
| typedef ZoneType | value_type |
| Type of values the list contains. | |
| typedef ZoneType & | reference |
| A non-const reference to the value_type. | |
| typedef const ZoneType & | const_reference |
| A const reference to the value_type. | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). More... | |
| Public Types inherited from IOobjectOption | |
| enum | readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 } |
| Enumeration defining read preferences. More... | |
| enum | writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
| Enumeration defining write preferences. More... | |
| enum | registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 } |
| Enumeration for use with registerObject(). Values map to bool (false/true). More... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
Public Member Functions | |
| ZoneMesh (const ZoneMesh &)=delete | |
| No copy construct. | |
| void | operator= (const ZoneMesh< ZoneType, MeshType > &)=delete |
| No copy assignment. | |
| ZoneMesh (const IOobject &io, const MeshType &mesh) | |
| Read construct from IOobject and mesh reference Any reading (mandatory, optional) based on IOobject properties. | |
| ZoneMesh (const IOobject &io, const MeshType &mesh, Foam::zero) | |
| Construct empty with IOobject properties and a mesh reference. Does not read. | |
| ZoneMesh (const IOobject &io, const MeshType &mesh, const label size) | |
| Construct with specified size if not read. Any reading (mandatory, optional) based on IOobject properties. | |
| ZoneMesh (const IOobject &io, const MeshType &mesh, const PtrList< ZoneType > &list) | |
| Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning). | |
| ZoneMesh (const IOobject &io, const MeshType &mesh, PtrList< entry > &&entries) | |
| Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning). | |
| ~ZoneMesh ()=default | |
| Destructor. | |
| const MeshType & | mesh () const noexcept |
| Return the mesh reference. | |
| const Map< label > & | zoneMap () const |
| Map of zones containing zone index for all zoned elements. | |
| label | whichZone (const label objectIndex) const |
| Given a global object index, return the zone it is in. | |
| label | whichZones (const label objectIndex, DynamicList< label > &zones) const |
| Given a global object index, return (in argument) its zones. | |
| labelList | zoneSizes () const |
| Return a list of zone sizes. | |
| wordList | types () const |
| Return a list of zone types. | |
| wordList | names () const |
| A list of the zone names. | |
| wordList | groupNames () const |
| A list of the zone group names (if any). | |
| wordList | names (const wordRe &matcher) const |
| A list of zone names satisfying the input matcher. | |
| wordList | names (const wordRes &matcher) const |
| A list of zone names satisfying the input matchers. | |
| wordList | sortedNames () const |
| Sorted list of the zone names. | |
| wordList | sortedNames (const wordRe &matcher) const |
| Sorted list of zone names satisfying the input matcher. | |
| wordList | sortedNames (const wordRes &matcher) const |
| Sorted list of zone names satisfying the input matchers. | |
| bool | reindex () |
| Adjust the index of zone entries to be consistent with their position in the list. | |
| labelList | indices (const wordRe &matcher, const bool useGroups=true) const |
| The (sorted) patch indices for all matches, optionally matching zone groups. | |
| labelList | indices (const wordRes &matcher, const bool useGroups=true) const |
| The (sorted) patch indices for all matches, optionally matching zone groups. | |
| labelList | indices (const wordRes &allow, const wordRes &deny, const bool useGroups=true) const |
| The (sorted) patch indices: logic as per Foam::wordRes::filter, optionally matching zone groups. | |
| label | findIndex (const wordRe &key) const |
| Zone index for the first match, return -1 if not found. | |
| label | findIndex (const wordRes &matcher) const |
| Zone index for the first match, return -1 if not found. | |
| label | findZoneID (const word &zoneName) const |
| Find zone index by name, return -1 if not found. | |
| const ZoneType * | cfindZone (const word &zoneName) const |
| Find zone by name and return const pointer, nullptr on error. | |
| ZoneType * | findZone (const word &zoneName) |
| Find zone by name and return pointer, nullptr on error. | |
| bitSet | selection (const labelUList &zoneIds) const |
| Return all elements (cells, faces, points) contained in the listed zones. | |
| bitSet | selection (const wordRe &matcher, const bool useGroups=true) const |
| Return all elements (cells, faces, points) that match the zone specification as a bitSet. | |
| bitSet | selection (const wordRes &matcher, const bool useGroups=true) const |
| Return all elements (cells, faces, points) that match the zone specification as a bitSet. | |
| const HashTable< labelList > & | groupZoneIDs () const |
| The zone indices per zone group. | |
| void | setGroup (const word &groupName, const labelUList &zoneIDs) |
| Set/add group with zones. | |
| bool | checkDefinition (const bool report=false) const |
| Check zone definition. Return true if in error. | |
| bool | checkParallelSync (const bool report=false) const |
| Check whether all procs have all zones and in same order. | |
| void | movePoints (const pointField &pts) |
| Correct zone mesh after moving points. | |
| void | clearAddressing () |
| Clear addressing. | |
| void | clearPrimitives () |
| Clear primitive addressing. | |
| void | clear () |
| Clear the zones. | |
| bool | hasZoneMap () const noexcept |
| The zoneMap has been allocated. | |
| const ZoneType & | operator[] (const word &zoneName) const |
| Return const reference to zone by name. | |
| ZoneType & | operator[] (const word &zoneName) |
| Return reference to an existing zone by name. | |
| ZoneType & | operator() (const word &zoneName, const bool verbose=false) |
| Find an existing zone by name or create a new empty one if required. | |
| void | updateMetaData () |
| Update internal meta-data (eg, prior to writing). | |
| void | writeEntry (Ostream &os) const |
| Write as a plain list of entries. | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write as a primitive entry with given name. If the keyword is empty, revert to a plain list. | |
| virtual bool | writeData (Ostream &os) const |
| The writeData member function required by regIOobject. | |
| labelList | findIndices (const wordRes &key) const |
| Identical to the indices() method (AUG-2018). | |
| Public Member Functions inherited from PtrList< ZoneType > | |
| Foam::PtrList< ZoneType > | clone (Args &&... args) const |
| constexpr | PtrList () noexcept |
| Default construct. | |
| ~PtrList () | |
| Destructor. Frees all pointers. | |
| const ZoneType * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| void | clear () |
| Clear the PtrList. Delete allocated entries and set size to zero. | |
| void | free () |
| Free memory and nullify all entries. Does not change the list size. | |
| void | resize (const label newLen) |
| Adjust size of PtrList. | |
| void | resize_null (const label newLen) |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. | |
| ZoneType & | emplace_back (Args &&... args) |
| Construct and append an element to the end of the list, return reference to the new list element. | |
| void | push_back (ZoneType *ptr) |
| Append an element to the end of the list. | |
| ZoneType & | emplace_set (const label i, Args &&... args) |
| Construct and set a new element at given position, (discard old element at that location). | |
| ZoneType & | emplace (const label i, Args &&... args) |
| Same as emplace_set(). | |
| ZoneType & | try_emplace (const label i, Args &&... args) |
| Like emplace_set() but will not overwrite an occupied (non-null) location. | |
| autoPtr< ZoneType > | release (const label i) |
| Release ownership of the pointer at the given position. | |
| void | transfer (PtrList< ZoneType > &list) |
| Transfer into this list and annul the argument list. | |
| void | operator= (const UPtrList< ZoneType > &list) |
| Copy assignment. | |
| void | setSize (const label n) |
| Same as resize(). | |
| void | append (autoPtr< ZoneType > &ptr) |
| Move append an element to the end of the list. | |
| Public Member Functions inherited from UPtrList< ZoneType > | |
| bool | empty () const noexcept |
| True if the list is empty (ie, size() is zero). | |
| label | size () const noexcept |
| The number of entries in the list. | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| label | count_nonnull () const noexcept |
| The number of non-nullptr entries in the list. | |
| ZoneType & | front () |
| Reference to the first element of the list. | |
| ZoneType & | back () |
| Reference to the last element of the list. | |
| const ZoneType * | test (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| const ZoneType * | get (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| const ZoneType * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| void | clear () |
| Set list size to zero. | |
| void | free () |
| Nullify all entries. Does not change the list size. | |
| void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr. | |
| void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr. | |
| label | squeezeNull () |
| Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. | |
| void | push_back (ZoneType *ptr) |
| Append an element to the end of the list. | |
| void | swap (UPtrList< ZoneType > &list) noexcept |
| Swap content. | |
| void | transfer (UPtrList< ZoneType > &list) |
| Transfer contents into this list and annul the argument. | |
| void | reorder (const labelUList &oldToNew, const bool check=false) |
| Reorder elements. Reordering must be unique (ie, shuffle). | |
| void | sortOrder (const labelUList &order, const bool check=false) |
| Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). | |
| void | checkNonNull () const |
| Check and raise FatalError if any nullptr exists in the list. | |
| const ZoneType & | at (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. | |
| const ZoneType & | operator[] (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). | |
| FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const ZoneType *operator()(const label i) const | |
| Deprecated(2022-09) - same as get(). | |
| void | operator= (const UPtrList< ZoneType > &list) |
| Copy assignment (shallow copies addresses). | |
| Ostream & | printAddresses (Ostream &os) const |
| Print pointer addresses to Ostream (debugging only). | |
| Ostream & | writeList (Ostream &os, const bool trimNull=false) const |
| Write UPtrList to Ostream, optionally ignoring null entries. | |
| ZoneType ** | begin_ptr () noexcept |
| Iterator to begin of raw pointers traversal (use with caution). | |
| ZoneType ** | end_ptr () noexcept |
| Iterator beyond end of raw pointers traversal (use with caution). | |
| iterator | begin () |
| Return iterator to begin traversal of non-nullptr entries. | |
| iterator | end () noexcept |
| Return iterator beyond end of UPtrList traversal. | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversal of non-nullptr entries. | |
| const_iterator | cend () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. | |
| void | setSize (const label n) |
| Alias for resize(). | |
| ZoneType & | first () |
| Reference to the first element of the list. | |
| ZoneType & | last () |
| Return reference to the last element of the list. | |
| void | append (ZoneType *ptr) |
| Append an element to the end of the list. | |
| label | count () const noexcept |
| The number of non-nullptr entries in the list. | |
| Public Member Functions inherited from regIOobject | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| Copy construct, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. | |
| virtual | ~regIOobject () |
| Destructor. | |
| bool | checkIn () |
| Add object to registry, if not already registered. | |
| bool | checkOut () |
| Remove object from registry, and remove all file watches. | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED). | |
| bool | registered () const noexcept |
| Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. | |
| bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? | |
| bool | store () |
| Register object with its registry and transfer ownership to the registry. | |
| void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. | |
| label | eventNo () const noexcept |
| Event number at last update. | |
| label & | eventNo () noexcept |
| Event number at last update. | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| void | setUpToDate () |
| Set as up-to-date. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. | |
| void | removeMetaData () |
| Remove meta-data. | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | headerOk () |
| Read and check header info. Does not check the headerClassName. | |
| Istream & | readStream (const word &, const bool readOnProc=true) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | readData (Istream &) |
| Virtual readData function. | |
| virtual bool | read () |
| Read object. | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. | |
| labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. | |
| virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time). | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified). | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. | |
| virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. | |
| virtual bool | global () const |
| Is object global. | |
| void | operator= (const IOobject &io) |
| Copy assignment. | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch). | |
| IOobject (const IOobject &)=default | |
| Copy construct. | |
| virtual | ~IOobject ()=default |
| Destructor. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. | |
| IOobject (const IOobject &io, const word &name, const fileName &local) | |
| Copy construct, resetting name and local component. | |
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
| Copy construct, resetting read/write options. | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. | |
| autoPtr< IOobject > | clone () const |
| Clone. | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. | |
| const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. | |
| const word & | name () const noexcept |
| Return the object name. | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. | |
| word & | headerClassName () noexcept |
| Modifiable access to the class name read from header. | |
| const string & | note () const noexcept |
| Return the optional note. | |
| string & | note () noexcept |
| Modifiable access to the optional note. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. | |
| bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading). | |
| bool | isHeaderClass (const word &expectedType) const |
| Check if headerClassName() equals the expected type. Always true if the expected type is empty. | |
| template<class Type> | |
| bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName Always true for a void type. | |
| word | group () const |
| Return group (extension part of name). | |
| word | member () const |
| Return member (name without the extension). | |
| const fileName & | rootPath () const noexcept |
| Return the Time::rootPath(). | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName(). | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName(). | |
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| Return the Time::caseName() - normal or global. | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. | |
| fileName & | instance () noexcept |
| Modifiable access to instance path component. | |
| scalar | instanceValue () const |
| Return the scalar value of the instance component (or 0), which often corresponds to a time index/value. | |
| const fileName & | local () const noexcept |
| Read access to local path component. | |
| fileName & | local () noexcept |
| Modifiable access to the local path component. | |
| fileName | path () const |
| The complete path for the object (with instance, local,...). | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...). | |
| fileName | path (IOobjectOption::Layout) const |
| The complete path (normal or global) for the object. | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. | |
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| The complete path (normal or global) with alternative instance and local. | |
| fileName | objectPath () const |
| The complete path + object name. | |
| fileName | globalObjectPath () const |
| The complete global path + object name. | |
| fileName | objectPath (IOobjectOption::Layout) const |
| The complete path (normal or global) + object name. | |
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| The complete path (normal or global) + object name with alternative instance. | |
| fileName | objectPath (const word &instance) const |
| The complete path + object name with alternative instance. | |
| fileName | globalObjectPath (const word &instance) const |
| The complete global path + object name with alternative instance. | |
| fileName | objectRelPath () const |
| The object path relative to the case. | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. | |
| bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| template<class Type> | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. A void type suppresses trait and type-name checks. | |
| template<class Type, bool Searching> | |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks. | |
| template<class Type> | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. | |
| template<class Type> | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type(). | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. | |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. | |
| bool | good () const noexcept |
| Did last readHeader() succeed? | |
| bool | bad () const noexcept |
| Did last readHeader() fail? | |
| InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. | |
| void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry). | |
| template<class Type> | |
| bool | isHeaderClassName () const |
| Same as isHeaderClass(). | |
| template<class StringType> | |
| Foam::word | groupName (StringType base, const word &group) |
| template<class Type> | |
| Foam::fileName | typeFilePath (const bool search) const |
| Public Member Functions inherited from IOobjectOption | |
| constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. | |
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. | |
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. | |
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. | |
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. | |
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. | |
| readOption | readOpt () const noexcept |
| Get the read option. | |
| readOption | readOpt (readOption opt) noexcept |
| Set the read option. | |
| writeOption | writeOpt () const noexcept |
| Get the write option. | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. | |
| bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? | |
| bool | registerObject (bool on) noexcept |
| Change registration preference. | |
| bool | globalObject () const noexcept |
| True if object is treated the same for all processors. | |
| bool | globalObject (bool on) noexcept |
| Change global-object status. | |
| bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| readOption & | readOpt () noexcept |
| Access to the read option. | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. | |
| bool & | registerObject () noexcept |
| Access to the register object option. | |
| bool & | globalObject () noexcept |
| Access to the global object option. | |
Static Public Attributes | |
| static int | disallowGenericZones |
| Debug switch to disallow the use of generic zones. | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
Friends | |
| Ostream & | operator (Ostream &os, const ZoneMesh< ZoneType, MeshType > &zones) |
Additional Inherited Members | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
| Protected Member Functions inherited from PtrList< ZoneType > | |
| void | readIstream (Istream &is, const INew &inew) |
| Read from Istream using Istream constructor class. | |
| Protected Member Functions inherited from UPtrList< ZoneType > | |
| void | setAddressableSize (const label n) noexcept |
| Adjust addressable size. | |
| label | find_next (label pos) const |
| The next non-null entry after the specified position. | |
| UPtrList (Detail::PtrListDetail< ZoneType > &&ptrs) noexcept | |
| Low-level move construct. | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| Helper: write content for FoamFile IOobject header with optional meta information. | |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Helper: write dictionary content for FoamFile header with optional meta information. | |
| Protected Attributes inherited from UPtrList< ZoneType > | |
| Detail::PtrListDetail< ZoneType > | ptrs_ |
| The list of pointers. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
A list of mesh zones.
Definition at line 61 of file ZoneMesh.H.
| typedef MeshType mesh_type |
The referenced mesh type.
Definition at line 137 of file ZoneMesh.H.
| typedef ZoneType zone_type |
The zone type. Same as PtrList<ZoneType>::value_type.
Definition at line 142 of file ZoneMesh.H.
|
delete |
No copy construct.
Referenced by cfindZone(), and findZoneID().
| ZoneMesh | ( | const IOobject & | io, |
| const MeshType & | mesh ) |
Read construct from IOobject and mesh reference Any reading (mandatory, optional) based on IOobject properties.
Definition at line 299 of file ZoneMesh.C.
References io, mesh(), PtrList< ZoneType >::PtrList(), and regIOobject::regIOobject().
| ZoneMesh | ( | const IOobject & | io, |
| const MeshType & | mesh, | ||
| Foam::zero | ) |
Construct empty with IOobject properties and a mesh reference. Does not read.
Definition at line 316 of file ZoneMesh.C.
References io, mesh(), PtrList< ZoneType >::PtrList(), and regIOobject::regIOobject().
| ZoneMesh | ( | const IOobject & | io, |
| const MeshType & | mesh, | ||
| const label | size ) |
Construct with specified size if not read. Any reading (mandatory, optional) based on IOobject properties.
Definition at line 330 of file ZoneMesh.C.
References io, mesh(), PtrList< ZoneType >::PtrList(), regIOobject::regIOobject(), and UPtrList< ZoneType >::size().
| ZoneMesh | ( | const IOobject & | io, |
| const MeshType & | mesh, | ||
| const PtrList< ZoneType > & | list ) |
Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning).
Definition at line 348 of file ZoneMesh.C.
References IOobject::clone(), forAll, io, mesh(), PtrList< ZoneType >::PtrList(), regIOobject::regIOobject(), PtrList< T >::resize(), PtrList< T >::set(), and UPtrList< T >::size().
| ZoneMesh | ( | const IOobject & | io, |
| const MeshType & | mesh, | ||
| PtrList< entry > && | entries ) |
Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning).
Definition at line 374 of file ZoneMesh.C.
References io, mesh(), PtrList< ZoneType >::PtrList(), and regIOobject::regIOobject().
|
default |
Destructor.
|
delete |
No copy assignment.
|
inlinenoexcept |
Return the mesh reference.
Definition at line 232 of file ZoneMesh.H.
Referenced by ZoneMesh(), ZoneMesh(), ZoneMesh(), ZoneMesh(), and ZoneMesh().
| const Foam::Map< Foam::label > & zoneMap | ( | ) | const |
Map of zones containing zone index for all zoned elements.
Return -1 if the object is not in the zone
Definition at line 397 of file ZoneMesh.C.
Referenced by whichZone(), and whichZones().
| Foam::label whichZone | ( | const label | objectIndex | ) | const |
Given a global object index, return the zone it is in.
If object does not belong to any zones, return -1
Definition at line 409 of file ZoneMesh.C.
References zoneMap().
Referenced by cyclicAMIPolyPatch::addAMIFaces(), meshRefinement::mergeBaffles(), edgeCollapser::setRefinement(), and removeCells::setRefinement().
| Foam::label whichZones | ( | const label | objectIndex, |
| DynamicList< label > & | zones ) const |
Given a global object index, return (in argument) its zones.
Returns number of zones (0 if object does not belong to any zones)
Definition at line 419 of file ZoneMesh.C.
References DynamicList< T, SizeMin >::clear(), DynamicList< T, SizeMin >::push_back(), DynamicList< T, SizeMin >::push_uniq(), UList< T >::size(), and zoneMap().
Referenced by polyMeshAdder::add().
| Foam::labelList zoneSizes | ( | ) | const |
Return a list of zone sizes.
Definition at line 448 of file ZoneMesh.C.
References Foam::PtrListOps::get().
| Foam::wordList types | ( | ) | const |
Return a list of zone types.
Definition at line 456 of file ZoneMesh.C.
References Foam::PtrListOps::get().
Referenced by checkParallelSync().
| Foam::wordList names | ( | ) | const |
A list of the zone names.
Definition at line 463 of file ZoneMesh.C.
References Foam::PtrListOps::get().
Referenced by preserveFaceZones::add(), surfaceZonesInfo::addFaceZonesToMesh(), preserveFaceZones::apply(), meshRefinement::checkCoupledFaceZones(), and displacementLayeredMotionMotionSolver::solve().
| Foam::wordList groupNames | ( | ) | const |
A list of the zone group names (if any).
Definition at line 470 of file ZoneMesh.C.
References groupZoneIDs().
| Foam::wordList names | ( | const wordRe & | matcher | ) | const |
A list of zone names satisfying the input matcher.
Definition at line 477 of file ZoneMesh.C.
References Foam::PtrListOps::names().
| Foam::wordList names | ( | const wordRes & | matcher | ) | const |
A list of zone names satisfying the input matchers.
Definition at line 487 of file ZoneMesh.C.
References Foam::PtrListOps::names().
| Foam::wordList sortedNames | ( | ) | const |
Sorted list of the zone names.
Definition at line 498 of file ZoneMesh.C.
References names, and Foam::sort().
| Foam::wordList sortedNames | ( | const wordRe & | matcher | ) | const |
Sorted list of zone names satisfying the input matcher.
Definition at line 508 of file ZoneMesh.C.
References names, and Foam::sort().
| Foam::wordList sortedNames | ( | const wordRes & | matcher | ) | const |
Sorted list of zone names satisfying the input matchers.
Definition at line 521 of file ZoneMesh.C.
References names, and Foam::sort().
| bool reindex | ( | ) |
Adjust the index of zone entries to be consistent with their position in the list.
If the indexing changed, invalidates any mapping.
Definition at line 535 of file ZoneMesh.C.
References forAll, and PtrList< ZoneType >::PtrList().
| Foam::labelList indices | ( | const wordRe & | matcher, |
| const bool | useGroups = true ) const |
The (sorted) patch indices for all matches, optionally matching zone groups.
Definition at line 561 of file ZoneMesh.C.
References HashTable< T, Key, Hash >::empty(), Foam::PtrListOps::findMatching(), Foam::PtrListOps::firstMatching(), forAllConstIters, groupZoneIDs(), HashSet< Key, Hash >::insert(), wordRe::isPattern(), HashTable< T, Key, Hash >::reserve(), UPtrList< ZoneType >::size(), and HashTable< T, Key, Hash >::sortedToc().
Referenced by ZoneMesh< faFaceZone, faMesh >::findIndices(), indices(), selection(), selection(), and sampledFaceZone::zoneIDs().
| Foam::labelList indices | ( | const wordRes & | matcher, |
| const bool | useGroups = true ) const |
The (sorted) patch indices for all matches, optionally matching zone groups.
Definition at line 634 of file ZoneMesh.C.
References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), forAllConstIters, UList< T >::front(), groupZoneIDs(), indices(), HashSet< Key, Hash >::insert(), HashTable< T, Key, Hash >::reserve(), UList< T >::size(), UPtrList< ZoneType >::size(), and HashTable< T, Key, Hash >::sortedToc().
| Foam::labelList indices | ( | const wordRes & | allow, |
| const wordRes & | deny, | ||
| const bool | useGroups = true ) const |
The (sorted) patch indices: logic as per Foam::wordRes::filter, optionally matching zone groups.
An empty allow accepts everything not in deny. A literal allow match has higher priority than any deny. A regex allow match has lower priority than any deny.
| useGroups | Match zone groups |
Definition at line 681 of file ZoneMesh.C.
References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), forAllConstIters, groupZoneIDs(), Foam::identity(), HashSet< Key, Hash >::insert(), HashTable< T, Key, Hash >::reserve(), UPtrList< ZoneType >::size(), and HashTable< T, Key, Hash >::sortedToc().
| Foam::label findIndex | ( | const wordRe & | key | ) | const |
Zone index for the first match, return -1 if not found.
A no-op (returns -1) for an empty key
Definition at line 728 of file ZoneMesh.C.
References Foam::PtrListOps::firstMatching().
| Foam::label findIndex | ( | const wordRes & | matcher | ) | const |
Zone index for the first match, return -1 if not found.
A no-op (returns -1) for an empty matcher
Definition at line 742 of file ZoneMesh.C.
References UList< T >::empty(), and Foam::PtrListOps::firstMatching().
| Foam::label findZoneID | ( | const word & | zoneName | ) | const |
Find zone index by name, return -1 if not found.
A no-op (returns -1) for an empty zoneName
Definition at line 756 of file ZoneMesh.C.
References DebugInFunction, disallowGenericZones, Foam::endl(), Foam::PtrListOps::firstMatching(), Foam::Info, names, and ZoneMesh().
Referenced by surfaceZonesInfo::addCellZone(), surfaceZonesInfo::addFaceZone(), meshRefinement::addPointZone(), FaceInteraction< CloudType >::FaceInteraction(), FacePostProcessing< CloudType >::FacePostProcessing(), operator[](), operator[](), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), RemoveParcels< CloudType >::RemoveParcels(), displacementLayeredMotionMotionSolver::solve(), and meshRefinement::zonify().
| const ZoneType * cfindZone | ( | const word & | zoneName | ) | const |
Find zone by name and return const pointer, nullptr on error.
A no-op (returns nullptr) for an empty zoneName
Definition at line 788 of file ZoneMesh.C.
References UPtrList< T >::begin(), disallowGenericZones, UPtrList< T >::end(), Foam::endl(), Foam::Info, PtrList< ZoneType >::PtrList(), and ZoneMesh().
Referenced by findZone().
| ZoneType * findZone | ( | const word & | zoneName | ) |
Find zone by name and return pointer, nullptr on error.
A no-op (returns nullptr) for an empty zoneName
Definition at line 823 of file ZoneMesh.C.
References cfindZone().
Referenced by operator()().
| Foam::bitSet selection | ( | const labelUList & | zoneIds | ) | const |
Return all elements (cells, faces, points) contained in the listed zones.
The bitSet is empty (zero-size) if there are no elements matched anywhere.
Definition at line 833 of file ZoneMesh.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, bitSet::set(), and UPtrList< ZoneType >::size().
Referenced by selection(), and selection().
| Foam::bitSet selection | ( | const wordRe & | matcher, |
| const bool | useGroups = true ) const |
Return all elements (cells, faces, points) that match the zone specification as a bitSet.
The bitSet is empty (zero-size) if there are no elements matched anywhere. Optionally matches zoneGroups. A no-op (returns empty bitSet) for an empty matcher
Definition at line 863 of file ZoneMesh.C.
References indices(), and selection().
| Foam::bitSet selection | ( | const wordRes & | matcher, |
| const bool | useGroups = true ) const |
Return all elements (cells, faces, points) that match the zone specification as a bitSet.
The bitSet is empty (zero-size) if there are no elements matched anywhere. A no-op (returns empty bitSet) for an empty matcher
Definition at line 875 of file ZoneMesh.C.
References indices(), and selection().
| const Foam::HashTable< Foam::labelList > & groupZoneIDs | ( | ) | const |
The zone indices per zone group.
Definition at line 888 of file ZoneMesh.C.
Referenced by groupNames(), indices(), indices(), and indices().
| void setGroup | ( | const word & | groupName, |
| const labelUList & | zoneIDs ) |
Set/add group with zones.
Definition at line 900 of file ZoneMesh.C.
References forAll, IOobject::groupName(), PtrList< ZoneType >::PtrList(), UPtrList< T >::size(), UList< T >::test(), UList< T >::unset(), and zoneIDs.
| bool checkDefinition | ( | const bool | report = false | ) | const |
Check zone definition. Return true if in error.
Definition at line 978 of file ZoneMesh.C.
References PtrList< ZoneType >::PtrList().
| bool checkParallelSync | ( | const bool | report = false | ) | const |
Check whether all procs have all zones and in same order.
Definition at line 997 of file ZoneMesh.C.
References UPstream::broadcast, Foam::endl(), globalIndex::gather(), Foam::Info, UPstream::master(), names, UPstream::parRun(), PtrList< ZoneType >::PtrList(), globalIndex::range(), UList< T >::size(), UList< T >::slice(), globalIndex::subProcs(), and types().
| void movePoints | ( | const pointField & | pts | ) |
Correct zone mesh after moving points.
Definition at line 1078 of file ZoneMesh.C.
References PtrList< ZoneType >::PtrList(), and pts.
| void clearAddressing | ( | ) |
Clear addressing.
Definition at line 944 of file ZoneMesh.C.
References PtrList< ZoneType >::PtrList().
Referenced by meshRefinement::addPointZone(), meshRefinement::blockLeakFaces(), clear(), and interRegionExplicitPorositySource::initialise().
| void clearPrimitives | ( | ) |
Clear primitive addressing.
Definition at line 958 of file ZoneMesh.C.
References PtrList< ZoneType >::PtrList().
| void clear | ( | ) |
Clear the zones.
Definition at line 970 of file ZoneMesh.C.
References PtrList< T >::clear(), and clearAddressing().
Referenced by polyMeshAdder::add(), cellTable::addCellZones(), and blockMesh::mesh().
|
inlinenoexcept |
The zoneMap has been allocated.
Definition at line 477 of file ZoneMesh.H.
Return const reference to zone by name.
Fatal if the zone does not exist.
Definition at line 1176 of file ZoneMesh.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, findZoneID(), names, Foam::nl, operator, and operator[]().
Referenced by operator[](), and operator[]().
Return reference to an existing zone by name.
Fatal if the zone does not exist.
Definition at line 1196 of file ZoneMesh.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, findZoneID(), names, Foam::nl, operator, and operator[]().
| ZoneType & operator() | ( | const word & | zoneName, |
| const bool | verbose = false ) |
Find an existing zone by name or create a new empty one if required.
To determine if the zone already existed or was newly created, it will be necessary to add additional logic in the caller. For example,
| zoneName | the name of the zone |
| verbose | report if an existing zone was selected or a new zone was created. |
Definition at line 1216 of file ZoneMesh.C.
References Foam::endl(), findZone(), Foam::Info, PtrList< ZoneType >::push_back(), and UPtrList< ZoneType >::size().
|
virtual |
Update internal meta-data (eg, prior to writing).
Reimplemented from regIOobject.
Definition at line 1090 of file ZoneMesh.C.
References UList< T >::begin(), token::BEGIN_LIST, UList< T >::empty(), UList< T >::end(), token::END_LIST, regIOobject::getMetaData(), names, regIOobject::removeMetaData(), and UList< T >::size().
| void writeEntry | ( | Ostream & | os | ) | const |
Write as a plain list of entries.
Definition at line 1115 of file ZoneMesh.C.
References token::BEGIN_LIST, UPtrList< T >::empty(), token::END_LIST, Foam::nl, os(), PtrList< ZoneType >::PtrList(), and UPtrList< T >::size().
Referenced by writeData(), and writeEntry().
| void writeEntry | ( | const word & | keyword, |
| Ostream & | os ) const |
Write as a primitive entry with given name. If the keyword is empty, revert to a plain list.
Definition at line 1142 of file ZoneMesh.C.
References UPtrList< T >::empty(), os(), PtrList< ZoneType >::PtrList(), token::SPACE, and writeEntry().
|
virtual |
The writeData member function required by regIOobject.
Implements regIOobject.
Definition at line 1166 of file ZoneMesh.C.
References os(), and writeEntry().
Identical to the indices() method (AUG-2018).
Definition at line 563 of file ZoneMesh.H.
|
friend |
Referenced by operator[](), and operator[]().
|
static |
Debug switch to disallow the use of generic zones.
Definition at line 148 of file ZoneMesh.H.
Referenced by cfindZone(), and findZoneID().
1.16.1 