Public Member Functions | List of all members
searchableSurfaces Class Reference

Container for searchableSurfaces. More...

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

Public Member Functions

 ClassName ("searchableSurfaces")
 
 searchableSurfaces (const label)
 Construct with length specified. Fill later. More...
 
 searchableSurfaces (const IOobject &, const dictionary &, const bool singleRegionName)
 Construct from dictionary and whether to construct names always. More...
 
const wordListnames () const
 
wordListnames ()
 
const List< wordList > & regionNames () const
 
List< wordList > & regionNames ()
 
label findSurfaceID (const word &name) const
 Find index of surface. Return -1 if not found. More...
 
label findSurfaceRegionID (const word &surfaceName, const word &regionName) const
 
void findAnyIntersection (const pointField &start, const pointField &end, labelList &surfaces, List< pointIndexHit > &) const
 Find any intersection. Return hit point information and. More...
 
void findAllIntersections (const pointField &start, const pointField &end, labelListList &surfaces, List< List< pointIndexHit >> &) const
 Find all intersections in order from start to end. Returns for. More...
 
void findNearestIntersection (const pointField &start, const pointField &end, labelList &surface1, List< pointIndexHit > &hit1, labelList &surface2, List< pointIndexHit > &hit2) const
 
void findNearest (const pointField &, const scalarField &nearestDistSqr, labelList &surfaces, List< pointIndexHit > &) const
 Find nearest. Return -1 (and a miss()) or surface and nearest. More...
 
void findNearest (const pointField &samples, const scalarField &nearestDistSqr, const labelList &regionIndices, labelList &nearestSurfaces, List< pointIndexHit > &nearestInfo) const
 
boundBox bounds () const
 Calculate bounding box. More...
 
bool checkClosed (const bool report) const
 Are all surfaces closed and manifold. More...
 
bool checkNormalOrientation (const bool report) const
 Are all (triangulated) surfaces consistent normal orientation. More...
 
bool checkSizes (const scalar maxRatio, const bool report) const
 Are all bounding boxes of similar size. More...
 
bool checkIntersection (const scalar tol, const autoPtr< writer< scalar >> &, const bool report) const
 Do surfaces self-intersect or intersect others. More...
 
bool checkQuality (const scalar minQuality, const bool report) const
 Check triangle quality. More...
 
label checkTopology (const bool report) const
 All topological checks. Return number of failed checks. More...
 
label checkGeometry (const scalar maxRatio, const scalar tolerance, const autoPtr< writer< scalar >> &setWriter, const scalar minQuality, const bool report) const
 All geometric checks. Return number of failed checks. More...
 
void writeStats (const List< wordList > &, Ostream &) const
 Write some stats. More...
 
const searchableSurfaceoperator[] (const word &) const
 Return const reference to searchableSurface by name. More...
 
searchableSurfaceoperator[] (const word &)
 Return reference to searchableSurface by name. More...
 
- Public Member Functions inherited from PtrList< searchableSurface >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< searchableSurface > &)
 Copy constructor. More...
 
 PtrList (const PtrList< searchableSurface > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< searchableSurface >> &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< searchableSurface > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< searchableSurface > &)
 Construct as copy of SLPtrList<T> More...
 
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (searchableSurface *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< searchableSurface > &)
 
void append (const tmp< searchableSurface > &)
 
