pfc::ResultsWriter Class Reference

Inheritance diagram for pfc::ResultsWriter:

Collaboration diagram for pfc::ResultsWriter:

Public Member Functions
	ResultsWriter (const std::string &filename)
virtual void	set_domain (const std::array< int, 3 > &arr_global, const std::array< int, 3 > &arr_local, const std::array< int, 3 > &arr_offset)=0
virtual MPI_Status	write (int increment, const RealField &data)=0
virtual MPI_Status	write (int increment, const ComplexField &data)=0
	Write a complex-valued field to file at specified time step.
template<typename T >
MPI_Status	write (const std::vector< T > &data)

Protected Attributes
std::string	m_filename

Detailed Description

Examples

/home/runner/work/OpenPFC/OpenPFC/include/openpfc/results_writers/vtk_writer.hpp, and 03_simulator_workflow.cpp.

Member Function Documentation

set_domain()

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

pure virtual

Implemented in pfc::VTKWriter.

write() [1/2]

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

pure virtual

Write a complex-valued field to file at specified time step.

Writes the local portion of a ComplexField (complex doubles) to the output file. Useful for storing Fourier coefficients or k-space data.

Parameters

[in]	increment	Time step or frame number
[in]	data	Local complex field data

Returns

MPI_Status Information about the write operation

Note

Complex field size is typically ~50% of real field size (r2c symmetry).

See also

FFT::forward() - produces ComplexField from RealField

Implemented in pfc::BinaryWriter, pfc::VTKWriter, and StatsWriter.

write() [2/2]

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

pure virtual

Implemented in pfc::VTKWriter.

---

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

• openpfc/results_writer.hpp