GenericPatchWriter< PatchType > Class Template Reference

Write concrete PrimitivePatch faces/points (optionally with fields) as a vtp file or a legacy vtk file. The patch type is limited to representations of polygon faces and 3D points and must support the following methods: More...

Inheritance diagram for GenericPatchWriter< PatchType >:
[legend]
Collaboration diagram for GenericPatchWriter< PatchType >:
[legend]

Public Member Functions

 GenericPatchWriter (const PatchType &pp, const vtk::outputOptions opts=vtk::formatType::INLINE_BASE64)
 Construct from patch (default output INLINE_BASE64) More...
 
 GenericPatchWriter (const PatchType &pp, const fileName &file, bool parallel=Pstream::parRun())
 
 GenericPatchWriter (const PatchType &pp, const vtk::outputOptions opts, const fileName &file, bool parallel=Pstream::parRun())
 Construct from components and open the file for writing. More...
 
virtual ~GenericPatchWriter ()=default
 Destructor. More...
 
const PatchType & patch () const noexcept
 Reference to the originating face/points patch. More...
 
virtual bool beginFile (std::string title="surface")
 Write file header (non-collective) More...
 
virtual bool writeGeometry ()
 Write patch topology. More...
 
bool writeProcIDs ()
 Write processor ids for each poly as CellData. More...
 
- Public Member Functions inherited from polyWriter
 polyWriter (const vtk::outputOptions opts=vtk::formatType::INLINE_BASE64)
 Construct from components (default format INLINE_BASE64) More...
 
 polyWriter (const fileName &file, bool parallel=Pstream::parRun())
 
 polyWriter (const vtk::outputOptions opts, const fileName &file, bool parallel=Pstream::parRun())
 Construct from components and open the file for writing. More...
 
virtual ~polyWriter ()=default
 Destructor. More...
 
virtual bool writeGeometry ()
 Dummy write mesh topology method - Fatal if called. More...
 
bool writeLineGeometry (const pointField &points, const edgeList &edges)
 
bool writePolyGeometry (const pointField &points, const faceList &faces)
 
virtual bool beginCellData (label nFields=0)
 Begin CellData output section for specified number of fields. More...
 
virtual bool beginPointData (label nFields=0)
 Begin PointData for specified number of fields. More...
 
template<class Type >
void write (const word &fieldName, const UList< Type > &field)
 Write primitive field of CellData (Poly or Line) or PointData values. More...
 
template<class Type >
void writeCellData (const word &fieldName, const UList< Type > &field)
 Write primitive field of CellData. More...
 
template<class Type >
void writePointData (const word &fieldName, const UList< Type > &field)
 Write primitive field of PointData. More...
 
- Public Member Functions inherited from fileWriter
 fileWriter (const vtk::fileTag contentType, const vtk::outputOptions opts)
 Construct from components. More...
 
virtual ~fileWriter ()
 Destructor. More...
 
vtk::fileTag contentType () const noexcept
 The content type. More...
 
vtk::outputOptions opts () const noexcept
 The output options in use. More...
 
word ext () const
 File extension for current format type. More...
 
bool legacy () const noexcept
 Commonly used query. More...
 
bool parallel () const noexcept
 Parallel output requested? More...
 
const wordstate () const
 The output state in printable format. More...
 
const fileNameoutput () const noexcept
 The current output file name. More...
 
virtual bool open (const fileName &file, bool parallel=Pstream::parRun())
 Open file for writing (creates parent directory). More...
 
void close ()
 End the file contents and close the file after writing. More...
 
virtual bool beginFile (std::string title="")
 Write file header (non-collective) More...
 
bool beginFieldData (label nFields=0)
 Begin FieldData output section for specified number of fields. More...
 
virtual bool writeGeometry ()=0
 Write mesh topology. More...
 
virtual bool beginCellData (label nFields=0)=0
 Begin CellData output section for specified number of fields. More...
 
virtual bool beginPointData (label nFields=0)=0
 Begin PointData for specified number of fields. More...
 
label nCellData () const noexcept
 Return the number of CellData written for the Piece thus far. More...
 
label nPointData () const noexcept
 Return the number of PointData written for the Piece thus far. More...
 
bool endFieldData ()
 Explicitly end FieldData output and switch to DECLARED state. More...
 
bool endCellData ()
 Explicitly end CellData output and switch to PIECE state. More...
 
bool endPointData ()
 Explicitly end PointData output and switch to PIECE state. More...
 
void writeTimeValue (scalar timeValue)
 Write "TimeValue" FieldData (name as per Catalyst output) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from polyWriter
static word ext (vtk::outputOptions opts)
 File extension for given output type. More...
 
- Protected Types inherited from fileWriter
enum  outputState : uint8_t {
  CLOSED = 0 , OPENED , DECLARED , FIELD_DATA ,
  PIECE , CELL_DATA , POINT_DATA
}
 Internal tracking of the output state. More...
 
- Protected Member Functions inherited from polyWriter
template<class Type >
void writeUniformValue (const label nCellValues, const word &fieldName, const Type &val)
 Write a uniform field of Cell (Poly or Line) or Point values. More...
 
- Protected Member Functions inherited from fileWriter
void checkFormatterValidity () const
 Verify that formatter in either allocated or not required. More...
 
OstreamreportBadState (Ostream &, outputState expected) const
 Generate message reporting bad writer state. More...
 
OstreamreportBadState (Ostream &, outputState, outputState) const
 Generate message reporting bad writer state. More...
 
std::ofstream & os () noexcept
 The backend ostream in use. More...
 
vtk::formatterformat ()
 The VTK formatter in use. FatalError for off-processor. More...
 
