FreeFOAM The Cross-Platform CFD Toolkit
searchableSurfaces Class Reference

Container for searchableSurfaces. More...

#include <meshTools/searchableSurfaces.H>


Detailed Description

+ Inheritance diagram for searchableSurfaces:
+ Collaboration diagram for searchableSurfaces:

List of all members.

Public Member Functions

 ClassName ("searchableSurfaces")
 searchableSurfaces (const label)
 Construct with length specified. Fill later.
 searchableSurfaces (const IOobject &, const dictionary &)
 Construct from dictionary.
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.
void findAnyIntersection (const pointField &start, const pointField &end, labelList &surfaces, List< pointIndexHit > &) const
 Find any intersection. Return hit point information and.
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.
void findNearest (const pointField &, const scalarField &nearestDistSqr, labelList &surfaces, List< pointIndexHit > &) const
 Find nearest. Return -1 (and a miss()) or surface and nearest.
pointIndexHit facesIntersection (const scalar initialDistSqr, const scalar convergenceDistSqr, const point &start) const
 Calculate point which is on a set of surfaces.
- Public Member Functions inherited from PtrList< searchableSurface >
 PtrList ()
 Null Constructor.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< searchableSurface > &)
 Copy constructor.
 PtrList (const PtrList< searchableSurface > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< searchableSurface > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< searchableSurface > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< searchableSurface > &)
 Construct as copy of SLPtrList<T>
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class.
 ~PtrList ()
label size () const
 Return the number of elements in the PtrList.
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero).
void setSize (const label)
 Reset size of PtrList. This can only be used to set the size.
void resize (const label)
 Reset size of PtrList. This can only be used to set the size.
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the.
void transfer (PtrList< searchableSurface > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList
< searchableSurface > > 
xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr< searchableSurfaceset (const label, searchableSurface *)
 Set element. Return old element (can be NULL).
autoPtr< searchableSurfaceset (const label, const autoPtr< searchableSurface > &)
autoPtr< searchableSurfaceset (const label, const tmp< searchableSurface > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const searchableSurfaceoperator[] (const label) const
 Return element const reference.
searchableSurfaceoperator[] (const label)
 Return element reference.
const searchableSurfaceoperator() (const label) const
 Return element const pointer.
PtrList< searchableSurface > & operator= (const PtrList< searchableSurface > &)
 Assignment.
iterator begin ()
 Return an iterator to begin traversing the PtrList.
iterator end ()
 Return an iterator to end traversing the PtrList.

Additional Inherited Members

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

Constructor & Destructor Documentation

searchableSurfaces ( const label  size)
explicit

Construct with length specified. Fill later.

Definition at line 44 of file searchableSurfaces.C.


Member Function Documentation

ClassName ( "searchableSurfaces"  )
const wordList& names ( ) const
inline

Definition at line 99 of file searchableSurfaces.H.

Referenced by refinementSurfaces::refinementSurfaces().

wordList& names ( )
inline

Definition at line 103 of file searchableSurfaces.H.

const List<wordList>& regionNames ( ) const
inline

Definition at line 108 of file searchableSurfaces.H.

List<wordList>& regionNames ( )
inline

Definition at line 112 of file searchableSurfaces.H.

Foam::label findSurfaceID ( const word name) const

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

Definition at line 259 of file searchableSurfaces.C.

References Foam::findIndex().

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 268 of file searchableSurfaces.C.

References searchableSurfacesQueries::findAnyIntersection().

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 289 of file searchableSurfaces.C.

References searchableSurfacesQueries::findAllIntersections().

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 310 of file searchableSurfaces.C.

References searchableSurfacesQueries::findNearest().

Foam::pointIndexHit facesIntersection ( const scalar  initialDistSqr,
const scalar  convergenceDistSqr,
const point start 
) const

Calculate point which is on a set of surfaces.

Definition at line 331 of file searchableSurfaces.C.

References searchableSurfacesQueries::facesIntersection().


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