Triangulated surface description with patch information. More...

Inheritance diagram for triSurface:

Collaboration diagram for triSurface:

Public Types
typedef bool	BoundaryMesh
	Placeholder only, but do not remove - it is needed for GeoMesh. More...

typedef labelledTri	face_type
	The face type (same as the underlying PrimitivePatch) More...

typedef point	point_type
	The point type (same as the underlying PrimitivePatch) More...

Public Types inherited from PrimitivePatch<::Foam::List< labelledTri >, pointField >
enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...

typedef std::remove_reference< ::Foam::List< labelledTri > >::type::value_type	face_type
	The face type. More...

typedef std::remove_reference< pointField >::type::value_type	point_type
	The point type. More...

typedef ::Foam::List< labelledTri >	FaceListType
	The face list type. More...

typedef pointField	PointFieldType
	The point field type. More...

typedef face_type	FaceType
	Deprecated(2020-03) prefer face_type typedef. More...

Public Types inherited from List< labelledTri >
typedef SubList< labelledTri >	subList
	Declare type of subList. More...

Public Member Functions
	ClassName ("triSurface")
	Runtime type information. More...

	triSurface ()
	Default construct. More...

	triSurface (const triSurface &surf)
	Copy construct. More...

	triSurface (triSurface &&surf)
	Move construct. More...

	triSurface (const List< labelledTri > &triangles, const geometricSurfacePatchList &patches, const pointField &pts)
	Construct from triangles, patches, points. More...

	triSurface (List< labelledTri > &triangles, const geometricSurfacePatchList &patches, pointField &pts, const bool reuse)
	Construct from triangles, patches, points. Reuse storage. More...

	triSurface (const List< labelledTri > &triangles, const pointField &pts)

	triSurface (const triFaceList &triangles, const pointField &pts)

	triSurface (const fileName &name, const scalar scaleFactor=-1)
	Construct from file name (uses extension to determine type). More...

	triSurface (const fileName &name, const word &fileType, const scalar scaleFactor=-1)
	Construct from file name with given format type. More...

	triSurface (Istream &is)
	Construct from Istream. More...

	triSurface (const Time &d)
	Construct from objectRegistry by reading an ".ftr" file. More...

	triSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
	Read construct using IO to find the file location. More...

virtual	~triSurface ()
	Destructor. More...

void	clearOut ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	swap (triSurface &surf)

const geometricSurfacePatchList &	patches () const noexcept

geometricSurfacePatchList &	patches () noexcept

const List< labelledTri > &	surfFaces () const noexcept
	Return const access to the faces. More...

const labelListList &	sortedEdgeFaces () const
	Return edge-face addressing sorted (for edges with more than. More...

const labelList &	edgeOwner () const
	If 2 face neighbours: label of face where ordering of edge. More...

const vectorField &	Sf () const
	Face area vectors (normals) More...

const scalarField &	magSf () const
	Face area magnitudes. More...

const vectorField &	Cf () const
	Face centres. More...

List< surfZone >	sortedZones (labelList &faceMap) const
	Sort faces according to zoneIds. More...

void	triFaceFaces (List< face > &plainFaceList) const
	Create a list of faces from the triFaces. More...

virtual void	movePoints (const pointField &pts)
	Move points. More...

virtual void	swapPoints (pointField &pts)
	Swap points. Similar to movePoints, but returns the old points. More...

virtual void	scalePoints (const scalar scaleFactor)
	Scale points. A non-positive factor is ignored. More...

void	checkTriangles (const bool verbose)
	Check/remove duplicate/degenerate triangles. More...

void	checkEdges (const bool verbose)
	Check triply (or more) connected edges. More...

void	cleanup (const bool verbose)
	Remove non-valid triangles. More...

void	compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null()))
	Remove unused points and renumber faces in local visit order. More...

void	markZone (const boolList &borderEdge, const label facei, const label currentZone, labelList &faceZone) const
	Fill faceZone with currentZone for every face reachable. More...

label	markZones (const boolList &borderEdge, labelList &faceZone) const
	(size and) fills faceZone with zone of face. Zone is area More...

template<class BoolListType >
void	subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
	Create mappings for a sub-surface. More...

triSurface	subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces. More...

triSurface	subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces. More...

triSurface	subsetMesh (const UList< bool > &include) const
	Return a new surface subsetted on the selected faces. More...

triSurface	subsetMesh (const bitSet &include) const
	Return a new surface subsetted on the selected faces. More...

triSurface	subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const
	Return a new surface subsetted on the selected patch names. More...

void	swapFaces (List< labelledTri > &faceLst)
	Swap the list of faces being addressed. More...

