Write an OpenFOAM volume (internal) geometry and internal fields as a vtu file or a legacy vtk file. More...

#include <foamVtkInternalWriter.H>

Inheritance diagram for internalWriter:

Collaboration diagram for internalWriter:

Public Member Functions
	internalWriter (const internalWriter &)=delete
	No copy construct.
void	operator= (const internalWriter &)=delete
	No copy assignment.
	internalWriter (const polyMesh &mesh, const vtk::vtuCells &cells, const vtk::outputOptions opts=vtk::formatType::INLINE_BASE64)
	Construct from components (default format INLINE_BASE64),.
	internalWriter (const polyMesh &mesh, const vtk::vtuCells &cells, const fileName &file, bool parallel=UPstream::parRun())
	Construct from components (default format INLINE_BASE64),.
	internalWriter (const polyMesh &mesh, const vtk::vtuCells &cells, const vtk::outputOptions opts, const fileName &file, bool parallel=UPstream::parRun())
	Construct from components (default format INLINE_BASE64),.
virtual	~internalWriter ()=default
	Destructor.
template<class Type, template< class > class PatchField>
void	write (const GeometricField< Type, PatchField, pointMesh > &field)
	Write point field.
template<class Type>
void	write (const DimensionedField< Type, volMesh > &field)
	Write the internal field (CellData).
template<class Type, template< class > class PatchField>
void	write (const GeometricField< Type, PatchField, volMesh > &field)
	Write the volume field (internal part).
template<class Type>
void	write (const DimensionedField< Type, volMesh > &vfield, const volPointInterpolation &pInterp)
	Write internal field with point interpolation.
template<class Type>
void	write (const GeometricField< Type, fvPatchField, volMesh > &vfield, const volPointInterpolation &pInterp)
	Write volume field with point interpolation.
Public Member Functions inherited from internalMeshWriter
	internalMeshWriter (const internalMeshWriter &)=delete
	File extension for given output type.
void	operator= (const internalMeshWriter &)=delete
	No copy assignment.
	internalMeshWriter (const polyMesh &mesh, const vtk::vtuCells &cells, const vtk::outputOptions opts=vtk::formatType::INLINE_BASE64)
	Construct from components (default format INLINE_BASE64),.
	internalMeshWriter (const polyMesh &mesh, const vtk::vtuCells &cells, const fileName &file, bool parallel=UPstream::parRun())
	Construct from components (default format INLINE_BASE64),.
	internalMeshWriter (const polyMesh &mesh, const vtk::vtuCells &cells, const vtk::outputOptions opts, const fileName &file, bool parallel=UPstream::parRun())
	Construct from components (default format INLINE_BASE64),.
virtual	~internalMeshWriter ()=default
	Destructor.
virtual bool	beginFile (std::string title="")
	Write file header (non-collective).
virtual bool	writeGeometry ()
	Write mesh topology.
virtual bool	beginCellData (label nFields=0)
	Begin CellData output section for specified number of fields.
virtual bool	beginPointData (label nFields=0)
	Begin PointData for specified number of fields.
void	writeCellIDs ()
	Write cell ids as CellData.
bool	writeProcIDs ()
	Write processor ids as CellData. This is no-op in serial.
void	writePointIDs ()
	Write point ids as PointData.
template<class Type>
void	writeUniform (const word &fieldName, const Type &val)
	Write a uniform field of Cell or Point values.
template<class Type>
void	writeCellData (const word &fieldName, const UList< Type > &field)
	Write primitive field of CellData.
template<class Type>
void	writePointData (const word &fieldName, const UList< Type > &field)
	Write primitive field of PointData.
word	ext () const
	File extension for current format type.
Public Member Functions inherited from fileWriter
	fileWriter (const vtk::fileTag contentType, const vtk::outputOptions opts)
	Construct from components.
virtual	~fileWriter ()
	Destructor.
vtk::fileTag	contentType () const noexcept
	The content type.
vtk::outputOptions	opts () const noexcept
	The output options in use.
word	ext () const
	File extension for current format type.
bool	legacy () const noexcept
	Commonly used query.
bool	parallel () const noexcept
	Parallel output requested?
