Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP. More...
Data Structures | |
class | iNew |
Class used for the read-construction of. More... | |
Public Member Functions | |
TypeName ("searchableSurface") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, searchableSurface, dict,(const IOobject &io, const dictionary &dict),(io, dict)) | |
searchableSurface (const IOobject &io) | |
virtual autoPtr< searchableSurface > | clone () const |
Clone. More... | |
virtual | ~searchableSurface () |
Destructor. More... | |
const boundBox & | bounds () const |
Return const reference to boundBox. More... | |
boundBox & | bounds () |
Return non-const access to the boundBox to allow it to be set. More... | |
virtual const wordList & | regions () const =0 |
Names of regions. More... | |
virtual bool | hasVolumeType () const =0 |
Whether supports volume type below. More... | |
virtual label | size () const =0 |
Range of local indices that can be returned. More... | |
virtual label | globalSize () const |
Range of global indices that can be returned. More... | |
virtual tmp< pointField > | coordinates () const =0 |
Get representative set of element coordinates. More... | |
virtual void | boundingSpheres (pointField ¢res, scalarField &radiusSqr) const =0 |
Get bounding spheres (centre and radius squared), one per element. More... | |
virtual tmp< pointField > | points () const =0 |
Get the points that define the surface. More... | |
virtual bool | overlaps (const boundBox &bb) const =0 |
Does any part of the surface overlap the supplied bound box? More... | |
virtual void | findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &) const =0 |
virtual void | findNearest (const pointField &samples, const scalarField &nearestDistSqr, const labelList ®ionIndices, List< pointIndexHit > &info) const |
Find the nearest locations for the supplied points to a. More... | |
virtual void | findLine (const pointField &start, const pointField &end, List< pointIndexHit > &) const =0 |
Find first intersection on segment from start to end. More... | |
virtual void | findLineAny (const pointField &start, const pointField &end, List< pointIndexHit > &) const =0 |
Return any intersection on segment from start to end. More... | |
virtual void | findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit > > &) const =0 |
Get all intersections in order from start to end. More... | |
virtual void | getRegion (const List< pointIndexHit > &, labelList ®ion) const =0 |
From a set of points and indices get the region. More... | |
virtual void | getNormal (const List< pointIndexHit > &, vectorField &normal) const =0 |
From a set of points and indices get the normal. More... | |
virtual void | getVolumeType (const pointField &, List< volumeType > &) const =0 |
Determine type (inside/outside) for point. unknown if. More... | |
virtual void | findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &, vectorField &normal, labelList ®ion) const |
Find nearest, normal and region. Can be overridden with. More... | |
virtual void | distribute (const List< treeBoundBox > &, const bool keepNonLocal, autoPtr< mapDistribute > &faceMap, autoPtr< mapDistribute > &pointMap) |
Set bounds of surface. Bounds currently set as list of. More... | |
virtual void | setField (const labelList &values) |
WIP. Store element-wise field. More... | |
virtual void | getField (const List< pointIndexHit > &, labelList &values) const |
WIP. From a set of hits (points and. More... | |
![]() | |
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... | |
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... | |
Istream & | readStream (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... | |
label & | watchIndex () |
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 | writeData (Ostream &) const =0 |
Pure virtual writaData function. 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 &) |
![]() | |
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 word &name) | |
Construct as copy resetting name. More... | |
Foam::autoPtr< IOobject > | clone () const |
Clone. 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... | |
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... | |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () 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< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
Static Public Member Functions | |
static autoPtr< searchableSurface > | New (const word &surfaceType, const IOobject &io, const dictionary &dict) |
Return a reference to the selected searchableSurface. More... | |
![]() | |
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 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 void | replaceFileName (const word &from, const word &to) |
Private Member Functions | |
searchableSurface (const searchableSurface &) | |
Disallow default bitwise copy construct. More... | |
void | operator= (const searchableSurface &) |
Disallow default bitwise assignment. More... | |
Private Attributes | |
const word | name_ |
boundBox | bounds_ |
Additional Inherited Members | |
![]() | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Types of communications. More... | |
![]() | |
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 const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static int | fileModificationSkew |
static fileCheckTypes | fileModificationChecking |
![]() | |
Istream * | objectStream () |
Construct and return an IFstream for the object. More... | |
Istream * | objectStream (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 bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP.
Information returned is usually a pointIndexHit:
Definition at line 66 of file searchableSurface.H.
|
private |
Disallow default bitwise copy construct.
searchableSurface | ( | const IOobject & | io | ) |
Definition at line 65 of file searchableSurface.C.
|
virtual |
Destructor.
Definition at line 73 of file searchableSurface.C.
|
private |
Disallow default bitwise assignment.
TypeName | ( | "searchableSurface" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
searchableSurface | , | ||
dict | , | ||
(const IOobject &io, const dictionary &dict) | , | ||
(io, dict) | |||
) |
|
inlinevirtual |
|
static |
Return a reference to the selected searchableSurface.
Definition at line 40 of file searchableSurface.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.
Referenced by searchableSurface::iNew::operator()(), searchableSurfaces::searchableSurfaces(), regionCoupledBase::surfPtr(), cyclicAMIPolyPatch::surfPtr(), and mappedPatchBase::surfPtr().
|
inline |
Return const reference to boundBox.
Definition at line 162 of file searchableSurface.H.
References searchableSurface::bounds_.
Referenced by distributedTriSurfaceMesh::distributedTriSurfaceMesh(), main(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), and triSurfaceMesh::triSurfaceMesh().
|
inline |
Return non-const access to the boundBox to allow it to be set.
Definition at line 168 of file searchableSurface.H.
References searchableSurface::bounds_.
|
pure virtual |
Names of regions.
Implemented in searchableCone, triSurfaceMesh, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableSphere, searchableBox, searchableRotatedBox, and searchablePlane.
Referenced by searchableSurfaceWithGaps::regions().
|
pure virtual |
Whether supports volume type below.
Implemented in distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableSphere, searchableBox, searchableRotatedBox, searchablePlane, and closedTriSurfaceMesh.
Referenced by searchableSurfaceWithGaps::hasVolumeType(), and shellSurfaces::setAndCheckLevels().
|
pure virtual |
Range of local indices that can be returned.
Implemented in searchableCone, triSurfaceMesh, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableSphere, searchableBox, searchableRotatedBox, and searchablePlane.
Referenced by searchableSurface::globalSize(), and searchableSurfaceWithGaps::size().
|
inlinevirtual |
Range of global indices that can be returned.
Reimplemented in distributedTriSurfaceMesh.
Definition at line 183 of file searchableSurface.H.
References searchableSurface::size().
Referenced by refinementSurfaces::setMinLevelFields().
|
pure virtual |
Get representative set of element coordinates.
Usually the element centres (should be of length size()).
Implemented in searchableCone, triSurfaceMesh, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableSphere, searchableBox, searchableRotatedBox, and searchablePlane.
|
pure virtual |
Get bounding spheres (centre and radius squared), one per element.
Any point on element is guaranteed to be inside.
Implemented in searchableCone, triSurfaceMesh, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableSphere, searchableBox, searchablePlane, and searchableRotatedBox.
Referenced by searchableSurfaceWithGaps::boundingSpheres(), meshRefinement::markSmallFeatureRefinement(), and refinementSurfaces::setMinLevelFields().
|
pure virtual |
Get the points that define the surface.
Implemented in searchableCone, triSurfaceMesh, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableSphere, searchableBox, searchablePlane, and searchableRotatedBox.
Referenced by searchableSurfaceWithGaps::points().
|
pure virtual |
Does any part of the surface overlap the supplied bound box?
Implemented in searchableCone, triSurfaceMesh, searchableSurfaceWithGaps, searchableSurfaceCollection, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, searchablePlane, searchableBox, and searchableRotatedBox.
|
pure virtual |
Implemented in searchableSurfaceWithGaps, distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableBox, searchableSurfaceCollection, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.
Referenced by searchableSurfaceWithGaps::findNearest(), searchableSurface::findNearest(), meshRefinement::markSmallFeatureRefinement(), AMIInterpolation< SourcePatch, TargetPatch >::projectPointsToSurface(), refinementSurfaces::setMinLevelFields(), and searchableSurfacesQueries::tempFindNearest().
|
inlinevirtual |
Find the nearest locations for the supplied points to a.
particular region in the searchable surface.
Reimplemented in triSurfaceMesh.
Definition at line 273 of file searchableSurface.H.
References searchableSurface::findNearest(), IOobject::info(), and samples().
|
pure virtual |
Find first intersection on segment from start to end.
Note: searchableSurfacesQueries expects no intersection to be found if start==end. Is problem?
Implemented in distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableSurfaceWithGaps, searchableBox, searchableSurfaceCollection, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.
Referenced by refinementSurfaces::findNearestIntersection().
|
pure virtual |
Return any intersection on segment from start to end.
Implemented in distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableSurfaceWithGaps, searchableBox, searchableSurfaceCollection, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.
Referenced by refinementSurfaces::findHigherIntersection().
|
pure virtual |
Get all intersections in order from start to end.
Implemented in distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableSurfaceWithGaps, searchableBox, searchableSurfaceCollection, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.
Referenced by extendedEdgeMesh::cut().
|
pure virtual |
From a set of points and indices get the region.
Implemented in searchableSurfaceWithGaps, distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableBox, searchableSurfaceCollection, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.
Referenced by refinementSurfaces::findHigherIntersection(), refinementSurfaces::findNearestIntersection(), searchableSurfaceWithGaps::getRegion(), meshRefinement::markSmallFeatureRefinement(), and refinementSurfaces::setMinLevelFields().
|
pure virtual |
From a set of points and indices get the normal.
Implemented in searchableSurfaceWithGaps, distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableBox, searchableSurfaceCollection, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.
Referenced by refinementSurfaces::findNearestIntersection(), searchableSurfaceWithGaps::getNormal(), and meshRefinement::markSmallFeatureRefinement().
|
pure virtual |
Determine type (inside/outside) for point. unknown if.
cannot be determined (e.g. non-manifold surface)
Implemented in searchableSurfaceWithGaps, distributedTriSurfaceMesh, searchableCone, triSurfaceMesh, searchableBox, searchableSurfaceCollection, searchableRotatedBox, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.
Referenced by searchableSurfaceWithGaps::getVolumeType(), and extendedEdgeMesh::select().
|
virtual |
Find nearest, normal and region. Can be overridden with.
optimised implementation
Definition at line 80 of file searchableSurface.C.
|
inlinevirtual |
Set bounds of surface. Bounds currently set as list of.
bounding boxes. The bounds are hints to the surface as for the range of queries it can expect. faceMap/pointMap can be set if the surface has done any redistribution.
Reimplemented in distributedTriSurfaceMesh, and searchableSurfaceCollection.
Definition at line 350 of file searchableSurface.H.
|
inlinevirtual |
WIP. Store element-wise field.
Reimplemented in searchableSurfaceWithGaps, triSurfaceMesh, and searchableSurfaceCollection.
Definition at line 359 of file searchableSurface.H.
|
inlinevirtual |
WIP. From a set of hits (points and.
indices) get the specified field. Misses do not get set. Return empty field if not supported.
Reimplemented in searchableSurfaceWithGaps, distributedTriSurfaceMesh, triSurfaceMesh, and searchableSurfaceCollection.
Definition at line 365 of file searchableSurface.H.
Referenced by refinementSurfaces::findHigherLevel(), and searchableSurfaceWithGaps::getField().
|
private |
Definition at line 72 of file searchableSurface.H.
|
private |
Definition at line 74 of file searchableSurface.H.
Referenced by searchableSurface::bounds().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.