Container for searchableSurfaces. The collection is specified as a dictionary. For example,. More...

Inheritance diagram for searchableSurfaces:

Collaboration diagram for searchableSurfaces:

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. More...

const wordList &	names () const
	Surface names, not region names. More...

wordList &	names ()
	Surface names, not region names. More...

const List< wordList > &	regionNames () const
	Region names per surface. More...

List< wordList > &	regionNames ()
	Region names per surface. More...

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 labelListList &regionIndices, const pointField &samples, const scalarField &nearestDistSqr, 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 searchableSurface &	operator[] (const word &) const
	Return const reference to searchableSurface by name. More...

searchableSurface &	operator[] (const word &)
	Return reference to searchableSurface by name. More...

Public Member Functions inherited from PtrList< searchableSurface >
constexpr	PtrList () noexcept
	Default construct. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< searchableSurface > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< searchableSurface > &&list)
	Move construct. More...

	PtrList (UList< searchableSurface * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< searchableSurface > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< searchableSurface > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< searchableSurface > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...

	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &is)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

PtrList< searchableSurface >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

Foam::PtrList< searchableSurface >	clone (Args &&... args) const

const searchableSurface *	set (const label i) const
	Return const pointer to element (can be nullptr),. More...

autoPtr< searchableSurface >	set (const label i, searchableSurface *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< searchableSurface >	set (const label i, autoPtr< searchableSurface > &ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< searchableSurface >	set (const label i, autoPtr< searchableSurface > &&ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< searchableSurface >	set (const label i, std::unique_ptr< searchableSurface > &&ptr)
	Set element to given unique_ptr and return old element. More...

autoPtr< searchableSurface >	set (const label i, const refPtr< searchableSurface > &ptr)
	Set element to given refPtr and return old element. More...

autoPtr< searchableSurface >	set (const label i, const tmp< searchableSurface > &ptr)
	Set element to given tmp and return old element. More...

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

void	setSize (const label newLen)
	Same as resize() More...

void	emplace_append (Args &&... args)
	Construct and append an element to the end of the list. More...

void	append (searchableSurface *ptr)
	Append an element to the end of the list. More...

void	append (autoPtr< searchableSurface > &ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< searchableSurface > &&ptr)
	Move append an element to the end of the list. More...

void	append (std::unique_ptr< searchableSurface > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< searchableSurface > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	append (const tmp< searchableSurface > &ptr)
	Move or clone append a tmp to the end of the list. More...

autoPtr< searchableSurface >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

Foam::autoPtr< searchableSurface >	emplace (const label i, Args &&... args)

autoPtr< searchableSurface >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< searchableSurface > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< searchableSurface > &list)
	Copy assignment. More...

void	operator= (PtrList< searchableSurface > &&list)
	Move assignment. More...

Additional Inherited Members
Protected Member Functions inherited from PtrList< searchableSurface >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

void	free ()
	Delete the allocated entries, but retain the list size. More...

Detailed Description

Container for searchableSurfaces. The collection is specified as a dictionary. For example,.

geometry
{
    surface1
    {
        type  ...;
    }
    surface2
    {
        type  ...;
    }
}

The Sub-dictionary parameters

Property	Description	Required	Default
`name`	alternative name for surface	no	dict name
`regions`	Region names sub-dictionary	no

Source files

Definition at line 92 of file searchableSurfaces.H.

Constructor & Destructor Documentation

◆ searchableSurfaces() [1/2]

searchableSurfaces ( const label size )

explicit

Construct with length specified. Fill later.

Definition at line 98 of file searchableSurfaces.C.

◆ searchableSurfaces() [2/2]

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

Construct from dictionary.

Parameters

singleRegionName controls if names are constructed as surfaceName "_" regionName (singleRegionName false) or for single region surfaces as surfaceName only (singleRegionName true)

Definition at line 197 of file searchableSurfaces.C.

References IOobject::clone(), dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::found(), dictionary::get(), dictionary::getOrDefault(), Foam::glTF::key(), searchableSurface::New(), Foam::nl, s, Foam::BitOps::set(), PtrList< T >::setSize(), List< T >::setSize(), 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

Surface names, not region names.

Definition at line 156 of file searchableSurfaces.H.

◆ names() [2/2]

wordList& names ( )

inline

Surface names, not region names.

Definition at line 162 of file searchableSurfaces.H.

◆ regionNames() [1/2]

const List<wordList>& regionNames ( ) const

inline

Region names per surface.

Definition at line 168 of file searchableSurfaces.H.

◆ regionNames() [2/2]

List<wordList>& regionNames ( )

inline

Region names per surface.

Definition at line 174 of file searchableSurfaces.H.

◆ findSurfaceID()

Foam::label findSurfaceID ( const word & name ) const

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

Definition at line 309 of file searchableSurfaces.C.

◆ findSurfaceRegionID()

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

Definition at line 318 of file searchableSurfaces.C.

References regionName.

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

References stdFoam::end(), and searchableSurfacesQueries::findAnyIntersection().

Here is the call 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 351 of file searchableSurfaces.C.

References stdFoam::end(), and searchableSurfacesQueries::findAllIntersections().

Here is the call 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 372 of file searchableSurfaces.C.

References stdFoam::end(), and searchableSurfacesQueries::findNearestIntersection().

Here is the call 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 396 of file searchableSurfaces.C.

References searchableSurfacesQueries::findNearest(), and samples().

Here is the call graph for this function:

◆ findNearest() [2/2]

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

Definition at line 416 of file searchableSurfaces.C.

References searchableSurfacesQueries::findNearest(), and samples().

Here is the call graph for this function:

◆ bounds()

Foam::boundBox bounds ( ) const

Calculate bounding box.

Definition at line 439 of file searchableSurfaces.C.

References searchableSurfacesQueries::bounds().

Here is the call graph for this function:

◆ checkClosed()

bool checkClosed ( const bool report ) const

Are all surfaces closed and manifold.

Definition at line 449 of file searchableSurfaces.C.

References Foam::endl(), forAll, Foam::Info, Foam::PtrListOps::names(), Foam::nl, Foam::returnReduce(), and s.

Here is the call graph for this function:

◆ checkNormalOrientation()

bool checkNormalOrientation ( const bool report ) const

Are all (triangulated) surfaces consistent normal orientation.

Definition at line 516 of file searchableSurfaces.C.

References PatchTools::checkOrientation(), Foam::endl(), forAll, Foam::Info, PatchTools::markZones(), Foam::PtrListOps::names(), nZones, Foam::returnReduce(), and s.

Here is the call graph for this function:

◆ checkSizes()

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

Are all bounding boxes of similar size.

Definition at line 563 of file searchableSurfaces.C.

References Foam::endl(), forAll, Foam::Info, boundBox::mag(), Foam::PtrListOps::names(), Foam::nl, and Foam::returnReduce().

Here is the call graph for this function:

◆ checkIntersection()

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

Do surfaces self-intersect or intersect others.

Definition at line 611 of file searchableSurfaces.C.

References Foam::constant::electromagnetic::e, PrimitivePatch< FaceList, PointField >::edges(), stdFoam::end(), Foam::endl(), forAll, Foam::Info, PrimitivePatch< FaceList, PointField >::localPoints(), Foam::mag(), Foam::PtrListOps::names(), os(), IOobject::path(), Foam::returnReduce(), and OBJstream::write().

Here is the call graph for this function:

◆ checkQuality()

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

Check triangle quality.

Definition at line 755 of file searchableSurfaces.C.

References Foam::endl(), f(), forAll, Foam::Info, Foam::PtrListOps::names(), Foam::returnReduce(), and s.

Here is the call graph for this function:

◆ checkTopology()

Foam::label checkTopology ( const bool report ) const

All topological checks. Return number of failed checks.

Definition at line 820 of file searchableSurfaces.C.

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

◆ writeStats()

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

Write some stats.

Definition at line 870 of file searchableSurfaces.C.

References Foam::endl(), forAll, Foam::Info, Foam::PtrListOps::names(), PrimitivePatch< FaceList, PointField >::nEdges(), Foam::nl, patchTypes(), triSurfaceMesh::points(), and s.

Here is the call graph for this function:

◆ operator[]() [1/2]

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

Return const reference to searchableSurface by name.

Definition at line 915 of file searchableSurfaces.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ operator[]() [2/2]

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

Return reference to searchableSurface by name.

Definition at line 934 of file searchableSurfaces.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ searchableSurfaces() [1/2]

◆ searchableSurfaces() [2/2]

Member Function Documentation

◆ ClassName()

◆ names() [1/2]

◆ names() [2/2]

◆ regionNames() [1/2]

◆ regionNames() [2/2]

◆ findSurfaceID()

◆ findSurfaceRegionID()

◆ findAnyIntersection()

◆ findAllIntersections()

◆ findNearestIntersection()

◆ findNearest() [1/2]

◆ findNearest() [2/2]

◆ bounds()

◆ checkClosed()

◆ checkNormalOrientation()

◆ checkSizes()

◆ checkIntersection()

◆ checkQuality()

◆ checkTopology()

◆ checkGeometry()

◆ writeStats()

◆ operator[]() [1/2]

◆ operator[]() [2/2]