Set of transformed searchableSurfaces. Does not do boolean operations so when meshing might find parts 'inside'. More...

Inheritance diagram for searchableSurfaceCollection:

[legend]

Collaboration diagram for searchableSurfaceCollection:

[legend]

Public Member Functions
	TypeName ("searchableSurfaceCollection")
	Runtime type information. More...

	searchableSurfaceCollection (const IOobject &io, const dictionary &dict)
	Construct from dictionary (used by searchableSurface) More...

virtual	~searchableSurfaceCollection ()
	Destructor. More...

const vectorField &	scale () const
	Scaling vector per subsurface. More...

vectorField &	scale ()
	Scaling vector per subsurface. More...

const PtrList< coordinateSystem > &	transform () const
	Coordinate system per subsurface. More...

PtrList< coordinateSystem > &	transform ()
	Coordinate system per subsurface. More...

virtual const wordList &	regions () const
	Names of regions. More...

virtual bool	hasVolumeType () const
	Whether supports volume type below. More...

virtual label	size () const
	Range of local indices that can be returned. More...

virtual tmp< pointField >	coordinates () const
	Get representative set of element coordinates. More...

virtual void	boundingSpheres (pointField &centres, scalarField &radiusSqr) const
	Get bounding spheres (centre and radius squared), one per element. More...

virtual tmp< pointField >	points () const
	Get the points that define the surface. More...

virtual bool	overlaps (const boundBox &bb) const
	Does any part of the surface overlap the supplied bound box? More...

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

virtual void	findLine (const pointField &start, const pointField &end, List< pointIndexHit > &) const
	Find first intersection on segment from start to end. More...

virtual void	findLineAny (const pointField &start, const pointField &end, List< pointIndexHit > &) const
	Return any intersection on segment from start to end. More...

virtual void	findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit > > &) const
	Get all intersections in order from start to end. More...

virtual void	getRegion (const List< pointIndexHit > &, labelList &region) const
	From a set of points and indices get the region. More...

virtual void	getNormal (const List< pointIndexHit > &, vectorField &normal) const
	From a set of points and indices get the normal. More...

virtual void	getVolumeType (const pointField &, List< volumeType > &) const
	Determine type (inside/outside/mixed) for point. unknown if. More...

virtual void	distribute (const List< treeBoundBox > &, const bool keepNonLocal, autoPtr< mapDistribute > &faceMap, autoPtr< mapDistribute > &pointMap)
	Set bounds of surface. Bounds currently set as list of. More...

virtual void	setField (const labelList &values)
	WIP. Store element-wise field. More...

virtual void	getField (const List< pointIndexHit > &, labelList &) const
	WIP. From a set of hits (points and. More...

bool	writeData (Ostream &) const
	Pure virtual writaData function. More...

Public Member Functions inherited from searchableSurface
	TypeName ("searchableSurface")
	Runtime type information. More...

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

	searchableSurface (const IOobject &io)

virtual autoPtr< searchableSurface >	clone () const
	Clone. More...

virtual	~searchableSurface ()
	Destructor. More...

const boundBox &	bounds () const
	Return const reference to boundBox. More...

boundBox &	bounds ()
	Return non-const access to the boundBox to allow it to be set. More...

virtual label	globalSize () const
	Range of global indices that can be returned. More...

virtual void	findNearest (const pointField &samples, const scalarField &nearestDistSqr, const labelList &regionIndices, List< pointIndexHit > &info) const
	Find the nearest locations for the supplied points to a. More...

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &, vectorField &normal, labelList &region) const
	Find nearest, normal and region. Can be overridden with. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Construct as copy. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

Istream &	readStream (const word &)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

label	watchIndex () const
	Return file-monitoring handle. More...

label &	watchIndex ()
	Return file-monitoring handle. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
	Write using given format, version and compression. More...

virtual bool	write () const
	Write using setting from DB. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...

Foam::autoPtr< IOobject >	clone () const
	Clone. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	Return complete path. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read and check header info. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Private Member Functions
void	findNearest (const pointField &samples, scalarField &minDistSqr, List< pointIndexHit > &nearestInfo, labelList &nearestSurf) const
	Find point nearest to sample. Updates minDistSqr. Sets nearestInfo. More...

