pfc::VTKWriter Class Reference

VTK ImageData format writer. More...

#include <vtk_writer.hpp>

Inheritance diagram for pfc::VTKWriter:

Collaboration diagram for pfc::VTKWriter:

Public Member Functions
	VTKWriter (const std::string &filename)
	Construct VTKWriter with filename pattern.
void	set_domain (const std::array< int, 3 > &arr_global, const std::array< int, 3 > &arr_local, const std::array< int, 3 > &arr_offset) override
	Set domain decomposition.
void	set_origin (const std::array< double, 3 > &origin)
	Set origin of the domain.
void	set_spacing (const std::array< double, 3 > &spacing)
	Set spacing of the domain.
void	set_field_name (const std::string &name)
	Set field name for VTK output.
MPI_Status	write (int increment, const RealField &data) override
	Write real field to VTK file.
MPI_Status	write (int increment, const ComplexField &data) override
	Write complex field to VTK file (writes magnitude)
Public Member Functions inherited from pfc::ResultsWriter
	ResultsWriter (const std::string &filename)
template<typename T >
MPI_Status	write (const std::vector< T > &data)

Additional Inherited Members
Protected Attributes inherited from pfc::ResultsWriter
std::string	m_filename

Detailed Description

VTK ImageData format writer.

Writes simulation fields to VTK ImageData (.vti) format for visualization. In parallel runs, creates a .pvti master file and .vti piece files.

Examples

/home/runner/work/OpenPFC/OpenPFC/include/openpfc/results_writers/vtk_writer.hpp.

Constructor & Destructor Documentation

VTKWriter()

pfc::VTKWriter::VTKWriter ( const std::string &  filename )

inlineexplicit

Construct VTKWriter with filename pattern.

Parameters

filename

Filename pattern (e.g., "output_%04d.vti")

Member Function Documentation

set_domain()

void pfc::VTKWriter::set_domain ( const std::array< int, 3 > &  arr_global, const std::array< int, 3 > &  arr_local, const std::array< int, 3 > &  arr_offset  )

overridevirtual

Set domain decomposition.

Implements pfc::ResultsWriter.

Examples

/home/runner/work/OpenPFC/OpenPFC/include/openpfc/results_writers/vtk_writer.hpp.

write() [1/2]

MPI_Status pfc::VTKWriter::write ( int  increment, const ComplexField &  data  )

overridevirtual

Write complex field to VTK file (writes magnitude)

Implements pfc::ResultsWriter.

write() [2/2]

MPI_Status pfc::VTKWriter::write ( int  increment, const RealField &  data  )

overridevirtual

Write real field to VTK file.

Implements pfc::ResultsWriter.

Examples

/home/runner/work/OpenPFC/OpenPFC/include/openpfc/results_writers/vtk_writer.hpp.

---

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

• openpfc/results_writers/vtk_writer.hpp