bool isState (outputState test) const noexcept
 True if output state corresponds to the test state. More...
 
bool notState (outputState test) const noexcept
 True if output state does not correspond to the test state. More...
 
template<class Type >
void beginDataArray (const word &fieldName, const label nValues)
 Start of a field or DataArray output (legacy or non-legacy). More...
 
void endDataArray ()
 Flush formatter and end of DataArray output (non-legacy) More...
 
void beginPoints (const label nPoints)
 Start of a POINTS DataArray. More...
 
void endPoints ()
 End of a POINTS DataArray. More...
 
bool enter_Piece ()
 Trigger change state to Piece. Resets nCellData_, nPointData_. More...
 
bool endPiece ()
 Explicitly end Piece output and switch to DECLARED state. More...
 
bool enter_CellData (label nEntries, label nFields)
 Trigger change state to CellData. More...
 
bool enter_PointData (label nEntries, label nFields)
 Trigger change state to PointData. More...
 
bool exit_File ()
 Emit file footer (end data, end piece, end file) More...
 
template<class Type >
void writeUniform (const word &fieldName, const Type &val, const label nValues)
 Write uniform field content. More...
 
template<class Type >
void writeBasicField (const word &fieldName, const UList< Type > &field)
 Write basic (primitive) field content. More...
 
bool writeProcIDs (const label nValues)
 Write nValues of processor ids as CellData (no-op in serial) More...
 
 fileWriter (const fileWriter &)=delete
 No copy construct. More...
 
void operator= (const fileWriter &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from polyWriter
label numberOfPoints_
 The number of field points for the current Piece. More...
 
label numberOfCells_
 The number of field cells (edges or faces) for the current Piece. More...
 
label nLocalPoints_
 Local number of points. More...
 
label nLocalVerts_
 Local number of vertices (points) More...
 
label nLocalLines_
 Local number of lines (edges) More...
 
label nLocalPolys_
 Local number of polys (faces) More...
 
- Protected Attributes inherited from fileWriter
outputState state_
 The output state. More...
 
vtk::fileTag contentType_
 The content type (PolyData, UnstructuredGrid ...) More...
 
bool parallel_
 Parallel writing (via master) More...
 
vtk::outputOptions opts_
 Requested output options. More...
 
label nCellData_
 The number of CellData written for the Piece thus far. More...
 
label nPointData_
 The number of PointData written for the Piece thus far. More...
 
fileName outputFile_
 The output file name. More...
 
autoPtr< vtk::formatterformat_
 The VTK formatter in use (only valid on master process) More...
 
std::ofstream os_
 The backend ostream in use (only opened on master process) More...
 
- Static Protected Attributes inherited from fileWriter
static const Enum< outputStatestateNames
 Names for the output state (for messages, not for file output). More...
 

Detailed Description

template<class PatchType>
class Foam::vtk::GenericPatchWriter< PatchType >

Write concrete PrimitivePatch faces/points (optionally with fields) as a vtp file or a legacy vtk file. The patch type is limited to representations of polygon faces and 3D points and must support the following methods:

  • localPoints()
  • localFaces()

The file output states are managed by the Foam::vtk::fileWriter class. FieldData (eg, TimeValue) must appear before any geometry pieces.

Note
Parallel output is combined into a single Piece without point merging, which is similar to using multi-piece data sets, but allows more convenient creation as a streaming process.

Definition at line 65 of file foamVtkGenericPatchWriter.H.

Constructor & Destructor Documentation

◆ GenericPatchWriter() [1/3]

GenericPatchWriter ( const PatchType &  pp,
const vtk::outputOptions  opts = vtk::formatType::INLINE_BASE64 
)
inlineexplicit

Construct from patch (default output INLINE_BASE64)

Definition at line 89 of file foamVtkGenericPatchWriter.H.

◆ GenericPatchWriter() [2/3]

GenericPatchWriter ( const PatchType &  pp,
const fileName file,
bool  parallel = Pstream::parRun() 
)
inline

Construct from components (default output INLINE_BASE64), and open the file for writing.

The file name is with/without an extension.

Definition at line 102 of file foamVtkGenericPatchWriter.H.

◆ GenericPatchWriter() [3/3]

GenericPatchWriter ( const PatchType &  pp,
const vtk::outputOptions  opts,
const fileName file,
bool  parallel = Pstream::parRun() 
)
inline

Construct from components and open the file for writing.

The file name is with/without an extension.

Definition at line 115 of file foamVtkGenericPatchWriter.H.

◆ ~GenericPatchWriter()

virtual ~GenericPatchWriter ( )
virtualdefault

Destructor.

Member Function Documentation

◆ patch()

const PatchType & patch ( ) const
inlinenoexcept

Reference to the originating face/points patch.

Definition at line 135 of file foamVtkGenericPatchWriter.H.

◆ beginFile()

virtual bool beginFile ( std::string  title = "surface")
inlinevirtual

Write file header (non-collective)

Note
Expected calling states: (OPENED).

Reimplemented from fileWriter.

Definition at line 142 of file foamVtkGenericPatchWriter.H.

◆ writeGeometry()

virtual bool writeGeometry ( )
inlinevirtual

Write patch topology.

Also writes the file header if not previously written.

Note
Must be called prior to writing CellData or PointData

Reimplemented from polyWriter.

Definition at line 150 of file foamVtkGenericPatchWriter.H.

◆ writeProcIDs()

bool writeProcIDs ( )
inline

Write processor ids for each poly as CellData.

Definition at line 159 of file foamVtkGenericPatchWriter.H.

References polyWriter::nLocalPolys_, and lineWriter::writeProcIDs().

Here is the call graph for this function:

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