Read/write VTK legacy format (ASCII) for surfaces. More...

#include <VTKsurfaceFormat.H>

Inheritance diagram for VTKsurfaceFormat< Face >:

[legend]

Collaboration diagram for VTKsurfaceFormat< Face >:

[legend]

Public Member Functions
	VTKsurfaceFormat (const fileName &filename)
	Construct from file name.
virtual	~VTKsurfaceFormat ()=default
	Destructor.
virtual bool	read (const fileName &filename) override
	Read from file.
virtual void	write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const override
	Write surface mesh to file (by proxy).
virtual void	write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const override
	Write surface mesh to file (by proxy).
Public Member Functions inherited from MeshedSurface< Face >
	ClassName ("MeshedSurface")
	Declare type-name (with debug switch).
	MeshedSurface ()
	Default construct, an empty surface.
	MeshedSurface (const MeshedSurface &surf)
	Copy construct.
	MeshedSurface (const UnsortedMeshedSurface< Face > &surf)
	Copy construct from an UnsortedMeshedSurface.
	MeshedSurface (MeshedSurface &&surf)
	Move construct.
	MeshedSurface (UnsortedMeshedSurface< Face > &&surf)
	Move construct from an UnsortedMeshedSurface.
	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst)
	Copy construct from components (points, faces, zones).
	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst)
	Move construct from components (points, faces).
	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Copy construct from components (points, faces).
	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Move construct from components (points, faces).
	MeshedSurface (const polyBoundaryMesh &pbm, const bool globalPoints=false)
	Construct from a boundary mesh with local points/faces.
	MeshedSurface (const surfMesh &mesh)
	Construct from a surfMesh.
	MeshedSurface (const fileName &name)
	Construct from file name (uses extension to determine type).
	MeshedSurface (const fileName &name, const word &fileType)
	Construct from file name and given file type.
	MeshedSurface (Istream &is)
	Construct from Istream.
	MeshedSurface (const Time &runTime)
	Construct from database (as surfMesh) with default name.
	MeshedSurface (const Time &runTime, const word &surfName)
	Construct from database (as surfMesh) with given surface name.
	MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
	Read construct using IO to find the file location.
	declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name))
virtual	~MeshedSurface ()
	Destructor.
	declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options))
label	size () const
	The surface size is the number of faces.
const List< Face > &	surfFaces () const
	Return const access to the faces.
const labelList &	faceIds () const
	Return const access to faces ids.
const surfZoneList &	surfZones () const
	Const access to the surface zones.
const vectorField &	Sf () const
	Face area vectors (normals).
const scalarField &	magSf () const
	Face area magnitudes.
const vectorField &	Cf () const
	Face centres.
virtual void	clear ()
	Clear all storage.
virtual void	addZones (const UList< surfZone > &, const bool cullEmpty=false)
	Add surface zones.
virtual void	addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
	Add surface zones.
virtual void	addZones (const labelUList &sizes, const bool cullEmpty=false)
	Add surface zones.
bool	addZonesToFaces ()
	Propagate zone information on face regions.
virtual void	removeZones ()
	Remove surface zones.
virtual void	movePoints (const pointField &newPoints)
	Move points.
virtual void	scalePoints (const scalar scaleFactor)
	Scale points. A non-positive factor is ignored.
virtual void	cleanup (const bool verbose)
	Remove invalid faces.
virtual void	compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null()))
	Remove unused points and renumber faces in local visit order.
virtual bool	stitchFaces (const scalar tol=SMALL, const bool verbose=false)
virtual bool	checkFaces (const bool verbose=false)
virtual label	nTriangles () const
	Count number of triangles.
virtual label	nTriangles (labelList &faceMap) const
	Count number of triangles, returning a face map of original ids.
virtual label	triangulate ()
	Triangulate in-place, returning the number of triangles added.
virtual label	triangulate (labelList &faceMap)
	Triangulate in-place, returning the number of triangles added.
template<class BoolListType>
void	subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
	Create mappings for a sub-surface.
MeshedSurface	subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces.
MeshedSurface	subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces.
MeshedSurface	subsetMesh (const UList< bool > &include) const
	Return a new surface subsetted on the selected faces.
MeshedSurface	subsetMesh (const bitSet &include) const
	Return a new surface subsetted on the selected faces.