void	transfer (triSurface &surf)
	Alter contents by transferring (triangles, points) components. More...

void	transfer (MeshedSurface< labelledTri > &surf)
	Alter contents by transferring (triangles, points) components. More...

void	write (Ostream &os) const
	Write to Ostream in simple OpenFOAM format. More...

void	write (const fileName &, const bool sortByRegion=false) const
	Generic write routine (uses extension to determine type). More...

void	write (const fileName &filename, const word &fileType, const bool sortByRegion=false) const
	Generic write routine for given format type. More...

void	write (const Time &d) const
	Write to database. More...

void	writeStats (Ostream &os) const
	Write some statistics. More...

void	operator= (const triSurface &surf)
	Copy assignment. More...

void	operator= (triSurface &&surf)
	Move assignment. More...

void	operator= (MeshedSurface< labelledTri > &&surf)
	Move assignment. More...

Public Member Functions inherited from PrimitivePatch<::Foam::List< labelledTri >, pointField >
	PrimitivePatch (const ::Foam::List< labelledTri > &faces, const pointField &points)
	Construct from components. More...

	PrimitivePatch (::Foam::List< labelledTri > &&faces, const pointField &points)
	Construct from components, transferring faces. More...

	PrimitivePatch (::Foam::List< labelledTri > &faces, pointField &points, const bool reuse)
	Construct from components, reuse storage. More...

	PrimitivePatch (const PrimitivePatch< ::Foam::List< labelledTri >, pointField > &pp)
	Copy construct. More...

virtual	~PrimitivePatch ()
	Destructor. More...

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	swap (PrimitivePatch &)=delete
	Suppress direct swapping, since storage containers may be const. More...

const Field< point_type > &	points () const noexcept
	Return reference to global points. More...

label	nFaces () const noexcept
	Number of faces in the patch. More...

label	nPoints () const
	Number of points supporting patch faces. More...

label	nEdges () const
	Number of edges in patch. More...

const edgeList &	edges () const
	Return list of edges, address into LOCAL point list. More...

const edgeList::subList	internalEdges () const
	Return sub-list of internal edges, address into LOCAL point list. More...

const edgeList::subList	boundaryEdges () const
	Return sub-list of boundary edges, address into LOCAL point list. More...

label	nInternalEdges () const
	Number of internal edges. More...

label	nBoundaryEdges () const
	Number of boundary edges == (nEdges() - nInternalEdges()) More...

bool	isInternalEdge (const label edgei) const
	Is internal edge? More...

const labelList &	boundaryPoints () const
	Return list of boundary points, address into LOCAL point list. More...

const labelListList &	faceFaces () const
	Return face-face addressing. More...

const labelListList &	edgeFaces () const
	Return edge-face addressing. More...

const labelListList &	faceEdges () const
	Return face-edge addressing. More...

const labelListList &	pointEdges () const
	Return point-edge addressing. More...

const labelListList &	pointFaces () const
	Return point-face addressing. More...

const List< face_type > &	localFaces () const
	Return patch faces addressing into local point list. More...

labelList	boundaryFaces () const

labelList	uniqBoundaryFaces () const

const labelList &	meshPoints () const
	Return labelList of mesh points in patch. More...

const Map< label > &	meshPointMap () const
	Mesh point map. More...

const Field< point_type > &	localPoints () const
	Return pointField of points in patch. More...

const labelList &	localPointOrder () const
	Return orders the local points for most efficient search. More...

label	whichPoint (const label gp) const
	Given a global point index, return the local point index. More...

edge	meshEdge (const label edgei) const
	From patch edge to global edge using meshPoints. More...

edge	meshEdge (const edge &e) const
	From patch edge to global edge using meshPoints. More...

label	meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const

label	findEdge (const edge &e) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const

labelList	meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const

const Field< point_type > &	faceCentres () const
	Return face centres for patch. More...

const Field< point_type > &	faceAreas () const
	Return face area vectors for patch. More...

const Field< scalar > &	magFaceAreas () const
	Return face area magnitudes for patch. More...

const Field< point_type > &	faceNormals () const
	Return face unit normals for patch. More...

const Field< point_type > &	pointNormals () const
	Return point normals for patch. More...

bool	hasFaceAreas () const

bool	hasFaceCentres () const

bool	hasFaceNormals () const

bool	hasPointNormals () const

bool	hasBoundaryPoints () const

bool	hasFaceFaces () const

bool	hasEdgeFaces () const

bool	hasFaceEdges () const

bool	hasPointEdges () const

bool	hasPointFaces () const

bool	hasMeshPointMap () const

List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch. More...

Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< labelledTri >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch. More...

Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< labelledTri >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices. More...

