FreeFOAM The Cross-Platform CFD Toolkit
polyBoundaryMesh Class Reference

Foam::polyBoundaryMesh. More...

#include <OpenFOAM/polyBoundaryMesh.H>


Detailed Description

+ Inheritance diagram for polyBoundaryMesh:
+ Collaboration diagram for polyBoundaryMesh:

List of all members.

Public Member Functions

 TypeName ("polyBoundaryMesh")
 Runtime type information.
 polyBoundaryMesh (const IOobject &, const polyMesh &)
 Read constructor given IOobject and a polyMesh reference.
 polyBoundaryMesh (const IOobject &, const polyMesh &, const label size)
 Construct given size.
 ~polyBoundaryMesh ()
void clearGeom ()
 Clear geometry at this level and at patches.
void clearAddressing ()
 Clear addressing at this level and at patches.
const polyMeshmesh () const
 Return the mesh reference.
const List< labelPairList > & neighbourEdges () const
 Per patch the edges on the neighbouring patch. Is for every external.
wordList names () const
 Return a list of patch names.
wordList types () const
 Return a list of patch types.
wordList physicalTypes () const
 Return a list of physical types.
label findPatchID (const word &patchName) const
 Find patch index given a name.
label whichPatch (const label faceIndex) const
 Return patch index for a given face label.
labelHashSet patchSet (const wordList &) const
 Return the set of patch IDs corresponding to the given list of names.
bool checkParallelSync (const bool report=false) const
 Check whether all procs have all patches and in same order. Return.
bool checkDefinition (const bool report=false) const
 Check boundary definition. Return true if in error.
void movePoints (const pointField &)
 Correct polyBoundaryMesh after moving points.
void updateMesh ()
 Correct polyBoundaryMesh after topology update.
void reorder (const UList< label > &)
 Reorders patches. Ordering does not have to be done in.
bool writeData (Ostream &) const
 writeData member function required by regIOobject
bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write using given format, version and form uncompression.
- Public Member Functions inherited from PtrList< T >
 PtrList ()
 Null Constructor.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< T > &)
 Copy constructor.
template<class CloneArg >
 PtrList (const PtrList< T > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< T > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< T > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< T > &)
 Construct as copy of SLPtrList<T>
template<class INew >
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class.
 ~PtrList ()
label size () const
 Return the number of elements in the PtrList.
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero).
void setSize (const label)
 Reset size of PtrList. This can only be used to set the size.
void resize (const label)
 Reset size of PtrList. This can only be used to set the size.
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the.
void transfer (PtrList< T > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList< T > > xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr< Tset (const label, T *)
 Set element. Return old element (can be NULL).
autoPtr< Tset (const label, const autoPtr< T > &)
autoPtr< Tset (const label, const tmp< T > &)
const Toperator[] (const label) const
 Return element const reference.
Toperator[] (const label)
 Return element reference.
const Toperator() (const label) const
 Return element const pointer.
PtrList< T > & operator= (const PtrList< T > &)
 Assignment.
iterator begin ()
 Return an iterator to begin traversing the PtrList.
iterator end ()
 Return an iterator to end traversing the PtrList.
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 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.
 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.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.

Friends

class polyMesh
 Declare friendship with polyMesh.
Ostreamoperator<< (Ostream &, const polyBoundaryMesh &)

Additional Inherited Members

- Public Types inherited from PtrList< T >
typedef T value_type
 Type of values the PtrList contains.
typedef Treference
 Type that can be used for storing into PtrList::value_type objects.
typedef const Tconst_reference
 Type that can be used for storing into constant PtrList::value_type.
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry.
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry.
- 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.
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner.
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider.
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider.
- Static Public Attributes inherited from regIOobject
static int fileModificationSkew
- Protected Member Functions inherited from PtrList< T >
template<class INew >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class.

Constructor & Destructor Documentation

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

References IOstream::check(), forAll, IOobject::MUST_READ, polyPatch::New(), patches, PtrList< T >::set(), PtrList< T >::setSize(), and PtrList< T >::size().

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

Construct given size.

Definition at line 101 of file polyBoundaryMesh.C.

Definition at line 116 of file polyBoundaryMesh.C.

References Foam::deleteDemandDrivenData().


Member Function Documentation

TypeName ( "polyBoundaryMesh"  )

Runtime type information.

void clearGeom ( )

Clear geometry at this level and at patches.

Definition at line 122 of file polyBoundaryMesh.C.

References forAll, and patchi.

void clearAddressing ( )

Clear addressing at this level and at patches.

Definition at line 131 of file polyBoundaryMesh.C.

References Foam::deleteDemandDrivenData(), forAll, and patchi.

const Foam::List< Foam::labelPairList > & neighbourEdges ( ) const
Foam::wordList types ( ) const

Return a list of patch types.

Definition at line 306 of file polyBoundaryMesh.C.

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

Referenced by polyMesh::readUpdate().

Foam::wordList physicalTypes ( ) const

Return a list of physical types.

Definition at line 321 of file polyBoundaryMesh.C.

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

Foam::labelHashSet patchSet ( const wordList patchNames) const

Return the set of patch IDs corresponding to the given list of names.

Wild cards are expanded.

Definition at line 412 of file polyBoundaryMesh.C.

References UList< T >::empty(), Foam::endl(), Foam::findStrings(), forAll, HashSet< Key, Hash >::insert(), and WarningIn.

Referenced by forces::read().

bool checkParallelSync ( const bool  report = false) const
bool checkDefinition ( const bool  report = false) const

Check boundary definition. Return true if in error.

Definition at line 529 of file polyBoundaryMesh.C.

References Foam::endl(), forAll, Foam::Info, mesh, IOobject::name(), primitiveMesh::nInternalFaces(), Foam::Pout, Foam::reduce(), and PtrList< T >::size().

void movePoints ( const pointField p)

Correct polyBoundaryMesh after moving points.

Definition at line 578 of file polyBoundaryMesh.C.

References forAll, patches, and patchi.

void updateMesh ( )

Correct polyBoundaryMesh after topology update.

Definition at line 594 of file polyBoundaryMesh.C.

References Foam::deleteDemandDrivenData(), forAll, patches, and patchi.

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

void reorder ( const UList< label > &  oldToNew)

Reorders patches. Ordering does not have to be done in.

ascending or descending order. Reordering has to be unique. (is shuffle) Calls updateMesh() after reordering to recalculate data.

Reimplemented from PtrList< T >.

Definition at line 612 of file polyBoundaryMesh.C.

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

Referenced by meshRefinement::addPatch().

bool writeData ( Ostream os) const
virtual
bool writeObject ( IOstream::streamFormat  fmt,
IOstream::versionNumber  ver,
IOstream::compressionType  cmp 
) const
virtual

Write using given format, version and form uncompression.

Reimplemented from regIOobject.

Definition at line 653 of file polyBoundaryMesh.C.

References IOstream::UNCOMPRESSED, and regIOobject::writeObject().


Friends And Related Function Documentation

friend class polyMesh
friend

Declare friendship with polyMesh.

Definition at line 93 of file polyBoundaryMesh.H.

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

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