Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP. More...

Inheritance diagram for searchableSurface:

[legend]

Collaboration diagram for searchableSurface:

Classes
class	iNew

Public Member Functions
	TypeName ("searchableSurface")

	declareRunTimeSelectionTable (autoPtr, searchableSurface, dict,(const IOobject &io, const dictionary &dict),(io, dict))

	searchableSurface (const IOobject &io)

virtual autoPtr< searchableSurface >	clone () const

virtual	~searchableSurface ()=default

virtual bool	global () const

virtual fileName	filePath () const

virtual const boundBox &	bounds () const

virtual boundBox &	bounds ()

virtual const wordList &	regions () const =0

virtual bool	hasVolumeType () const

virtual volumeType	outsideVolumeType () const =0

virtual label	size () const =0

virtual label	globalSize () const

virtual tmp< pointField >	coordinates () const =0

virtual void	boundingSpheres (pointField &centres, scalarField &radiusSqr) const =0

virtual tmp< pointField >	points () const =0

virtual bool	overlaps (const boundBox &bb) const =0

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &) const =0

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

virtual void	findLine (const pointField &start, const pointField &end, List< pointIndexHit > &) const =0

virtual void	findLineAny (const pointField &start, const pointField &end, List< pointIndexHit > &) const =0

virtual void	findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit >> &) const =0

virtual void	getRegion (const List< pointIndexHit > &, labelList &region) const =0

virtual void	getNormal (const List< pointIndexHit > &, vectorField &normal) const =0

virtual void	getVolumeType (const pointField &, List< volumeType > &) const =0

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &, vectorField &normal, labelList &region) const

virtual void	distribute (const List< treeBoundBox > &, const bool keepNonLocal, autoPtr< mapDistribute > &faceMap, autoPtr< mapDistribute > &pointMap)

virtual void	setField (const labelList &values)

virtual void	getField (const List< pointIndexHit > &, labelList &values) const

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	readData (Istream &)

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	writeData (Ostream &) const =0

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

virtual bool	write (const bool valid=true) const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Static Public Member Functions
static autoPtr< searchableSurface >	New (const word &surfaceType, const IOobject &io, const dictionary &dict)

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &ptr)

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

template<class Type >
static Type &	store (tmp< Type > &ptr)

template<class Type >
static Type &	store (tmp< Type > &&ptr)

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

template<class StringType >
static word	groupName (StringType base, const word &group)

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP.

Information returned is usually a pointIndexHit:

bool : was intersection/nearest found?
point : intersection point or nearest point
index : unique index on surface (e.g. triangle for triSurfaceMesh)

Source files

Definition at line 65 of file searchableSurface.H.

Constructor & Destructor Documentation

◆ searchableSurface()

searchableSurface ( const IOobject & io )

Definition at line 61 of file searchableSurface.C.

◆ ~searchableSurface()

virtual ~searchableSurface ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "searchableSurface" )

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		searchableSurface	,
		dict	,
		(const IOobject &io, const dictionary &dict)	,
		(io, dict)
	)

◆ clone()

virtual autoPtr<searchableSurface> clone ( ) const

inlinevirtual

Definition at line 137 of file searchableSurface.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::searchableSurface > New	(	const word &	surfaceType,
		const IOobject &	io,
		const dictionary &	dict
	)

static

Definition at line 36 of file searchableSurface.C.

References dict, Foam::exit(), Foam::FatalIOError, and FatalIOErrorInLookup.

Referenced by searchableSurface::iNew::operator()(), searchableSurfaces::searchableSurfaces(), cyclicAMIPolyPatch::surfPtr(), and mappedPatchBase::surfPtr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ global()

virtual bool global ( ) const

inlinevirtual

Reimplemented from regIOobject.

Reimplemented in distributedTriSurfaceMesh, and triSurfaceMesh.

Definition at line 162 of file searchableSurface.H.

◆ filePath()

virtual fileName filePath ( ) const

inlinevirtual

Reimplemented from regIOobject.

Reimplemented in distributedTriSurfaceMesh, and triSurfaceMesh.

Definition at line 169 of file searchableSurface.H.

References IOobject::globalFilePath(), and Foam::type().

Here is the call graph for this function:

◆ bounds() [1/2]

virtual const boundBox& bounds ( ) const

inlinevirtual

Definition at line 175 of file searchableSurface.H.

Referenced by distributedTriSurfaceMesh::distributedTriSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), and triSurfaceTools::writeCloseness().

Here is the caller graph for this function:

◆ bounds() [2/2]

virtual boundBox& bounds ( )

inlinevirtual

Definition at line 181 of file searchableSurface.H.

◆ regions()

virtual const wordList& regions ( ) const

pure virtual

Implemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableCylinder, searchableSurfaceWithGaps, searchablePlate, searchableDisk, searchableRotatedBox, searchableBox, searchableExtrudedCircle, and searchablePlane.

