surfaceWriter Class Reference

Write faces/points (optionally with fields) as a vtp file or a legacy vtk file. More...

Inheritance diagram for surfaceWriter:
[legend]
Collaboration diagram for surfaceWriter:
[legend]

Public Member Functions

 surfaceWriter (const pointField &pts, const faceList &faces, const vtk::outputOptions opts=vtk::formatType::INLINE_BASE64)
 Construct from components (default format INLINE_BASE64) More...
 
 surfaceWriter (const pointField &pts, const faceList &faces, const fileName &file, bool parallel=Pstream::parRun())
 
 surfaceWriter (const pointField &pts, const faceList &faces, const vtk::outputOptions opts, const fileName &file, bool parallel=Pstream::parRun())
 Construct from components and open the file for writing. More...
 
virtual ~surfaceWriter ()=default
 Destructor. More...
 
virtual void setTime (const instant &inst)
 Define a time name/value for the output. More...
 
virtual bool beginFile (std::string title="")
 Write file header (non-collective) More...
 
virtual bool writeGeometry ()
 Write patch topology. More...
 
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...
 
void writeTimeValue ()
 Write the currently set time as "TimeValue" FieldData. More...
 
void piece (const pointField &points, const faceList &faces)
 Reset point, face references to begin a new piece. More...
 
template<class Type >
void writeUniform (const word &fieldName, const Type &val)
 Write a uniform field of Cell (Face) or Point values. More...
 
template<class Type >
void write (const word &fieldName, const UList< Type > &field)
 Write a list of Cell (Face) or Point values. 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
 The content type. More...
 
vtk::outputOptions opts () const
 The output options in use. More...
 
word ext () const
 File extension for current format type. More...
 
bool legacy () const
 Commonly used query. More...
 
bool parallel () const
 Parallel output requested? More...
 
const wordstate () const
 The output state in printable format. More...
 
const fileNameoutput () const
 The current output file name. More...
 
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...
 
bool beginFieldData (label nFields=0)
 Begin FieldData output section for specified number of fields. More...
 
label nCellData () const
 Return the number of CellData written for the Piece thus far. More...
 
label nPointData () const
 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...
 

Static Public Member Functions

static word ext (vtk::outputOptions opts)
 File extension for given output type. More...
 

Additional Inherited Members

- Protected Types inherited from fileWriter
enum  outputState {
  CLOSED = 0, OPENED, DECLARED, FIELD_DATA,
  PIECE, CELL_DATA, POINT_DATA
}
 Internal tracking of the output state. More...
 
- Protected Member Functions inherited from fileWriter
std::ofstream & os ()
 The backend ostream in use. More...
 
vtk::formatterformat ()
 The VTK formatter in use. More...
 
bool isState (outputState test) const
 True if the output state corresponds to the test state. More...
 
bool notState (outputState test) const
 True if the output state does not correspond to the test state. More...
 
template<class Type >
void writeUniform (const word &fieldName, const Type &val, const label nValues)
 Write uniform field content. 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...
 
 fileWriter (const fileWriter &)=delete
 No copy construct. More...
 
void operator= (const fileWriter &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from fileWriter
vtk::fileTag contentType_
 The content type. More...
 
outputOptions opts_
 The requested output options. More...
 
bool parallel_
 Writing in parallel (via master) More...
 
outputState state_
 The output state. 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 (master process) More...
 
std::ofstream os_
 The backend ostream in use (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

Write faces/points (optionally with fields) as a vtp file or a legacy vtk file.

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. In the future, the duplicate points at processor connections may be addressed using ghost points.
Source files

Definition at line 68 of file foamVtkSurfaceWriter.H.

Constructor & Destructor Documentation

◆ surfaceWriter() [1/3]

surfaceWriter ( const pointField pts,
const faceList faces,
const vtk::outputOptions  opts = vtk::formatType::INLINE_BASE64 
)

Construct from components (default format INLINE_BASE64)

Definition at line 353 of file foamVtkSurfaceWriter.C.

◆ surfaceWriter() [2/3]

surfaceWriter ( const pointField pts,
const faceList faces,
const fileName file,
bool  parallel = Pstream::parRun() 
)

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

The file name is with/without an extension.

Definition at line 375 of file foamVtkSurfaceWriter.C.

◆ surfaceWriter() [3/3]

surfaceWriter ( const pointField pts,
const faceList faces,
const vtk::outputOptions  opts,
const fileName file,
bool  parallel = Pstream::parRun() 
)

Construct from components and open the file for writing.

The file name is with/without an extension.

Definition at line 389 of file foamVtkSurfaceWriter.C.

◆ ~surfaceWriter()

virtual ~surfaceWriter ( )
virtualdefault

Destructor.

Member Function Documentation

◆ ext()

static word ext ( vtk::outputOptions  opts)
inlinestatic

File extension for given output type.

Definition at line 169 of file foamVtkSurfaceWriter.H.

References outputOptions::ext(), fileWriter::opts(), and Foam::vtk::POLY_DATA.

Here is the call graph for this function:

◆ setTime()

void setTime ( const instant inst)
virtual

Define a time name/value for the output.

Definition at line 405 of file foamVtkSurfaceWriter.C.

◆ beginFile()

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

Write file header (non-collective)

Note
Expected calling states: (OPENED).

Reimplemented from fileWriter.

Definition at line 411 of file foamVtkSurfaceWriter.C.

References fileWriter::beginFile().

Here is the call graph for this function:

◆ writeGeometry()

bool writeGeometry ( )
virtual

Write patch topology.

Also writes the file header if not previously written.

Note
Must be called prior to writing CellData or PointData

Implements fileWriter.

Definition at line 431 of file foamVtkSurfaceWriter.C.

References globalIndex::localStart().

Here is the call graph for this function:

◆ beginCellData()

bool beginCellData ( label  nFields = 0)
virtual

Begin CellData output section for specified number of fields.

Must be called prior to writing any cell data fields.

Parameters
nFieldsis for legacy format only. When nFields=0, this a no-op for legacy format.
Note
Expected calling states: (PIECE | POINT_DATA).
Returns
True if the state changed

Implements fileWriter.

Definition at line 457 of file foamVtkSurfaceWriter.C.

◆ beginPointData()

bool beginPointData ( label  nFields = 0)
virtual

Begin PointData for specified number of fields.

Must be called prior to writing any point data fields.

Parameters
nFieldsis for legacy format only. When nFields=0, this a no-op for legacy format.
Note
Expected calling states: (PIECE | CELL_DATA).
Returns
True if the state changed

Implements fileWriter.

Definition at line 463 of file foamVtkSurfaceWriter.C.

◆ writeTimeValue()

void writeTimeValue ( )

Write the currently set time as "TimeValue" FieldData.

Definition at line 469 of file foamVtkSurfaceWriter.C.

References fileWriter::writeTimeValue().

Here is the call graph for this function:

◆ piece()

void piece ( const pointField points,
const faceList faces 
)

Reset point, face references to begin a new piece.

Definition at line 479 of file foamVtkSurfaceWriter.C.

References points.

◆ writeUniform()

void writeUniform ( const word fieldName,
const Type &  val 
)

Write a uniform field of Cell (Face) or Point values.

Definition at line 32 of file foamVtkSurfaceWriterTemplates.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, Foam::nl, Foam::expressions::patchExpr::POINT_DATA, and WarningInFunction.

Here is the call graph for this function:

◆ write()

void write ( const word fieldName,
const UList< Type > &  field 
)

Write a list of Cell (Face) or Point values.

Definition at line 59 of file foamVtkSurfaceWriterTemplates.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, field(), format(), Foam::nl, Foam::expressions::patchExpr::POINT_DATA, reduce(), Foam::vtk::writeList(), and Foam::vtk::writeListParallel().

Here is the call graph for this function:

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