Public Member Functions | Friends | List of all members
polyBoundaryMesh Class Reference

A polyBoundaryMesh is a polyPatch list with additional search methods and registered IO. More...

Inheritance diagram for polyBoundaryMesh:
Inheritance graph
[legend]
Collaboration diagram for polyBoundaryMesh:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("polyBoundaryMesh")
 Runtime type information. More...
 
 polyBoundaryMesh (const IOobject &io, const polyMesh &mesh)
 Read constructor given IOobject and a polyMesh reference. More...
 
 polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const label size)
 Construct given size. More...
 
 polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const polyPatchList &ppl)
 Construct given polyPatchList. More...
 
 ~polyBoundaryMesh ()=default
 Destructor. More...
 
void clearGeom ()
 Clear geometry at this level and at patches. More...
 
void clearAddressing ()
 Clear addressing at this level and at patches. More...
 
const polyMeshmesh () const noexcept
 Return the mesh reference. More...
 
UPtrList< const labelUListfaceCells () 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...
 
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< labelRangepatchRanges () 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...
 
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 faceIndex) const
 Lookup mesh face index and return (patchi, patchFacei) tuple or (-1, meshFacei) for internal faces. More...
 
labelPairList whichPatchFace (const labelUList &faceIndices) const
 Lookup mesh face indices and return (patchi, patchFacei) tuples. More...
 
label whichPatch (const label faceIndex) const
 Return patch index for a given mesh face index. More...
 
const labelListpatchID () const
 Per boundary face label the patch index. 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 > &patchNames, 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...
 
virtual bool writeData (Ostream &os) const
 writeData member function required by regIOobject More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
const polyPatchoperator[] (const word &patchName) const
 Return const reference to polyPatch by name. More...
 
polyPatchoperator[] (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)
 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< Tclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