Referenced by searchableSurfaceWithGaps::regions(), shellSurfaces::shellSurfaces(), and surfaceZonesInfo::surfaceZonesInfo().

Here is the caller graph for this function:

◆ hasVolumeType()

bool hasVolumeType ( ) const

virtual

Reimplemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableCylinder, searchableSurfaceWithGaps, searchablePlate, searchableDisk, searchableRotatedBox, searchableBox, searchableExtrudedCircle, searchablePlane, and closedTriSurfaceMesh.

Definition at line 69 of file searchableSurface.C.

Referenced by refinementSurfaces::findInside(), searchableSurfaceWithGaps::hasVolumeType(), and surfaceZonesInfo::surfaceZonesInfo().

Here is the caller graph for this function:

◆ outsideVolumeType()

virtual volumeType outsideVolumeType ( ) const

pure virtual

Implemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableCylinder, searchableSurfaceWithGaps, searchablePlate, searchableDisk, searchableRotatedBox, searchableBox, searchableExtrudedCircle, and searchablePlane.

Referenced by searchableSurfaceWithGaps::outsideVolumeType().

Here is the caller graph for this function:

◆ size()

virtual label size ( ) const

pure virtual

Implemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableCylinder, searchableSurfaceWithGaps, searchablePlate, searchableDisk, searchableRotatedBox, searchableBox, searchableExtrudedCircle, and searchablePlane.

Referenced by searchableSurface::globalSize(), and searchableSurfaceWithGaps::size().

Here is the caller graph for this function:

◆ globalSize()

virtual label globalSize ( ) const

inlinevirtual

Reimplemented in distributedTriSurfaceMesh.

Definition at line 201 of file searchableSurface.H.

References searchableSurface::size().

Referenced by refinementSurfaces::setMinLevelFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coordinates()

virtual tmp<pointField> coordinates ( ) const

pure virtual

Implemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableCylinder, searchableSurfaceWithGaps, searchablePlate, searchableDisk, searchableRotatedBox, searchableBox, searchableExtrudedCircle, and searchablePlane.

Referenced by searchableSurfaceWithGaps::coordinates().

Here is the caller graph for this function:

◆ boundingSpheres()

virtual void boundingSpheres	(	pointField &	centres,
		scalarField &	radiusSqr
	)		const

pure virtual

Implemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableRotatedBox, searchableBox, searchableExtrudedCircle, and searchablePlane.

Referenced by searchableSurfaceWithGaps::boundingSpheres(), and refinementSurfaces::setMinLevelFields().

Here is the caller graph for this function:

◆ points()

virtual tmp<pointField> points ( ) const

pure virtual

Implemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchablePlate, searchableDisk, searchableRotatedBox, searchableBox, searchableExtrudedCircle, and searchablePlane.

Referenced by searchablePlateFeatures::features(), and searchableSurfaceWithGaps::points().

Here is the caller graph for this function:

◆ overlaps()

virtual bool overlaps ( const boundBox & bb ) const

pure virtual

Implemented in searchableSphere, triSurfaceMesh, searchableCone, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchableDisk, searchablePlate, searchableRotatedBox, searchableBox, searchableExtrudedCircle, and searchablePlane.

Referenced by searchableSurfaceWithGaps::overlaps().

Here is the caller graph for this function:

◆ findNearest() [1/3]

virtual void findNearest	(	const pointField &	sample,
		const scalarField &	nearestDistSqr,
		List< pointIndexHit > &
	)		const

pure virtual

◆ findNearest() [2/3]

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

inlinevirtual

Reimplemented in distributedTriSurfaceMesh, and triSurfaceMesh.

Definition at line 291 of file searchableSurface.H.

References searchableSurface::findNearest(), IOobject::info(), and samples().

Here is the call graph for this function:

◆ findLine()

virtual void findLine	(	const pointField &	start,
		const pointField &	end,
		List< pointIndexHit > &
	)		const

pure virtual

Implemented in distributedTriSurfaceMesh, searchableSphere, triSurfaceMesh, searchableCone, searchableBox, searchableRotatedBox, searchableSurfaceWithGaps, searchableSurfaceCollection, searchableCylinder, searchableDisk, searchablePlate, searchableExtrudedCircle, and searchablePlane.

Referenced by refinementSurfaces::findNearestIntersection().

Here is the caller graph for this function:

◆ findLineAny()

virtual void findLineAny	(	const pointField &	start,
		const pointField &	end,
		List< pointIndexHit > &
	)		const

pure virtual

Implemented in distributedTriSurfaceMesh, searchableSphere, searchableCone, triSurfaceMesh, searchableBox, searchableRotatedBox, searchableSurfaceWithGaps, searchableSurfaceCollection, searchableCylinder, searchableDisk, searchablePlate, searchableExtrudedCircle, and searchablePlane.