MeshedSurface	subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const
	Return a new surface subsetted on the selected zone names.
void	swap (MeshedSurface< Face > &surf)
	Swap contents.
void	transfer (pointField &pointLst, List< Face > &faceLst)
	Transfer the components.
void	transfer (MeshedSurface< Face > &surf)
	Transfer the contents of the argument and annul the argument.
void	transfer (UnsortedMeshedSurface< Face > &surf)
	Transfer the contents of the argument and annul the argument.
autoPtr< MeshedSurface< Face > >	releaseGeom ()
	Release (clear) geometry and return for reuse.
void	swapFaces (List< Face > &faces)
	Swap the stored faces. Use with caution.
void	swapPoints (pointField &points)
	Swap the stored points.
bool	read (const fileName &name, const word &fileType)
	Read from file. Chooses reader based on explicit extension.
void	writeStats (Ostream &os) const
void	write (const Time &runTime, const word &surfName=word::null) const
	Write to database.
void	operator= (const MeshedSurface< Face > &surf)
	Copy assignment.
void	operator= (MeshedSurface< Face > &&surf)
	Move assignment.
	operator MeshedSurfaceProxy< Face > () const
	Conversion operator to MeshedSurfaceProxy.
template<class Face>
	MeshedSurface (const MeshedSurface< Face > &surf)
template<class Face>
	MeshedSurface (MeshedSurface< Face > &&surf)
bool	addZonesToFaces ()
	Specialization for labelledTri.
bool	addZonesToFaces ()
Public Member Functions inherited from PrimitivePatch<::Foam::List< Face >, pointField >
	PrimitivePatch (const ::Foam::List< Face > &faces, const pointField &points)
	Construct from components.
	PrimitivePatch (::Foam::List< Face > &&faces, const pointField &points)
	Construct from components, transferring faces.
	PrimitivePatch (::Foam::List< Face > &faces, pointField &points, const bool reuse)
	Construct from components, reuse storage.
	PrimitivePatch (const PrimitivePatch< ::Foam::List< Face >, pointField > &pp)
	Copy construct.
virtual	~PrimitivePatch ()
	Destructor.
void	clearOut ()
void	clearGeom ()
void	clearTopology ()
void	clearPatchMeshAddr ()
void	swap (PrimitivePatch &)=delete
	Suppress direct swapping, since storage containers may be const.
const Field< point_type > &	points () const noexcept
	Return reference to global points.
label	nFaces () const noexcept
	Number of faces in the patch.
label	nPoints () const
	Number of points supporting patch faces.
label	nEdges () const
	Number of edges in patch.
const edgeList &	edges () const
	Return list of edges, address into LOCAL point list.
const edgeList::subList	internalEdges () const
	Return sub-list of internal edges, address into LOCAL point list.
const edgeList::subList	boundaryEdges () const
	Return sub-list of boundary edges, address into LOCAL point list.
label	nInternalEdges () const
	Number of internal edges.
label	nBoundaryEdges () const
	Number of boundary edges == (nEdges() - nInternalEdges()).
bool	isInternalEdge (const label edgei) const
	Is internal edge?
const labelList &	boundaryPoints () const
	Return list of boundary points, address into LOCAL point list.
const labelListList &	faceFaces () const
	Return face-face addressing.
const labelListList &	edgeFaces () const
	Return edge-face addressing.
const labelListList &	faceEdges () const
	Return face-edge addressing.
const labelListList &	pointEdges () const
	Return point-edge addressing.
const labelListList &	pointFaces () const
	Return point-face addressing.
const List< face_type > &	localFaces () const
	Return patch faces addressing into local point list.
labelList	boundaryFaces () const
	Extract list of local faces corresponding to the boundary edges.
labelList	uniqBoundaryFaces () const
	Extract sorted list of unique local faces associated with the boundary edges.
const labelList &	meshPoints () const
	Return labelList of mesh points in patch.
const Map< label > &	meshPointMap () const
	Mesh point map.
const Field< point_type > &	localPoints () const
	Return pointField of points in patch.
const labelList &	localPointOrder () const
	Return orders the local points for most efficient search.
label	whichPoint (const label gp) const
	Given a global point index, return the local point index.
edge	meshEdge (const label edgei) const
	From patch edge to global edge using meshPoints.
edge	meshEdge (const edge &e) const
	From patch edge to global edge using meshPoints.
