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")
 
 polyBoundaryMesh (const IOobject &io, const polyMesh &mesh)
 
 polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const label size)
 
 polyBoundaryMesh (const IOobject &io, const polyMesh &mesh, const polyPatchList &ppl)
 
 ~polyBoundaryMesh ()=default
 
void clearGeom ()
 
void clearAddressing ()
 
const polyMeshmesh () const noexcept
 
UPtrList< const labelUListfaceCells () const
 
const List< labelPairList > & neighbourEdges () const
 
label nNonProcessor () const
 
wordList names () const
 
wordList types () const
 
wordList physicalTypes () const
 
labelList patchStarts () const
 
labelList patchSizes () const
 
List< labelRangepatchRanges () const
 
label start () const
 
label nFaces () const
 
labelRange range () const
 
labelRange range (const label patchi) const
 
labelList indices (const wordRe &matcher, const bool useGroups=true) const
 
labelList indices (const wordRes &matcher, const bool useGroups=true) const
 
label findIndex (const wordRe &key) const
 
label findPatchID (const word &patchName, const bool allowNotFound=true) const
 
template<class Type >
labelHashSet findPatchIDs () const
 
label whichPatch (const label faceIndex) const
 
const labelListpatchID () const
 
const HashTable< labelList > & groupPatchIDs () const
 
void setGroup (const word &groupName, const labelUList &patchIDs)
 
labelHashSet patchSet (const UList< wordRe > &patchNames, const bool warnNotFound=true, const bool useGroups=true) const
 
void matchGroups (const labelUList &patchIDs, wordList &groups, labelHashSet &nonGroupPatches) const
 
bool checkParallelSync (const bool report=false) const
 
bool checkDefinition (const bool report=false) const
 
void movePoints (const pointField &p)
 
void updateMesh ()
 
void reorder (const labelUList &oldToNew, const bool validBoundary)
 
virtual bool writeData (Ostream &os) const
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
const polyPatchoperator[] (const word &patchName) const
 
polyPatchoperator[] (const word &patchName)
 
labelList findIndices (const wordRe &key, bool useGroups=true) const
 
template<class Type >
Foam::labelHashSet findPatchIDs () const
 
- Public Member Functions inherited from PtrList
constexpr PtrList () noexcept
 
 PtrList (const label len)
 
 PtrList (const PtrList< T > &list)
 
 PtrList (PtrList< T > &&list)
 
 PtrList (UList< T * > &list)
 
template<class CloneArg >
 PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)
 
 PtrList (PtrList< T > &list, bool reuse)
 
 PtrList (const SLPtrList< T > &list)
 
template<class INew >
 PtrList (Istream &is, const INew &inew)
 
 PtrList (Istream &is)
 
 ~PtrList ()
 
template<class... Args>
PtrList< Tclone (Args &&... args) const
 
const Tset (const label i) const
 
void clear ()
 
void resize (const label newLen)
 
void setSize (const label newLen)
 
template<class... Args>
void emplace_append (Args &&... args)
 
void append (T *ptr)
 
void append (autoPtr< T > &ptr)
 
void append (autoPtr< T > &&ptr)
 
void append (std::unique_ptr< T > &&ptr)
 
void append (const refPtr< T > &ptr)
 
void append (const tmp< T > &ptr)
 
template<class... Args>
autoPtr< Templace (const label i, Args &&... args)
 
autoPtr< Tset (const label i, T *ptr)
 
autoPtr< Tset (const label i, autoPtr< T > &ptr)
 
autoPtr< Tset (const label i, autoPtr< T > &&ptr)
 
autoPtr< Tset (const label i, std::unique_ptr< T > &&ptr)
 
autoPtr< Tset (const label i, const refPtr< T > &ptr)
 
autoPtr< Tset (const label i, const tmp< T > &ptr)
 
autoPtr< Trelease (const label i)
 
void transfer (PtrList< T > &list)
 
void operator= (const PtrList< T > &list)
 
void operator= (PtrList< T > &&list)
 
template<class T >
 PtrList (PtrList< T > &list, bool reuse)
 
template<class T >
 PtrList (const SLPtrList< T > &list)
 
template<class... Args>
Foam::PtrList< Tclone (Args &&... args) const
 
template<class T >
constexpr PtrList () noexcept
 
template<class T >
 PtrList (const label len)
 
template<class T >
 PtrList (const PtrList< T > &list)
 
template<class T >
 PtrList (PtrList< T > &&list)
 
template<class T >
 PtrList (UList< T * > &list)
 
template<class... Args>
Foam::autoPtr< Templace (const label i, Args &&... args)
 
template<class T >
 PtrList (Istream &is)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionaryfindMetaData () const noexcept
 
dictionarygetMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
virtual fileName filePath () const
 
bool headerOk ()
 
IstreamreadStream (const word &, const bool valid=true)
 
void close ()
 
virtual bool readData (Istream &)
 
virtual bool read ()
 
virtual label addWatch (const fileName &)
 
const labelListwatchIndices () const
 
labelListwatchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool write (const bool valid=true) const
 
virtual bool global () const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobjectclone () const
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 
const objectRegistrydb () const noexcept
 
const Timetime () const
 
const wordname () const noexcept
 
const wordheaderClassName () const noexcept
 
wordheaderClassName () noexcept
 
const stringnote () const noexcept
 
stringnote () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 
writeOptionwriteOpt () noexcept
 
boolregisterObject () noexcept
 
boolglobalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 

Friends

class polyMesh
 
