MeshObject wrapper around meshSearch(mesh). More...
Public Member Functions | |
| TypeName ("meshSearchMeshObject") | |
| meshSearchMeshObject (const polyMesh &mesh) | |
| Constructor given polyMesh. More... | |
| virtual | ~meshSearchMeshObject () |
| Destructor. More... | |
 Public Member Functions inherited from MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject > | |
| MeshObject (const polyMesh &mesh) | |
| MeshObject (const polyMesh &mesh, const IOobject &io) | |
| virtual | ~MeshObject () |
| const polyMesh & | mesh () const |
| virtual bool | writeData (Foam::Ostream &) const |
| Public Member Functions inherited from GeometricMeshObject< polyMesh > | |
| GeometricMeshObject (const word &typeName, const objectRegistry &obr) | |
| GeometricMeshObject (const word &typeName, const IOobject &io) | |
| Public Member Functions inherited from TopologicalMeshObject< polyMesh > | |
| TopologicalMeshObject (const word &typeName, const objectRegistry &obr) | |
| TopologicalMeshObject (const word &typeName, const IOobject &io) | |
| Public Member Functions inherited from meshObject | |
| ClassName ("meshObject") | |
| meshObject (const word &typeName, const objectRegistry &obr) | |
| meshObject (const word &typeName, const IOobject &io) | |
| 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 &) | |
| Copy constructor. More... | |
| regIOobject (const regIOobject &&) | |
| Move constructor. More... | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Copy constructor, transferring registry registration to copy. More... | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy constructor with new name, transferring registry registration. More... | |
| regIOobject (const IOobject &, const regIOobject &) | |
| Copy constructor with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| virtual bool | global () const |
| Return true if object is global, i.e. same for all processors. More... | |
| virtual bool | globalFile () const |
| Return true if object is global, i.e. same for all processors. More... | |
| const fileName & | caseName () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | checkIn () |
| Add object to registry. More... | |
| bool | checkOut () |
| Remove object from registry. More... | |
| void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | registered () const |
| Is this object registered with the 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... | |
| label & | eventNo () |
| 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... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool read=true) |
| 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... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. 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 bool write) const |
| Write using given format, version and compression. More... | |
| virtual bool | write (const bool write=true) 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 ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Construct from copy resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Construct from copy resetting name. More... | |
| IOobject (const IOobject &io)=default | |
| Copy constructor. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| virtual | ~IOobject () |
| Destructor. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| word & | headerClassName () |
| Return name of the class name read from header. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| const string & | note () 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 |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| word | modelName (const char *name) const |
| Return the name of the object within this model. More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName (const bool global) const |
| fileName & | instance () const |
| Return the instance directory, constant, system, <time> etc. More... | |
| void | updateInstance () const |
| If the instance is a time directory update to the current time. More... | |
| const fileName & | local () const |
| fileName | path (const bool global) const |
| Return complete path including the processor sub-directory. More... | |
| fileName | objectPath (const bool global) const |
| Return complete path + object name including the processor. More... | |
| fileName | relativePath () const |
| Return the path relative to the case directory. More... | |
| fileName | relativeObjectPath () const |
| Return complete relativePath + object name. More... | |
| fileName | filePath (const word &typeName, const bool global) const |
| Return complete path + object name if the file exists. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| bool | headerOk () |
| Read header of local object without type-checking. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. 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< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &) |
| template<class Name > | |
| Foam::word | groupName (Name name, const word &group) |
| template<class Name > | |
| Foam::word | modelName (Name name, const word &model) |
| Public Member Functions inherited from meshSearch | |
| ClassName ("meshSearch") | |
| meshSearch (const polyMesh &mesh, const polyMesh::cellDecomposition=polyMesh::CELL_TETS) | |
| Construct from components. Constructs bb slightly bigger than. More... | |
| meshSearch (const polyMesh &mesh, const treeBoundBox &bb, const polyMesh::cellDecomposition=polyMesh::CELL_TETS) | |
| Construct with a custom bounding box. Any mesh element outside. More... | |
| meshSearch (const meshSearch &)=delete | |
| Disallow default bitwise copy construction. More... | |
| ~meshSearch () | |
| Destructor. More... | |
| const polyMesh & | mesh () const |
| polyMesh::cellDecomposition | decompMode () const |
| const indexedOctree< treeDataFace > & | boundaryTree () const |
| Get (demand driven) reference to octree holding all. More... | |
| const indexedOctree< treeDataCell > & | cellTree () const |
| Get (demand driven) reference to octree holding all cells. More... | |
| label | findNearestCell (const point &location, const label seedCelli=-1, const bool useTreeSearch=true) const |
| Find nearest cell in terms of cell centre. More... | |
| label | findNearestFace (const point &location, const label seedFacei=-1, const bool useTreeSearch=true) const |
| label | findCell (const point &location, const label seedCelli=-1, const bool useTreeSearch=true) const |
| Find cell containing location. More... | |
| label | findNearestBoundaryFace (const point &location, const label seedFacei=-1, const bool useTreeSearch=true) const |
| Find nearest boundary face. More... | |
| pointIndexHit | intersection (const point &pStart, const point &pEnd) const |
| Find first intersection of boundary in segment [pStart, pEnd]. More... | |
| List< pointIndexHit > | intersections (const point &pStart, const point &pEnd) const |
| Find all intersections of boundary within segment pStart .. pEnd. More... | |
| bool | isInside (const point &) const |
| Determine inside/outside status. More... | |
| void | clearOut () |
| Delete all storage. More... | |
| void | correct () |
| Correct for mesh geom/topo changes. More... | |
| void | operator= (const meshSearch &)=delete |
| Disallow default bitwise assignment. More... | |
Additional Inherited Members | |
| 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... | |
| enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Static Public Member Functions inherited from MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject > | |
| static meshSearchMeshObject & | New (polyMesh &mesh) |
| static const meshSearchMeshObject & | New (const polyMesh &mesh) |
| static meshSearchMeshObject & | New (polyMesh &mesh, const Args &... args) |
| static const meshSearchMeshObject & | New (const polyMesh &mesh, const Args &... args) |
| static bool | Delete (const polyMesh &mesh) |
| static bool | found (const polyMesh &mesh) |
| Return true if this MeshObject is found in the mesh registry. More... | |
| Static Public Member Functions inherited from meshObject | |
| template<class Mesh > | |
| static void | movePoints (objectRegistry &) |
| template<class Mesh > | |
| static void | topoChange (objectRegistry &, const polyTopoChangeMap &) |
| template<class Mesh > | |
| static void | mapMesh (objectRegistry &, const polyMeshMap &) |
| template<class Mesh > | |
| static void | distribute (objectRegistry &, const polyDistributionMap &) |
| template<class Mesh > | |
| static void | addPatch (objectRegistry &, const label patchi) |
| template<class Mesh > | |
| static void | reorderPatches (objectRegistry &, const labelUList &newToOld, const bool validBoundary) |
| 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) |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| template<class Name > | |
| static word | modelName (Name name, const word &model) |
| Return the name of the object within the given model. More... | |
| 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 float | fileModificationSkew |
| Static Public Attributes inherited from IOobject | |
| static constexpr const char * | foamFile = "FoamFile" |
| Keyword for the FoamFile header sub-dictionary. More... | |
| static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| Static Public Attributes inherited from meshSearch | |
| static scalar | tol_ = 1e-3 |
| Tolerance on linear dimensions. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName) |
| Read header, check readOpt flags and read data if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType) |
| Read header using typeGlobalFile to find file. More... | |
| Protected Attributes inherited from MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject > | |
| const polyMesh & | mesh_ |
MeshObject wrapper around meshSearch(mesh).
Definition at line 48 of file meshSearchMeshObject.H.
|
explicit |
Constructor given polyMesh.
Definition at line 38 of file meshSearchMeshObject.C.
|
inlinevirtual |
Destructor.
Definition at line 66 of file meshSearchMeshObject.H.
| TypeName | ( | "meshSearchMeshObject" | ) |
1.8.13 
