A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMesh, which actually refers to the cell faces of a volume mesh. More...

Inheritance diagram for MeshedSurface< Face >:

[legend]

Collaboration diagram for MeshedSurface< Face >:

[legend]

Public Types
typedef Face	FaceType
	Face type used. More...

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

typedef ::Foam::List< Face >	FaceListType

typedef std::remove_reference< ::Foam::List< Face > >::type::value_type	FaceType

typedef pointField	PointFieldType

typedef std::remove_reference< pointField >::type::value_type	PointType

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

Public Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

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

	MeshedSurface ()
	Construct null. More...

	MeshedSurface (pointField &&, List< Face > &&, surfZoneList &&)
	Construct by transferring components (points, faces, zones). More...

	MeshedSurface (pointField &&, List< Face > &&, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Construct by transferring components (points, faces). More...

	MeshedSurface (const MeshedSurface &)
	Copy constructor. More...

	MeshedSurface (const UnsortedMeshedSurface< Face > &)
	Construct from a UnsortedMeshedSurface. More...

	MeshedSurface (const polyBoundaryMesh &, const bool globalPoints=false)
	Construct from a boundary mesh with local points/faces. More...

	MeshedSurface (const surfMesh &)
	Construct from a surfMesh. More...

	MeshedSurface (UnsortedMeshedSurface< Face > &&)
	Construct by transferring the contents from a UnsortedMeshedSurface. More...

	MeshedSurface (MeshedSurface< Face > &&)
	Construct by transferring the contents from a MeshedSurface. More...

	MeshedSurface (const fileName &)
	Construct from file name (uses extension to determine type) More...

	MeshedSurface (const fileName &, const word &ext)
	Construct from file name (uses extension to determine type) More...

	MeshedSurface (const Time &, const word &surfName="")
	Construct from database. More...

	declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name))

virtual	~MeshedSurface ()
	Destructor. More...

	declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf),(name, surf))

label	size () const
	The surface size is the number of faces. More...

const List< Face > &	faces () const
	Return const access to the faces. More...

const List< surfZone > &	surfZones () const
	Const access to the surface zones. More...

