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)

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

const wordList &	names () const

wordList &	names ()

const List< wordList > &	regionNames () const

List< wordList > &	regionNames ()

label	findSurfaceID (const word &name) const

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

void	findAnyIntersection (const pointField &start, const pointField &end, labelList &surfaces, List< pointIndexHit > &) const

void	findAllIntersections (const pointField &start, const pointField &end, labelListList &surfaces, List< List< pointIndexHit >> &) const

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

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

boundBox	bounds () const

bool	checkClosed (const bool report) const

bool	checkNormalOrientation (const bool report) const

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

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

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

label	checkTopology (const bool report) const

label	checkGeometry (const scalar maxRatio, const scalar tolerance, const autoPtr< writer< scalar >> &setWriter, const scalar minQuality, const bool report) const

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

const searchableSurface &	operator[] (const word &) const

searchableSurface &	operator[] (const word &)

Public Member Functions inherited from PtrList< searchableSurface >
constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

	PtrList (Istream &is, const INew &inew)

	PtrList (Istream &is)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (Istream &is)

	~PtrList ()

PtrList< T >	clone (Args &&... args) const

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

const T *	set (const label i) const

autoPtr< T >	set (const label i, T *ptr)

autoPtr< T >	set (const label i, autoPtr< T > &ptr)

autoPtr< T >	set (const label i, autoPtr< T > &&ptr)

autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)

autoPtr< T >	set (const label i, const refPtr< T > &ptr)

autoPtr< T >	set (const label i, const tmp< T > &ptr)

void	clear ()

void	resize (const label newLen)

void	setSize (const label newLen)

void	emplace_append (Args &&... args)

void	append (T *ptr)

void	append (autoPtr< T > &ptr)

void	append (autoPtr< T > &&ptr)

void	append (std::unique_ptr< T > &&ptr)

void	append (const refPtr< T > &ptr)

void	append (const tmp< T > &ptr)

autoPtr< T >	emplace (const label i, Args &&... args)

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

autoPtr< T >	release (const label i)

void	transfer (PtrList< T > &list)

void	operator= (const PtrList< T > &list)

void	operator= (PtrList< T > &&list)

Additional Inherited Members
Protected Member Functions inherited from PtrList< searchableSurface >
void	readIstream (Istream &is, const INew &inew)

void	free ()

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 88 of file searchableSurfaces.H.

Constructor & Destructor Documentation

◆ searchableSurfaces() [1/2]

searchableSurfaces ( const label size )

explicit

Definition at line 91 of file searchableSurfaces.C.

◆ searchableSurfaces() [2/2]

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

Definition at line 190 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::setSize(), List::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

Definition at line 152 of file searchableSurfaces.H.

◆ names() [2/2]

wordList& names ( )

inline

Definition at line 158 of file searchableSurfaces.H.

◆ regionNames() [1/2]

const List<wordList>& regionNames ( ) const

inline

Definition at line 164 of file searchableSurfaces.H.

◆ regionNames() [2/2]

List<wordList>& regionNames ( )

inline

Definition at line 170 of file searchableSurfaces.H.

◆ findSurfaceID()

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

Definition at line 302 of file searchableSurfaces.C.

◆ findSurfaceRegionID()

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

Definition at line 311 of file searchableSurfaces.C.

References regionName.

◆ findAnyIntersection()

void findAnyIntersection	(	const pointField &	start,
		const pointField &	end,
		labelList &	surfaces,
		List< pointIndexHit > &	hitInfo
	)		const

Definition at line 324 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

Definition at line 344 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 365 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

Definition at line 389 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 409 of file searchableSurfaces.C.

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

Here is the call graph for this function:

◆ bounds()

Foam::boundBox bounds ( ) const

Definition at line 432 of file searchableSurfaces.C.

References searchableSurfacesQueries::bounds().

Here is the call graph for this function:

◆ checkClosed()

bool checkClosed ( const bool report ) const

Definition at line 442 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

Definition at line 509 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

Definition at line 556 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

Definition at line 604 of file searchableSurfaces.C.

References DynamicField::append(), DynamicField::capacity(), 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(), and Foam::returnReduce().

Here is the call graph for this function:

◆ checkQuality()

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

Definition at line 748 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

Definition at line 813 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

Definition at line 833 of file searchableSurfaces.C.

◆ writeStats()

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

Definition at line 863 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

Definition at line 908 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 )

Definition at line 927 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]