void	sortHits (const List< pointIndexHit > &info, List< List< pointIndexHit > > &surfInfo, labelListList &infoMap) const
	Sort hits into per-surface bins. Misses are rejected. More...

	searchableSurfaceCollection (const searchableSurfaceCollection &)
	Disallow default bitwise copy construct. More...

void	operator= (const searchableSurfaceCollection &)
	Disallow default bitwise assignment. More...

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &) const=0
	Inherit findNearest from searchableSurface. More...

virtual void	findNearest (const pointField &samples, const scalarField &nearestDistSqr, const labelList &regionIndices, List< pointIndexHit > &info) const
	Inherit findNearest from searchableSurface. More...

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

Private Attributes
wordList	instance_
	Instance name. More...

vectorField	scale_
	Scaling vector. More...

PtrList< coordinateSystem >	transform_
	transformation More...

UPtrList< searchableSurface >	subGeom_

Switch	mergeSubRegions_

labelList	indexOffset_
	Offsets for indices coming from different surfaces. More...

wordList	regions_
	Region names. More...

labelList	regionOffset_
	From individual regions to collection regions. More...

Additional Inherited Members
Public Types inherited from regIOobject
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. More...

Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

Static Public Member Functions inherited from searchableSurface
static autoPtr< searchableSurface >	New (const word &surfaceType, const IOobject &io, const dictionary &dict)
	Return a reference to the selected searchableSurface. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

static void	replaceFileName (const word &from, const word &to)

Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

Protected Member Functions inherited from IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...

void	setBad (const string &)
	Set the object state to bad. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Set of transformed searchableSurfaces. Does not do boolean operations so when meshing might find parts 'inside'.

Source files

Definition at line 53 of file searchableSurfaceCollection.H.

Constructor & Destructor Documentation

◆ searchableSurfaceCollection() [1/2]

searchableSurfaceCollection ( const searchableSurfaceCollection & )

private

Disallow default bitwise copy construct.

◆ searchableSurfaceCollection() [2/2]

searchableSurfaceCollection	(	const IOobject &	io,
		const dictionary &	dict
	)

Construct from dictionary (used by searchableSurface)

Definition at line 175 of file searchableSurfaceCollection.C.

References Foam::cmptMultiply(), IOobject::db(), dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, forAllConstIter(), Foam::Info, dictionary::lookup(), objectRegistry::lookupObject(), boundBox::max(), Foam::max(), Vector< Cmpt >::min, boundBox::min(), Foam::min(), Foam::name(), Foam::compressible::New(), s(), and dictionary::subDict().

Here is the call graph for this function:

◆ ~searchableSurfaceCollection()

~searchableSurfaceCollection ( )

virtual

Destructor.

Definition at line 280 of file searchableSurfaceCollection.C.

Member Function Documentation

◆ findNearest() [1/5]

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

private

Find point nearest to sample. Updates minDistSqr. Sets nearestInfo.

and surface index

Definition at line 51 of file searchableSurfaceCollection.C.

References Foam::cmptDivide(), Foam::cmptMultiply(), forAll, Foam::magSqr(), samples(), and List::setSize().

Here is the call graph for this function:

◆ sortHits()

void sortHits	(	const List< pointIndexHit > &	info,
		List< List< pointIndexHit > > &	surfInfo,
		labelListList &	infoMap
	)		const

private

Sort hits into per-surface bins. Misses are rejected.

Maintains map back to position

Definition at line 119 of file searchableSurfaceCollection.C.

References Foam::findLower(), forAll, and List::setSize().

Here is the call graph for this function:

◆ operator=()

void operator= ( const searchableSurfaceCollection & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "searchableSurfaceCollection" )

Runtime type information.

◆ scale() [1/2]

const vectorField& scale ( ) const

inline

Scaling vector per subsurface.

Definition at line 140 of file searchableSurfaceCollection.H.

References searchableSurfaceCollection::scale_.

◆ scale() [2/2]

vectorField& scale ( )

inline

Scaling vector per subsurface.

Definition at line 146 of file searchableSurfaceCollection.H.

References searchableSurfaceCollection::scale_.

◆ transform() [1/2]

const PtrList<coordinateSystem>& transform ( ) const

inline

Coordinate system per subsurface.

Definition at line 152 of file searchableSurfaceCollection.H.