const word &	state () const
	The output state in printable format.
const fileName &	output () const noexcept
	The current output file name.
virtual bool	open (const fileName &file, bool parallel=UPstream::parRun())
	Open file for writing (creates parent directory).
void	close ()
	End the file contents and close the file after writing.
bool	beginFieldData (label nFields=0)
	Begin FieldData output section for specified number of fields.
bool	isCellData () const noexcept
	True if output state corresponds to CELL_DATA.
bool	isPointData () const noexcept
	True if output state corresponds to POINT_DATA.
label	nCellData () const noexcept
	The number of CellData written for the Piece thus far.
label	nPointData () const noexcept
	The number of PointData written for the Piece thus far.
bool	endFieldData ()
	Explicitly end FieldData output and switch to DECLARED state.
bool	endCellData ()
	Explicitly end CellData output and switch to PIECE state.
bool	endPointData ()
	Explicitly end PointData output and switch to PIECE state.
void	writeTimeValue (scalar timeValue)
	Write "TimeValue" FieldData (name as per Catalyst output).

Additional Inherited Members
Static Public Member Functions inherited from internalMeshWriter
static word	ext (vtk::outputOptions opts)
	File extension for given output type.
Static Public Attributes inherited from internalMeshWriter
static int	debug
	Debug information.
Protected Types inherited from fileWriter
enum class	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 internalMeshWriter
label	nTotalPoints () const noexcept
	Total number of field points for the current Piece.
label	nTotalCells () const noexcept
	Total number of field cells for the current Piece.
Protected Member Functions inherited from fileWriter
void	checkFormatterValidity () const
	Verify that formatter in either allocated or not required.
Ostream &	reportBadState (Ostream &, outputState expected) const
	Generate message reporting bad writer state.
Ostream &	reportBadState (Ostream &, outputState, outputState) const
	Generate message reporting bad writer state.
std::ofstream &	os () noexcept
	The backend ostream in use.
vtk::formatter &	format ()
	The VTK formatter in use. FatalError for off-processor.
bool	isState (outputState test) const noexcept
	True if output state corresponds to the test state.
bool	notState (outputState test) const noexcept
	True if output state does not correspond to the test state.
template<class Type>
void	beginDataArray (const word &fieldName, const label nValues)
	Start of a field or DataArray output (legacy or non-legacy).
void	endDataArray ()
	Flush formatter and end of DataArray output (non-legacy).
void	beginPoints (const label nPoints)
	Start of a POINTS DataArray.
void	endPoints ()
	End of a POINTS DataArray.
bool	enter_Piece ()
	Trigger change state to Piece. Resets nCellData_, nPointData_.
bool	endPiece ()
	Explicitly end Piece output and switch to DECLARED state.
bool	enter_CellData (label nEntries, label nFields)
	Trigger change state to CellData.
bool	enter_PointData (label nEntries, label nFields)
	Trigger change state to PointData.
bool	exit_File ()
	Emit file footer (end data, end piece, end file).
template<class Type>
void	writeUniform (const word &fieldName, const Type &val, const label nValues)
	Write uniform field content.
template<class Type>
void	writeBasicField (const word &fieldName, const UList< Type > &field)
	Write basic (primitive) field content.
bool	writeProcIDs (const label nValues)
	Write nValues of processor ids as CellData or PointData (no-op in serial).
	fileWriter (const fileWriter &)=delete
	No copy construct.
void	operator= (const fileWriter &)=delete
	No copy assignment.
Protected Attributes inherited from internalMeshWriter
const polyMesh &	mesh_
	Reference to the OpenFOAM mesh (or subset).
const vtk::vtuCells &	vtuCells_
	The volume cells (internalMesh).
OffsetRange< label >	pointSlab_
	Slab addressing for field points of the current Piece.
OffsetRange< label >	cellSlab_
	Slab addressing for field cells of the current Piece.
Protected Attributes inherited from fileWriter
outputState	state_
	The output state.
vtk::fileTag	contentType_
	The content type (PolyData, UnstructuredGrid ...).
bool	parallel_
	Parallel writing (via master).
vtk::outputOptions	opts_
	Requested output options.
