A list of mesh zones. More...
Public Member Functions | |
ZoneMesh (const IOobject &, const MeshType &) | |
Read constructor given IOobject and a MeshType reference. More... | |
ZoneMesh (const IOobject &, const MeshType &, const label size) | |
Construct given size. More... | |
ZoneMesh (const IOobject &, const MeshType &, const PtrList< ZoneType > &) | |
Construct given a PtrList. More... | |
~ZoneMesh () | |
Destructor. More... | |
const MeshType & | mesh () const |
Return the mesh reference. More... | |
const Map< label > & | zoneMap () const |
Map of zones containing zone index for all zoned elements. More... | |
label | whichZone (const label objectIndex) const |
Given a global object index, return the zone it is in. More... | |
wordList | types () const |
Return a list of zone types. More... | |
wordList | names () const |
Return a list of zone names. More... | |
labelList | findIndices (const keyType &) const |
Return zone indices for all matches. More... | |
label | findIndex (const keyType &) const |
Return zone index for the first match, return -1 if not found. More... | |
label | findZoneID (const word &zoneName) const |
Find zone index given a name. More... | |
PackedBoolList | findMatching (const keyType &) const |
Mark cells that match the zone specification. More... | |
void | clearAddressing () |
Clear addressing. More... | |
void | clear () |
Clear the zones. More... | |
bool | checkDefinition (const bool report=false) const |
Check zone definition. Return true if in error. More... | |
bool | checkParallelSync (const bool report=false) const |
Check whether all procs have all zones and in same order. Return. More... | |
void | movePoints (const pointField &) |
Correct zone mesh after moving points. More... | |
bool | writeData (Ostream &) const |
writeData member function required by regIOobject More... | |
const ZoneType & | operator[] (const word &) const |
Return const reference to ZoneType by name. More... | |
ZoneType & | operator[] (const word &) |
Return reference to ZoneType by name. More... | |
Public Member Functions inherited from PtrList< ZoneType > | |
PtrList () | |
Null Constructor. More... | |
PtrList (const label) | |
Construct with size specified. More... | |
PtrList (const PtrList< ZoneType > &) | |
Copy constructor. More... | |
PtrList (const PtrList< ZoneType > &, const CloneArg &) | |
Copy constructor with additional argument for clone. More... | |
PtrList (const Xfer< PtrList< ZoneType >> &) | |
Construct by transferring the parameter contents. More... | |
PtrList (PtrList< ZoneType > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< ZoneType > &) | |
Construct as copy of SLPtrList<T> More... | |
PtrList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. More... | |
PtrList (Istream &) | |
Construct from Istream using default Istream constructor class. More... | |
~PtrList () | |
Destructor. More... | |
void | setSize (const label) |
Reset size of PtrList. If extending the PtrList, new entries are. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | clear () |
Clear the PtrList, i.e. set size to zero deleting all the. More... | |
void | append (ZoneType *) |
Append an element at the end of the list. More... | |
void | append (const autoPtr< ZoneType > &) |
void | append (const tmp< ZoneType > &) |
void | transfer (PtrList< ZoneType > &) |
Transfer the contents of the argument PtrList into this PtrList. More... | |
Xfer< PtrList< ZoneType > > | xfer () |
Transfer contents to the Xfer container. More... | |
bool | set (const label) const |
Is element set. More... | |
autoPtr< ZoneType > | set (const label, ZoneType *) |
Set element to given T* and return old element (can be nullptr) More... | |
autoPtr< ZoneType > | set (const label, const autoPtr< ZoneType > &) |
Set element to given autoPtr<T> and return old element. More... | |
autoPtr< ZoneType > | set (const label, const tmp< ZoneType > &) |
Set element to given tmp<T> and return old element. More... | |
void | reorder (const labelUList &) |
Reorders elements. Ordering does not have to be done in. More... | |
void | operator= (const PtrList< ZoneType > &) |
Assignment. More... | |
Public Member Functions inherited from UPtrList< T > | |
UPtrList () | |
Null Constructor. More... | |
UPtrList (const label) | |
Construct with size specified. More... | |
UPtrList (const Xfer< UPtrList< T >> &) | |
Construct by transferring the parameter contents. More... | |
UPtrList (UPtrList< T > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
label | size () const |
Return the number of elements in the UPtrList. More... | |
bool | empty () const |
Return true if the UPtrList is empty (ie, size() is zero) More... | |
T & | first () |
Return 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 | setSize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | resize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | clear () |
Clear the UPtrList, i.e. set size to zero. More... | |
void | transfer (UPtrList< T > &) |
Transfer the contents of the argument UPtrList into this. More... | |
Xfer< UPtrList< T > > | xfer () |
Transfer contents to the Xfer container. More... | |
bool | set (const label) const |
Is element set. More... | |
T * | set (const label, T *) |
Set element. Return old element (can be nullptr). More... | |
void | reorder (const labelUList &) |
Reorders elements. Ordering does not have to be done in. More... | |
const T & | operator[] (const label) const |
Return element const reference. More... | |
T & | operator[] (const label) |
Return element reference. More... | |
const T * | operator() (const label) const |
Return element const pointer. More... | |
iterator | begin () |
Return an iterator to begin traversing the UPtrList. More... | |
iterator | end () |
Return an iterator to end traversing the UPtrList. More... | |
const_iterator | cbegin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | cend () const |
Return an const_iterator to end traversing the UPtrList. More... | |
const_iterator | begin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | end () const |
Return an const_iterator to end traversing the UPtrList. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &, const bool isTime=false) | |
Construct from IOobject. Optional flag for if IOobject is the. More... | |
regIOobject (const regIOobject &) | |
Construct as copy. More... | |
regIOobject (const regIOobject &, bool registerCopy) | |
Construct as copy, transferring registry registration to copy. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Construct as copy with new name, transfering registry registration. More... | |
regIOobject (const IOobject &, const regIOobject &) | |
Construct as copy with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry. More... | |
bool | checkOut () |
Remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | ownedByRegistry () const |
Is this object owned by the registry? More... | |
void | store () |
Transfer ownership of this object to its registry. More... | |
void | release () |
Release ownership of this object from its registry. More... | |
label | eventNo () const |
Event number at last update. More... | |
label & | eventNo () |
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 up to date (obviously) More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. More... | |
Istream & | readStream (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 label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. Return. More... | |
const labelList & | watchIndices () const |
Return file-monitoring handles. More... | |
labelList & | watchIndices () |
Return file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const |
Write using given format, version and compression. 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 &) |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Runtime type information. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Construct from copy resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct from copy resetting name. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
word & | headerClassName () |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () const |
Return the optional note. More... | |
bool & | registerObject () |
Register object created from this IOobject with registry if true. More... | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. More... | |
bool & | globalObject () |
Is object same for all processors. More... | |
bool | globalObject () const |
Is object same for all processors. More... | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () const |
fileName | path () const |
Return complete path. More... | |
fileName | path (const word &instance, const fileName &local="") const |
Return complete path with alternative instance and local. More... | |
fileName | objectPath () const |
Return complete path + object name. More... | |
fileName | localFilePath (const word &typeName) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName) const |
Helper for filePath that searches up if in parallel. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true) |
Read header (uses typeFilePath to find file) and check header. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &) const |
Write header. More... | |
bool | writeHeader (Ostream &, const word &objectType) const |
Write header. Allow override of type. More... | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
Friends | |
Ostream & | operator (Ostream &, const ZoneMesh< ZoneType, MeshType > &) |
Additional Inherited Members | |
Public Types inherited from UPtrList< T > | |
typedef T | value_type |
Type of values the UPtrList contains. More... | |
typedef T & | reference |
Type that can be used for storing into UPtrList::value_type objects. More... | |
typedef const T & | const_reference |
Type that can be used for storing into constant UPtrList::value_type. More... | |
Public Types inherited from IOobject | |
enum | objectState { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &) |
Transfer ownership of the given object pointer to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class Name > | |
static word | groupName (Name name, const word &group) |
template<class Stream > | |
static Stream & | writeBanner (Stream &os, bool noHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
template<class Stream > | |
static Stream & | writeDivider (Stream &os) |
Write the standard file section divider. More... | |
template<class Stream > | |
static Stream & | writeEndDivider (Stream &os) |
Write the standard end file divider. More... | |
Static Public Attributes inherited from regIOobject | |
static float | fileModificationSkew |
Static Public Attributes inherited from IOobject | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
Protected Member Functions inherited from PtrList< ZoneType > | |
void | read (Istream &, const INew &inewt) |
Read from Istream using given Istream constructor class. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &) |
Set the object state to bad. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
A list of mesh zones.
Definition at line 39 of file cellZoneMeshFwd.H.
Read constructor given IOobject and a MeshType reference.
Definition at line 137 of file ZoneMesh.C.
Construct given size.
Definition at line 153 of file ZoneMesh.C.
Construct given a PtrList.
Definition at line 171 of file ZoneMesh.C.
~ZoneMesh | ( | ) |
Destructor.
Definition at line 198 of file ZoneMesh.C.
|
inline |
Return the mesh reference.
Definition at line 127 of file ZoneMesh.H.
const Foam::Map< Foam::label > & zoneMap | ( | ) | const |
Map of zones containing zone index for all zoned elements.
Return -1 if the object is not in the zone
Definition at line 208 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::mesh().
Foam::label whichZone | ( | const label | objectIndex | ) | const |
Given a global object index, return the zone it is in.
If object does not belong to any zones, return -1
Definition at line 221 of file ZoneMesh.C.
Referenced by repatchPolyTopoChanger::changeAnchorPoint(), repatchPolyTopoChanger::changePatchID(), meshRefinement::checkZoneFaces(), meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), ZoneMesh< cellZone, polyMesh >::mesh(), removeCells::setRefinement(), duplicatePoints::setRefinement(), perfectInterface::setRefinement(), tetDecomposer::setRefinement(), edgeCollapser::setRefinement(), and ZoneMesh< cellZone, polyMesh >::zoneMap().
Foam::wordList types | ( | ) | const |
Return a list of zone types.
Definition at line 240 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::mesh().
Foam::wordList names | ( | ) | const |
Return a list of zone names.
Definition at line 256 of file ZoneMesh.C.
Referenced by preserveFaceZonesConstraint::add(), preserveFaceZonesConstraint::apply(), meshRefinement::checkCoupledFaceZones(), displacementInterpolationMotionSolver::displacementInterpolationMotionSolver(), fvMeshDistribute::distribute(), ZoneMesh< cellZone, polyMesh >::mesh(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), cellTable::operator=(), solidBodyMotionSolver::solidBodyMotionSolver(), displacementLayeredMotionMotionSolver::solve(), and CellZoneInjection< CloudType >::updateMesh().
Foam::labelList findIndices | ( | const keyType & | key | ) | const |
Return zone indices for all matches.
Definition at line 273 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::mesh(), and ZoneMesh< cellZone, polyMesh >::names().
Foam::label findIndex | ( | const keyType & | key | ) | const |
Return zone index for the first match, return -1 if not found.
Definition at line 306 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::findIndices(), ZoneMesh< cellZone, polyMesh >::mesh(), and sampledPlane::sampledPlane().
Foam::label findZoneID | ( | const word & | zoneName | ) | const |
Find zone index given a name.
Definition at line 341 of file ZoneMesh.C.
Referenced by cellZoneSet::cellZoneSet(), displacementInterpolationMotionSolver::displacementInterpolationMotionSolver(), snappySnapDriver::doSnap(), FacePostProcessing< CloudType >::FacePostProcessing(), faceZoneSet::faceZoneSet(), ZoneMesh< cellZone, polyMesh >::findIndex(), snappySnapDriver::getZoneSurfacePoints(), interRegionExplicitPorositySource::initialise(), ZoneMesh< cellZone, polyMesh >::mesh(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), listPlusEqOp< T >::operator()(), pointZoneSet::pointZoneSet(), fvMeshDistribute::printCoupleInfo(), solidBodyMotionSolver::solidBodyMotionSolver(), displacementLayeredMotionMotionSolver::solve(), CellZoneInjection< CloudType >::updateMesh(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), and faceZoneSet::writeObject().
Foam::PackedBoolList findMatching | ( | const keyType & | key | ) | const |
Mark cells that match the zone specification.
Definition at line 370 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::findZoneID(), ZoneMesh< cellZone, polyMesh >::mesh(), and sampledPlane::update().
void clearAddressing | ( | ) |
Clear addressing.
Definition at line 387 of file ZoneMesh.C.
Referenced by polyMesh::clearAddressing(), interRegionExplicitPorositySource::initialise(), ZoneMesh< cellZone, polyMesh >::mesh(), Foam::polyMeshZipUpCells(), polyMesh::updateMesh(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), and faceZoneSet::writeObject().
void clear | ( | ) |
Clear the zones.
Definition at line 401 of file ZoneMesh.C.
Referenced by cellTable::addCellZones(), and ZoneMesh< cellZone, polyMesh >::mesh().
bool checkDefinition | ( | const bool | report = false | ) | const |
Check zone definition. Return true if in error.
Definition at line 410 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::clear(), and ZoneMesh< cellZone, polyMesh >::mesh().
bool checkParallelSync | ( | const bool | report = false | ) | const |
Check whether all procs have all zones and in same order. Return.
true if in error.
Definition at line 428 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::checkDefinition(), and ZoneMesh< cellZone, polyMesh >::mesh().
void movePoints | ( | const pointField & | p | ) |
Correct zone mesh after moving points.
Definition at line 505 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::mesh(), and polyMesh::movePoints().
|
virtual |
writeData member function required by regIOobject
Implements regIOobject.
Definition at line 517 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::mesh().
Return const reference to ZoneType by name.
Definition at line 528 of file ZoneMesh.C.
Referenced by ZoneMesh< cellZone, polyMesh >::mesh().
Return reference to ZoneType by name.
Definition at line 548 of file ZoneMesh.C.