Public Member Functions | Friends | List of all members
ZoneMesh< ZoneType, MeshType > Class Template Reference

A list of mesh zones. More...

Inheritance diagram for ZoneMesh< ZoneType, MeshType >:
Inheritance graph
[legend]
Collaboration diagram for ZoneMesh< ZoneType, MeshType >:
Collaboration graph
[legend]

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...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero). More...
 
ZoneType & first ()
 Return reference to the first element of the list. More...
 
const ZoneType & first () const
 Return reference to first element of the list. More...
 
ZoneType & last ()
 Return reference to the last element of the list. More...
 
const ZoneType & last () const
 Return reference to the last element of the list. 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. Return old element (can be NULL). More...
 
autoPtr< ZoneType > set (const label, const autoPtr< ZoneType > &)
 
autoPtr< ZoneType > set (const label, const tmp< ZoneType > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const ZoneType & operator[] (const label) const
 Return element const reference. More...
 
ZoneType & operator[] (const label)
 Return element reference. More...
 
const ZoneType * operator() (const label) const
 Return element const pointer. More...
 
PtrList< ZoneType > & operator= (const PtrList< ZoneType > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the PtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the PtrList. 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...
 
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...
 
labeleventNo ()
 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...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. 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
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. 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 &registry, 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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () 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 filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Friends

Ostreamoperator (Ostream &, const ZoneMesh< ZoneType, MeshType > &)
 

Additional Inherited Members

- Public Types inherited from PtrList< ZoneType >
typedef ZoneType value_type
 Type of values the PtrList contains. More...
 
typedef ZoneType & reference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const ZoneType & const_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. 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...
 
- 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 const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- 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 IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
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...
 

Detailed Description

template<class ZoneType, class MeshType>
class Foam::ZoneMesh< ZoneType, MeshType >

A list of mesh zones.

Source files

Definition at line 39 of file cellZoneMeshFwd.H.

Constructor & Destructor Documentation

ZoneMesh ( const IOobject io,
const MeshType &  mesh 
)

Read constructor given IOobject and a MeshType reference.

Definition at line 144 of file ZoneMesh.C.

References Foam::read().

Here is the call graph for this function:

ZoneMesh ( const IOobject io,
const MeshType &  mesh,
const label  size 
)

Construct given size.

Definition at line 161 of file ZoneMesh.C.

References Foam::read().

Here is the call graph for this function:

ZoneMesh ( const IOobject io,
const MeshType &  mesh,
const PtrList< ZoneType > &  pzm 
)

Construct given a PtrList.

Definition at line 179 of file ZoneMesh.C.

References forAll, Foam::read(), PtrList< T >::set(), PtrList< T >::setSize(), and PtrList< T >::size().

Here is the call graph for this function:

~ZoneMesh ( )

Destructor.

Definition at line 206 of file ZoneMesh.C.

Member Function Documentation

const MeshType& mesh ( ) const
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 217 of file ZoneMesh.C.

References ZoneMesh< ZoneType, MeshType >::whichZone().

Referenced by ZoneMesh< cellZone, polyMesh >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label whichZone ( const label  objectIndex) const
Foam::wordList types ( ) const

Return a list of zone types.

Definition at line 252 of file ZoneMesh.C.

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

Referenced by ZoneMesh< cellZone, polyMesh >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::wordList names ( ) const
Foam::labelList findIndices ( const keyType key) const

Return zone indices for all matches.

Definition at line 286 of file ZoneMesh.C.

References ZoneMesh< ZoneType, MeshType >::findIndex(), Foam::findStrings(), forAll, keyType::isPattern(), Foam::name(), and List< T >::setSize().

Referenced by ZoneMesh< cellZone, polyMesh >::mesh(), and ZoneMesh< ZoneType, MeshType >::names().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label findIndex ( const keyType key) const

Return zone index for the first match, return -1 if not found.

Definition at line 319 of file ZoneMesh.C.

References UList< T >::empty(), Foam::findIndices(), ZoneMesh< ZoneType, MeshType >::findZoneID(), forAll, keyType::isPattern(), and Foam::name().

Referenced by ZoneMesh< ZoneType, MeshType >::findIndices(), ZoneMesh< cellZone, polyMesh >::mesh(), and sampledPlane::sampledPlane().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label findZoneID ( const word zoneName) const
Foam::PackedBoolList findMatching ( const keyType key) const

Mark cells that match the zone specification.

Definition at line 383 of file ZoneMesh.C.

References Foam::findIndices(), and forAll.

Referenced by ZoneMesh< ZoneType, MeshType >::findZoneID(), ZoneMesh< cellZone, polyMesh >::mesh(), and sampledPlane::update().

Here is the call graph for this function:

Here is the caller graph for this function:

void clearAddressing ( )
void clear ( )

Clear the zones.

Definition at line 414 of file ZoneMesh.C.

References ZoneMesh< ZoneType, MeshType >::checkDefinition(), and clear().

Referenced by cellTable::addCellZones(), and ZoneMesh< cellZone, polyMesh >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

bool checkDefinition ( const bool  report = false) const

Check zone definition. Return true if in error.

Definition at line 424 of file ZoneMesh.C.

References ZoneMesh< ZoneType, MeshType >::checkParallelSync(), and forAll.

Referenced by ZoneMesh< ZoneType, MeshType >::clear(), and ZoneMesh< cellZone, polyMesh >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

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 442 of file ZoneMesh.C.

References Foam::endl(), forAll, Foam::Info, and List< T >::size().

Referenced by ZoneMesh< ZoneType, MeshType >::checkDefinition(), and ZoneMesh< cellZone, polyMesh >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void movePoints ( const pointField p)

Correct zone mesh after moving points.

Definition at line 520 of file ZoneMesh.C.

References forAll.

Referenced by ZoneMesh< cellZone, polyMesh >::mesh(), and polyMesh::movePoints().

Here is the caller graph for this function:

bool writeData ( Ostream os) const
virtual

writeData member function required by regIOobject

Implements regIOobject.

Definition at line 533 of file ZoneMesh.C.

References IOstream::good().

Referenced by ZoneMesh< cellZone, polyMesh >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

const ZoneType & operator[] ( const word zoneName) const

Return const reference to ZoneType by name.

Definition at line 543 of file ZoneMesh.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorIn, and Foam::nl.

Referenced by ZoneMesh< cellZone, polyMesh >::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

ZoneType & operator[] ( const word zoneName)

Return reference to ZoneType by name.

Definition at line 565 of file ZoneMesh.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, and Foam::nl.

Here is the call graph for this function:

Friends And Related Function Documentation

Ostream& operator ( Ostream ,
const ZoneMesh< ZoneType, MeshType > &   
)
friend

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