label	nCellData_
	The number of CellData written for the Piece thus far.
label	nPointData_
	The number of PointData written for the Piece thus far.
fileName	outputFile_
	The output file name.
autoPtr< vtk::formatter >	format_
	The VTK formatter in use (only valid on master process).
std::ofstream	os_
	The backend ostream in use (only opened on master process).
Static Protected Attributes inherited from fileWriter
static const Enum< outputState >	stateNames
	Names for the output state (for messages, not for file output).

Detailed Description

Write an OpenFOAM volume (internal) geometry and internal fields as a vtu 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.

See also: Foam::vtk::internalMeshWriter

Source files

Definition at line 68 of file foamVtkInternalWriter.H.

Constructor & Destructor Documentation

◆ internalWriter() [1/4]

internalWriter ( const internalWriter & )

delete

No copy construct.

References internalWriter().

Referenced by internalWriter(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ internalWriter() [2/4]

internalWriter	(	const polyMesh &	mesh,
		const vtk::vtuCells &	cells,
		const vtk::outputOptions	opts = vtk::formatType::INLINE_BASE64 )

inline

Construct from components (default format INLINE_BASE64),.

Definition at line 92 of file foamVtkInternalWriter.H.

References cells, Foam::vtk::INLINE_BASE64, internalMeshWriter::internalMeshWriter(), mesh, and fileWriter::opts().

Here is the call graph for this function:

◆ internalWriter() [3/4]

internalWriter	(	const polyMesh &	mesh,
		const vtk::vtuCells &	cells,
		const fileName &	file,
		bool	parallel = UPstream::parRun() )

inline

Construct from components (default format INLINE_BASE64),.

The file name is with/without an extension.

Definition at line 108 of file foamVtkInternalWriter.H.

References cells, internalMeshWriter::internalMeshWriter(), mesh, fileWriter::parallel(), and UPstream::parRun().

Here is the call graph for this function:

◆ internalWriter() [4/4]

internalWriter	(	const polyMesh &	mesh,
		const vtk::vtuCells &	cells,
		const vtk::outputOptions	opts,
		const fileName &	file,
		bool	parallel = UPstream::parRun() )

inline

Construct from components (default format INLINE_BASE64),.

The file name is with/without an extension.

Definition at line 124 of file foamVtkInternalWriter.H.

References cells, internalMeshWriter::internalMeshWriter(), mesh, fileWriter::opts(), fileWriter::parallel(), and UPstream::parRun().

Here is the call graph for this function:

◆ ~internalWriter()

virtual ~internalWriter ( )

virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const internalWriter & )

delete

No copy assignment.

References internalWriter().

Here is the call graph for this function:

◆ write() [1/5]

template<class Type, template< class > class PatchField>

void write ( const GeometricField< Type, PatchField, pointMesh > & field )

Write point field.

Interpolate to originating cell centre for decomposed cells.

References field().

Here is the call graph for this function:

◆ write() [2/5]

template<class Type>

void write ( const DimensionedField< Type, volMesh > & field )

Write the internal field (CellData).

References field().

Here is the call graph for this function:

◆ write() [3/5]

template<class Type, template< class > class PatchField>

void write ( const GeometricField< Type, PatchField, volMesh > & field )

Write the volume field (internal part).

References field().

Here is the call graph for this function:

◆ write() [4/5]

template<class Type>

void write	(	const DimensionedField< Type, volMesh > &	vfield,
		const volPointInterpolation &	pInterp )

Write internal field with point interpolation.

References pInterp.

◆ write() [5/5]

template<class Type>

void write	(	const GeometricField< Type, fvPatchField, volMesh > &	vfield,
		const volPointInterpolation &	pInterp )

Write volume field with point interpolation.

References pInterp.

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

src/conversion/vtk/output/foamVtkInternalWriter.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ internalWriter() [1/4]

◆ internalWriter() [2/4]

◆ internalWriter() [3/4]

◆ internalWriter() [4/4]

◆ ~internalWriter()

Member Function Documentation

◆ operator=()

◆ write() [1/5]

◆ write() [2/5]

◆ write() [3/5]

◆ write() [4/5]

◆ write() [5/5]