label	findEdge (const edge &e) const
	Search for edge (local point labels) and return its index in the edge list or -1 if not found.
labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using cell addressing.
labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges into the global edge list using basic edge addressing.
label	meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const
	Return label of the local patch edge into the global edge list using basic edge addressing.
labelList	meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of specified patch edges into the global edge list using basic edge addressing.
const Field< point_type > &	faceCentres () const
	Return face centres for patch.
const Field< point_type > &	faceAreas () const
	Return face area vectors for patch.
const Field< scalar > &	magFaceAreas () const
	Return face area magnitudes for patch.
const Field< point_type > &	faceNormals () const
	Return face unit normals for patch.
const Field< point_type > &	pointNormals () const
	Return point normals for patch.
Pair< point_type >	box () const
	The enclosing (bounding) box for the patch points.
scalar	sphere (const label facei) const
	The enclosing (bounding) sphere radius^2 for specified face.
bool	hasFaceAreas () const
bool	hasFaceCentres () const
bool	hasFaceNormals () const
bool	hasPointNormals () const
bool	hasBoundaryPoints () const
bool	hasEdges () const
bool	hasFaceFaces () const
bool	hasEdgeFaces () const
bool	hasFaceEdges () const
bool	hasPointEdges () const
bool	hasPointFaces () const
bool	hasMeshPoints () 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.
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.
const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices.
surfaceTopo	surfaceType (labelHashSet *badEdgesPtr=nullptr) const
	Calculate surface type formed by patch, optionally recording the indices of illegal edges.
bool	checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above).
bool	checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
	Checks primitivePatch for faces sharing point but not edge.
virtual void	movePoints (const Field< point_type > &)
	Correct patch after moving points.
void	operator= (const PrimitivePatch< ::Foam::List< Face >, pointField > &rhs)
	Copy assign faces. Leave points alone (could be a reference).
void	operator= (PrimitivePatch< ::Foam::List< Face >, pointField > &&rhs)
	Move assign faces. Leave points alone (could be a reference).
label	whichEdge (const edge &e) const
	Identical to findEdge.
Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< Face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< Face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
Public Member Functions inherited from PrimitivePatchBase
	ClassName ("PrimitivePatch")
	Runtime type information.
	PrimitivePatchBase ()=default
	Default construct.
Public Member Functions inherited from List< T >
constexpr	List () noexcept
	Default construct.
	List (const label len)
	Construct with given size.
	List (const label len, const T &val)
	Construct with given size and value for all elements.
	List (const label len, Foam::zero)
	Construct with given size initializing all elements to zero.
	List (Foam::one, const T &val)
	Construct with length=1, copying the value as the only content.
	List (Foam::one, T &&val)
	Construct with length=1, moving the value as the only content.
	List (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	List (const List< T > &list)
	Copy construct from list.
	List (const UList< T > &list)
	Copy construct contents from list.
	List (List< T > &list, bool reuse)
	Construct as copy or re-use as specified.
	List (const UList< T > &list, const labelUList &indices)
	Copy construct subset of list.
template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct subset of list.
template<unsigned N>
	List (const FixedList< T, N > &list)
	Construct as copy of FixedList<T, N>.
	List (const UPtrList< T > &list)
	Construct as copy of UPtrList<T> content.
template<class Addr>
	List (const IndirectListBase< T, Addr > &list)
	Construct as copy of IndirectList contents.
	List (std::initializer_list< T > list)
	Construct from an initializer list.
	List (List< T > &&list) noexcept
	Move construct from List.
template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	Move construct from DynamicList.
	List (Istream &is)
	Construct from Istream.
autoPtr< List< T > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize (const label len)
	Adjust allocated size of list.
void	resize (const label len, const T &val)
	Adjust allocated size of list and set val for new elements.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const T &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< T > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
T &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
template<class... Args>
T &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const T &val)
	Append an element at the end of the list.
void	push_back (T &&val)
	Move append an element at the end of the list.
void	push_back (const UList< T > &list)
	Append a List to the end of this list.