References searchableSurfaceCollection::transform_.

◆ transform() [2/2]

PtrList<coordinateSystem>& transform ( )

inline

Coordinate system per subsurface.

Definition at line 158 of file searchableSurfaceCollection.H.

References searchableSurfaceCollection::transform_.

◆ regions()

const Foam::wordList & regions ( ) const

virtual

Names of regions.

Implements searchableSurface.

Definition at line 286 of file searchableSurfaceCollection.C.

References DynamicList::append(), forAll, Foam::name(), List::setSize(), and DynamicList::shrink().

Here is the call graph for this function:

◆ hasVolumeType()

virtual bool hasVolumeType ( ) const

inlinevirtual

Whether supports volume type below.

Implements searchableSurface.

Definition at line 167 of file searchableSurfaceCollection.H.

◆ size()

Foam::label size ( ) const

virtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 318 of file searchableSurfaceCollection.C.

◆ coordinates()

Foam::tmp< Foam::pointField > coordinates ( ) const

virtual

Get representative set of element coordinates.

Usually the element centres (should be of length size()).

Implements searchableSurface.

Definition at line 325 of file searchableSurfaceCollection.C.

References Foam::cmptMultiply(), coordinates(), and forAll.

Here is the call graph for this function:

◆ boundingSpheres()

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

virtual

Get bounding spheres (centre and radius squared), one per element.

Any point on element is guaranteed to be inside.

Implements searchableSurface.

Definition at line 355 of file searchableSurfaceCollection.C.

References Foam::cmptMax(), Foam::cmptMultiply(), and forAll.

Here is the call graph for this function:

◆ points()

Foam::tmp< Foam::pointField > points ( ) const

virtual

Get the points that define the surface.

Implements searchableSurface.

Definition at line 392 of file searchableSurfaceCollection.C.

References Foam::cmptMultiply(), forAll, nPoints, and points.

Here is the call graph for this function:

◆ overlaps()

virtual bool overlaps ( const boundBox & bb ) const

inlinevirtual

Does any part of the surface overlap the supplied bound box?

Implements searchableSurface.

Definition at line 191 of file searchableSurfaceCollection.H.

References NotImplemented.

◆ findNearest() [2/5]

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

virtual

Implements searchableSurface.

Definition at line 430 of file searchableSurfaceCollection.C.

References samples().

Here is the call graph for this function:

◆ findLine()

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

virtual

Find first intersection on segment from start to end.

Note: searchableSurfacesQueries expects no intersection to be found if start==end. Is problem?

Implements searchableSurface.

Definition at line 451 of file searchableSurfaceCollection.C.

References Foam::abort(), Foam::cmptDivide(), Foam::cmptMultiply(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::mag(), n, s(), and List::setSize().

Here is the call graph for this function:

◆ findLineAny()

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

virtual

Return any intersection on segment from start to end.

Implements searchableSurface.

Definition at line 548 of file searchableSurfaceCollection.C.

◆ findLineAll()

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

virtual

Get all intersections in order from start to end.

Implements searchableSurface.

Definition at line 560 of file searchableSurfaceCollection.C.

References List::clear(), forAll, and List::setSize().

Here is the call graph for this function:

◆ getRegion()

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

virtual

From a set of points and indices get the region.

Implements searchableSurface.

Definition at line 587 of file searchableSurfaceCollection.C.

References forAll, List::setSize(), and List::size().

Here is the call graph for this function:

◆ getNormal()

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

virtual

From a set of points and indices get the normal.

Implements searchableSurface.

Definition at line 652 of file searchableSurfaceCollection.C.

References forAll, and List::size().

Here is the call graph for this function:

◆ getVolumeType()

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

virtual

Determine type (inside/outside/mixed) for point. unknown if.

cannot be determined (e.g. non-manifold surface)

Implements searchableSurface.

Definition at line 695 of file searchableSurfaceCollection.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ distribute()

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

virtual

Set bounds of surface. Bounds currently set as list of.

bounding boxes. The bounds are hints to the surface as for the range of queries it can expect. faceMap/pointMap can be set if the surface has done any redistribution.

Reimplemented from searchableSurface.

Definition at line 707 of file searchableSurfaceCollection.C.

References Foam::faceMap(), and forAll.

Here is the call graph for this function: