Write OpenFOAM patches and patch fields in VTP or legacy vtk format. More...

Inheritance diagram for patchWriter:

Collaboration diagram for patchWriter:

Public Member Functions
	patchWriter (const fvMesh &mesh, const labelList &patchIDs, const vtk::outputOptions opts=vtk::formatType::INLINE_BASE64, const bool useNearCellValue=false)
	Construct from components (default format INLINE_BASE64) More...

	patchWriter (const fvMesh &mesh, const labelList &patchIDs, const fileName &file, bool parallel=Pstream::parRun())

	patchWriter (const fvMesh &mesh, const labelList &patchIDs, const vtk::outputOptions opts, const fileName &file, bool parallel=Pstream::parRun())

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

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

const labelList &	patchIDs () const
	The patch IDs. 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	writePatchIDs ()
	Write patch ids as CellData. More...

bool	writeProcIDs ()
	Write processor ids as CellData. This is no-op in serial. More...

bool	writeNeighIDs ()
	Write processor neighbour ids as CellData. This is no-op in serial. 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 , template< class > class PatchField>
void	write (const GeometricField< Type, PatchField, pointMesh > &field)
	Write point field. More...

template<class Type , template< class > class PatchField>
void	write (const GeometricField< Type, PatchField, volMesh > &field)
	Write volume field. More...

template<class Type >
void	write (const GeometricField< Type, fvPatchField, volMesh > &field, const PrimitivePatchInterpolation< primitivePatch > &pInterp)
	Write volume field with point interpolation. More...

template<class Type >
void	write (const GeometricField< Type, fvPatchField, volMesh > &field, const PrimitivePatchInterpolation< primitivePatch > *pInterp)
	Write volume field with point interpolation. 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 word &	state () const
	The output state in printable format. More...

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

Detailed Description

Write OpenFOAM patches and patch fields in VTP or legacy vtk format.

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 66 of file foamVtkPatchWriter.H.

Constructor & Destructor Documentation

◆ patchWriter() [1/4]

patchWriter	(	const fvMesh &	mesh,
		const labelList &	patchIDs,
		const vtk::outputOptions	opts = `vtk::formatType::INLINE_BASE64`,
		const bool	useNearCellValue = `false`
	)

Construct from components (default format INLINE_BASE64)

Parameters

useNearCellValue to use cell instead of patch values

Definition at line 391 of file foamVtkPatchWriter.C.

◆ patchWriter() [2/4]