surfaceTopo	surfaceType () const
	Calculate surface type formed by patch. More...

bool	checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above). More...

bool	checkPointManifold (const bool report=false, labelHashSet *setPtr=nullptr) const
	Checks primitivePatch for faces sharing point but not edge. More...

virtual void	movePoints (const Field< point_type > &)
	Correct patch after moving points. More...

void	operator= (const PrimitivePatch< ::Foam::List< labelledTri >, pointField > &rhs)
	Copy assign faces. Leave points alone (could be a reference). More...

void	operator= (PrimitivePatch< ::Foam::List< labelledTri >, pointField > &&rhs)
	Move assign faces. Leave points alone (could be a reference). More...

label	whichEdge (const edge &e) const
	Identical to findEdge. More...

Public Member Functions inherited from PrimitivePatchBase
	ClassName ("PrimitivePatch")
	Runtime type information. More...

	PrimitivePatchBase ()=default
	Default construct. More...

Public Member Functions inherited from List< labelledTri >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const labelledTri &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const labelledTri &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, labelledTri &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< labelledTri > &a)
	Copy construct from list. More...

	List (const UList< labelledTri > &a)
	Copy construct contents from list. More...

	List (List< labelledTri > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< labelledTri > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< labelledTri > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< labelledTri, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< labelledTri > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< labelledTri > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< labelledTri, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< labelledTri > list)
	Construct from an initializer list. More...

	List (List< labelledTri > &&list)
	Move construct from List. More...

	List (DynamicList< labelledTri, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< labelledTri > &&list)
	Move construct from SortableList. More...

	List (SLList< labelledTri > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< labelledTri > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const labelledTri &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const labelledTri &val)
	Alias for resize() More...

void	append (const labelledTri &val)
	Append an element at the end of the list. More...

void	append (labelledTri &&val)
	Move append an element at the end of the list. More...

void	append (const UList< labelledTri > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< labelledTri, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const labelledTri &val)
	Append an element if not already in the list. More...

void	transfer (List< labelledTri > &list)

void	transfer (DynamicList< labelledTri, SizeMin > &list)

void	transfer (SortableList< labelledTri > &list)

labelledTri &	newElmt (const label i)

void	operator= (const UList< labelledTri > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< labelledTri > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< labelledTri > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< labelledTri, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< labelledTri, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< labelledTri > list)
	Assignment to an initializer list. More...

void	operator= (const labelledTri &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< labelledTri > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< labelledTri, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< labelledTri > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< labelledTri > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< labelledTri > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Static Public Member Functions
static fileName	triSurfInstance (const Time &)
	Name of triSurface directory to use. More...

static wordHashSet	readTypes ()
	Known readable file-types, including via friends or proxies. More...

static wordHashSet	writeTypes ()
	Known writable file-types, including via friends or proxies. More...

static bool	canReadType (const word &fileType, bool verbose=false)
	Can we read this file format? More...

static bool	canWriteType (const word &fileType, bool verbose=false)
	Can we write this file format? More...

static bool	canRead (const fileName &name, bool verbose=false)
	Can we read this file format? More...

static fileName	relativeFilePath (const IOobject &io, const fileName &f, const bool isGlobal=true)
	Return fileName. More...

static fileName	checkFile (const IOobject &io, const bool isGlobal=true)
	Return fileName to load IOobject from. More...

static fileName	checkFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
	Return fileName to load IOobject from. More...

static fileName	findFile (const IOobject &io, const bool isGlobal=true)

static fileName	findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)

static autoPtr< triSurface >	New (const fileName &name, const word &fileType)
	Read construct from filename with given file type. More...

static autoPtr< triSurface >	New (const fileName &name)
	Read construct from filename (file type implicit from extension) More...

Static Public Member Functions inherited from List< labelledTri >
static const List< labelledTri > &	null ()
	Return a null List. More...

Protected Member Functions
pointField &	storedPoints ()
	Non-const access to global points. More...

List< labelledTri > &	storedFaces ()
	Non-const access to the faces. More...

Friends
Istream &	operator>> (Istream &is, triSurface &s)

Ostream &	operator<< (Ostream &os, const triSurface &s)

Detailed Description

Triangulated surface description with patch information.

Source files

Definition at line 76 of file triSurface.H.

Member Typedef Documentation

◆ BoundaryMesh

typedef bool BoundaryMesh

Placeholder only, but do not remove - it is needed for GeoMesh.

Definition at line 206 of file triSurface.H.

◆ face_type

typedef labelledTri face_type

The face type (same as the underlying PrimitivePatch)

Definition at line 209 of file triSurface.H.

◆ point_type

typedef point point_type

