A polyBoundaryMesh is a polyPatch list with additional search methods and registered IO. More...
Public Member Functions | |
TypeName ("polyBoundaryMesh") | |
Runtime type information. More... | |
polyBoundaryMesh (const polyBoundaryMesh &)=delete | |
No copy construct. More... | |
void | operator= (const polyBoundaryMesh &)=delete |
No copy assignment. More... | |
polyBoundaryMesh (const IOobject &io, const polyMesh &mesh) | |
Read construct given IOobject and a mesh reference. It will only read for MUST_READ variants (not READ_IF_PRESENT). More... | |
polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, Foam::zero) | |
Construct empty with IOobject properties and a mesh reference. Does not read. More... | |
polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const label size) | |
Construct with specified size. Does not read. More... | |
polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const polyPatchList &list) | |
Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning). More... | |
polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, PtrList< entry > &&entries) | |
Read construct (mandatory, optional) based on IOobject properties or fallback to constructing from a list of dictionary entries. More... | |
~polyBoundaryMesh ()=default | |
Destructor. More... | |
void | clear () |
Clear the patch list and all demand-driven data. More... | |
void | clearGeom () |
Clear geometry at this level and at patches. More... | |
void | clearAddressing () |
Clear addressing at this level and at patches. More... | |
const polyMesh & | mesh () const noexcept |
Return the mesh reference. More... | |
const faceList::subList | faces () const |
Return mesh faces for the entire boundary. More... | |
const labelList::subList | faceOwner () const |
Return face owner for the entire boundary. More... | |
UPtrList< const labelUList > | faceCells () const |
Return a list of faceCells for each patch. More... | |
const List< labelPairList > & | neighbourEdges () const |
Per patch the edges on the neighbouring patch. More... | |
label | nNonProcessor () const |
The number of patches before the first processor patch. More... | |
label | nProcessorPatches () const |
The number of processorPolyPatch patches. More... | |
wordList | names () const |
Return a list of patch names. More... | |
wordList | types () const |
Return a list of patch types. More... | |
wordList | physicalTypes () const |
Return a list of physical types. More... | |
labelList | patchStarts () const |
Return a list of patch start face indices. More... | |
labelList | patchSizes () const |
Return a list of patch sizes. More... | |
List< labelRange > | patchRanges () const |
Return a list of patch ranges. More... | |
wordList | groupNames () const |
A list of the group names (if any) More... | |
label | start () const noexcept |
The start label of boundary faces in the polyMesh face list. More... | |
label | nFaces () const noexcept |
The number of boundary faces in the underlying mesh. More... | |
labelRange | range () const noexcept |
The face range for all boundary faces. More... | |
labelRange | range (const label patchi) const |
Return the range used for boundary faces on patchi. More... | |
labelList | indices (const wordRe &matcher, const bool useGroups=true) const |
Return (sorted) patch indices for all matches. More... | |
labelList | indices (const wordRes &matcher, const bool useGroups=true) const |
Return (sorted) patch indices for all matches. More... | |
labelList | indices (const wordRes &select, const wordRes &ignore, const bool useGroups=true) const |
Return (sorted) patch indices for all selected matches that are not ignored. The selection logic as per Foam::wordRes::filter. More... | |
label | findIndex (const wordRe &key) const |
Return patch index for the first match, return -1 if not found. More... | |
label | findPatchID (const word &patchName, const bool allowNotFound=true) const |
Find patch index given a name, return -1 if not found. More... | |
template<class Type > | |
labelHashSet | findPatchIDs () const |
Find patch indices for a given polyPatch type. More... | |
labelPair | whichPatchFace (const label meshFacei) const |
Lookup mesh face index and return (patchi, patchFacei) tuple or (-1, meshFacei) for internal faces. More... | |
labelPairList | whichPatchFace (const labelUList &meshFaceIndices) const |
Lookup mesh face indices and return (patchi, patchFacei) tuples. More... | |
label | whichPatch (const label meshFacei) const |
Return patch index for a given mesh face index. Uses binary search. More... | |
const labelList & | patchID () const |
Per boundary face label the patch index. More... | |
label | patchID (const label meshFacei) const |
Return patch index for a given mesh face index. Uses direct lookup into patchID() list. Returns -1 for internal or out-of-range faces. More... | |
labelList | patchID (const labelUList &meshFaceIndices) const |
Lookup mesh face indices and return patch indices. Uses direct lookup into patchID() list. Returns values of -1 for internal or out-of-range faces. More... | |
const HashTable< labelList > & | groupPatchIDs () const |
The patch indices per patch group. More... | |
void | setGroup (const word &groupName, const labelUList &patchIDs) |
Set/add group with patches. More... | |
labelHashSet | patchSet (const UList< wordRe > &select, const bool warnNotFound=true, const bool useGroups=true) const |
Return the set of patch IDs corresponding to the given names. More... | |
void | matchGroups (const labelUList &patchIDs, wordList &groups, labelHashSet &nonGroupPatches) const |
Match the patches to groups. More... | |
bool | checkParallelSync (const bool report=false) const |
Check whether all procs have all patches and in same order. More... | |
bool | checkDefinition (const bool report=false) const |
Check boundary definition. More... | |
void | movePoints (const pointField &p) |
Correct polyBoundaryMesh after moving points. More... | |
void | updateMesh () |
Correct polyBoundaryMesh after topology update. More... | |
void | reorder (const labelUList &oldToNew, const bool validBoundary) |
Reorders patches. Ordering does not have to be done in. More... | |
void | writeEntry (Ostream &os) const |
Write as a plain list of entries. More... | |
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. More... | |
virtual bool | writeData (Ostream &os) const |
The writeData member function required by regIOobject. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc=true) const |
Write using stream options, but always UNCOMPRESSED. More... | |
const polyPatch & | operator[] (const word &patchName) const |
Return const reference to polyPatch by name. More... | |
polyPatch & | operator[] (const word &patchName) |
Return reference to polyPatch by name. More... | |
labelList | findIndices (const wordRe &key, bool useGroups=true) const |
Identical to the indices() method (AUG-2018) More... | |
template<class Type > | |
Foam::labelHashSet | findPatchIDs () const |
Public Member Functions inherited from PtrList< T > | |
constexpr | PtrList () noexcept |
Default construct. More... | |
PtrList (const label len) | |
Construct with specified size, each element initialized to nullptr. More... | |
PtrList (const PtrList< T > &list) | |
Copy construct using 'clone()' method on each element. More... | |
PtrList (PtrList< T > &&list) noexcept | |
Move construct. More... | |
PtrList (UList< T *> &list) | |
Take ownership of pointers in the list, set old pointers to null. More... | |
template<class CloneArg > | |
PtrList (const PtrList< T > &list, const CloneArg &cloneArgs) | |
Copy construct using 'clone()' method on each element. More... | |
PtrList (PtrList< T > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< T > &list) | |
Copy construct using 'clone()' on each element of SLPtrList<T> More... | |
template<class INew > | |
PtrList (Istream &is, const INew &inew) | |
Construct from Istream using given Istream constructor class. More... | |
PtrList (Istream &is) | |
Construct from Istream using default Istream constructor class. More... | |
~PtrList () | |
Destructor. Frees all pointers. More... | |
template<class... Args> | |
PtrList< T > | clone (Args &&... args) const |
Make a copy by cloning each of the list elements. More... | |
const T * | set (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
void | clear () |
Clear the PtrList. Delete allocated entries and set size to zero. More... | |
void | free () |
Free memory and nullify all entries. Does not change the list size. More... | |
void | resize (const label newLen) |
Adjust size of PtrList. More... | |
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. More... | |
template<class... Args> | |
T & | emplace_back (Args &&... args) |
Construct and append an element to the end of the list, return reference to the new list element. More... | |
void | push_back (T *ptr) |
Append an element to the end of the list. More... | |
void | push_back (std::unique_ptr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | push_back (autoPtr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | push_back (const refPtr< T > &ptr) |
Move or clone append a refPtr to the end of the list. More... | |
void | push_back (const tmp< T > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
void | push_back (PtrList< T > &&other) |
Move append another list to the end of this list. More... | |
template<class... Args> | |
T & | emplace_set (const label i, Args &&... args) |
Construct and set a new element at given position, (discard old element at that location). More... | |
template<class... Args> | |
T & | emplace (const label i, Args &&... args) |
Same as emplace_set() More... | |
template<class... Args> | |
T & | try_emplace (const label i, Args &&... args) |
Like emplace_set() but will not overwrite an occupied (non-null) location. More... | |
autoPtr< T > | set (const label i, T *ptr) |
Set element to given pointer and return old element (can be null) More... | |
autoPtr< T > | set (const label i, std::unique_ptr< T > &&ptr) |
Set element to given unique_ptr and return old element. More... | |
autoPtr< T > | set (const label i, autoPtr< T > &&ptr) |
Set element to given autoPtr and return old element. More... | |
autoPtr< T > | set (const label i, const refPtr< T > &ptr) |
Set element to given refPtr and return old element. More... | |
autoPtr< T > | set (const label i, const tmp< T > &ptr) |
Set element to given tmp and return old element. More... | |
autoPtr< T > | release (const label i) |
Release ownership of the pointer at the given position. More... | |
void | transfer (PtrList< T > &list) |
Transfer into this list and annul the argument list. More... | |
void | operator= (const PtrList< T > &list) |
Copy assignment. More... | |
void | operator= (PtrList< T > &&list) |
Move assignment. More... | |
void | push_back (autoPtr< T > &ptr)=delete |
Disallow push_back with autoPtr without std::move. More... | |
autoPtr< T > | set (const label i, autoPtr< T > &ptr) |
Set element to given autoPtr and return old element. More... | |
void | setSize (const label newLen) |
Same as resize() More... | |
void | append (autoPtr< T > &ptr) |
Move append an element to the end of the list. More... | |
void | append (T *ptr) |
Append an element to the end of the list. More... | |
void | append (std::unique_ptr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | append (autoPtr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | append (const refPtr< T > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
void | append (const tmp< T > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
void | append (PtrList< T > &&other) |
Move append another list to the end of this list. More... | |
template<class... Args> | |
Foam::PtrList< T > | clone (Args &&... args) const |
Public Member Functions inherited from UPtrList< T > | |
constexpr | UPtrList () noexcept=default |
Default construct. More... | |
UPtrList (const label len) | |
Construct with specified size and set all entries to nullptr . More... | |
UPtrList (const UPtrList< T > &list) | |
Copy construct (shallow copies addresses) More... | |
UPtrList (UPtrList< T > &&list) noexcept | |
Move construct. More... | |
UPtrList (UPtrList< T > &list, bool reuse) | |
Construct as shallow copy or re-use as specified. More... | |
UPtrList (PtrList< T > &list) | |
Shallow copy from PtrList. More... | |
UPtrList (const UList< T *> &list) | |
Construct from UList of pointers (shallow copy) More... | |
UPtrList (UList< T > &list) | |
Construct from UList, taking the address of each list element. More... | |
bool | empty () const noexcept |
True if the list is empty (ie, size() is zero) More... | |
label | size () const noexcept |
The number of entries in the list. More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
label | count_nonnull () const noexcept |
The number of non-nullptr entries in the list. More... | |
T & | front () |
Reference to the first element of the list. More... | |
const T & | front () const |
Reference to first element of the list. More... | |
T & | back () |
Reference to the last element of the list. More... | |
const T & | back () const |
Reference to the last element of the list. More... | |
const T * | test (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
const T * | get (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
T * | get (const label i) |
Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
const T * | set (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
void | clear () |
Set list size to zero. More... | |
void | free () |
Nullify all entries. Does not change the list size. More... | |
void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr . More... | |
void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr . More... | |
label | squeezeNull () |
Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More... | |
void | trimTrailingNull () |
Reduce addressable list size to ignore any trailing null pointers. More... | |
void | push_back (T *ptr) |
Append an element to the end of the list. More... | |
void | push_back (UPtrList< T > &&other) |
Move append another list to the end of this list. More... | |
void | swap (UPtrList< T > &list) noexcept |
Swap content. More... | |
void | transfer (UPtrList< T > &list) |
Transfer contents into this list and annul the argument. More... | |
T * | set (const label i, T *ptr) |
Set element to specified pointer and return the old list element, which can be a nullptr. More... | |
void | reorder (const labelUList &oldToNew, const bool check=false) |
Reorder elements. Reordering must be unique (ie, shuffle). More... | |
void | sortOrder (const labelUList &order, const bool check=false) |
Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More... | |
void | checkNonNull () const |
Check and raise FatalError if any nullptr exists in the list. More... | |
const T & | at (const label i) const |
Return const reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
T & | at (const label i) |
Return reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
const T & | operator[] (const label i) const |
Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
T & | operator[] (const label i) |
Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const | |
Deprecated(2022-09) - same as get() More... | |
void | operator= (const UPtrList< T > &list) |
Copy assignment (shallow copies addresses) More... | |
void | operator= (UPtrList< T > &&list) |
Move assignment. More... | |
T ** | begin_ptr () noexcept |
Iterator to begin of raw pointers traversal (use with caution) More... | |
T ** | end_ptr () noexcept |
Iterator beyond end of raw pointers traversal (use with caution) More... | |
iterator | begin () |
Return iterator to begin traversal of non-nullptr entries. More... | |
iterator | end () noexcept |
Return iterator beyond end of UPtrList traversal. More... | |
const_iterator | cbegin () const |
Return const_iterator to begin traversal of non-nullptr entries. More... | |
const_iterator | cend () const noexcept |
Return const_iterator beyond end of UPtrList traversal. More... | |
const_iterator | begin () const |
Return const_iterator to begin traversal of non-nullptr entries. More... | |
const_iterator | end () const noexcept |
Return const_iterator beyond end of UPtrList traversal. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
T & | first () |
Reference to the first element of the list. More... | |
const T & | first () const |
Return reference to first element of the list. More... | |
T & | last () |
Return reference to the last element of the list. More... | |
const T & | last () const |
Return reference to the last element of the list. More... | |
void | append (T *ptr) |
Append an element to the end of the list. More... | |
void | append (UPtrList< T > &&other) |
Move append another list to the end of this list. More... | |
label | count () const noexcept |
The number of non-nullptr entries in the list. More... | |
Public Member Functions inherited from regIOobject | |
void | operator= (const regIOobject &)=delete |
No copy assignment. More... | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
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). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove object from registry, and remove all file watches. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
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. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool readOnProc=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | write (const bool writeOnProc=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
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. More... | |
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. More... | |
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. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const noexcept |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const noexcept |
Return the Time::rootPath() More... | |
const fileName & | caseName () const noexcept |
Return the Time::caseName() More... | |
const fileName & | globalCaseName () const noexcept |
Return the Time::globalCaseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path for the object (with instance, local,...). More... | |
fileName | globalPath () const |
The complete global path for the object (with instance, local,...) More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
The complete global path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | globalObjectPath () const |
The complete global path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
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. More... | |
template<class Type > | |
fileName | typeFilePath (const bool search=true) const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
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. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Friends | |
class | polyMesh |
Declare friendship with polyMesh. More... | |
Ostream & | operator<< (Ostream &os, const polyBoundaryMesh &pbm) |
Additional Inherited Members | |
Public Types inherited from UPtrList< T > | |
typedef T | value_type |
Type of values the list contains. More... | |
typedef T & | reference |
A non-const reference to the value_type. More... | |
typedef const T & | const_reference |
A const reference to the value_type. More... | |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. 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... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (std::unique_ptr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
Create scope:name1:name2 or scope_name1_name2 string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Protected Member Functions inherited from PtrList< T > | |
template<class INew > | |
void | readIstream (Istream &is, const INew &inew) |
Read from Istream using Istream constructor class. More... | |
Protected Member Functions inherited from UPtrList< T > | |
void | setAddressableSize (const label n) noexcept |
Adjust addressable size. More... | |
label | find_next (label pos) const |
The next non-null entry after the specified position. More... | |
UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept | |
Low-level move construct. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
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. More... | |
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. More... | |
Protected Attributes inherited from UPtrList< T > | |
Detail::PtrListDetail< T > | ptrs_ |
The list of pointers. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
A polyBoundaryMesh is a polyPatch list with additional search methods and registered IO.
Definition at line 60 of file polyBoundaryMesh.H.
|
delete |
No copy construct.
polyBoundaryMesh | ( | const IOobject & | io, |
const polyMesh & | mesh | ||
) |
Read construct given IOobject and a mesh reference. It will only read for MUST_READ variants (not READ_IF_PRESENT).
Definition at line 167 of file polyBoundaryMesh.C.
polyBoundaryMesh | ( | const IOobject & | io, |
const polyMesh & | mesh, | ||
Foam::zero | |||
) |
Construct empty with IOobject properties and a mesh reference. Does not read.
Definition at line 181 of file polyBoundaryMesh.C.
polyBoundaryMesh | ( | const IOobject & | io, |
const polyMesh & | mesh, | ||
const label | size | ||
) |
Construct with specified size. Does not read.
Definition at line 194 of file polyBoundaryMesh.C.
polyBoundaryMesh | ( | const IOobject & | io, |
const polyMesh & | mesh, | ||
const polyPatchList & | list | ||
) |
Read construct (mandatory, optional) based on IOobject properties or use the fallback PtrList (with cloning).
Definition at line 207 of file polyBoundaryMesh.C.
References forAll, patches, PtrList< T >::resize(), PtrList< T >::set(), and UPtrList< T >::size().
polyBoundaryMesh | ( | const IOobject & | io, |
const polyMesh & | mesh, | ||
PtrList< entry > && | entries | ||
) |
Read construct (mandatory, optional) based on IOobject properties or fallback to constructing from a list of dictionary entries.
Definition at line 232 of file polyBoundaryMesh.C.
|
default |
Destructor.
TypeName | ( | "polyBoundaryMesh" | ) |
Runtime type information.
|
delete |
No copy assignment.
void clear | ( | ) |
Clear the patch list and all demand-driven data.
Definition at line 252 of file polyBoundaryMesh.C.
References PtrList< T >::clear().
Referenced by polyMesh::removeBoundary().
void clearGeom | ( | ) |
Clear geometry at this level and at patches.
Definition at line 259 of file polyBoundaryMesh.C.
void clearAddressing | ( | ) |
Clear addressing at this level and at patches.
Definition at line 279 of file polyBoundaryMesh.C.
|
inlinenoexcept |
Return the mesh reference.
Definition at line 229 of file polyBoundaryMesh.H.
Referenced by cyclicAMIPolyPatch::canResetAMI(), processorPolyPatch::comm(), patchPatchDist::correct(), motionSmootherAlgo::curPoints(), coupleGroupIdentifier::findOtherPatchID(), Sampled< Type >::haveSampleField(), mappedPatchBase::lookupMesh(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), mappedPatchFieldBase< scalar >::mappedField(), betaMax::markProcessorEdges(), Sampled< Type >::sampleField(), mappedPatchFieldBase< scalar >::sampleField(), adjointBoundaryCondition< Type >::setBoundaryContributionPtr(), mappedPatchBase::surfPtr(), cyclicACMIPolyPatch::updateAreas(), mappedPatchBase::updateMeshTime(), mappedPatchBase::updateSampleMeshTime(), and mappedPatchBase::upToDate().
const Foam::faceList::subList faces | ( | ) | const |
Return mesh faces for the entire boundary.
Definition at line 340 of file polyBoundaryMesh.C.
const Foam::labelList::subList faceOwner | ( | ) | const |
Return face owner for the entire boundary.
Definition at line 351 of file polyBoundaryMesh.C.
Referenced by Foam::calcCellCellsImpl().
Foam::UPtrList< const Foam::labelUList > faceCells | ( | ) | const |
Return a list of faceCells for each patch.
Definition at line 369 of file polyBoundaryMesh.C.
References forAll, patches, PtrList< T >::set(), and UPtrList< T >::size().
Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::injectParticles(), thermoSingleLayer::Sh(), and thermoSingleLayer::Srho().
const Foam::List< Foam::labelPairList > & neighbourEdges | ( | ) | const |
Per patch the edges on the neighbouring patch.
Is for every external edge the neighbouring patch and neighbouring (external) patch edge label. Note that edge indices are offset by nInternalEdges to keep it as much as possible consistent with coupled patch addressing (where coupling is by local patch face index). Only valid for singly connected polyBoundaryMesh and not parallel
Definition at line 385 of file polyBoundaryMesh.C.
References Foam::abort(), Foam::constant::electromagnetic::e, PrimitivePatch< FaceList, PointField >::edges(), Foam::endl(), HashTable< T, edge, Hash< edge > >::erase(), Foam::FatalError, FatalErrorInFunction, HashTable< T, edge, Hash< edge > >::find(), forAll, HashTable< T, edge, Hash< edge > >::insert(), PrimitivePatch< FaceList, PointField >::localPoints(), PrimitivePatch< FaceList, PointField >::meshPoints(), PrimitivePatch< FaceList, PointField >::nEdges(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), Foam::nl, UPstream::parRun(), pp(), UList< T >::size(), HashTable< T, edge, Hash< edge > >::size(), and WarningInFunction.
Foam::label nNonProcessor | ( | ) | const |
The number of patches before the first processor patch.
Definition at line 608 of file polyBoundaryMesh.C.
References Foam::BitOps::count(), p, and patches.
Referenced by fvMeshAdder::add(), meshRefinement::blockLeakFaces(), betaMax::markProcessorEdges(), Foam::nonProcessorPatchNames(), polyMeshAdder::procPatchPairs(), fvMeshSubset::reset(), and dynamicMotionSolverFvMeshAMI::update().
Foam::label nProcessorPatches | ( | ) | const |
The number of processorPolyPatch patches.
Definition at line 628 of file polyBoundaryMesh.C.
References Foam::BitOps::count(), p, and patches.
Referenced by syncTools::syncEdgeMap(), and syncTools::syncPointMap().
Foam::wordList names | ( | ) | const |
Return a list of patch names.
Definition at line 646 of file polyBoundaryMesh.C.
Referenced by curvatureSeparation::curvatureSeparation(), meshReader::mesh(), meshRefinement::meshedPatches(), Foam::nonProcessorPatchNames(), polyMeshAdder::procPatchPairs(), processorCyclicPolyPatch::referPatchID(), fvMeshSubset::reset(), and mappedPatchBase::samplePolyPatch().
Foam::wordList types | ( | ) | const |
Return a list of patch types.
Definition at line 652 of file polyBoundaryMesh.C.
Foam::wordList physicalTypes | ( | ) | const |
Foam::labelList patchStarts | ( | ) | const |
Return a list of patch start face indices.
Definition at line 669 of file polyBoundaryMesh.C.
References p.
Referenced by polyMeshAdder::add().
Foam::labelList patchSizes | ( | ) | const |
Return a list of patch sizes.
Definition at line 680 of file polyBoundaryMesh.C.
References p, and UList< T >::size().
Referenced by polyMeshAdder::add().
Foam::List< Foam::labelRange > patchRanges | ( | ) | const |
Foam::wordList groupNames | ( | ) | const |
A list of the group names (if any)
Definition at line 702 of file polyBoundaryMesh.C.
|
noexcept |
The start label of boundary faces in the polyMesh face list.
Same as polyMesh::nInternalFaces()
Definition at line 708 of file polyBoundaryMesh.C.
Referenced by attachPolyTopoChanger::attach(), polyBoundaryMesh::checkDefinition(), Foam::createReconstructMap(), faMeshDecomposition::decomposeMesh(), fvMeshDistribute::distribute(), polyBoundaryMesh::patchID(), and fvFieldDecomposer::reset().
|
noexcept |
The number of boundary faces in the underlying mesh.
Same as polyMesh::nBoundaryFaces()
Definition at line 714 of file polyBoundaryMesh.C.
Referenced by volPointInterpolation::flatBoundaryField(), and Foam::flattenBoundary().
|
noexcept |
The face range for all boundary faces.
Spans [nInternalFaces, nFaces) of the underlying mesh
Definition at line 720 of file polyBoundaryMesh.C.
Referenced by lumpedPointMovement::writeZonesVTP().
Foam::labelRange range | ( | const label | patchi | ) | const |
Return the range used for boundary faces on patchi.
Always returns an empty range for negative values of patchi, which allows safe use with findIndex or findPatchID.
Definition at line 726 of file polyBoundaryMesh.C.
Foam::labelList indices | ( | const wordRe & | matcher, |
const bool | useGroups = true |
||
) | const |
Return (sorted) patch indices for all matches.
Optionally matches patch groups. A no-op (returns empty list) for an empty matcher
Definition at line 739 of file polyBoundaryMesh.C.
References HashTable< T, Key, Hash >::empty(), Foam::PtrListOps::findMatching(), Foam::PtrListOps::firstMatching(), forAllConstIters(), HashSet< Key, Hash >::insert(), wordRe::isPattern(), patchId(), and HashTable< T, Key, Hash >::sortedToc().
Referenced by polyBoundaryMesh::findIndices(), pointBoundaryMesh::indices(), fvBoundaryMesh::indices(), viewFactor::initialise(), processorCyclicPolyPatch::patchIDs(), and Foam::selectPatchFaces().
Foam::labelList indices | ( | const wordRes & | matcher, |
const bool | useGroups = true |
||
) | const |
Return (sorted) patch indices for all matches.
Optionally matches patch groups. A no-op (returns empty list) for an empty matcher
Definition at line 806 of file polyBoundaryMesh.C.
References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), forAllConstIters(), UList< T >::front(), HashSet< Key, Hash >::insert(), HashTable< T, Key, Hash >::reserve(), UList< T >::size(), and HashTable< T, Key, Hash >::sortedToc().
Foam::labelList indices | ( | const wordRes & | select, |
const wordRes & | ignore, | ||
const bool | useGroups = true |
||
) | const |
Return (sorted) patch indices for all selected matches that are not ignored. The selection logic as per Foam::wordRes::filter.
Optionally matches patch groups. A no-op (returns empty list) for an empty select matcher
Definition at line 852 of file polyBoundaryMesh.C.
References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), forAllConstIters(), HashSet< Key, Hash >::insert(), HashTable< T, Key, Hash >::reserve(), Foam::BitOps::select(), and HashTable< T, Key, Hash >::sortedToc().
Foam::label findIndex | ( | const wordRe & | key | ) | const |
Return patch index for the first match, return -1 if not found.
A no-op (returns -1) for an empty key
Definition at line 896 of file polyBoundaryMesh.C.
References Foam::PtrListOps::firstMatching(), and Foam::glTF::key().
Foam::label findPatchID | ( | const word & | patchName, |
const bool | allowNotFound = true |
||
) | const |
Find patch index given a name, return -1 if not found.
A no-op (returns -1) for an empty patchName
Definition at line 907 of file polyBoundaryMesh.C.
References Foam::ensightOutput::debug, polyMesh::defaultRegion, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::firstMatching(), Foam::PtrListOps::names(), patchId(), and Foam::Pout.
Referenced by fvMeshTools::addPatch(), meshRefinement::addPatch(), inverseFaceDistanceDiffusivity::correct(), directions::directions(), pointBoundaryMesh::findPatchID(), meshRefinement::getFaceZoneInfo(), marchingCells::initialise(), mappedPatchBase::lookupPatch(), mappedPatchFieldBase< scalar >::mappedField(), meshRefinement::meshedPatches(), processorCyclicPolyPatch::referPatchID(), fvMeshSubset::reset(), sampledCuttingPlane::sampledCuttingPlane(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), mappedPatchBase::samplePolyPatch(), and outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs().
labelHashSet findPatchIDs | ( | ) | const |
Find patch indices for a given polyPatch type.
Referenced by levelSetDesignVariables::readField().
Foam::labelPair whichPatchFace | ( | const label | meshFacei | ) | const |
Lookup mesh face index and return (patchi, patchFacei) tuple or (-1, meshFacei) for internal faces.
Definition at line 955 of file polyBoundaryMesh.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::findLower(), Foam::flatOutput(), mesh, Foam::PtrListOps::names(), primitiveMesh::nFaces(), primitiveMesh::nInternalFaces(), Foam::nl, p, patches, and range.
Referenced by polyBoundaryMesh::whichPatch().
Foam::labelPairList whichPatchFace | ( | const labelUList & | meshFaceIndices | ) | const |
Lookup mesh face indices and return (patchi, patchFacei) tuples.
Definition at line 1013 of file polyBoundaryMesh.C.
References forAll, Foam::output(), and UList< T >::size().
|
inline |
Return patch index for a given mesh face index. Uses binary search.
Definition at line 414 of file polyBoundaryMesh.H.
References Pair< T >::first(), and polyBoundaryMesh::whichPatchFace().
Referenced by meshRefinement::balance(), addPatchCellLayer::calcExtrudeInfo(), deltaBoundary::cellCenters_d(), polyMeshGeometry::checkFaceDotProduct(), polyMeshGeometry::checkFaceSkewness(), polyMeshGeometry::checkFaceTets(), polyMeshGeometry::checkFaceTwist(), polyMeshGeometry::checkFaceWeights(), faceZone::checkParallelSync(), polyMeshGeometry::checkVolRatio(), localPointRegion::findDuplicateFacePairs(), patchProbes::findElements(), heatExchangerModel::initialise(), waWallFunctionFvPatchScalarField::manipulateMatrix(), polyMeshAdder::mergePoints(), cellPointWeightWallModified::onWall(), patchProbes::sample(), duplicatePoints::setRefinement(), perfectInterface::setRefinement(), combineFaces::setRefinement(), removeFaces::setRefinement(), meshCutAndRemove::setRefinement(), addPatchCellLayer::setRefinement(), and sampledFaceZone::update().
const Foam::labelList & patchID | ( | ) | const |
Per boundary face label the patch index.
Definition at line 514 of file polyBoundaryMesh.C.
References forAll, patches, UPtrList< T >::size(), and polyBoundaryMesh::start().
Foam::label patchID | ( | const label | meshFacei | ) | const |
Return patch index for a given mesh face index. Uses direct lookup into patchID() list. Returns -1 for internal or out-of-range faces.
Definition at line 538 of file polyBoundaryMesh.C.
References patchID.
Foam::labelList patchID | ( | const labelUList & | meshFaceIndices | ) | const |
Lookup mesh face indices and return patch indices. Uses direct lookup into patchID() list. Returns values of -1 for internal or out-of-range faces.
Definition at line 552 of file polyBoundaryMesh.C.
References forAll, Foam::output(), patchID, and UList< T >::size().
const Foam::HashTable< Foam::labelList > & groupPatchIDs | ( | ) | const |
The patch indices per patch group.
Definition at line 564 of file polyBoundaryMesh.C.
void setGroup | ( | const word & | groupName, |
const labelUList & | patchIDs | ||
) |
Set/add group with patches.
Definition at line 576 of file polyBoundaryMesh.C.
References forAll, patches, patchIDs(), UPtrList< T >::size(), and UList< T >::unset().
Foam::labelHashSet patchSet | ( | const UList< wordRe > & | select, |
const bool | warnNotFound = true , |
||
const bool | useGroups = true |
||
) | const |
Return the set of patch IDs corresponding to the given names.
By default warns if given names are not found. Optionally matches to patchGroups as well as patchNames.
Definition at line 1025 of file polyBoundaryMesh.C.
References UList< T >::empty(), Foam::endl(), forAllConstIters(), HashSet< Key, Hash >::insert(), wordRes::match(), Foam::name(), patches, HashTable< T, Key, Hash >::reserve(), Foam::BitOps::select(), UPtrList< T >::size(), and WarningInFunction.
Referenced by betaMax::computeLength(), inversePointDistanceDiffusivity::correct(), structuredDecomp::decompose(), patchProbes::findElements(), cellDistFuncs::getPatchIDs(), and heatTransferCoeffModel::read().
void matchGroups | ( | const labelUList & | patchIDs, |
wordList & | groups, | ||
labelHashSet & | nonGroupPatches | ||
) | const |
Match the patches to groups.
Returns all the (fully matched) groups and any remaining unmatched patches.
Definition at line 1109 of file polyBoundaryMesh.C.
References HashTable< T, Key, Hash >::erase(), forAllConstIters(), patchIDs(), DynamicList< T, SizeMin >::push_back(), List< T >::transfer(), and HashTable< T, Key, Hash >::transfer().
bool checkParallelSync | ( | const bool | report = false | ) | const |
Check whether all procs have all patches and in same order.
Definition at line 1148 of file polyBoundaryMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), forAll, globalIndex::gather(), Foam::Info, IOobject::name(), UPstream::parRun(), Foam::Pout, procAddr(), globalIndex::range(), PtrList< T >::resize(), Foam::returnReduceOr(), UPtrList< T >::size(), and globalIndex::subProcs().
Referenced by fvMeshDistribute::distribute(), and Foam::nonProcessorPatchNames().
bool checkDefinition | ( | const bool | report = false | ) | const |
Check boundary definition.
Definition at line 1230 of file polyBoundaryMesh.C.
References Foam::ensightOutput::debug, Foam::endl(), forAll, Foam::Info, mesh, IOobject::name(), primitiveMesh::nInternalFaces(), patchNames(), Foam::Pout, UPstream::reduceOr(), UPtrList< T >::size(), and polyBoundaryMesh::start().
void movePoints | ( | const pointField & | p | ) |
Correct polyBoundaryMesh after moving points.
Definition at line 1287 of file polyBoundaryMesh.C.
References UPstream::buffered, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, p, globalMeshData::patchSchedule(), and UPstream::scheduled.
void updateMesh | ( | ) |
Correct polyBoundaryMesh after topology update.
Definition at line 1333 of file polyBoundaryMesh.C.
References UPstream::buffered, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, globalMeshData::patchSchedule(), and UPstream::scheduled.
Referenced by polyMesh::readUpdate(), and polyMesh::updateMesh().
void reorder | ( | const labelUList & | oldToNew, |
const bool | validBoundary | ||
) |
Reorders patches. Ordering does not have to be done in.
ascending or descending order. Reordering has to be unique. (is shuffle) If validBoundary calls updateMesh() after reordering to recalculate data (so call needs to be parallel sync in that case)
Definition at line 1384 of file polyBoundaryMesh.C.
References forAll, patches, and UPtrList< T >::reorder().
Referenced by meshRefinement::addPatch().
void writeEntry | ( | Ostream & | os | ) | const |
Write as a plain list of entries.
Definition at line 1407 of file polyBoundaryMesh.C.
References token::BEGIN_LIST, Ostream::beginBlock(), IOstream::check(), Foam::decrIndent(), UPtrList< T >::empty(), token::END_LIST, Ostream::endBlock(), FUNCTION_NAME, Foam::incrIndent(), Foam::nl, os(), pp(), and UPtrList< T >::size().
Write as a primitive entry with given name. If the keyword is empty, revert to a plain list.
Definition at line 1435 of file polyBoundaryMesh.C.
References UPtrList< T >::empty(), Ostream::endEntry(), token::NL, os(), token::SPACE, and OBJstream::write().
|
virtual |
The writeData member function required by regIOobject.
Implements regIOobject.
Definition at line 1454 of file polyBoundaryMesh.C.
References IOstream::good(), and os().
Referenced by Foam::operator<<().
|
virtual |
Write using stream options, but always UNCOMPRESSED.
Reimplemented from regIOobject.
Definition at line 1462 of file polyBoundaryMesh.C.
References IOstreamOption::compression(), IOstreamOption::UNCOMPRESSED, and regIOobject::writeObject().
const Foam::polyPatch & operator[] | ( | const word & | patchName | ) | const |
Return const reference to polyPatch by name.
Definition at line 1475 of file polyBoundaryMesh.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::names(), and Foam::nl.
Foam::polyPatch & operator[] | ( | const word & | patchName | ) |
Return reference to polyPatch by name.
Definition at line 1494 of file polyBoundaryMesh.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::names(), and Foam::nl.
Identical to the indices() method (AUG-2018)
Definition at line 566 of file polyBoundaryMesh.H.
References polyBoundaryMesh::indices().
Foam::labelHashSet findPatchIDs | ( | ) | const |
Definition at line 24 of file polyBoundaryMeshTemplates.C.
References forAll, patches, and patchIDs().
|
friend |
Declare friendship with polyMesh.
Definition at line 126 of file polyBoundaryMesh.H.
|
friend |