Public Types | Public Member Functions | Static Public Member Functions | List of all members
pointMesh Class Reference

Mesh representing a set of points created from polyMesh. More...

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

Public Types

typedef pointMesh Mesh
 
typedef pointBoundaryMesh BoundaryMesh
 
- 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...
 
- Public Types inherited from GeoMesh< polyMesh >
typedef polyMesh Mesh
 
typedef polyMesh::BoundaryMesh BoundaryMesh
 

Public Member Functions

 ClassName ("pointMesh")
 
 pointMesh (const polyMesh &pMesh)
 Construct from polyMesh. More...
 
 ~pointMesh ()
 Destructor. More...
 
label size () const
 Return number of points. More...
 
const pointBoundaryMeshboundary () const
 Return reference to boundary mesh. More...
 
const globalMeshDataglobalData () const
 Return parallel info. More...
 
const objectRegistrythisDb () const
 Return database. For now is its polyMesh. More...
 
bool movePoints ()
 Move points. More...
 
void updateMesh (const mapPolyMesh &mpm)
 Update the mesh corresponding to given map. More...
 
bool operator!= (const pointMesh &pm) const
 
bool operator== (const pointMesh &pm) const
 
- Public Member Functions inherited from MeshObject< polyMesh, UpdateableMeshObject, pointMesh >
 MeshObject (const polyMesh &mesh)
 
virtual ~MeshObject ()
 
const polyMeshmesh () const
 
virtual bool writeData (Foam::Ostream &) const
 
- Public Member Functions inherited from UpdateableMeshObject< polyMesh >
 UpdateableMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from MoveableMeshObject< polyMesh >
 MoveableMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from GeometricMeshObject< polyMesh >
 GeometricMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from TopologicalMeshObject< polyMesh >
 TopologicalMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from meshObject
 ClassName ("meshObject")
 
 meshObject (const word &typeName, const objectRegistry &obr)
 
- 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)
 
- Public Member Functions inherited from GeoMesh< polyMesh >
 GeoMesh (const polyMesh &mesh)
 Construct from MESH. More...
 
const objectRegistrythisDb () const
 Return the object registry. More...
 
const polyMeshoperator() () const
 Return reference to polyMesh. More...
 

Static Public Member Functions

static label size (const Mesh &mesh)
 Return number of points. More...
 
- Static Public Member Functions inherited from MeshObject< polyMesh, UpdateableMeshObject, pointMesh >
static const pointMeshNew (const polyMesh &mesh)
 
static const pointMeshNew (const polyMesh &mesh, const Data1 &d)
 
static const pointMeshNew (const polyMesh &mesh, const Data1 &, const Data2 &)
 
static const pointMeshNew (const polyMesh &mesh, const Data1 &, const Data2 &, const Data3 &)
 
static const pointMeshNew (const polyMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)
 
static bool Delete (const polyMesh &mesh)
 
- Static Public Member Functions inherited from meshObject
template<class Mesh >
static void movePoints (objectRegistry &)
 
template<class Mesh >
static void updateMesh (objectRegistry &, const mapPolyMesh &)
 
template<class Mesh , template< class > class MeshObjectType>
static void clear (objectRegistry &)
 
template<class Mesh , template< class > class FromType, template< class > class ToType>
static void clearUpto (objectRegistry &)
 Clear all meshObject derived from FromType up to (but not including) 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...
 

Additional Inherited Members

- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- 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...
 
- Protected Attributes inherited from MeshObject< polyMesh, UpdateableMeshObject, pointMesh >
const polyMeshmesh_
 
- Protected Attributes inherited from GeoMesh< polyMesh >
const polyMeshmesh_
 Reference to Mesh. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Mesh representing a set of points created from polyMesh.

Definition at line 48 of file pointMesh.H.

Member Typedef Documentation

typedef pointMesh Mesh

Definition at line 77 of file pointMesh.H.

Definition at line 78 of file pointMesh.H.

Constructor & Destructor Documentation

pointMesh ( const polyMesh pMesh)
explicit

Construct from polyMesh.

Definition at line 73 of file pointMesh.C.

References Foam::endl(), IOobject::name(), and Foam::Pout.

Here is the call graph for this function:

~pointMesh ( )

Destructor.

Definition at line 93 of file pointMesh.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

Member Function Documentation

ClassName ( "pointMesh"  )
label size ( ) const
inline

Return number of points.

Definition at line 94 of file pointMesh.H.

Referenced by pointMapper::pointMapper(), and pointFieldReconstructor::reconstructField().

Here is the caller graph for this function:

static label size ( const Mesh mesh)
inlinestatic

Return number of points.

Definition at line 100 of file pointMesh.H.

References GeoMesh< MESH >::GeoMesh(), GeoMesh< polyMesh >::mesh_, and primitiveMesh::nPoints().

Here is the call graph for this function:

const pointBoundaryMesh& boundary ( ) const
inline
const globalMeshData& globalData ( ) const
inline

Return parallel info.

Definition at line 112 of file pointMesh.H.

Referenced by pointBoundaryMesh::findIndices(), pointBoundaryMesh::movePoints(), and pointBoundaryMesh::updateMesh().

Here is the caller graph for this function:

const objectRegistry& thisDb ( ) const
inline

Return database. For now is its polyMesh.

Definition at line 118 of file pointMesh.H.

References pointMesh::movePoints(), GeoMesh< MESH >::thisDb(), and pointMesh::updateMesh().

Referenced by volPointInterpolation::interpolate(), fvMeshSubset::interpolate(), and uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

bool movePoints ( )
virtual

Move points.

Implements MoveableMeshObject< polyMesh >.

Definition at line 105 of file pointMesh.C.

References Foam::endl(), pointBoundaryMesh::movePoints(), points, and Foam::Pout.

Referenced by pointMesh::thisDb().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh mpm)
virtual

Update the mesh corresponding to given map.

Implements UpdateableMeshObject< polyMesh >.

Definition at line 119 of file pointMesh.C.

References Foam::endl(), Foam::Pout, and pointBoundaryMesh::updateMesh().

Referenced by pointMesh::thisDb().

Here is the call graph for this function:

Here is the caller graph for this function:

bool operator!= ( const pointMesh pm) const
inline

Definition at line 135 of file pointMesh.H.

bool operator== ( const pointMesh pm) const
inline

Definition at line 140 of file pointMesh.H.


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