Write surfaces fields (as PointData) in VTP format. Legacy VTK format is intentionally not supported. More...

Inheritance diagram for surfaceFieldWriter:

Collaboration diagram for surfaceFieldWriter:

Public Member Functions
	surfaceFieldWriter (const fvMesh &mesh, const vtk::outputOptions opts=vtk::formatType::INLINE_BASE64)
	Construct from mesh (default format INLINE_BASE64) More...

	surfaceFieldWriter (const fvMesh &mesh, const fileName &file, bool parallel=Pstream::parRun())

	surfaceFieldWriter (const fvMesh &mesh, const vtk::outputOptions opts, const fileName &file, bool parallel=Pstream::parRun())
	Construct from mesh and open the file for writing. More...

virtual	~surfaceFieldWriter ()=default
	Destructor. More...

virtual bool	beginFile (std::string title="")
	Write file header (non-collective) More...

virtual bool	writeGeometry ()
	Write cloud positions. 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 output section. More...

void	write (const surfaceVectorField &field)
	Write field. 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 word &	state () const
	The output state in printable format. More...

const fileName &	output () 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...

Static Public Member Functions
static word	ext (vtk::outputOptions)
	File extension for given output type. More...

Additional Inherited Members
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 fileWriter
void	checkFormatterValidity () const
	Verify that formatter in either allocated or not required. More...

Ostream &	reportBadState (Ostream &, outputState expected) const
	Generate message reporting bad writer state. More...

Ostream &	reportBadState (Ostream &, outputState, outputState) const
	Generate message reporting bad writer state. More...

std::ofstream &	os () noexcept
	The backend ostream in use. More...

vtk::formatter &	format ()
	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 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::formatter >	format_
	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< outputState >	stateNames
	Names for the output state (for messages, not for file output). More...

Detailed Description

Write surfaces fields (as PointData) in VTP format. Legacy VTK format is intentionally not supported.

The file output is structured as HEAD, FIELD_DATA, PIECE followed by any CELL_DATA or POINT_DATA. These states are tracked internally to help detect logic errors.

The FieldData element is to be placed prior to writing any geometry Piece. This moves the information to the front of the output file for visibility and simplifies the logic.

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 71 of file foamVtkSurfaceFieldWriter.H.