patchWriter	(	const fvMesh &	mesh,
		const labelList &	patchIDs,
		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 414 of file foamVtkPatchWriter.C.

◆ patchWriter() [3/4]

patchWriter	(	const fvMesh &	mesh,
		const labelList &	patchIDs,
		const vtk::outputOptions	opts,
		const fileName &	file,
		bool	parallel = `Pstream::parRun()`
	)

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

The file name is with/without an extension.

Definition at line 428 of file foamVtkPatchWriter.C.

◆ patchWriter() [4/4]

patchWriter	(	const fvMesh &	mesh,
		const labelList &	patchIDs,
		const vtk::outputOptions	opts,
		const bool	useNearCellValue,
		const fileName &	file,
		bool	parallel = `Pstream::parRun()`
	)

Construct from components and open the file for writing.

The file name is with/without an extension.

Parameters

useNearCellValue to use cell instead of patch values

Definition at line 443 of file foamVtkPatchWriter.C.

◆ ~patchWriter()

virtual ~patchWriter ( )

virtualdefault

Destructor.

Member Function Documentation

◆ ext()

static word ext ( vtk::outputOptions opts )

inlinestatic

File extension for given output type.

Definition at line 183 of file foamVtkPatchWriter.H.

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

Here is the call graph for this function:

◆ patchIDs()

const labelList& patchIDs ( ) const

inline

The patch IDs.

Definition at line 189 of file foamVtkPatchWriter.H.

◆ beginFile()

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

virtual

Write file header (non-collective)

Note: Expected calling states: (OPENED).

Reimplemented from fileWriter.

Definition at line 460 of file foamVtkPatchWriter.C.

References fileWriter::beginFile(), and Foam::name().

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 510 of file foamVtkPatchWriter.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

nFields is 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 536 of file foamVtkPatchWriter.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

nFields is 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 542 of file foamVtkPatchWriter.C.

◆ writePatchIDs()

void writePatchIDs ( )

Write patch ids as CellData.

Must be called within the CELL_DATA state.

Definition at line 548 of file foamVtkPatchWriter.C.

References UPstream::blocking, Foam::vtk::CELL_DATA, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, UPstream::firstSlave(), format(), UPstream::lastSlave(), UPstream::master(), UPstream::masterNo(), Foam::nl, patches, patchId(), Foam::reduce(), Foam::val, and Foam::vtk::write().

Here is the call graph for this function:

◆ writeProcIDs()

bool writeProcIDs ( )

Write processor ids as CellData. This is no-op in serial.

Must be called within the CELL_DATA state.

Definition at line 659 of file foamVtkPatchWriter.C.

References Foam::vtk::CELL_DATA, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, format(), globalIndex::localSize(), UPstream::master(), UPstream::myProcNo(), Foam::nl, UPstream::nProcs(), UPstream::parRun(), Foam::reduce(), Foam::returnReduce(), and Foam::vtk::write().

Here is the call graph for this function:

◆ writeNeighIDs()

bool writeNeighIDs ( )

Write processor neighbour ids as CellData. This is no-op in serial.

Must be called within the CELL_DATA state.

Definition at line 743 of file foamVtkPatchWriter.C.

References UPstream::blocking, Foam::vtk::CELL_DATA, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, UPstream::firstSlave(), format(), UPstream::lastSlave(), UPstream::master(), UPstream::masterNo(), Foam::nl, UPstream::parRun(), patches, patchId(), Foam::reduce(), Foam::returnReduce(), Foam::val, and Foam::vtk::write().

Here is the call graph for this function:

◆ writeUniform()

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

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

Definition at line 35 of file foamVtkPatchWriterTemplates.C.

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

Here is the call graph for this function:

◆ write() [1/4]

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

Write point field.

Definition at line 62 of file foamVtkPatchWriterTemplates.C.

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

Here is the call graph for this function:

◆ write() [2/4]

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

Write volume field.

Definition at line 173 of file foamVtkPatchWriterTemplates.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, field(), format(), Foam::nl, nPatches, patchId(), Foam::reduce(), and Foam::vtk::writeList().

Here is the call graph for this function:

◆ write() [3/4]

void write	(	const GeometricField< Type, fvPatchField, volMesh > &	field,
		const PrimitivePatchInterpolation< primitivePatch > &	pInterp
	)

Write volume field with point interpolation.

Definition at line 297 of file foamVtkPatchWriterTemplates.C.

References Foam::endl(), Foam::exit(), PrimitivePatchInterpolation< Patch >::faceToPointInterpolate(), Foam::FatalError, FatalErrorInFunction, field(), format(), Foam::nl, nPatches, nPoints, patchId(), Foam::expressions::patchExpr::POINT_DATA, Foam::reduce(), and Foam::vtk::writeList().

Here is the call graph for this function:

◆ write() [4/4]

void write	(	const GeometricField< Type, fvPatchField, volMesh > &	field,
		const PrimitivePatchInterpolation< primitivePatch > *	pInterp
	)

Write volume field with point interpolation.

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

src/conversion/vtk/output/foamVtkPatchWriter.H
src/conversion/vtk/output/foamVtkPatchWriter.C
src/conversion/vtk/output/foamVtkPatchWriterTemplates.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ patchWriter() [1/4]

◆ patchWriter() [2/4]

◆ patchWriter() [3/4]

◆ patchWriter() [4/4]

◆ ~patchWriter()

Member Function Documentation

◆ ext()

◆ patchIDs()

◆ beginFile()

◆ writeGeometry()

◆ beginCellData()

◆ beginPointData()

◆ writePatchIDs()

◆ writeProcIDs()

◆ writeNeighIDs()

◆ writeUniform()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]