OpenPFC  0.1.4
Phase Field Crystal simulation framework
Loading...
Searching...
No Matches
pfc::BinaryWriter Class Reference
Inheritance diagram for pfc::BinaryWriter:
Collaboration diagram for pfc::BinaryWriter:

Public Member Functions

void set_domain (const std::array< int, 3 > &arr_global, const std::array< int, 3 > &arr_local, const std::array< int, 3 > &arr_offset)
 
MPI_Status write (int increment, const RealField &data)
 
MPI_Status write (int increment, const ComplexField &data)
 Write a complex-valued field to file at specified time step.
 
template<typename T >
MPI_Status write_ (int increment, const std::vector< T > &data)
 
- 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
 

Member Function Documentation

◆ set_domain()

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

Implements pfc::ResultsWriter.

◆ write() [1/2]

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

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]incrementTime step or frame number
[in]dataLocal 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]

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

Implements pfc::ResultsWriter.


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