const Tset (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 resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
template<class... Args>
void emplace_back (Args &&... args)
 Construct and append an element to the end of the list. 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>
autoPtr< Templace (const label i, Args &&... args)
 Construct and set an element. More...
 
autoPtr< Tset (const label i, T *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< Tset (const label i, std::unique_ptr< T > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< Tset (const label i, autoPtr< T > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< Tset (const label i, const refPtr< T > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< Tset (const label i, const tmp< T > &ptr)
 Set element to given tmp and return old element. More...
 
autoPtr< Trelease (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...
 
autoPtr< Tset (const label i, autoPtr< T > &ptr)
 Set element to given autoPtr and return old element. 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< Tclone (Args &&... args) const
 
template<class... Args>
Foam::autoPtr< Templace (const label i, Args &&... args)
 
- Public Member Functions inherited from UPtrList< T >
constexpr UPtrList () noexcept
 Default construct. More...
 
 UPtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 UPtrList (const UPtrList< T > &list)
 Copy construct (shallow copies addresses) More...
 
 UPtrList (UPtrList< T > &&list)
 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...
 
label size () const noexcept
 The number of elements in the list. More...
 
bool empty () const noexcept
 True if the list is empty (ie, size() is zero) More...
 
Tfront ()
 Reference to the first element of the list. More...
 
const Tfront () const
 Reference to first element of the list. More...
 
Tback ()
 Reference to the last element of the list. More...
 
const Tback () const
 Reference to the last element of the list. More...
 
const Ttest (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 Tget (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
Tget (const label i)
 Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
const Tset (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 resize (const label newLen)
 Change the size of the list. More...
 
void setSize (const label n)
 Alias for resize() More...
 
label squeezeNull ()
 Squeeze out intermediate nullptr entries in the list of 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)
 Swap content. More...
 
void transfer (UPtrList< T > &list)
 Transfer contents into this list and annul the argument. More...
 
Tset (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 Toperator[] (const label i) const
 Return const reference to the element. More...
 
Toperator[] (const label i)
 Return reference to the element. 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 () noexcept
 Return an iterator to begin of UPtrList traversal. More...
 
iterator end () noexcept
 Return iterator beyond end of UPtrList traversal. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator cend () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator end () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
Tfirst ()
 Reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () 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...
 
- Public Member Functions inherited from regIOobject
 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 f 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 all file watches and remove object from registry. 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 dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () 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...
 
IstreamreadStream (const word &, const bool valid=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 labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () 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 valid=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 valid) 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 &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from path, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, 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 &registry, 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 &registry, 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 &registry)
 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...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () 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...
 
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 fileNamerootPath () const
 Return the Time::rootPath() More...
 
const fileNamecaseName () const
 Return the Time::caseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete 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 (uses typeFilePath to find file) and check its info. 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< IOobjectinfo () const
 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)
 
- 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 isReadRequired () const noexcept
 True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More...
 
bool isReadOptional () const noexcept
 True if (READ_IF_PRESENT) bits are set. More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () 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...
 
Ostreamoperator<< (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 Treference
 A non-const reference to the value_type. More...
 
typedef const Tconst_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, MUST_READ_IF_MODIFIED = 0x3, 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 }
 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 (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 IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from IOobjectOption
static bool isReadRequired (readOption opt) noexcept
 True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More...
 
static bool isReadOptional (readOption opt) noexcept
 True if (READ_IF_PRESENT) bits are set. More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 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...
 
void free ()
 Delete the allocated entries, but retain the list size. More...
 
- Protected Member Functions inherited from UPtrList< T >
void setAddressableSize (const label n) noexcept
 Adjust addressable size. More...
 
 UPtrList (Detail::PtrListDetail< T > &&ptrs)
 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< Tptrs_
 The list of pointers. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

A polyBoundaryMesh is a polyPatch list with additional search methods and registered IO.

Source files

Definition at line 58 of file polyBoundaryMesh.H.

Constructor & Destructor Documentation

◆ polyBoundaryMesh() [1/3]

polyBoundaryMesh ( const IOobject io,
const polyMesh mesh 
)

Read constructor given IOobject and a polyMesh reference.

Note point pointers are unset, only used in copying meshes

Definition at line 151 of file polyBoundaryMesh.C.

◆ polyBoundaryMesh() [2/3]

polyBoundaryMesh ( const IOobject io,
const polyMesh mesh,
const label  size 
)

Construct given size.

Definition at line 165 of file polyBoundaryMesh.C.

◆ polyBoundaryMesh() [3/3]

polyBoundaryMesh ( const IOobject io,
const polyMesh mesh,
const polyPatchList ppl 
)

Construct given polyPatchList.

Definition at line 178 of file polyBoundaryMesh.C.

References forAll, patches, PtrList< T >::resize(), PtrList< T >::set(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ ~polyBoundaryMesh()

~polyBoundaryMesh ( )
default

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "polyBoundaryMesh"  )

Runtime type information.

◆ clearGeom()

void clearGeom ( )

Clear geometry at this level and at patches.

Definition at line 202 of file polyBoundaryMesh.C.

References p, and patches.

◆ clearAddressing()

void clearAddressing ( )

Clear addressing at this level and at patches.

Definition at line 213 of file polyBoundaryMesh.C.

References p, and patches.

◆ mesh()

const polyMesh& mesh ( ) const
inlinenoexcept

◆ faceCells()

Return a list of faceCells for each patch.

Definition at line 277 of file polyBoundaryMesh.C.

References forAll, patches, and UPtrList< T >::size().

Referenced by curvatureSeparation::calcInvR1(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::injectParticles(), thermoSingleLayer::Sh(), and thermoSingleLayer::Srho().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ neighbourEdges()

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 293 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(), patchIdentifier::name(), PrimitivePatch< FaceList, PointField >::nEdges(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), Foam::nl, UPstream::parRun(), UList< T >::size(), HashTable< T, edge, Hash< edge > >::size(), and WarningInFunction.

Here is the call graph for this function:

◆ nNonProcessor()

Foam::label nNonProcessor ( ) const

The number of patches before the first processor patch.

Definition at line 501 of file polyBoundaryMesh.C.

References p, and patches.

Referenced by fvMeshAdder::add(), meshRefinement::blockLeakFaces(), Foam::nonProcessorPatchNames(), polyMeshAdder::procPatchPairs(), and fvMeshSubset::reset().

Here is the caller graph for this function:

◆ names()

Foam::wordList names ( ) const

◆ types()

Foam::wordList types ( ) const

Return a list of patch types.

Definition at line 527 of file polyBoundaryMesh.C.

Referenced by polyMesh::readUpdate().

Here is the caller graph for this function:

◆ physicalTypes()

Foam::wordList physicalTypes ( ) const

Return a list of physical types.

Definition at line 533 of file polyBoundaryMesh.C.

References p.

◆ patchStarts()

Foam::labelList patchStarts ( ) const

Return a list of patch start face indices.

Definition at line 544 of file polyBoundaryMesh.C.

References p.

◆ patchSizes()

Foam::labelList patchSizes ( ) const

Return a list of patch sizes.

Definition at line 555 of file polyBoundaryMesh.C.

References p, and UList< T >::size().

Here is the call graph for this function:

◆ patchRanges()

Foam::List< Foam::labelRange > patchRanges ( ) const

Return a list of patch ranges.

Definition at line 566 of file polyBoundaryMesh.C.

References p.

◆ groupNames()

Foam::wordList groupNames ( ) const

A list of the group names (if any)

Definition at line 577 of file polyBoundaryMesh.C.

Referenced by faceSetOption::setFaceSelection().

Here is the caller graph for this function:

◆ start()

Foam::label start ( ) const
noexcept

◆ nFaces()

Foam::label nFaces ( ) const
noexcept

The number of boundary faces in the underlying mesh.

Same as polyMesh::nBoundaryFaces()

Definition at line 589 of file polyBoundaryMesh.C.

◆ range() [1/2]

Foam::labelRange range ( ) const
noexcept

The face range for all boundary faces.

Spans [nInternalFaces, nFaces) of the underlying mesh

Definition at line 595 of file polyBoundaryMesh.C.

Referenced by sampledMeshedSurface::sampleOnFaces(), and lumpedPointMovement::writeZonesVTP().

Here is the caller graph for this function:

◆ range() [2/2]

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 601 of file polyBoundaryMesh.C.

◆ indices() [1/2]

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 614 of file polyBoundaryMesh.C.

References HashTable< T, Key, Hash >::empty(), Foam::PtrListOps::findMatching(), Foam::PtrListOps::firstMatching(), forAllConstIters(), HashSet< Key, Hash >::insert(), wordRe::isPattern(), wordRe::match(), patchId(), and HashTable< T, Key, Hash >::sortedToc().

Referenced by polyBoundaryMesh::findIndices(), fvBoundaryMesh::indices(), viewFactor::initialise(), processorCyclicPolyPatch::patchIDs(), fieldExtents::read(), and faceSetOption::setFaceSelection().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ indices() [2/2]

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 681 of file polyBoundaryMesh.C.

References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), Foam::PtrListOps::findMatching(), UList< T >::first(), forAllConstIters(), HashSet< Key, Hash >::insert(), wordRes::match(), HashTable< T, Key, Hash >::resize(), UList< T >::size(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ findIndex()

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 726 of file polyBoundaryMesh.C.

References Foam::PtrListOps::firstMatching(), and Foam::glTF::key().

Here is the call graph for this function:

◆ findPatchID()

Foam::label findPatchID ( const word patchName,
const bool  allowNotFound = true 
) const

◆ findPatchIDs() [1/2]

labelHashSet findPatchIDs ( ) const

Find patch indices for a given polyPatch type.

◆ whichPatchFace() [1/2]

Foam::labelPair whichPatchFace ( const label  faceIndex) const

Lookup mesh face index and return (patchi, patchFacei) tuple or (-1, meshFacei) for internal faces.

Definition at line 785 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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ whichPatchFace() [2/2]

Foam::labelPairList whichPatchFace ( const labelUList faceIndices) const

Lookup mesh face indices and return (patchi, patchFacei) tuples.

Definition at line 840 of file polyBoundaryMesh.C.

References forAll, Foam::output(), and UList< T >::size().

Here is the call graph for this function:

◆ whichPatch()

label whichPatch ( const label  faceIndex) const
inline

◆ patchID()

const Foam::labelList & patchID ( ) const

Per boundary face label the patch index.

Definition at line 422 of file polyBoundaryMesh.C.

References forAll, patches, UPtrList< T >::size(), and polyBoundaryMesh::start().

Referenced by FacePostProcessing< CloudType >::FacePostProcessing(), interpolationCellPatchConstrained< Type >::interpolate(), and RemoveParcels< CloudType >::RemoveParcels().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ groupPatchIDs()

const Foam::HashTable< Foam::labelList > & groupPatchIDs ( ) const

The patch indices per patch group.

Definition at line 447 of file polyBoundaryMesh.C.

◆ setGroup()

void setGroup ( const word groupName,
const labelUList patchIDs 
)

Set/add group with patches.

Definition at line 459 of file polyBoundaryMesh.C.

References forAll, UList< T >::found(), patches, List< T >::resize(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ patchSet()

Foam::labelHashSet patchSet ( const UList< wordRe > &  patchNames,
const bool  warnNotFound = true,
const bool  useGroups = true 
) const

◆ matchGroups()

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 921 of file polyBoundaryMesh.C.

References DynamicList< T, SizeMin >::append(), HashTable< T, Key, Hash >::erase(), forAllConstIters(), List< T >::transfer(), and HashTable< T, Key, Hash >::transfer().

Here is the call graph for this function:

◆ checkParallelSync()

bool checkParallelSync ( const bool  report = false) const

Check whether all procs have all patches and in same order.

Returns
True if in error.

Definition at line 960 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(), fvMeshTools::loadOrCreateMesh(), and Foam::nonProcessorPatchNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool  report = false) const

Check boundary definition.

Returns
True if in error.

Definition at line 1042 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().

Referenced by fvMeshTools::loadOrCreateMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const pointField p)

◆ updateMesh()

void updateMesh ( )

Correct polyBoundaryMesh after topology update.

Definition at line 1145 of file polyBoundaryMesh.C.

References UPstream::blocking, PstreamBuffers::commsType(), UPstream::defaultCommsType, PstreamBuffers::finishedSends(), forAll, polyMesh::globalData(), mesh, UPstream::nonBlocking, globalMeshData::patchSchedule(), and UPstream::scheduled.

Referenced by polyMesh::readUpdate(), and polyMesh::updateMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reorder()

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 1196 of file polyBoundaryMesh.C.

References forAll, patches, and UPtrList< T >::reorder().

Referenced by meshRefinement::addPatch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream os) const
virtual

writeData member function required by regIOobject

Implements regIOobject.

Definition at line 1219 of file polyBoundaryMesh.C.

References token::BEGIN_LIST, Ostream::beginBlock(), IOstream::check(), Foam::decrIndent(), token::END_LIST, Ostream::endBlock(), FUNCTION_NAME, IOstream::good(), Foam::incrIndent(), Foam::nl, os(), patches, and UPtrList< T >::size().

Referenced by Foam::operator<<().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeObject()

bool writeObject ( IOstreamOption  streamOpt,
const bool  valid 
) const
virtual

Write using stream options.

Reimplemented from regIOobject.

Definition at line 1240 of file polyBoundaryMesh.C.

References IOstreamOption::compression(), IOstreamOption::UNCOMPRESSED, and regIOobject::writeObject().

Here is the call graph for this function:

◆ operator[]() [1/2]

const Foam::polyPatch & operator[] ( const word patchName) const

Return const reference to polyPatch by name.

Definition at line 1253 of file polyBoundaryMesh.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::names(), and Foam::nl.

Here is the call graph for this function:

◆ operator[]() [2/2]

Foam::polyPatch & operator[] ( const word patchName)

Return reference to polyPatch by name.

Definition at line 1272 of file polyBoundaryMesh.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::PtrListOps::names(), and Foam::nl.

Here is the call graph for this function:

◆ findIndices()

labelList findIndices ( const wordRe key,
bool  useGroups = true 
) const
inline

Identical to the indices() method (AUG-2018)

Definition at line 467 of file polyBoundaryMesh.H.

References polyBoundaryMesh::indices().

Here is the call graph for this function:

◆ findPatchIDs() [2/2]

Foam::labelHashSet findPatchIDs ( ) const

Definition at line 24 of file polyBoundaryMeshTemplates.C.

References forAll, and patches.

Friends And Related Function Documentation

◆ polyMesh

friend class polyMesh
friend

Declare friendship with polyMesh.

Definition at line 124 of file polyBoundaryMesh.H.

◆ operator<<

Ostream& operator<< ( Ostream os,
const polyBoundaryMesh pbm 
)
friend

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