Foam::searchableSurfaces Namespace Reference

Classes

class  box
 Surface geometry with a rectangular box shape, aligned with the coordinate axes, which can be used with snappyHexMesh. More...
 
class  closedTriSurface
 Like triSurface, a surface geometry formed of discrete facets, e.g. \ triangles and/or quadrilaterals, defined in a file using formats such as Wavefront OBJ, or stereolithography STL. A closedTriSurface is a geometry surface which is meant to be closed but contains some imperfections, e.g. small holes or multiple parts, which mean it is not strictly closed. More...
 
class  collection
 Makes a collection of surface geometries by copying from an existing defined surface geometry. There are no boolean operations, e.g. overlapping surfaces are not intersected. More...
 
class  cylinder
 Surface geometry with a cylinder shape, which can be used with snappyHexMesh. More...
 
class  disk
 Surface geometry with a circular disk shape, which can be used with snappyHexMesh. More...
 
class  extrudedCircle
 Surface geometry with a tube shape, which can be used with snappyHexMesh. The geometry is formed from a line geometry, described by the edgeMesh (.eMesh) file format, to which a radius is applied to form a tube. More...
 
class  plane
 Surface geometry of an infinite plane, which can be used with snappyHexMesh. More...
 
class  plate
 Surface geometry of a finite plane, aligned with the coordinate axes, which can be used with snappyHexMesh. More...
 
class  sphere
 Surface geometry with a sphere shape, which can be used with snappyHexMesh. More...
 
class  triSurface
 A surface geometry formed of discrete facets, e.g. triangles and/or quadrilaterals, defined in a file using formats such as Wavefront OBJ, or stereolithography STL. More...
 
class  withGaps
 
class  distributedTriSurface
 IOoject and searching on distributed triSurface. All processor hold (possibly overlapping) part of the overall surface. All queries are distributed to the processor that can answer it and the result sent back. More...
 

Functions

 defineTypeNameAndDebug (box, 0)
 
 addToRunTimeSelectionTable (searchableSurface, box, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, box, dictionary, searchableBox, "searchableBox")
 
 defineTypeNameAndDebug (closedTriSurface, 0)
 
 addToRunTimeSelectionTable (searchableSurface, closedTriSurface, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, closedTriSurface, dictionary, closedTriSurfaceMesh, "closedTriSurfaceMesh")
 
 defineTypeNameAndDebug (collection, 0)
 
 addToRunTimeSelectionTable (searchableSurface, collection, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, collection, dictionary, searchableSurfaceCollection, "searchableSurfaceCollection")
 
 defineTypeNameAndDebug (cylinder, 0)
 
 addToRunTimeSelectionTable (searchableSurface, cylinder, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, cylinder, dictionary, searchableCylinder, "searchableCylinder")
 
 defineTypeNameAndDebug (disk, 0)
 
 addToRunTimeSelectionTable (searchableSurface, disk, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, disk, dictionary, searchableDisk, "searchableDisk")
 
 defineTypeNameAndDebug (extrudedCircle, 0)
 
 addToRunTimeSelectionTable (searchableSurface, extrudedCircle, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, extrudedCircle, dictionary, searchableExtrudedCircle, "searchableExtrudedCircle")
 
 defineTypeNameAndDebug (plane, 0)
 
 addToRunTimeSelectionTable (searchableSurface, plane, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, plane, dictionary, searchablePlane, "searchablePlane")
 
 defineTypeNameAndDebug (plate, 0)
 
 addToRunTimeSelectionTable (searchableSurface, plate, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, plate, dictionary, searchablePlate, "searchablePlate")
 
 defineTypeNameAndDebug (sphere, 0)
 
 addToRunTimeSelectionTable (searchableSurface, sphere, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, sphere, dictionary, searchableSphere, "searchableSphere")
 
 defineTypeNameAndDebug (triSurface, 0)
 
 addToRunTimeSelectionTable (searchableSurface, triSurface, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, triSurface, dictionary, triSurfaceMesh, "triSurfaceMesh")
 
 defineTypeNameAndDebug (withGaps, 0)
 
 addToRunTimeSelectionTable (searchableSurface, withGaps, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, withGaps, dictionary, searchableSurfaceWithGaps, "searchableSurfaceWithGaps")
 
 defineTypeNameAndDebug (distributedTriSurface, 0)
 
 addToRunTimeSelectionTable (searchableSurface, distributedTriSurface, dictionary)
 
 addBackwardCompatibleToRunTimeSelectionTable (searchableSurface, distributedTriSurface, dictionary, distributedTriSurfaceMesh, "distributedTriSurfaceMesh")
 