Ostreamoperator<< (Ostream &os, const polyBoundaryMesh &pbm)
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 
static OstreamwriteDivider (Ostream &os)
 
static OstreamwriteEndDivider (Ostream &os)
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Protected Member Functions inherited from PtrList
template<class INew >
void readIstream (Istream &is, const INew &inew)
 
void free ()
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 

Detailed Description

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

Source files

Definition at line 59 of file polyBoundaryMesh.H.

Constructor & Destructor Documentation

◆ polyBoundaryMesh() [1/3]

polyBoundaryMesh ( const IOobject io,
const polyMesh mesh 
)

◆ polyBoundaryMesh() [2/3]

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

Definition at line 155 of file polyBoundaryMesh.C.

◆ polyBoundaryMesh() [3/3]

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

◆ ~polyBoundaryMesh()

~polyBoundaryMesh ( )
default

Member Function Documentation

◆ TypeName()

TypeName ( "polyBoundaryMesh"  )

◆ clearGeom()

void clearGeom ( )

Definition at line 229 of file polyBoundaryMesh.C.

References p, and patches.

◆ clearAddressing()

void clearAddressing ( )

Definition at line 240 of file polyBoundaryMesh.C.

References p, and patches.

◆ mesh()

const polyMesh& mesh ( ) const
inlinenoexcept

◆ faceCells()

Definition at line 304 of file polyBoundaryMesh.C.

References forAll, patches, and UPtrList::set().

Referenced by SurfaceFilmModel< CloudType >::inject(), 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

◆ nNonProcessor()

Foam::label nNonProcessor ( ) const

Definition at line 528 of file polyBoundaryMesh.C.

References p, and patches.

Referenced by fvMeshAdder::add(), Foam::nonProcessorPatchNames(), probes::prepare(), polyMeshAdder::procPatchPairs(), and dynamicMotionSolverFvMeshAMI::update().

Here is the caller graph for this function:

◆ names()

Foam::wordList names ( ) const

◆ types()

Foam::wordList types ( ) const

Definition at line 554 of file polyBoundaryMesh.C.

Referenced by polyMesh::readUpdate().

Here is the caller graph for this function:

◆ physicalTypes()

Foam::wordList physicalTypes ( ) const

Definition at line 560 of file polyBoundaryMesh.C.

References p.

◆ patchStarts()

Foam::labelList patchStarts ( ) const

Definition at line 571 of file polyBoundaryMesh.C.

References p.

◆ patchSizes()

Foam::labelList patchSizes ( ) const

Definition at line 582 of file polyBoundaryMesh.C.

References p.

◆ patchRanges()

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

Definition at line 593 of file polyBoundaryMesh.C.

References p.

◆ start()

Foam::label start ( ) const

◆ nFaces()

Foam::label nFaces ( ) const

Definition at line 610 of file polyBoundaryMesh.C.

◆ range() [1/2]

Foam::labelRange range ( ) const

Definition at line 616 of file polyBoundaryMesh.C.

Referenced by lumpedPointMovement::writeZonesVTP().

Here is the caller graph for this function:

◆ range() [2/2]

Foam::labelRange range ( const label  patchi) const

Definition at line 622 of file polyBoundaryMesh.C.

◆ indices() [1/2]

Foam::labelList indices ( const wordRe matcher,
const bool  useGroups = true 
) const

◆ indices() [2/2]

Foam::labelList indices ( const wordRes matcher,
const bool  useGroups = true 
) const

Definition at line 702 of file polyBoundaryMesh.C.

References Foam::PtrListOps::findMatching(), forAllConstIters(), HashSet::insert(), and wordRes::match().

Here is the call graph for this function:

◆ findIndex()

Foam::label findIndex ( const wordRe key) const

Definition at line 747 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

◆ whichPatch()

Foam::label whichPatch ( const label  faceIndex) const

◆ patchID()

const Foam::labelList & patchID ( ) const

◆ groupPatchIDs()

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

Definition at line 474 of file polyBoundaryMesh.C.

Referenced by meshRefinement::findRegions().

Here is the caller graph for this function:

◆ setGroup()

void setGroup ( const word groupName,
const labelUList patchIDs 
)

Definition at line 486 of file polyBoundaryMesh.C.

References forAll, patches, and List::resize().

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

Definition at line 926 of file polyBoundaryMesh.C.

References DynamicList::append(), forAllConstIters(), and List::transfer().

Here is the call graph for this function:

◆ checkParallelSync()

bool checkParallelSync ( const bool  report = false) const

◆ checkDefinition()

bool checkDefinition ( const bool  report = false) const

◆ movePoints()

void movePoints ( const pointField p)

◆ updateMesh()

void updateMesh ( )

◆ reorder()

void reorder ( const labelUList oldToNew,
const bool  validBoundary 
)

Definition at line 1207 of file polyBoundaryMesh.C.

References forAll, patches, and Foam::reorder().

Referenced by fvMeshTools::addPatch(), meshRefinement::addPatch(), and fvMeshTools::reorderPatches().

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

◆ writeData()

bool writeData ( Ostream os) const
virtual

Implements regIOobject.

Definition at line 1230 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(), and patches.

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

Reimplemented from regIOobject.

Definition at line 1251 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

Definition at line 1264 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)

Definition at line 1283 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

Definition at line 322 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, HashSet::insert(), and patches.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ polyMesh

friend class polyMesh
friend

Definition at line 100 of file polyBoundaryMesh.H.

◆ operator<<

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

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