virtual void	addZones (const UList< surfZone > &, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	removeZones ()
	Remove surface zones. More...

virtual void	clear ()
	Clear all storage. More...

virtual void	setPoints (const pointField &)
	Reset the points. More...

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

virtual void	reset (pointField &&points, List< Face > &&faces, surfZoneList &&zones)
	Reset primitive data (points, faces and zones) More...

virtual void	reset (List< point > &&points, List< Face > &&faces, surfZoneList &&zones)
	Reset primitive data (points, faces and zones) More...

virtual void	cleanup (const bool verbose)
	Remove invalid faces. More...

virtual bool	stitchFaces (const scalar tol=small, const bool verbose=false)

virtual bool	checkFaces (const bool verbose=false)

virtual label	triangulate ()
	Triangulate in-place, returning the number of triangles added. More...

virtual label	triangulate (List< label > &faceMap)
	Triangulate in-place, returning the number of triangles added. More...

MeshedSurface	subsetMesh (const labelHashSet &include, labelList &pointMap, labelList &faceMap) const
	Return new surface. More...

MeshedSurface	subsetMesh (const labelHashSet &include) const
	Return new surface. More...

void	transfer (MeshedSurface< Face > &)
	Transfer the contents of the argument and annul the argument. More...

void	transfer (UnsortedMeshedSurface< Face > &)
	Transfer the contents of the argument and annul the argument. More...

bool	read (const fileName &, const word &ext)
	Read from file. Chooses reader based on explicit extension. More...

virtual bool	read (const fileName &)
	Read from file. Chooses reader based on detected extension. More...

void	writeStats (Ostream &os) const

virtual void	write (const fileName &name) const
	Generic write routine. Chooses writer based on extension. More...

void	write (const Time &, const word &surfName="") const
	Write to database. More...

void	operator= (const MeshedSurface< Face > &)

	operator MeshedSurfaceProxy< Face > () const
	Conversion operator to MeshedSurfaceProxy. More...

template<class Face >
	MeshedSurface (const MeshedSurface< Face > &surf)

bool	isTri ()
	Specialisation for holding triangulated information. More...

label	triangulate ()
	Specialisation for holding triangulated information. More...

label	triangulate (List< label > &faceMap)
	Specialisation for holding triangulated information. More...

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

	PrimitivePatch (::Foam::List< Face > &&faces, Field< PointType > &&points)
	Move constructor from components. More...

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

	PrimitivePatch (const PrimitivePatch< ::Foam::List< Face >, pointField > &)
	Copy constructor. More...

	PrimitivePatch (PrimitivePatch< ::Foam::List< Face >, pointField > &&)
	Move constructor. More...

autoPtr< PrimitivePatch< ::Foam::List< Face >, pointField > >	clone () const
	Construct and return a clone. More...

	~PrimitivePatch ()
	Destructor. More...

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

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

label	nEdges () const
	Return number of edges in patch. More...

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

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

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

const labelList &	boundaryPoints () const
	Return list of boundary points,. 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< FaceType > &	localFaces () const
	Return patch faces addressing into local point list. More...

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

const Map< label > &	meshPointMap () const
	Mesh point map. Given the global point index find its. More...

const Field< PointType > &	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...

label	whichEdge (const edge &) const
	Given an edge in local point labels, return its. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges in the global edge list using. More...

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

const Field< PointType > &	faceAreas () const
	Return face areas for patch. More...

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

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

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

Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

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

Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &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...

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	operator= (const PrimitivePatch< ::Foam::List< Face >, pointField > &)
	Assignment operator. More...

void	operator= (PrimitivePatch< ::Foam::List< Face >, pointField > &&)
	Move assignment operator. More...

Public Member Functions inherited from List< Face >
	List ()
	Null constructor. More...

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

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

	List (const label, const zero)
	Construct with given size initialising all elements to zero. More...

	List (const List< Face > &)
	Copy constructor. More...

	List (const UList< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< Face > &&)
	Move constructor. More...

	List (List< Face > &, bool reuse)
	Construct as copy or reuse as specified. More...

	List (const UList< Face > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	List (const FixedList< Face, Size > &)
	Construct as copy of FixedList<T, Size> More...

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

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

	List (const UIndirectList< Face > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< Face > &)
	Construct as copy of BiIndirectList<T> More...

	List (std::initializer_list< Face >)
	Construct from an initialiser list. More...

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

label	size () const
	Return the number of elements in the UList. More...

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

	~List ()
	Destructor. More...

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

void	resize (const label, const Face &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const Face &)
	Reset size of List and value for new elements. More...

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

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

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

void	append (const UIndirectList< Face > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< Face > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (DynamicList< Face, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< Face > &)
	Transfer the contents of the argument List into this list. More...

Face &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< Face > &)=delete
	Disallow implicit shallowCopy. More...

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

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

void	operator= (List< Face > &&)
	Move assignment operator. More...

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

void	operator= (const UIndirectList< Face > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< Face > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

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

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

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

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

	UList (const UList< T > &)=default
	Copy construct. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

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

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

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

const bool &	operator[] (const label i) const

Static Public Member Functions
static bool	isTri ()
	Face storage only handles triangulated faces. More...

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

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

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

static wordHashSet	readTypes ()

static wordHashSet	writeTypes ()

static autoPtr< MeshedSurface >	New (const fileName &, const word &ext)
	Select constructed from filename (explicit extension) More...

static autoPtr< MeshedSurface >	New (const fileName &)
	Select constructed from filename (implicit extension) More...

static void	write (const fileName &, const MeshedSurface< Face > &)
	Write to file. More...

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

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

Static Public Member Functions inherited from surfaceFormatsCore
static bool	checkSupport (const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
	... More...

Protected Member Functions
void	transcribe (MeshedSurface< face > &)
	Transfer points/zones and transcribe face -> triFace. More...

void	checkZones ()
	Basic sanity check on zones. More...

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

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

surfZoneList &	storedZones ()
	Non-const access to the zones. More...

void	sortFacesAndStore (List< Face > &&unsortedFaces, List< label > &&zoneIds, const bool sorted)
	Sort faces by zones and store sorted faces. More...

virtual void	remapFaces (const labelUList &faceMap)
	Set new zones from faceMap. More...

void	transcribe (MeshedSurface< face > &surf)

void	transcribe (MeshedSurface< face > &surf)

Protected Member Functions inherited from List< Face >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Friends
template<class Face2 >
class	MeshedSurface

template<class Face2 >
class	UnsortedMeshedSurface

class	surfMesh

Additional Inherited Members
Static Public Attributes inherited from surfaceFormatsCore
static word	nativeExt
	The file extension corresponding to 'native' surface format. More...

Static Protected Member Functions inherited from surfaceFormatsCore
template<class Container >
static List< surfZone >	oneZone (const Container &container, const word &name="zone0")
	Return a list with a single entry,. More...

static string	getLineNoComment (IFstream &)
	Read non-comment line. More...

Detailed Description

template<class Face>
class Foam::MeshedSurface< Face >

A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMesh, which actually refers to the cell faces of a volume mesh.

A MeshedSurface can have zero or more surface zones (roughly equivalent to faceZones for a polyMesh). If surface zones are defined, they must be contiguous and cover all of the faces.

The MeshedSurface is intended for surfaces from a variety of sources.

A set of points and faces without any surface zone information.
A set of points and faces with randomly ordered zone information. This could arise, for example, from reading external file formats such as STL, etc.

Source files

Definition at line 81 of file MeshedSurface.H.

Member Typedef Documentation

◆ FaceType

typedef Face FaceType

Face type used.

Definition at line 151 of file MeshedSurface.H.

Constructor & Destructor Documentation

◆ MeshedSurface() [1/13]

MeshedSurface

Construct null.

Definition at line 159 of file MeshedSurface.C.

◆ MeshedSurface() [2/13]

MeshedSurface	(	pointField &&	pointLst,
		List< Face > &&	faceLst,
		surfZoneList &&	zoneLst
	)

Construct by transferring components (points, faces, zones).

Definition at line 166 of file MeshedSurface.C.

◆ MeshedSurface() [3/13]

MeshedSurface	(	pointField &&	pointLst,
		List< Face > &&	faceLst,
		const labelUList &	zoneSizes = `labelUList()`,
		const UList< word > &	zoneNames = `UList<word>()`
	)

Construct by transferring components (points, faces).

Use zone information if available

Definition at line 181 of file MeshedSurface.C.

◆ MeshedSurface() [4/13]

MeshedSurface ( const MeshedSurface< Face > & )

Copy constructor.

◆ MeshedSurface() [5/13]

MeshedSurface ( const UnsortedMeshedSurface< Face > & surf )

Construct from a UnsortedMeshedSurface.

Definition at line 219 of file MeshedSurface.C.

◆ MeshedSurface() [6/13]

MeshedSurface	(	const polyBoundaryMesh &	bMesh,
		const bool	globalPoints = `false`
	)

Construct from a boundary mesh with local points/faces.

Definition at line 259 of file MeshedSurface.C.

References bMesh, polyMesh::faces(), mesh, primitiveMesh::nFaces(), and primitiveMesh::nInternalFaces().

Here is the call graph for this function:

◆ MeshedSurface() [7/13]

MeshedSurface ( const surfMesh & mesh )

Construct from a surfMesh.

Definition at line 242 of file MeshedSurface.C.

References PrimitivePatch<::Foam::List< Face >, pointField >::clone(), polyMesh::faces(), mesh, polyMesh::points(), and MeshedSurface< Face >::transcribe().

Here is the call graph for this function:

◆ MeshedSurface() [8/13]

MeshedSurface ( UnsortedMeshedSurface< Face > && )

Construct by transferring the contents from a UnsortedMeshedSurface.

◆ MeshedSurface() [9/13]

MeshedSurface ( MeshedSurface< Face > && )

Construct by transferring the contents from a MeshedSurface.

◆ MeshedSurface() [10/13]

MeshedSurface ( const fileName & name )

Construct from file name (uses extension to determine type)

Definition at line 347 of file MeshedSurface.C.

References Foam::name(), and MeshedSurface< Face >::read().

Here is the call graph for this function:

◆ MeshedSurface() [11/13]

MeshedSurface	(	const fileName &	name,
		const word &	ext
	)

Construct from file name (uses extension to determine type)

Definition at line 334 of file MeshedSurface.C.

◆ MeshedSurface() [12/13]

MeshedSurface	(	const Time &	t,
		const word &	surfName = `""`
	)

Construct from database.

Definition at line 356 of file MeshedSurface.C.

◆ ~MeshedSurface()

~MeshedSurface

virtual

Destructor.

Definition at line 393 of file MeshedSurface.C.

◆ MeshedSurface() [13/13]

MeshedSurface ( const MeshedSurface< Face > & surf )

Definition at line 208 of file MeshedSurface.C.

Member Function Documentation

◆ transcribe() [1/3]

void transcribe ( MeshedSurface< face > & )

protected

Transfer points/zones and transcribe face -> triFace.

Referenced by MeshedSurface< Face >::MeshedSurface(), and OFSsurfaceFormat< Face >::read().

Here is the caller graph for this function:

◆ checkZones()

void checkZones

protected

Basic sanity check on zones.

Definition at line 31 of file MeshedSurfaceZones.C.

References Foam::count(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, UList< T >::last(), List< T >::size(), and WarningInFunction.

Here is the call graph for this function:

◆ storedPoints()

pointField& storedPoints ( )

inlineprotected

Non-const access to global points.

Definition at line 117 of file MeshedSurface.H.

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

Referenced by MeshedSurface< Face >::transcribe(), MeshedSurface< Face >::transfer(), surfMesh::transfer(), and UnsortedMeshedSurface< Face >::transfer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storedFaces()

List<Face>& storedFaces ( )

inlineprotected

Non-const access to the faces.

Definition at line 123 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::transcribe(), MeshedSurface< Face >::transfer(), surfMesh::transfer(), and UnsortedMeshedSurface< Face >::transfer().

Here is the caller graph for this function:

◆ storedZones()

surfZoneList& storedZones ( )

inlineprotected

Non-const access to the zones.

Definition at line 129 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::transcribe(), MeshedSurface< Face >::transfer(), and surfMesh::transfer().

Here is the caller graph for this function:

◆ sortFacesAndStore()

void sortFacesAndStore	(	List< Face > &&	unsortedFaces,
		List< label > &&	zoneIds,
		const bool	sorted
	)

protected

Sort faces by zones and store sorted faces.

Definition at line 65 of file MeshedSurfaceZones.C.

References List< T >::clear(), Foam::faceMap(), forAll, Foam::sortedOrder(), and List< T >::transfer().

Here is the call graph for this function:

◆ remapFaces()

void remapFaces ( const labelUList & faceMap )

protectedvirtual

Set new zones from faceMap.

Reimplemented in UnsortedMeshedSurface< Face >.

Definition at line 400 of file MeshedSurface.C.

◆ ClassName()

ClassName ( "MeshedSurface< Face >" )

Runtime type information.

◆ isTri() [1/2]

bool isTri

inlinestatic

Face storage only handles triangulated faces.

Definition at line 42 of file MeshedSurface.C.

◆ canRead()

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

static

Can we read this file format?

Definition at line 99 of file MeshedSurface.C.

References Foam::name().

Here is the call graph for this function:

◆ canReadType()

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

static

Can we read this file format?

Definition at line 65 of file MeshedSurface.C.

◆ canWriteType()

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

static

Can we write this file format?

Definition at line 82 of file MeshedSurface.C.

◆ readTypes()

Foam::wordHashSet readTypes

static

Definition at line 49 of file MeshedSurface.C.

◆ writeTypes()

Foam::wordHashSet writeTypes

static

Definition at line 56 of file MeshedSurface.C.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		MeshedSurface< Face >	,
		fileExtension	,
		(const fileName &name)	,
		(name)
	)

◆ New() [1/2]

Foam::autoPtr< Foam::MeshedSurface< Face > > New	(	const fileName &	name,
		const word &	ext
	)

static

Select constructed from filename (explicit extension)

Definition at line 33 of file MeshedSurfaceNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::found(), InfoInFunction, Foam::name(), Foam::compressible::New(), and Foam::nl.

Here is the call graph for this function:

◆ New() [2/2]

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

static

Select constructed from filename (implicit extension)

Definition at line 72 of file MeshedSurfaceNew.C.

References Foam::name(), and Foam::compressible::New().

Here is the call graph for this function:

◆ declareMemberFunctionSelectionTable()

declareMemberFunctionSelectionTable	(	void	,
		UnsortedMeshedSurface< Face >	,
		write	,
		fileExtension	,
		(const fileName &name, const MeshedSurface< Face > &surf)	,
		(name, surf)
	)

◆ write() [1/3]

void write	(	const fileName &	name,
		const MeshedSurface< Face > &	surf
	)

static

Write to file.

Definition at line 115 of file MeshedSurface.C.

References Foam::endl(), FatalErrorInFunction, HashTable< T, Key, Hash >::found(), InfoInFunction, Foam::name(), and MeshedSurfaceProxy< Face >::write().

Referenced by MeshedSurface< Face >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

label size ( ) const

inline

The surface size is the number of faces.

Definition at line 285 of file MeshedSurface.H.

References List< Face >::size().

Referenced by UnsortedMeshedSurface< Face >::size(), and GTSsurfaceFormat< Face >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faces()

const List<Face>& faces ( ) const

inline

Return const access to the faces.

Definition at line 291 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::operator=(), GTSsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), VTKsurfaceFormat< Face >::write(), STLsurfaceFormat< Face >::writeAscii(), and STLsurfaceFormat< Face >::writeBinary().

Here is the caller graph for this function:

◆ surfZones()

const List<surfZone>& surfZones ( ) const

inline

Const access to the surface zones.

If zones are defined, they must be contiguous and cover the entire surface

Definition at line 299 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::operator=(), UnsortedMeshedSurface< Face >::transfer(), UnsortedMeshedSurface< Face >::UnsortedMeshedSurface(), and GTSsurfaceFormat< Face >::write().

Here is the caller graph for this function:

◆ addZones() [1/3]

void addZones	(	const UList< surfZone > &	srfZones,
		const bool	cullEmpty = `false`
	)

virtual

Add surface zones.

Definition at line 104 of file MeshedSurfaceZones.C.

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

Here is the call graph for this function:

◆ addZones() [2/3]

void addZones	(	const labelUList &	sizes,
		const UList< word > &	names,
		const bool	cullEmpty = `false`
	)

virtual

Add surface zones.

Definition at line 127 of file MeshedSurfaceZones.C.

◆ addZones() [3/3]

void addZones	(	const labelUList &	sizes,
		const bool	cullEmpty = `false`
	)

virtual

Add surface zones.

Definition at line 159 of file MeshedSurfaceZones.C.

References forAll, Foam::name(), List< T >::setSize(), and UList< T >::size().

Here is the call graph for this function:

◆ removeZones()

void removeZones

virtual

Remove surface zones.

Definition at line 190 of file MeshedSurfaceZones.C.

◆ clear()

void clear

virtual

Clear all storage.

Reimplemented in UnsortedMeshedSurface< Face >.

Definition at line 450 of file MeshedSurface.C.

Referenced by OFSsurfaceFormat< Face >::read(), MeshedSurface< Face >::transcribe(), and UnsortedMeshedSurface< Face >::transfer().

Here is the caller graph for this function:

◆ setPoints()

void setPoints ( const pointField & newPoints )

virtual

Reset the points.

Definition at line 461 of file MeshedSurface.C.

◆ scalePoints()

void scalePoints ( const scalar scaleFactor )

virtual

Scale points. A non-positive factor is ignored.

Definition at line 472 of file MeshedSurface.C.

References points.

◆ reset() [1/2]

void reset	(	pointField &&	points,
		List< Face > &&	faces,
		surfZoneList &&	zones
	)

virtual

Reset primitive data (points, faces and zones)

Note, optimised to avoid overwriting data (with null)

Definition at line 488 of file MeshedSurface.C.

References Foam::notNull().

Referenced by OFSsurfaceFormat< Face >::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset() [2/2]

void reset	(	List< point > &&	points,
		List< Face > &&	faces,
		surfZoneList &&	zones
	)

virtual

Reset primitive data (points, faces and zones)

Note, optimised to avoid overwriting data (with null)

Definition at line 517 of file MeshedSurface.C.

References Foam::notNull().

Here is the call graph for this function:

◆ cleanup()

void cleanup ( const bool verbose )

virtual

Remove invalid faces.

Definition at line 547 of file MeshedSurface.C.

References Foam::meshCheck::checkTopology().

Here is the call graph for this function:

◆ stitchFaces()

bool stitchFaces	(	const scalar	tol = `small`,
		const bool	verbose = `false`
	)

virtual

Definition at line 558 of file MeshedSurface.C.

References List< T >::clear(), Foam::endl(), f(), Foam::faceMap(), forAll, InfoInFunction, Foam::mergePoints(), Foam::Pout, List< T >::setSize(), List< T >::size(), and List< T >::transfer().

Here is the call graph for this function:

◆ checkFaces()

bool checkFaces ( const bool verbose = false )

virtual

Definition at line 640 of file MeshedSurface.C.

References Foam::endl(), Foam::exit(), f(), Foam::faceMap(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, points, List< T >::setSize(), List< T >::size(), and WarningInFunction.

Here is the call graph for this function:

◆ triangulate() [1/4]

Foam::label triangulate

virtual

Triangulate in-place, returning the number of triangles added.

Definition at line 793 of file MeshedSurface.C.

Referenced by MeshedSurface< Face >::transcribe().

Here is the caller graph for this function:

◆ triangulate() [2/4]

Foam::label triangulate ( List< label > & faceMap )

virtual

Triangulate in-place, returning the number of triangles added.

and setting a map of original face Ids. The faceMap is zero-sized when no triangulation was done.

Definition at line 803 of file MeshedSurface.C.

References List< T >::clear(), f(), Foam::faceMap(), UList< T >::fcIndex(), forAll, n, Foam::notNull(), points, List< T >::size(), List< T >::transfer(), triFace(), and polygonTriangulate::triPoints().

Here is the call graph for this function:

◆ subsetMesh() [1/2]

Foam::MeshedSurface< Face > subsetMesh	(	const labelHashSet &	include,
		labelList &	pointMap,
		labelList &	faceMap
	)		const

Return new surface.

Returns return pointMap, faceMap from subsetMeshMap

Definition at line 905 of file MeshedSurface.C.

References List< T >::clear(), f(), Foam::faceMap(), forAll, surfZone::size(), List< T >::size(), surfZone::start(), and PatchTools::subsetMap().

Here is the call graph for this function:

◆ subsetMesh() [2/2]

Foam::MeshedSurface< Face > subsetMesh ( const labelHashSet & include ) const

Return new surface.

Definition at line 992 of file MeshedSurface.C.

References Foam::faceMap().

Here is the call graph for this function:

◆ transfer() [1/2]

void transfer ( MeshedSurface< Face > & surf )

Transfer the contents of the argument and annul the argument.

Definition at line 1004 of file MeshedSurface.C.

References MeshedSurface< Face >::storedFaces(), MeshedSurface< Face >::storedPoints(), and MeshedSurface< Face >::storedZones().

Here is the call graph for this function:

◆ transfer() [2/2]

void transfer ( UnsortedMeshedSurface< Face > & surf )

Transfer the contents of the argument and annul the argument.

Definition at line 1019 of file MeshedSurface.C.

References clear(), UnsortedMeshedSurface< Face >::clear(), Foam::faceMap(), forAll, List< T >::size(), UnsortedMeshedSurface< Face >::sortedZones(), MeshedSurface< Face >::storedFaces(), MeshedSurface< Face >::storedPoints(), and List< T >::transfer().

Here is the call graph for this function:

◆ read() [1/2]

bool read	(	const fileName &	name,
		const word &	ext
	)

Read from file. Chooses reader based on explicit extension.

Definition at line 1080 of file MeshedSurface.C.

References clear(), Foam::name(), and Foam::New().

Referenced by MeshedSurface< Face >::MeshedSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [2/2]

bool read ( const fileName & name )

virtual

Read from file. Chooses reader based on detected extension.

Reimplemented in UnsortedMeshedSurface< Face >, VTKsurfaceFormat< Face >, TRIsurfaceFormat< Face >, STLsurfaceFormat< Face >, STARCDsurfaceFormat< Face >, OFSsurfaceFormat< Face >, OFFsurfaceFormat< Face >, OBJsurfaceFormat< Face >, NASsurfaceFormat< Face >, GTSsurfaceFormat< Face >, and AC3DsurfaceFormat< Face >.

Definition at line 1063 of file MeshedSurface.C.

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

Here is the call graph for this function:

◆ writeStats()

void writeStats ( Ostream & os ) const

Definition at line 33 of file MeshedSurfaceIO.C.

References Foam::endl(), forAll, n, Foam::nl, and points.

Here is the call graph for this function:

◆ write() [2/3]

virtual void write ( const fileName & name ) const

inlinevirtual

Generic write routine. Chooses writer based on extension.

Reimplemented in UnsortedMeshedSurface< Face >, X3DsurfaceFormat< Face >, WRLsurfaceFormat< Face >, VTKsurfaceFormat< Face >, TRIsurfaceFormat< Face >, STLsurfaceFormat< Face >, STARCDsurfaceFormat< Face >, SMESHsurfaceFormat< Face >, OFSsurfaceFormat< Face >, OFFsurfaceFormat< Face >, OBJsurfaceFormat< Face >, GTSsurfaceFormat< Face >, and AC3DsurfaceFormat< Face >.

Definition at line 418 of file MeshedSurface.H.

References Foam::name(), and MeshedSurface< Face >::write().

Here is the call graph for this function:

◆ write() [3/3]

void write	(	const Time &	t,
		const word &	surfName = `""`
	)		const

Write to database.

Definition at line 1095 of file MeshedSurface.C.

References MeshedSurfaceProxy< Face >::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const MeshedSurface< Face > & )

Definition at line 1108 of file MeshedSurface.C.

References clear(), MeshedSurface< Face >::faces(), PrimitivePatch< FaceList, PointField >::points(), and MeshedSurface< Face >::surfZones().

Here is the call graph for this function:

◆ operator MeshedSurfaceProxy< Face >()

operator MeshedSurfaceProxy< Face > ( ) const

Conversion operator to MeshedSurfaceProxy.

◆ isTri() [2/2]

bool isTri ( )

inline

Specialisation for holding triangulated information.

Definition at line 440 of file MeshedSurface.H.

◆ triangulate() [3/4]

label triangulate ( )

inline

Specialisation for holding triangulated information.

Definition at line 448 of file MeshedSurface.H.

◆ triangulate() [4/4]

label triangulate ( List< label > & faceMap )

inline

Specialisation for holding triangulated information.

Definition at line 456 of file MeshedSurface.H.

References Foam::faceMap(), and Foam::notNull().

Here is the call graph for this function:

◆ transcribe() [2/3]

void transcribe ( MeshedSurface< face > & surf )

protected

Definition at line 35 of file MeshedSurfaceCore.C.

References MeshedSurface< Face >::clear(), forAll, List< T >::size(), MeshedSurface< Face >::storedFaces(), MeshedSurface< Face >::storedPoints(), MeshedSurface< Face >::storedZones(), MeshedSurface< Face >::triangulate(), and triFace().

Here is the call graph for this function:

◆ transcribe() [3/3]

void transcribe ( MeshedSurface< face > & surf )

protected

Definition at line 60 of file MeshedSurfaceCore.C.

Friends And Related Function Documentation

◆ MeshedSurface

friend class MeshedSurface

friend

Definition at line 87 of file MeshedSurface.H.

◆ UnsortedMeshedSurface

friend class UnsortedMeshedSurface

friend

Definition at line 88 of file MeshedSurface.H.

◆ surfMesh

friend class surfMesh

friend

Definition at line 89 of file MeshedSurface.H.

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

src/surfMesh/MeshedSurface/MeshedSurface.H
src/surfMesh/MeshedSurface/MeshedSurface.C
src/surfMesh/MeshedSurface/MeshedSurfaceIO.C
src/surfMesh/MeshedSurface/MeshedSurfaceNew.C
src/surfMesh/MeshedSurface/MeshedSurfaceZones.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

template<class Face> class Foam::MeshedSurface< Face >

Member Typedef Documentation

◆ FaceType

Constructor & Destructor Documentation

◆ MeshedSurface() [1/13]

◆ MeshedSurface() [2/13]

◆ MeshedSurface() [3/13]

◆ MeshedSurface() [4/13]

◆ MeshedSurface() [5/13]

◆ MeshedSurface() [6/13]

◆ MeshedSurface() [7/13]

◆ MeshedSurface() [8/13]

◆ MeshedSurface() [9/13]

◆ MeshedSurface() [10/13]

◆ MeshedSurface() [11/13]

◆ MeshedSurface() [12/13]

◆ ~MeshedSurface()

◆ MeshedSurface() [13/13]

Member Function Documentation

◆ transcribe() [1/3]

◆ checkZones()

◆ storedPoints()

◆ storedFaces()

◆ storedZones()

◆ sortFacesAndStore()

◆ remapFaces()

◆ ClassName()

◆ isTri() [1/2]

◆ canRead()

◆ canReadType()

◆ canWriteType()

◆ readTypes()

◆ writeTypes()

◆ declareRunTimeSelectionTable()

◆ New() [1/2]

◆ New() [2/2]

◆ declareMemberFunctionSelectionTable()

◆ write() [1/3]

◆ size()

◆ faces()

◆ surfZones()

◆ addZones() [1/3]

◆ addZones() [2/3]

◆ addZones() [3/3]

◆ removeZones()

◆ clear()

◆ setPoints()

◆ scalePoints()

◆ reset() [1/2]

◆ reset() [2/2]

◆ cleanup()

◆ stitchFaces()

◆ checkFaces()

◆ triangulate() [1/4]

◆ triangulate() [2/4]

◆ subsetMesh() [1/2]

◆ subsetMesh() [2/2]

◆ transfer() [1/2]

◆ transfer() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ writeStats()

◆ write() [2/3]

◆ write() [3/3]

◆ operator=()

◆ operator MeshedSurfaceProxy< Face >()

◆ isTri() [2/2]

◆ triangulate() [3/4]

◆ triangulate() [4/4]

◆ transcribe() [2/3]

◆ transcribe() [3/3]

Friends And Related Function Documentation

◆ MeshedSurface

template<class Face>
class Foam::MeshedSurface< Face >