Public Member Functions | Protected Attributes | Friends | List of all members
polyTopoChanger Class Reference

List of mesh modifiers defining the mesh dynamics. More...

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

Public Member Functions

 TypeName ("polyTopoChanger")
 Runtime type information. More...
 
 polyTopoChanger (const IOobject &, polyMesh &)
 Read constructor given IOobject and a polyMesh. More...
 
 polyTopoChanger (polyMesh &)
 Read constructor for given polyMesh. More...
 
virtual ~polyTopoChanger ()
 Destructor. More...
 
const polyMeshmesh () const
 Return the mesh reference. More...
 
wordList types () const
 Return a list of patch types. More...
 
wordList names () const
 Return a list of patch names. More...
 
bool changeTopology () const
 Is topology change required. More...
 
autoPtr< polyTopoChangetopoChangeRequest () const
 Return topology change request. More...
 
void modifyMotionPoints (pointField &) const
 Modify point motion. More...
 
autoPtr< mapPolyMeshchangeMesh (const bool inflate, const bool syncParallel=true, const bool orderCells=false, const bool orderPoints=false)
 
void update (const mapPolyMesh &m)
 Force recalculation of locally stored data on topological change. More...
 
void addTopologyModifiers (const List< polyMeshModifier * > &tm)
 Add given set of topology modifiers to the topoChanger. More...
 
label findModifierID (const word &modName) const
 Find modifier given a name. More...
 
bool writeData (Ostream &) const
 writeData member function required by regIOobject More...
 
bool operator!= (const polyTopoChanger &) const
 
bool operator== (const polyTopoChanger &) const
 
- Public Member Functions inherited from PtrList< polyMeshModifier >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< polyMeshModifier > &)
 Copy constructor. More...
 
 PtrList (const PtrList< polyMeshModifier > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< polyMeshModifier > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< polyMeshModifier > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< polyMeshModifier > &)
 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...
 
polyMeshModifierfirst ()
 Return reference to the first element of the list. More...
 
const polyMeshModifierfirst () const
 Return reference to first element of the list. More...
 
polyMeshModifierlast ()
 Return reference to the last element of the list. More...
 
const polyMeshModifierlast () 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 (polyMeshModifier *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< polyMeshModifier > &)
 
void append (const tmp< polyMeshModifier > &)
 
void transfer (PtrList< polyMeshModifier > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< polyMeshModifier > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< polyMeshModifierset (const label, polyMeshModifier *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< polyMeshModifierset (const label, const autoPtr< polyMeshModifier > &)
 
autoPtr< polyMeshModifierset (const label, const tmp< polyMeshModifier > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const polyMeshModifieroperator[] (const label) const
 Return element const reference. More...
 
polyMeshModifieroperator[] (const label)
 Return element reference. More...
 
const polyMeshModifieroperator() (const label) const
 Return element const pointer. More...
 
PtrList< polyMeshModifier > & operator= (const PtrList< polyMeshModifier > &)
 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...
 
virtual bool read ()
 Read object. 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)
 

Protected Attributes

polyMeshmesh_
 Reference to mesh. More...
 

Friends

Ostreamoperator<< (Ostream &, const polyTopoChanger &)
 

Additional Inherited Members

- Public Types inherited from PtrList< polyMeshModifier >
typedef polyMeshModifier value_type
 Type of values the PtrList contains. More...
 
typedef polyMeshModifierreference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const polyMeshModifierconst_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< polyMeshModifier >
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

List of mesh modifiers defining the mesh dynamics.

Source files

Definition at line 56 of file polyTopoChanger.H.

Constructor & Destructor Documentation

polyTopoChanger ( const IOobject io,
polyMesh mesh 
)

Read constructor given IOobject and a polyMesh.

Definition at line 91 of file polyTopoChanger.C.

polyTopoChanger ( polyMesh mesh)
explicit

Read constructor for given polyMesh.

Definition at line 104 of file polyTopoChanger.C.

virtual ~polyTopoChanger ( )
inlinevirtual

Destructor.

Definition at line 95 of file polyTopoChanger.H.

Member Function Documentation

TypeName ( "polyTopoChanger"  )

Runtime type information.

const polyMesh& mesh ( ) const
inline
Foam::wordList types ( ) const

Return a list of patch types.

Definition at line 130 of file polyTopoChanger.C.

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

Referenced by polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::wordList names ( ) const

Return a list of patch names.

Definition at line 145 of file polyTopoChanger.C.

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

Referenced by polyTopoChanger::findModifierID(), and polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

bool changeTopology ( ) const

Is topology change required.

Definition at line 160 of file polyTopoChanger.C.

References Foam::endl(), forAll, and Foam::Info.

Referenced by polyTopoChanger::changeMesh(), and polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::autoPtr< Foam::polyTopoChange > topoChangeRequest ( ) const

Return topology change request.

Definition at line 206 of file polyTopoChanger.C.

References forAll, and polyTopoChanger::mesh().

Referenced by polyTopoChanger::changeMesh(), and polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void modifyMotionPoints ( pointField p) const

Modify point motion.

Definition at line 226 of file polyTopoChanger.C.

References forAll.

Referenced by polyTopoChanger::mesh(), and rawTopoChangerFvMesh::update().

Here is the caller graph for this function:

Foam::autoPtr< Foam::mapPolyMesh > changeMesh ( const bool  inflate,
const bool  syncParallel = true,
const bool  orderCells = false,
const bool  orderPoints = false 
)
void update ( const mapPolyMesh m)

Force recalculation of locally stored data on topological change.

Definition at line 240 of file polyTopoChanger.C.

References IOobject::AUTO_WRITE, polyTopoChanger::changeMesh(), forAll, IOobject::instance(), polyTopoChanger::mesh_, objectRegistry::time(), Time::timeName(), and IOobject::writeOpt().

Referenced by polyTopoChanger::changeMesh(), and polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

void addTopologyModifiers ( const List< polyMeshModifier * > &  tm)

Add given set of topology modifiers to the topoChanger.

Definition at line 291 of file polyTopoChanger.C.

References Foam::abort(), IOobject::AUTO_WRITE, Foam::FatalError, FatalErrorIn, polyTopoChanger::findModifierID(), forAll, PtrList< polyMeshModifier >::setSize(), List< T >::size(), and IOobject::writeOpt().

Referenced by polyTopoChanger::changeMesh(), and polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label findModifierID ( const word modName) const

Find modifier given a name.

Definition at line 319 of file polyTopoChanger.C.

References Foam::endl(), forAll, IOobject::name(), polyTopoChanger::names(), and WarningIn.

Referenced by polyTopoChanger::addTopologyModifiers(), and polyTopoChanger::mesh().

Here is the call graph for this function:

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 346 of file polyTopoChanger.C.

References IOstream::good().

Referenced by polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

bool operator!= ( const polyTopoChanger me) const

Definition at line 355 of file polyTopoChanger.C.

Referenced by polyTopoChanger::mesh().

Here is the caller graph for this function:

bool operator== ( const polyTopoChanger me) const

Definition at line 361 of file polyTopoChanger.C.

References token::BEGIN_LIST, token::END_LIST, forAll, Foam::nl, Foam::operator<<(), and PtrList< T >::size().

Referenced by polyTopoChanger::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

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

Referenced by polyTopoChanger::mesh().

Member Data Documentation

polyMesh& mesh_
protected

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