The point type (same as the underlying PrimitivePatch)

Definition at line 212 of file triSurface.H.

Constructor & Destructor Documentation

◆ triSurface() [1/12]

triSurface ( )

Default construct.

Definition at line 432 of file triSurface.C.

◆ triSurface() [2/12]

triSurface ( const triSurface & surf )

Copy construct.

Definition at line 441 of file triSurface.C.

◆ triSurface() [3/12]

triSurface ( triSurface && surf )

Move construct.

Definition at line 450 of file triSurface.C.

References triSurface::transfer().

Here is the call graph for this function:

◆ triSurface() [4/12]

triSurface	(	const List< labelledTri > &	triangles,
		const geometricSurfacePatchList &	patches,
		const pointField &	pts
	)

Construct from triangles, patches, points.

Definition at line 459 of file triSurface.C.

◆ triSurface() [5/12]

triSurface	(	List< labelledTri > &	triangles,
		const geometricSurfacePatchList &	patches,
		pointField &	pts,
		const bool	reuse
	)

Construct from triangles, patches, points. Reuse storage.

Definition at line 473 of file triSurface.C.

◆ triSurface() [6/12]

triSurface	(	const List< labelledTri > &	triangles,
		const pointField &	pts
	)

Construct from triangles, points. Set patch names to default.

Definition at line 488 of file triSurface.C.

◆ triSurface() [7/12]

triSurface	(	const triFaceList &	triangles,
		const pointField &	pts
	)

Construct from triangles, points. Set region to 0 and default patchName.

Definition at line 503 of file triSurface.C.

◆ triSurface() [8/12]

triSurface	(	const fileName &	name,
		const scalar	scaleFactor = `-1`
	)

explicit

Construct from file name (uses extension to determine type).

Optional (positive, non-zero) point scaling is possible.

Definition at line 518 of file triSurface.C.

◆ triSurface() [9/12]

triSurface	(	const fileName &	name,
		const word &	fileType,
		const scalar	scaleFactor = `-1`
	)

Construct from file name with given format type.

If the format type is "", uses the file extension.

Definition at line 528 of file triSurface.C.

References Foam::name(), and Foam::read().

Here is the call graph for this function:

◆ triSurface() [10/12]

triSurface ( Istream & is )

explicit

Construct from Istream.

Definition at line 280 of file triSurfaceIO.C.

◆ triSurface() [11/12]

triSurface ( const Time & d )

explicit

Construct from objectRegistry by reading an ".ftr" file.

Definition at line 290 of file triSurfaceIO.C.

References Time::caseName(), Time::path(), and triSurface::triSurfInstance().

Here is the call graph for this function:

◆ triSurface() [12/12]

triSurface	(	const IOobject &	io,
		const dictionary &	dict,
		const bool	isGlobal = `true`
	)

Read construct using IO to find the file location.

Dictionary may contain the following entries:

file = alternative file name (default is dictionary name)
fileType = file format (default is from file extension)
scale (eg, 0.001: mm to m)

Parameters

isGlobal resolve as a global file

Definition at line 306 of file triSurfaceIO.C.

References dict, dictionary::getOrDefault(), word::null, and Foam::read().

Here is the call graph for this function:

◆ ~triSurface()

~triSurface ( )

virtual

Destructor.

Definition at line 544 of file triSurface.C.

Member Function Documentation

◆ storedPoints()

pointField& storedPoints ( )

inlineprotected

Non-const access to global points.

Definition at line 189 of file triSurface.H.

References PrimitivePatch<::Foam::List< labelledTri >, pointField >::points().

Referenced by triSurface::swap(), and triSurface::transfer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storedFaces()

List<labelledTri>& storedFaces ( )

inlineprotected

Non-const access to the faces.

Definition at line 195 of file triSurface.H.

Referenced by triSurface::swap(), and triSurface::transfer().

Here is the caller graph for this function:

◆ ClassName()

ClassName ( "triSurface" )

Runtime type information.

◆ triSurfInstance()

Foam::fileName triSurfInstance ( const Time & d )

static

Name of triSurface directory to use.

Definition at line 73 of file triSurface.C.