void transfer (PtrList< searchableSurface > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< searchableSurface > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< searchableSurfaceset (const label, searchableSurface *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< searchableSurfaceset (const label, const autoPtr< searchableSurface > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< searchableSurfaceset (const label, const tmp< searchableSurface > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< searchableSurface > &)
 Assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (const Xfer< UPtrList< T >> &)
 Construct by transferring the parameter contents. More...
 
 UPtrList (UPtrList< T > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
label size () const
 Return the number of elements in the UPtrList. More...
 
bool empty () const
 Return true if the UPtrList is empty (ie, size() is zero) More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void resize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void clear ()
 Clear the UPtrList, i.e. set size to zero. More...
 
void transfer (UPtrList< T > &)
 Transfer the contents of the argument UPtrList into this. More...
 
Xfer< UPtrList< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
Tset (const label, T *)
 Set element. Return old element (can be nullptr). More...
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
iterator begin ()
 Return an iterator to begin traversing the UPtrList. More...
 
iterator end ()
 Return an iterator to end traversing the UPtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the UPtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the UPtrList. More...
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the UPtrList contains. More...
 
typedef Treference
 Type that can be used for storing into UPtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant UPtrList::value_type. More...
 
- Protected Member Functions inherited from PtrList< searchableSurface >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

Container for searchableSurfaces.

Source files

Definition at line 53 of file searchableSurfaces.H.

Constructor & Destructor Documentation

◆ searchableSurfaces() [1/2]

searchableSurfaces ( const label  size)
explicit

Construct with length specified. Fill later.

Definition at line 69 of file searchableSurfaces.C.

◆ searchableSurfaces() [2/2]

searchableSurfaces ( const IOobject io,
const dictionary topDict,
const bool  singleRegionName 
)

Construct from dictionary and whether to construct names always.

as surfaceName "_" regionName (singleRegionName false) or for single region surfaces as surfaceName only (singleRegionName true)

Definition at line 170 of file searchableSurfaces.C.

References IOobject::clone(), dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::findIndex(), searchableSurfaces::findSurfaceID(), forAll, forAllConstIter(), dictionary::found(), dictionary::isDict(), dictionary::lookup(), IOobject::name(), searchableSurface::New(), searchableSurfaces::operator[](), dictionary::readIfPresent(), searchableSurface::regions(), PtrList< T >::setSize(), List< T >::setSize(), List< T >::size(), and dictionary::subDict().

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "searchableSurfaces"  )

◆ names() [1/2]

const wordList& names ( ) const
inline

◆ names() [2/2]

wordList& names ( )
inline

Definition at line 123 of file searchableSurfaces.H.

◆ regionNames() [1/2]

const List<wordList>& regionNames ( ) const
inline

Definition at line 128 of file searchableSurfaces.H.

◆ regionNames() [2/2]

List<wordList>& regionNames ( )
inline

◆ findSurfaceID()

Foam::label findSurfaceID ( const word name) const

Find index of surface. Return -1 if not found.

Definition at line 284 of file searchableSurfaces.C.

References Foam::findIndex(), and searchableSurfaces::findSurfaceRegionID().

Referenced by searchableSurfaces::findSurfaceRegionID(), searchableSurfaces::operator[](), searchableSurfaces::regionNames(), and searchableSurfaces::searchableSurfaces().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findSurfaceRegionID()

Foam::label findSurfaceRegionID ( const word surfaceName,
const word regionName 
) const

Definition at line 293 of file searchableSurfaces.C.

References searchableSurfaces::findAnyIntersection(), Foam::findIndex(), and searchableSurfaces::findSurfaceID().

Referenced by searchableSurfaces::findSurfaceID(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findAnyIntersection()

void findAnyIntersection ( const pointField start,
const pointField end,
labelList surfaces,
List< pointIndexHit > &  hitInfo 
) const

Find any intersection. Return hit point information and.

surface number. If multiple surfaces hit the first surface is returned, not necessarily the nearest (to start).

Definition at line 306 of file searchableSurfaces.C.

References searchableSurfaces::findAllIntersections(), and searchableSurfacesQueries::findAnyIntersection().

Referenced by searchableSurfaces::findSurfaceRegionID(), NamedEnum< directionType, 3 >::names(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findAllIntersections()

void findAllIntersections ( const pointField start,
const pointField end,
labelListList surfaces,
List< List< pointIndexHit >> &  hitInfo 
) const

Find all intersections in order from start to end. Returns for.

every hit the surface and the hit info.

Definition at line 326 of file searchableSurfaces.C.

References searchableSurfacesQueries::findAllIntersections(), and searchableSurfaces::findNearestIntersection().

Referenced by searchableSurfaces::findAnyIntersection(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findNearestIntersection()

void findNearestIntersection ( const pointField start,
const pointField end,
labelList surface1,
List< pointIndexHit > &  hit1,
labelList surface2,
List< pointIndexHit > &  hit2 
) const

Definition at line 347 of file searchableSurfaces.C.

References searchableSurfaces::findNearest(), and searchableSurfacesQueries::findNearestIntersection().

Referenced by searchableSurfaces::findAllIntersections(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findNearest() [1/2]

void findNearest ( const pointField samples,
const scalarField nearestDistSqr,
labelList surfaces,
List< pointIndexHit > &  nearestInfo 
) const

Find nearest. Return -1 (and a miss()) or surface and nearest.

point.

Definition at line 371 of file searchableSurfaces.C.

References searchableSurfacesQueries::findNearest().

Referenced by searchableSurfaces::findNearestIntersection(), NamedEnum< directionType, 3 >::names(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findNearest() [2/2]

void findNearest ( const pointField samples,
const scalarField nearestDistSqr,
const labelList regionIndices,
labelList nearestSurfaces,
List< pointIndexHit > &  nearestInfo 
) const

Definition at line 391 of file searchableSurfaces.C.

References searchableSurfacesQueries::findNearest().

Here is the call graph for this function:

◆ bounds()

Foam::boundBox bounds ( ) const

Calculate bounding box.

Definition at line 412 of file searchableSurfaces.C.

References searchableSurfacesQueries::bounds().

Referenced by searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkClosed()

bool checkClosed ( const bool  report) const

Are all surfaces closed and manifold.

Definition at line 422 of file searchableSurfaces.C.

References PrimitivePatch< Face, FaceList, PointField, PointType >::edgeFaces(), Foam::endl(), forAll, Foam::Info, searchableSurfaces::names(), Foam::nl, searchableSurfaces::operator[](), Foam::returnReduce(), and UPtrList< T >::size().

Referenced by searchableSurfaces::checkTopology(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkNormalOrientation()

bool checkNormalOrientation ( const bool  report) const

Are all (triangulated) surfaces consistent normal orientation.

Definition at line 489 of file searchableSurfaces.C.

References PatchTools::checkOrientation(), searchableSurfaces::checkSizes(), Foam::endl(), forAll, Foam::Info, PatchTools::markZones(), searchableSurfaces::names(), searchableSurfaces::operator[](), Foam::returnReduce(), and List< T >::size().

Referenced by searchableSurfaces::checkTopology(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkSizes()

bool checkSizes ( const scalar  maxRatio,
const bool  report 
) const

◆ checkIntersection()

bool checkIntersection ( const scalar  tol,
const autoPtr< writer< scalar >> &  setWriter,
const bool  report 
) const

◆ checkQuality()

bool checkQuality ( const scalar  minQuality,
const bool  report 
) const

◆ checkTopology()

Foam::label checkTopology ( const bool  report) const

All topological checks. Return number of failed checks.

Definition at line 791 of file searchableSurfaces.C.

References searchableSurfaces::checkClosed(), searchableSurfaces::checkGeometry(), and searchableSurfaces::checkNormalOrientation().

Referenced by searchableSurfaces::checkQuality(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkGeometry()

Foam::label checkGeometry ( const scalar  maxRatio,
const scalar  tolerance,
const autoPtr< writer< scalar >> &  setWriter,
const scalar  minQuality,
const bool  report 
) const

All geometric checks. Return number of failed checks.

Definition at line 811 of file searchableSurfaces.C.

References searchableSurfaces::checkIntersection(), searchableSurfaces::checkQuality(), searchableSurfaces::checkSizes(), and searchableSurfaces::writeStats().

Referenced by searchableSurfaces::checkTopology(), and searchableSurfaces::regionNames().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeStats()

void writeStats ( const List< wordList > &  patchTypes,
Ostream os 
) const

◆ operator[]() [1/2]

const Foam::searchableSurface & operator[] ( const word surfName) const

◆ operator[]() [2/2]

Foam::searchableSurface & operator[] ( const word surfName)

Return reference to searchableSurface by name.

Definition at line 905 of file searchableSurfaces.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, searchableSurfaces::findSurfaceID(), Foam::nl, and searchableSurfaces::operator[]().

Here is the call graph for this function:

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