Referenced by refinementSurfaces::findHigherIntersection().

Here is the caller graph for this function:

◆ findLineAll()

virtual void findLineAll	(	const pointField &	start,
		const pointField &	end,
		List< List< pointIndexHit >> &
	)		const

pure virtual

Implemented in distributedTriSurfaceMesh, searchableSphere, triSurfaceMesh, searchableCone, searchableBox, searchableRotatedBox, searchableSurfaceWithGaps, searchableSurfaceCollection, searchableCylinder, searchableDisk, searchablePlate, searchableExtrudedCircle, and searchablePlane.

Referenced by extendedEdgeMesh::cut(), and refinementSurfaces::findAllIntersections().

Here is the caller graph for this function:

◆ getRegion()

virtual void getRegion	(	const List< pointIndexHit > &	,
		labelList &	region
	)		const

pure virtual

Implemented in searchableSurfaceWithGaps, distributedTriSurfaceMesh, searchableSphere, triSurfaceMesh, searchableCone, searchableBox, searchableRotatedBox, searchableSurfaceCollection, searchableCylinder, searchableDisk, searchablePlate, searchableExtrudedCircle, and searchablePlane.

Referenced by refinementSurfaces::findAllIntersections(), refinementSurfaces::findHigherIntersection(), refinementSurfaces::findNearestIntersection(), searchableSurfaceWithGaps::getRegion(), and refinementSurfaces::setMinLevelFields().

Here is the caller graph for this function:

◆ getNormal()

virtual void getNormal	(	const List< pointIndexHit > &	,
		vectorField &	normal
	)		const

pure virtual

Implemented in searchableSurfaceWithGaps, searchableDisk, distributedTriSurfaceMesh, searchableSphere, triSurfaceMesh, searchableCone, searchableBox, searchableRotatedBox, searchableSurfaceCollection, searchableCylinder, searchablePlate, searchableExtrudedCircle, and searchablePlane.

Referenced by distanceSurface::createGeometry(), searchablePlateFeatures::features(), distanceSurface::filterFaceProximity(), refinementSurfaces::findAllIntersections(), refinementSurfaces::findNearestIntersection(), and searchableSurfaceWithGaps::getNormal().

Here is the caller graph for this function:

◆ getVolumeType()

virtual void getVolumeType	(	const pointField &	,
		List< volumeType > &
	)		const

pure virtual

Implemented in searchableSurfaceWithGaps, searchableSphere, triSurfaceMesh, searchableCone, searchableBox, searchableRotatedBox, searchableSurfaceCollection, searchableCylinder, searchableDisk, distributedTriSurfaceMesh, searchablePlate, searchableExtrudedCircle, and searchablePlane.

Referenced by refinementSurfaces::findInside(), searchableSurfaceWithGaps::getVolumeType(), and extendedEdgeMesh::select().

Here is the caller graph for this function:

◆ findNearest() [3/3]

void findNearest	(	const pointField &	sample,
		const scalarField &	nearestDistSqr,
		List< pointIndexHit > &	info,
		vectorField &	normal,
		labelList &	region
	)		const

virtual

Definition at line 76 of file searchableSurface.C.

◆ distribute()

virtual void distribute	(	const List< treeBoundBox > &	,
		const bool	keepNonLocal,
		autoPtr< mapDistribute > &	faceMap,
		autoPtr< mapDistribute > &	pointMap
	)

inlinevirtual

Reimplemented in distributedTriSurfaceMesh, and searchableSurfaceCollection.

Definition at line 368 of file searchableSurface.H.

◆ setField()

virtual void setField ( const labelList & values )

inlinevirtual

Reimplemented in triSurfaceMesh, searchableSurfaceWithGaps, and searchableSurfaceCollection.

Definition at line 377 of file searchableSurface.H.

◆ getField()

virtual void getField	(	const List< pointIndexHit > &	,
		labelList &	values
	)		const

inlinevirtual

Reimplemented in searchableSurfaceWithGaps, distributedTriSurfaceMesh, triSurfaceMesh, and searchableSurfaceCollection.

Definition at line 383 of file searchableSurface.H.

References List::clear(), and Foam::HashTableOps::values().

Referenced by searchableSurfaceWithGaps::getField().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ searchableSurface()

◆ ~searchableSurface()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ global()

◆ filePath()

◆ bounds() [1/2]

◆ bounds() [2/2]

◆ regions()

◆ hasVolumeType()

◆ outsideVolumeType()

◆ size()

◆ globalSize()

◆ coordinates()

◆ boundingSpheres()

◆ points()

◆ overlaps()

◆ findNearest() [1/3]

◆ findNearest() [2/3]

◆ findLine()

◆ findLineAny()

◆ findLineAll()

◆ getRegion()

◆ getNormal()

◆ getVolumeType()

◆ findNearest() [3/3]

◆ distribute()

◆ setField()

◆ getField()