References Time::caseName(), TimePaths::constant(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::isFile(), OSstream::name(), IOstream::name(), fileName::name(), Time::path(), Foam::Pout, TimeState::timeOutputValue(), and TimePaths::times().

Referenced by triSurface::triSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readTypes()

Foam::wordHashSet readTypes ( )

static

Known readable file-types, including via friends or proxies.

Definition at line 40 of file triSurfaceIO.C.

References HashSet< Key, Hash >::insert().

Here is the call graph for this function:

◆ writeTypes()

Foam::wordHashSet writeTypes ( )

static

Known writable file-types, including via friends or proxies.

Definition at line 58 of file triSurfaceIO.C.

References HashSet< Key, Hash >::insert().

Here is the call graph for this function:

◆ canReadType()

bool canReadType	(	const word &	fileType,
		bool	verbose = `false`
	)

static

Can we read this file format?

Definition at line 75 of file triSurfaceIO.C.

References surfaceFormatsCore::checkSupport().

Here is the call graph for this function:

◆ canWriteType()

bool canWriteType	(	const word &	fileType,
		bool	verbose = `false`
	)

static

Can we write this file format?

Definition at line 87 of file triSurfaceIO.C.

References surfaceFormatsCore::checkSupport().

Here is the call graph for this function:

◆ canRead()

bool canRead	(	const fileName &	name,
		bool	verbose = `false`
	)

static

Can we read this file format?

Definition at line 99 of file triSurfaceIO.C.

References word::ext(), word::lessExt(), and Foam::name().

Referenced by triSurfaceLoader::readDir().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ relativeFilePath()

Foam::fileName relativeFilePath	(	const IOobject &	io,
		const fileName &	f,
		const bool	isGlobal = `true`
	)

static

Return fileName.

If fileName is relative gets treated as local to IOobject.

Parameters

isGlobal resolve as a global file

Definition at line 111 of file triSurfaceIO.C.

References f(), and surfaceFormatsCore::relativeFilePath().

Referenced by triSurfaceMesh::triSurfaceMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkFile() [1/2]

Foam::fileName checkFile	(	const IOobject &	io,
		const bool	isGlobal = `true`
	)

static

Return fileName to load IOobject from.

Fatal if the file does not exist

Parameters

isGlobal resolve as a global file

Definition at line 122 of file triSurfaceIO.C.

References surfaceFormatsCore::checkFile().

Referenced by distributedTriSurfaceMesh::distributedTriSurfaceMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkFile() [2/2]

Foam::fileName checkFile	(	const IOobject &	io,
		const dictionary &	dict,
		const bool	isGlobal = `true`
	)

static

Return fileName to load IOobject from.

Supports optional override of fileName with "file" entry Fatal if the file does not exist

Parameters

isGlobal resolve as a global file

Definition at line 132 of file triSurfaceIO.C.

References surfaceFormatsCore::checkFile(), and dict.

Here is the call graph for this function:

◆ findFile() [1/2]

Foam::fileName findFile	(	const IOobject &	io,
		const bool	isGlobal = `true`
	)

static

Use IOobject information to resolve file to load from, or empty if the file does not exist.

Parameters

isGlobal resolve as a global file

Definition at line 143 of file triSurfaceIO.C.

References surfaceFormatsCore::findFile().

Here is the call graph for this function:

◆ findFile() [2/2]

Foam::fileName findFile	(	const IOobject &	io,
		const dictionary &	dict,
		const bool	isGlobal = `true`
	)

static

Use IOobject information to resolve file to load from, or empty if the file does not exist.

Supports optional override of fileName with "file" entry

Parameters

isGlobal resolve as a global file

Definition at line 153 of file triSurfaceIO.C.

References dict, and surfaceFormatsCore::findFile().

Here is the call graph for this function:

◆ New() [1/2]

Foam::autoPtr< Foam::triSurface > New	(	const fileName &	name,
		const word &	fileType
	)

static

Read construct from filename with given file type.

Definition at line 37 of file triSurfaceNew.C.

References Foam::exit(), word::ext(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), found, word::lessExt(), Foam::name(), Foam::New(), and Foam::nl.

Referenced by triSurface::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::triSurface > New ( const fileName & name )

static

Read construct from filename (file type implicit from extension)

Definition at line 141 of file triSurfaceNew.C.

References word::ext(), word::lessExt(), Foam::name(), and triSurface::New().

Here is the call graph for this function:

◆ clearOut()

void clearOut ( )

Definition at line 566 of file triSurface.C.

Referenced by triSurfaceMesh::clearOut(), isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), triSurface::swap(), and triSurface::transfer().

Here is the caller graph for this function:

◆ clearTopology()

void clearTopology ( )

Definition at line 552 of file triSurface.C.

◆ clearPatchMeshAddr()

void clearPatchMeshAddr ( )

Definition at line 560 of file triSurface.C.

◆ swap()

void swap ( triSurface & surf )

Definition at line 574 of file triSurface.C.

References triSurface::clearOut(), triSurface::patches(), triSurface::storedFaces(), and triSurface::storedPoints().

Here is the call graph for this function:

◆ patches() [1/2]

const geometricSurfacePatchList& patches ( ) const

inlinenoexcept