template<class Addr>
void	push_back (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list.
label	push_uniq (const T &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< T > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (const List< T > &list)
	Assignment operator. Takes linear time.
template<class Addr>
void	operator= (const IndirectListBase< T, Addr > &list)
	Assignment from IndirectList. Takes linear time.
template<unsigned N>
void	operator= (const FixedList< T, N > &list)
	Copy assignment from FixedList.
void	operator= (std::initializer_list< T > list)
	Assignment to an initializer list.
void	operator= (const T &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
void	operator= (List< T > &&list)
	Move assignment. Takes constant time.
template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
	Move assignment. Takes constant time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< T > &)=delete
	No shallowCopy permitted.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const T &val)
	Append an element at the end of the list.
void	append (T &&val)
	Move append an element at the end of the list.
void	append (const UList< T > &list)
	Append a List to the end of this list.
template<class Addr>
void	append (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list.
label	appendUniq (const T &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
void	setSize (label n, const T &val)
	Alias for resize().
template<typename E>
	List (const Expression::ListExpression< E > &expr)
	Construct from value expression.
template<typename E>
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	resize (const label len)
Public Member Functions inherited from UList< T >
	UList (const UList< T > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< T > &&) noexcept=default
	Move construct, shallow copy.
UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy).
UList< T > &	operator= (UList< T > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (T *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< T > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
T *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
T &	front ()
	Access first element of the list, position [0].
const T &	front () const
	Access first element of the list.
T &	back ()
	Access last element of the list, position [size()-1].
const T &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const T &val) const
	True if the value is contained in the list.
bool	contains (const T &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const T &val) const
	Find index of the first occurrence of the value.
label	find (const T &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (T *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< T > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match!
template<class Addr>
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
T &	operator[] (const label i)
	Return element of UList.
const T &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&.
void	operator= (const T &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< T > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< T > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< T > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< T > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< T > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	all () const
	True if all entries are 'true' or if the list is empty.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	any () const
	True if any entries are 'true'.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	none () const
	True if no entries are 'true'.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_char_v<TypeT>>>
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
T &	first ()
	Access first element of the list, position [0].
const T &	first () const
	Access first element of the list.
T &	last ()
	Access last element of the list, position [size()-1].
const T &	last () const
	Access last element of the list, position [size()-1].
bool	found (const T &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
template<typename E>
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
Public Member Functions inherited from surfaceFormatsCore
	surfaceFormatsCore ()=default
	Default construct.
virtual	~surfaceFormatsCore ()=default
	Destructor.

Static Public Member Functions
static void	write (const fileName &filename, const MeshedSurfaceProxy< Face > &surf, IOstreamOption=IOstreamOption(), const dictionary &options=dictionary::null)
	Write surface mesh components (by proxy) in legacy VTK format.
static void	write (const fileName &fileName, const UnsortedMeshedSurface< Face > &surf, IOstreamOption=IOstreamOption(), const dictionary &options=dictionary::null)
	Write UnsortedMeshedSurface, the output remains unsorted.
Static Public Member Functions inherited from MeshedSurface< Face >
static wordHashSet	readTypes ()
	Known readable file-types, without friends or proxies.
static wordHashSet	writeTypes ()
	Known writable file-types, without friends or proxies.
static bool	canReadType (const word &fileType, bool verbose=false)
	Can we read this file format? Also checks friend types.
static bool	canWriteType (const word &fileType, bool verbose=false)
	Can we write this file format? Also checks proxy types.
static bool	canRead (const fileName &name, bool verbose=false)
	Can we read this file format?
static autoPtr< MeshedSurface >	New (const fileName &name, const word &fileType, bool mandatory=true)
	Read construct from filename with given file type.
static autoPtr< MeshedSurface >	New (const fileName &name)
	Read construct from filename (file type implicit from extension).
static void	write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file, selecting writer based on its extension.
static void	write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file, selecting writer based on the given extension.
Static Public Member Functions inherited from List< T >
static const List< T > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< T >
static const UList< T > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.
Static Public Member Functions inherited from surfaceFormatsCore
static bool	checkSupport (const wordHashSet &available, const word &fileType, const bool verbose=false, const char *functionName=nullptr)
	Verbose checking of fileType in the list of available types.
static fileName	findFile (const IOobject &io, const bool isGlobal=true)
	Use IOobject information to resolve file to load from, or empty if the file does not exist.
static fileName	findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
	Use IOobject information to resolve file to load from, or empty if the file does not exist.

Additional Inherited Members
Public Types inherited from MeshedSurface< Face >
typedef Face	face_type
	The face type (same as the underlying PrimitivePatch).
typedef point	point_type
	The point type (same as the underlying PrimitivePatch).
Public Types inherited from PrimitivePatch<::Foam::List< Face >, pointField >
enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...
typedef std::remove_reference< ::Foam::List< Face > >::type::value_type	face_type
	The face type.
typedef std::remove_reference< pointField >::type::value_type	point_type
	The point type.
typedef ::Foam::List< Face >	FaceListType
	The face list type.
typedef pointField	PointFieldType
	The point field type.
typedef face_type	FaceType
	Deprecated(2020-03) prefer face_type typedef.
Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList.
Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains.
typedef T *	pointer
	The pointer type for non-const access to value_type items.
typedef const T *	const_pointer
	The pointer type for const access to value_type items.
typedef T &	reference
	The type used for storing into value_type objects.
typedef const T &	const_reference
	The type used for reading from constant value_type objects.
typedef T *	iterator
	Random access iterator for traversing a UList.
typedef const T *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List = void
	Have unique tag.
Static Public Attributes inherited from surfaceFormatsCore
static word	nativeExt
	The file extension corresponding to 'native' surface format.
Protected Member Functions inherited from MeshedSurface< Face >
void	transcribe (MeshedSurface< face > &surf)
	Transfer points/zones from 'face' to other other shapes.
void	checkZones (const bool verbose=true)
	Sanity check/resizing on zones.
pointField &	storedPoints ()
	Non-const access to global points.
List< Face > &	storedFaces ()
	Non-const access to the faces.
labelList &	storedFaceIds ()
	Non-const access to face ids.
surfZoneList &	storedZones ()
	Non-const access to the zones.
void	sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted)
	Sort faces by zones and store sorted faces.
virtual void	remapFaces (const labelUList &faceMapNewToOld)
	Set new zones from faceMap.
void	transcribe (MeshedSurface< face > &surf)
void	transcribe (MeshedSurface< face > &surf)
void	transcribe (MeshedSurface< face > &surf)
Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const T &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.
Static Protected Member Functions inherited from surfaceFormatsCore
static string	getLineNoComment (ISstream &is, const char comment='#')
	Read non-empty and non-comment line.
template<class Container>
static List< surfZone >	oneZone (const Container &container, const word &name="zone0")
	Return a surfZone list with a single entry, the size of which corresponds to that of the container.
static labelList	getSelectedPatches (const surfZoneList &patches, const wordRes &allow, const wordRes &deny=wordRes())
	Return ids for zone/patch that match by name.
static fileName	relativeFilePath (const IOobject &io, const fileName &f, const bool isGlobal=true)
	Return fileName.
static fileName	checkFile (const IOobject &io, const bool isGlobal=true)
	Return fileName to load IOobject from.
static fileName	checkFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
	Return fileName to load IOobject from.
Static Protected Member Functions inherited from VTKsurfaceFormatCore
static vtk::outputOptions	formatOptions (const dictionary &dict, vtk::outputOptions opts=vtk::formatType::LEGACY_ASCII)
	Extract format options (default format LEGACY_ASCII).
static void	writeHeader (vtk::formatter &format, const UList< point > &pts)
	Write header information with points.
static void	writeCellData (vtk::formatter &format, const UList< surfZone > &zones)
	Write regions (zones) information as CellData.
static void	writeCellData (vtk::formatter &format, const labelUList &zoneIds)
	Write regions (zones) information as CellData.

Detailed Description

template<class Face>
class Foam::fileFormats::VTKsurfaceFormat< Face >

Read/write VTK legacy format (ASCII) for surfaces.

The output is never sorted by zone.

Output stream options: ignored (dictionary options only)

Format options

Property	Description	Required	Default
`format`	ascii or binary format	no	ascii
`precision`	Write precision in ascii	no	same as IOstream

Source files

Definition at line 79 of file VTKsurfaceFormat.H.

Constructor & Destructor Documentation

◆ VTKsurfaceFormat()

template<class Face>

VTKsurfaceFormat ( const fileName & filename )

explicit

Construct from file name.

Definition at line 69 of file VTKsurfaceFormat.C.

References read().

Here is the call graph for this function:

◆ ~VTKsurfaceFormat()

template<class Face>

virtual ~VTKsurfaceFormat ( )

virtualdefault

Destructor.

References dictionary::null, and MeshedSurface< Face >::UnsortedMeshedSurface.

Here is the call graph for this function:

Member Function Documentation

◆ write() [1/4]

template<class Face>

void write	(	const fileName &	filename,
		const MeshedSurfaceProxy< Face > &	surf,
		IOstreamOption	= IOstreamOption(),
		const dictionary &	options = dictionary::null )

static

Write surface mesh components (by proxy) in legacy VTK format.

Definition at line 239 of file VTKsurfaceFormat.C.

References Foam::vtk::legacy::beginPolys(), f(), Foam::faceMap(), MeshedSurfaceProxy< Face >::faceMap(), forAll, format(), formatOptions(), outputOptions::newFormatter(), surfaceFormatsCore::oneZone(), os(), MeshedSurfaceProxy< Face >::points(), UList< T >::size(), MeshedSurfaceProxy< Face >::surfFaces(), MeshedSurfaceProxy< Face >::surfZones(), MeshedSurfaceProxy< Face >::useFaceMap(), VTKsurfaceFormatCore::writeCellData(), VTKsurfaceFormatCore::writeHeader(), and Foam::vtk::writeList().

Here is the call graph for this function:

◆ write() [2/4]

template<class Face>

void write	(	const fileName &	fileName,
		const UnsortedMeshedSurface< Face > &	surf,
		IOstreamOption	= IOstreamOption(),
		const dictionary &	options = dictionary::null )

static

Write UnsortedMeshedSurface, the output remains unsorted.

Definition at line 313 of file VTKsurfaceFormat.C.

References format(), formatOptions(), outputOptions::newFormatter(), os(), PrimitivePatch< FaceList, PointField >::points(), MeshedSurface< Face >::surfFaces(), MeshedSurface< Face >::UnsortedMeshedSurface, VTKsurfaceFormatCore::writeCellData(), VTKsurfaceFormatCore::writeHeader(), and UnsortedMeshedSurface< Face >::zoneIds().

Here is the call graph for this function:

◆ read()

template<class Face>

bool read ( const fileName & filename )

overridevirtual

Read from file.

Reimplemented from MeshedSurface< Face >.

Definition at line 81 of file VTKsurfaceFormat.C.

References MeshedSurface< Face >::addZones(), MeshedSurface< Face >::addZonesToFaces(), DynamicList< T, SizeMin >::append(), vtkUnstructuredReader::cellData(), clear(), List< T >::clear(), surfZoneIdentifier::defaultName(), Foam::exit(), f(), vtkUnstructuredReader::faces(), Foam::FatalError, FatalErrorInFunction, objectRegistry::findObject(), forAll, IOstream::good(), faceTraits< FaceType >::isTri(), Foam::max(), Time::New(), Foam::nl, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, vtkUnstructuredReader::points(), UList< T >::size(), MeshedSurface< Face >::sortFacesAndStore(), MeshedSurface< Face >::storedPoints(), and Foam::Zero.

Referenced by VTKsurfaceFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [3/4]

template<class Face>

virtual void write	(	const fileName &	name,
		IOstreamOption	streamOpt = IOstreamOption(),
		const dictionary &	options = dictionary::null ) const

inlineoverridevirtual

Write surface mesh to file (by proxy).

Reimplemented from MeshedSurface< Face >.

Definition at line 147 of file VTKsurfaceFormat.H.

References Foam::name(), dictionary::null, and write().

Here is the call graph for this function:

◆ write() [4/4]

template<class Face>

virtual void write	(	const fileName &	name,
		const word &	fileType,
		IOstreamOption	streamOpt = IOstreamOption(),
		const dictionary &	options = dictionary::null ) const

inlineoverridevirtual

Write surface mesh to file (by proxy).

Reimplemented from MeshedSurface< Face >.

Definition at line 160 of file VTKsurfaceFormat.H.

References Foam::name(), dictionary::null, and write().

Here is the call graph for this function:

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

src/surfMesh/surfaceFormats/vtk/VTKsurfaceFormat.H
src/surfMesh/surfaceFormats/vtk/VTKsurfaceFormat.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VTKsurfaceFormat()

◆ ~VTKsurfaceFormat()

Member Function Documentation

◆ write() [1/4]

◆ write() [2/4]

◆ read()

◆ write() [3/4]

◆ write() [4/4]