FreeFOAM The Cross-Platform CFD Toolkit
pointMesh Class Reference

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

#include <OpenFOAM/pointMesh.H>


Detailed Description

Mesh representing a set of points created from polyMesh.

Definition at line 49 of file pointMesh.H.

+ Inheritance diagram for pointMesh:
+ Collaboration diagram for pointMesh:

List of all members.

Public Types

typedef pointMesh Mesh
typedef pointBoundaryMesh BoundaryMesh
- Public Types inherited from GeoMesh< polyMesh >

Public Member Functions

 pointMesh (const polyMesh &pMesh, bool alwaysConstructGlobalPatch=false)
 Construct from polyMesh.
label size () const
 Return number of points.
const pointBoundaryMeshboundary () const
 Return reference to boundary mesh.
const globalMeshDataglobalData () const
 Return parallel info.
const objectRegistrythisDb () const
 Return database. For now is its polyMesh.
void movePoints (const pointField &)
 Move points, returns volumes swept by faces in motion.
void updateMesh (const mapPolyMesh &mpm)
 Update the mesh corresponding to given map.
bool operator!= (const pointMesh &pm) const
bool operator== (const pointMesh &pm) const
- Public Member Functions inherited from MeshObject< polyMesh, pointMesh >
 MeshObject (const polyMesh &mesh)
virtual ~MeshObject ()
const polyMeshmesh () const
virtual bool writeData (Foam::Ostream &) const
 Pure virtual writaData function.
- 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 writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
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.
- Public Member Functions inherited from GeoMesh< polyMesh >
 GeoMesh (const polyMesh &mesh)
 Construct from MESH.
const polyMeshoperator() () const
 Return reference to polyMesh.

Static Public Member Functions

static label size (const Mesh &mesh)
 Return number of points.
- Static Public Member Functions inherited from MeshObject< polyMesh, 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 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.

Additional Inherited Members

- Protected Attributes inherited from MeshObject< polyMesh, pointMesh >
const polyMeshmesh_
- Protected Attributes inherited from GeoMesh< polyMesh >
const polyMeshmesh_
 Reference to Mesh.

Member Typedef Documentation

typedef pointMesh Mesh

Reimplemented from GeoMesh< polyMesh >.

Definition at line 74 of file pointMesh.H.

Reimplemented from GeoMesh< polyMesh >.

Definition at line 75 of file pointMesh.H.


Constructor & Destructor Documentation

pointMesh ( const polyMesh pMesh,
bool  alwaysConstructGlobalPatch = false 
)
explicit

Construct from polyMesh.

Definition at line 59 of file pointMesh.C.


Member Function Documentation

label size ( ) const
inline

Return number of points.

Definition at line 91 of file pointMesh.H.

Referenced by pointMapper::pointMapper().

static label size ( const Mesh mesh)
inlinestatic

Return number of points.

Definition at line 97 of file pointMesh.H.

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

const globalMeshData& globalData ( ) const
inline

Return parallel info.

Definition at line 109 of file pointMesh.H.

Referenced by globalPointPatch::globalPointSize(), globalPointPatch::meshPoints(), and globalPointPatch::sharedPointAddr().

const objectRegistry& thisDb ( ) const
inline

Return database. For now is its polyMesh.

Reimplemented from GeoMesh< polyMesh >.

Definition at line 115 of file pointMesh.H.

References GeoMesh< MESH >::thisDb().

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

void movePoints ( const pointField newPoints)

Move points, returns volumes swept by faces in motion.

Definition at line 93 of file pointMesh.C.

Referenced by polyMesh::movePoints().

void updateMesh ( const mapPolyMesh mpm)

Update the mesh corresponding to given map.

Definition at line 99 of file pointMesh.C.

Referenced by polyMesh::updateMesh().

bool operator!= ( const pointMesh pm) const
inline

Definition at line 132 of file pointMesh.H.

bool operator== ( const pointMesh pm) const
inline

Definition at line 137 of file pointMesh.H.


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