Definition at line 399 of file triSurface.H.

Referenced by triSurfaceTools::collapseEdges(), triSurfaceTools::greenRefine(), intersectedSurface::intersectedSurface(), triSurfaceLoader::load(), triSurfaceTools::mergePoints(), triSurface::operator=(), boundaryMesh::readTriSurface(), triSurface::swap(), triSurface::transfer(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), and triSurfaceMesh::triSurfaceMesh().

Here is the caller graph for this function:

◆ patches() [2/2]

geometricSurfacePatchList& patches ( )

inlinenoexcept

Definition at line 404 of file triSurface.H.

◆ surfFaces()

const List<labelledTri>& surfFaces ( ) const

inlinenoexcept

Return const access to the faces.

Definition at line 410 of file triSurface.H.

◆ sortedEdgeFaces()

const Foam::labelListList & sortedEdgeFaces ( ) const

Return edge-face addressing sorted (for edges with more than.

2 faces) according to the angle around the edge. Orientation is anticlockwise looking from edge.vec(localPoints())

Definition at line 590 of file triSurface.C.

◆ edgeOwner()

const Foam::labelList & edgeOwner ( ) const

If 2 face neighbours: label of face where ordering of edge.

is consistent with righthand walk. If 1 neighbour: label of only face. If >2 neighbours: undetermined.

Definition at line 601 of file triSurface.C.

◆ Sf()

const vectorField& Sf ( ) const

inline

Face area vectors (normals)

Definition at line 429 of file triSurface.H.

References PrimitivePatch<::Foam::List< labelledTri >, pointField >::faceAreas().

Here is the call graph for this function:

◆ magSf()

const scalarField& magSf ( ) const

inline

Face area magnitudes.

Definition at line 435 of file triSurface.H.

References PrimitivePatch<::Foam::List< labelledTri >, pointField >::magFaceAreas().

Here is the call graph for this function:

◆ Cf()

const vectorField& Cf ( ) const

inline

Face centres.

Definition at line 441 of file triSurface.H.

References PrimitivePatch<::Foam::List< labelledTri >, pointField >::faceCentres().

Here is the call graph for this function:

◆ sortedZones()

Foam::List< Foam::surfZone > sortedZones ( labelList & faceMap ) const

Sort faces according to zoneIds.

Returns a surfZoneList and sets faceMap to index within faces() (i.e. map from original,unsorted to sorted)

Definition at line 709 of file triSurface.C.

References Foam::faceMap(), forAll, and patches.

Here is the call graph for this function:

◆ triFaceFaces()

void triFaceFaces ( List< face > & plainFaceList ) const

Create a list of faces from the triFaces.

Definition at line 723 of file triSurface.C.

References forAll, and List< T >::setSize().

Referenced by isoSurfaceCell::isoSurfaceCell(), and isoSurfacePoint::isoSurfacePoint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const pointField & pts )

virtual

Move points.

Reimplemented in triSurfaceMesh.

Definition at line 612 of file triSurface.C.

Referenced by triSurfaceMesh::movePoints().

Here is the caller graph for this function:

◆ swapPoints()

void swapPoints ( pointField & pts )

virtual

Swap points. Similar to movePoints, but returns the old points.

Definition at line 625 of file triSurface.C.

Referenced by isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), and triSurfaceLoader::load().

Here is the caller graph for this function:

◆ scalePoints()

void scalePoints ( const scalar scaleFactor )

virtual

Scale points. A non-positive factor is ignored.

Definition at line 638 of file triSurface.C.

References Foam::equal().

Here is the call graph for this function:

◆ checkTriangles()

void checkTriangles ( const bool verbose )

Check/remove duplicate/degenerate triangles.

Definition at line 182 of file triSurface.C.

