searchableSurfaces Class Reference

Container for searchableSurfaces. More...

#include <meshTools/searchableSurfaces.H>

---

Detailed Description

Container for searchableSurfaces.

Source files

• src/meshTools/searchableSurface/searchableSurfaces.H
• src/meshTools/searchableSurface/searchableSurfaces.C

Definition at line 52 of file searchableSurfaces.H.

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 wordList &	names () const
wordList &	names ()
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.

---

Constructor & Destructor Documentation

searchableSurfaces

(

const label

size  )

[explicit]

Construct with length specified. Fill later.

Definition at line 44 of file searchableSurfaces.C.

searchableSurfaces	(	const IOobject &	io,
		const dictionary &	topDict
	)

Construct from dictionary.

Definition at line 148 of file searchableSurfaces.C.

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

---

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:

• src/meshTools/searchableSurface/searchableSurfaces.H
• src/meshTools/searchableSurface/searchableSurfaces.C