Public Member Functions | Static Public Member Functions | List of all members
VTKsurfaceFormat< Face > Class Template Reference

Provide a means of reading/writing VTK legacy format. The output is never sorted by zone. More...

Inheritance diagram for VTKsurfaceFormat< Face >:
Inheritance graph
[legend]
Collaboration diagram for VTKsurfaceFormat< Face >:
Collaboration graph
[legend]

Public Member Functions

 VTKsurfaceFormat (const fileName &)
 Construct from file name. More...
 
virtual ~VTKsurfaceFormat ()
 Destructor. More...
 
virtual bool read (const fileName &)
 Read from file. More...
 
virtual void write (const fileName &name) const
 Write object file. More...
 
- Public Member Functions inherited from MeshedSurface< Face >
 ClassName ("MeshedSurface")
 Runtime type information. More...
 
 MeshedSurface ()
 Construct null. More...
 
 MeshedSurface (const Xfer< pointField > &, const Xfer< List< Face > > &, const Xfer< surfZoneList > &)
 Construct by transferring components (points, faces, zones). More...
 
 MeshedSurface (const Xfer< pointField > &, const Xfer< List< Face > > &, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
 Construct by transferring components (points, faces). More...
 
 MeshedSurface (const MeshedSurface &)
 Construct as copy. 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 (const Xfer< UnsortedMeshedSurface< Face > > &)
 Construct by transferring the contents from a UnsortedMeshedSurface. More...
 
 MeshedSurface (const Xfer< 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 movePoints (const pointField &)
 Move points. More...
 
virtual void scalePoints (const scalar)
 Scale points. A non-positive factor is ignored. More...
 
virtual void reset (const Xfer< pointField > &points, const Xfer< List< Face > > &faces, const Xfer< surfZoneList > &zones)
 Reset primitive data (points, faces and zones) More...
 
virtual void reset (const Xfer< List< point > > &points, const Xfer< List< Face > > &faces, const Xfer< 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...
 
Xfer< MeshedSurface< Face > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool read (const fileName &, const word &ext)
 Read from file. Chooses reader based on explicit extension. More...
 
void writeStats (Ostream &os) const
 
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)
 
template<>
bool isTri ()
 Specialization for holding triangulated information. More...
 
template<>
label triangulate ()
 Specialization for holding triangulated information. More...
 
template<>
label triangulate (List< label > &faceMap)
 Specialization for holding triangulated information. More...
 
- Public Member Functions inherited from PrimitivePatch< Face,::Foam::List, pointField, point >
 PrimitivePatch (const ::Foam::List< Face > &faces, const Field< point > &points)
 Construct from components. More...
 
 PrimitivePatch (const Xfer< ::Foam::List< Face > > &faces, const Xfer< List< point > > &points)
 Construct from components. More...
 
 PrimitivePatch (::Foam::List< Face > &faces, Field< point > &points, const bool reUse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< Face,::Foam::List, pointField, point > &)
 Construct as copy. More...
 
virtual ~PrimitivePatch ()
 Destructor. More...
 
void clearOut ()
 
void clearGeom ()
 
void clearTopology ()
 
void clearPatchMeshAddr ()
 
const Field< point > & 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 edgeListedges () 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 labelListboundaryPoints () const
 Return list of boundary points,. More...
 
const labelListListfaceFaces () const
 Return face-face addressing. More...
 
const labelListListedgeFaces () const
 Return edge-face addressing. More...
 
const labelListListfaceEdges () const
 Return face-edge addressing. More...
 
const labelListListpointEdges () const
 Return point-edge addressing. More...
 
const labelListListpointFaces () const
 Return point-face addressing. More...
 
const List< Face > & localFaces () const
 Return patch faces addressing into local point list. More...
 
const labelListmeshPoints () 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< point > & localPoints () const
 Return pointField of points in patch. More...
 
const labelListlocalPointOrder () 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< point > & faceCentres () const
 Return face centres for patch. More...
 
const Field< point > & faceNormals () const
 Return face normals for patch. More...
 
const Field< point > & pointNormals () const
 Return point normals for patch. More...
 
List< objectHitprojectPoints (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch. More...
 
List< objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch. More...
 
const labelListListedgeLoops () 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=NULL) const
 Check surface formed by patch for manifoldness (see above). More...
 
bool checkPointManifold (const bool report=false, labelHashSet *setPtr=NULL) const
 Checks primitivePatch for faces sharing point but not edge. More...
 
virtual void movePoints (const Field< point > &)
 Correct patch after moving points. More...
 
void operator= (const PrimitivePatch< Face,::Foam::List, pointField, point > &)
 Assignment. More...
 
- Public Member Functions inherited from List< Face >
label size () const
 Return the number of elements in the UList. More...
 
 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 List< Face > &)
 Copy constructor. More...
 
 List (const Xfer< List< Face > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< Face > &, bool reUse)
 Construct as copy or re-use 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 (Istream &)
 Construct from Istream. 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...
 
Xfer< List< Face > > xfer ()
 Transfer contents to the Xfer container. More...
 
Face & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< Face > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< Face > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Face > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Face > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Face > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const Face &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. 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 Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () 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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (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...
 
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...
 
template<>
const bool & operator[] (const label i) const
 
- Public Member Functions inherited from surfaceFormatsCore
 surfaceFormatsCore ()
 Construct null. More...
 
virtual ~surfaceFormatsCore ()
 Destructor. More...
 

Static Public Member Functions

static autoPtr< MeshedSurface< Face > > New (const fileName &name)
 Read file and return surface. More...
 
static void write (const fileName &, const MeshedSurfaceProxy< Face > &)
 Write surface mesh components by proxy. More...
 
static void write (const fileName &, const UnsortedMeshedSurface< Face > &)
 Write UnsortedMeshedSurface, the output remains unsorted. More...
 
- Static Public Member Functions inherited from MeshedSurface< Face >
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< MeshedSurfaceNew (const fileName &, const word &ext)
 Select constructed from filename (explicit extension) More...
 
static autoPtr< MeshedSurfaceNew (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)
 
static fileName localMeshFileName (const word &surfName="")
 Return the local file name (within time directory) More...
 
static fileName findMeshInstance (const Time &, const word &surfName="")
 Find instance with surfName. More...
 
static fileName findMeshFile (const Time &, const word &surfName="")
 Find mesh file with surfName. More...
 

Additional Inherited Members

- Public Types inherited from MeshedSurface< Face >
typedef Face FaceType
 Face type used. More...
 
- Public Types inherited from PrimitivePatch< Face,::Foam::List, pointField, point >
enum  surfaceTopo
 Enumeration defining the surface type. Used in check routines. More...
 
typedef Face FaceType
 
typedef ::Foam::List< Face > FaceListType
 
typedef pointField PointFieldType
 
- 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 Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_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 Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Protected Member Functions inherited from MeshedSurface< Face >
void transcribe (MeshedSurface< face > &)
 Transfer points/zones and transcribe face -> triFace. More...
 
void checkZones ()
 Basic sanity check on zones. More...
 
pointFieldstoredPoints ()
 Non-const access to global points. More...
 
List< Face > & storedFaces ()
 Non-const access to the faces. More...
 
surfZoneListstoredZones ()
 Non-const access to the zones. More...
 
void sortFacesAndStore (const Xfer< List< Face > > &unsortedFaces, const Xfer< 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...
 
template<>
void transcribe (MeshedSurface< face > &surf)
 
template<>
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...
 
- Static Protected Member Functions inherited from surfaceFormatsCore
template<class Container >
static List< surfZoneoneZone (const Container &container, const word &name="zone0")
 Return a list with a single entry,. More...
 
static string getLineNoComment (IFstream &)
 Read non-comment line. More...
 
- Static Protected Member Functions inherited from VTKsurfaceFormatCore
static void writeHeader (Ostream &, const pointField &)
 Write header information with points. More...
 
static void writeTail (Ostream &, const UList< surfZone > &)
 Write trailing information with zone information. More...
 
static void writeTail (Ostream &, const labelUList &zoneIds)
 Write trailing information with zone Ids. More...
 

Detailed Description

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

Provide a means of reading/writing VTK legacy format. The output is never sorted by zone.

Source files

Definition at line 55 of file VTKsurfaceFormat.H.

Constructor & Destructor Documentation

VTKsurfaceFormat ( const fileName filename)

Construct from file name.

Definition at line 56 of file VTKsurfaceFormat.C.

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

Here is the call graph for this function:

virtual ~VTKsurfaceFormat ( )
inlinevirtual

Destructor.

Definition at line 92 of file VTKsurfaceFormat.H.

References VTKsurfaceFormat< Face >::read(), and VTKsurfaceFormat< Face >::write().

Here is the call graph for this function:

Member Function Documentation

static autoPtr<MeshedSurface<Face> > New ( const fileName name)
inlinestatic

Read file and return surface.

Definition at line 83 of file VTKsurfaceFormat.H.

References Foam::name().

Here is the call graph for this function:

void write ( const fileName filename,
const MeshedSurfaceProxy< Face > &  surf 
)
static
void write ( const fileName filename,
const UnsortedMeshedSurface< Face > &  surf 
)
static
bool read ( const fileName filename)
virtual
virtual void write ( const fileName name) const
inlinevirtual

Write object file.

Reimplemented from MeshedSurface< Face >.

Definition at line 110 of file VTKsurfaceFormat.H.

References VTKsurfaceFormat< Face >::write().

Here is the call graph for this function:


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