StatsWriter Class Reference

Simple writer that prints statistics. More...

Inheritance diagram for StatsWriter:

Collaboration diagram for StatsWriter:

Public Member Functions
void	write (int iteration, const RealField &field) override
void	write (int iteration, const ComplexField &field) override
	Write a complex-valued field to file at specified time step.
	StatsWriter (const std::string &filename)
void	write_statistics (int step, double time, const RealField &local_data)
Public Member Functions inherited from pfc::ResultsWriter
	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
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

Simple writer that prints statistics.

Examples

03_simulator_workflow.cpp.

Member Function Documentation

write() [1/2]

void StatsWriter::write ( int  increment, const ComplexField &  data  )

inlineoverridevirtual

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

Implements pfc::ResultsWriter.

write() [2/2]

void StatsWriter::write ( int  iteration, const RealField &  field  )

inlineoverridevirtual

Implements pfc::ResultsWriter.

---

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

• /home/runner/work/OpenPFC/OpenPFC/docs/api/examples/03_simulator_workflow.cpp
• /home/runner/work/OpenPFC/OpenPFC/docs/api/examples/06_results_writers.cpp