References bitSet::all(), Foam::endl(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, forAll, n, points, Foam::printTriangle(), bitSet::unset(), Foam::Warning, and WarningInFunction.

Here is the call graph for this function:

◆ checkEdges()

void checkEdges ( const bool verbose )

Check triply (or more) connected edges.

Definition at line 301 of file triSurface.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and WarningInFunction.

Here is the call graph for this function:

◆ cleanup()

void cleanup ( const bool verbose )

Remove non-valid triangles.

Definition at line 655 of file triSurface.C.

◆ compactPoints()

void compactPoints ( labelList & pointMap = const_cast<labelList&>(labelList::null()) )

Remove unused points and renumber faces in local visit order.

Parameters

[out] pointMap from new to old points (optional)

Definition at line 669 of file triSurface.C.

References List< T >::append(), f(), Foam::notNull(), points, and List< T >::transfer().

Here is the call graph for this function:

◆ markZone()

void markZone	(	const boolList &	borderEdge,
		const label	facei,
		const label	currentZone,
		labelList &	faceZone
	)		const

Fill faceZone with currentZone for every face reachable.

from facei without crossing edge marked in borderEdge. Note: faceZone has to be sized nFaces before calling this fun.

Definition at line 737 of file triSurface.C.

References Foam::abort(), List< T >::append(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ markZones()

Foam::label markZones	(	const boolList &	borderEdge,
		labelList &	faceZone
	)		const

(size and) fills faceZone with zone of face. Zone is area

reachable by edge crossing without crossing borderEdge (bool for every edge in surface). Returns number of zones.

Definition at line 796 of file triSurface.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and List< T >::setSize().

Referenced by booleanSurface::booleanSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subsetMeshMap()

void subsetMeshMap	(	const BoolListType &	include,
		labelList &	pointMap,
		labelList &	faceMap
	)		const

inline

Create mappings for a sub-surface.

Parameters

[in]	include	the faces to select
[out]	pointMap	from new to old localPoints
[out]	faceMap	from new to old localFaces

Definition at line 513 of file triSurface.H.

References Foam::faceMap(), and PatchTools::subsetMap().

Here is the call graph for this function:

◆ subsetMesh() [1/5]

Foam::triSurface subsetMesh	(	const UList< bool > &	include,
		labelList &	pointMap,
		labelList &	faceMap
	)		const

Return a new surface subsetted on the selected faces.

Parameters

[in]	include	the faces to select
[out]	pointMap	from new to old localPoints
[out]	faceMap	from new to old localFaces

Definition at line 879 of file triSurface.C.

References Foam::faceMap().

Referenced by booleanSurface::booleanSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subsetMesh() [2/5]

Foam::triSurface subsetMesh	(	const bitSet &	include,
		labelList &	pointMap,
		labelList &	faceMap
	)		const

Return a new surface subsetted on the selected faces.

Parameters

[in]	include	the faces to select
[out]	pointMap	from subsetMeshMap
[out]	faceMap	from subsetMeshMap

Definition at line 892 of file triSurface.C.

References Foam::faceMap().

Here is the call graph for this function:

◆ subsetMesh() [3/5]

Foam::triSurface subsetMesh ( const UList< bool > & include ) const

Return a new surface subsetted on the selected faces.

Parameters

[in] include the faces to select

Definition at line 904 of file triSurface.C.

References Foam::faceMap().

Here is the call graph for this function:

◆ subsetMesh() [4/5]

Foam::triSurface subsetMesh ( const bitSet & include ) const

Return a new surface subsetted on the selected faces.

Parameters

[in] include the faces to select

Definition at line 912 of file triSurface.C.

References Foam::faceMap().

Here is the call graph for this function:

◆ subsetMesh() [5/5]

Foam::triSurface subsetMesh	(	const wordRes &	includeNames,
		const wordRes &	excludeNames = `wordRes()`
	)		const

Return a new surface subsetted on the selected patch names.

Parameters

[in]	includeNames	surface patch names to include
[in]	excludeNames	surface patch names to exclude

See also: Foam::stringListOps::findMatching for details about matching

Definition at line 921 of file triSurface.C.

References Foam::stringListOps::findMatching(), forAll, bitSet::set(), and bitSet::test().

Here is the call graph for this function:

◆ swapFaces()

void swapFaces ( List< labelledTri > & faceLst )

Swap the list of faces being addressed.

Definition at line 953 of file triSurface.C.

Referenced by triSurfaceLoader::load().

Here is the caller graph for this function:

◆ transfer() [1/2]

void transfer ( triSurface & surf )

Alter contents by transferring (triangles, points) components.

Patch information is small and therefore just copied.

Definition at line 961 of file triSurface.C.

References triSurface::clearOut(), triSurface::patches(), triSurface::storedFaces(), and triSurface::storedPoints().

Referenced by triSurface::triSurface(), and triSurfaceMesh::triSurfaceMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transfer() [2/2]

void transfer ( MeshedSurface< labelledTri > & surf )

Alter contents by transferring (triangles, points) components.

Patch information is small and therefore just copied.

Definition at line 973 of file triSurface.C.

References MeshedSurface< Face >::clear(), patches, s, MeshedSurface< Face >::surfZones(), MeshedSurface< Face >::swapFaces(), and MeshedSurface< Face >::swapPoints().

Here is the call graph for this function:

◆ write() [1/4]

void write ( Ostream & os ) const

Write to Ostream in simple OpenFOAM format.

Definition at line 336 of file triSurfaceIO.C.

References os().

Referenced by booleanSurface::booleanSurface(), isoSurfacePoint::isoSurfacePoint(), triSurfaceMesh::writeObject(), distributedTriSurfaceMesh::writeObject(), and boundaryMesh::writeTriSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/4]

void write	(	const fileName &	name,
		const bool	sortByRegion = `false`
	)		const

Generic write routine (uses extension to determine type).

The sort option may not have an effect.

Definition at line 327 of file triSurfaceIO.C.

References word::ext(), Foam::name(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [3/4]

void write	(	const fileName &	filename,
		const word &	fileType,
		const bool	sortByRegion = `false`
	)		const

Generic write routine for given format type.

If the format type is "", uses the file extension. The sort option may not have an effect.

Definition at line 207 of file triSurfaceIO.C.

References Foam::exit(), word::ext(), Foam::faceMap(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::name(), Foam::nl, os(), points, Foam::vtk::write(), and MeshedSurfaceProxy< Face >::write().

Here is the call graph for this function:

◆ write() [4/4]

void write ( const Time & d ) const

Write to database.

Definition at line 342 of file triSurfaceIO.C.

References Time::caseName(), os(), and Time::path().

Here is the call graph for this function:

◆ writeStats()

void writeStats ( Ostream & os ) const

Write some statistics.

Definition at line 353 of file triSurfaceIO.C.

References boundBox::add(), bitSet::count(), Foam::endl(), f(), HashSet< Key, Hash >::insert(), boundBox::invertedBox, Foam::nl, os(), points, and bitSet::set().

Referenced by booleanSurface::booleanSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/3]

void operator= ( const triSurface & surf )

Copy assignment.

Definition at line 999 of file triSurface.C.

References triSurface::patches(), and PrimitivePatch< FaceList, PointField >::points().

Referenced by booleanSurface::booleanSurface(), distributedTriSurfaceMesh::distribute(), and intersectedSurface::intersectedSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/3]

void operator= ( triSurface && surf )

Move assignment.

Definition at line 1009 of file triSurface.C.

◆ operator=() [3/3]

void operator= ( MeshedSurface< labelledTri > && surf )

Move assignment.

Definition at line 1015 of file triSurface.C.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	is,
		triSurface &	s
	)