Function Documentation

◆ defineTypeNameAndDebug() [1/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( box  ,
 
)

◆ addToRunTimeSelectionTable() [1/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
box  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [1/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
box  ,
dictionary  ,
searchableBox  ,
"searchableBox"   
)

◆ defineTypeNameAndDebug() [2/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( closedTriSurface  ,
 
)

◆ addToRunTimeSelectionTable() [2/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
closedTriSurface  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [2/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
closedTriSurface  ,
dictionary  ,
closedTriSurfaceMesh  ,
"closedTriSurfaceMesh"   
)

◆ defineTypeNameAndDebug() [3/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( collection  ,
 
)

◆ addToRunTimeSelectionTable() [3/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
collection  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [3/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
collection  ,
dictionary  ,
searchableSurfaceCollection  ,
"searchableSurfaceCollection"   
)

◆ defineTypeNameAndDebug() [4/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( cylinder  ,
 
)

◆ addToRunTimeSelectionTable() [4/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
cylinder  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [4/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
cylinder  ,
dictionary  ,
searchableCylinder  ,
"searchableCylinder"   
)

◆ defineTypeNameAndDebug() [5/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( disk  ,
 
)

◆ addToRunTimeSelectionTable() [5/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
disk  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [5/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
disk  ,
dictionary  ,
searchableDisk  ,
"searchableDisk"   
)

◆ defineTypeNameAndDebug() [6/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( extrudedCircle  ,
 
)

◆ addToRunTimeSelectionTable() [6/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
extrudedCircle  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [6/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
extrudedCircle  ,
dictionary  ,
searchableExtrudedCircle  ,
"searchableExtrudedCircle"   
)

◆ defineTypeNameAndDebug() [7/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( plane  ,
 
)

◆ addToRunTimeSelectionTable() [7/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
plane  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [7/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
plane  ,
dictionary  ,
searchablePlane  ,
"searchablePlane"   
)

◆ defineTypeNameAndDebug() [8/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( plate  ,
 
)

◆ addToRunTimeSelectionTable() [8/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
plate  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [8/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
plate  ,
dictionary  ,
searchablePlate  ,
"searchablePlate"   
)

◆ defineTypeNameAndDebug() [9/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( sphere  ,
 
)

◆ addToRunTimeSelectionTable() [9/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
sphere  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [9/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
sphere  ,
dictionary  ,
searchableSphere  ,
"searchableSphere"   
)

◆ defineTypeNameAndDebug() [10/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( triSurface  ,
 
)

◆ addToRunTimeSelectionTable() [10/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
triSurface  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [10/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
triSurface  ,
dictionary  ,
triSurfaceMesh  ,
"triSurfaceMesh"   
)

◆ defineTypeNameAndDebug() [11/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( withGaps  ,
 
)

◆ addToRunTimeSelectionTable() [11/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
withGaps  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [11/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
withGaps  ,
dictionary  ,
searchableSurfaceWithGaps  ,
"searchableSurfaceWithGaps"   
)

◆ defineTypeNameAndDebug() [12/12]

Foam::searchableSurfaces::defineTypeNameAndDebug ( distributedTriSurface  ,
 
)

◆ addToRunTimeSelectionTable() [12/12]

Foam::searchableSurfaces::addToRunTimeSelectionTable ( searchableSurface  ,
distributedTriSurface  ,
dictionary   
)

◆ addBackwardCompatibleToRunTimeSelectionTable() [12/12]

Foam::searchableSurfaces::addBackwardCompatibleToRunTimeSelectionTable ( searchableSurface  ,
distributedTriSurface  ,
dictionary  ,
distributedTriSurfaceMesh  ,
"distributedTriSurfaceMesh"   
)