friend

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const triSurface &	s
	)

friend

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

src/surfMesh/triSurface/triSurface.H
src/surfMesh/surfaceFormats/gts/triSurfaceGTSformat.C
src/surfMesh/surfaceFormats/stl/triSurfaceSTLformat.C
src/surfMesh/triSurface/triSurface.C
src/surfMesh/triSurface/triSurfaceAddressing.C
src/surfMesh/triSurface/triSurfaceIO.C
src/surfMesh/triSurface/triSurfaceNew.C
src/surfMesh/triSurface/triSurfaceStitch.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ BoundaryMesh

◆ face_type

◆ point_type

Constructor & Destructor Documentation

◆ triSurface() [1/12]

◆ triSurface() [2/12]

◆ triSurface() [3/12]

◆ triSurface() [4/12]

◆ triSurface() [5/12]

◆ triSurface() [6/12]

◆ triSurface() [7/12]

◆ triSurface() [8/12]

◆ triSurface() [9/12]

◆ triSurface() [10/12]

◆ triSurface() [11/12]

◆ triSurface() [12/12]

◆ ~triSurface()

Member Function Documentation

◆ storedPoints()

◆ storedFaces()

◆ ClassName()

◆ triSurfInstance()

◆ readTypes()

◆ writeTypes()

◆ canReadType()

◆ canWriteType()

◆ canRead()

◆ relativeFilePath()

◆ checkFile() [1/2]

◆ checkFile() [2/2]

◆ findFile() [1/2]

◆ findFile() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ clearOut()

◆ clearTopology()

◆ clearPatchMeshAddr()

◆ swap()

◆ patches() [1/2]

◆ patches() [2/2]

◆ surfFaces()

◆ sortedEdgeFaces()

◆ edgeOwner()

◆ Sf()

◆ magSf()

◆ Cf()

◆ sortedZones()

◆ triFaceFaces()

◆ movePoints()

◆ swapPoints()

◆ scalePoints()

◆ checkTriangles()

◆ checkEdges()

◆ cleanup()

◆ compactPoints()

◆ markZone()

◆ markZones()

◆ subsetMeshMap()

◆ subsetMesh() [1/5]

◆ subsetMesh() [2/5]

◆ subsetMesh() [3/5]

◆ subsetMesh() [4/5]

◆ subsetMesh() [5/5]

◆ swapFaces()

◆ transfer() [1/2]

◆ transfer() [2/2]

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

◆ writeStats()

◆ operator=() [1/3]

◆ operator=() [2/3]