Loading...
Searching...
No Matches
q3::VolumetricFieldWriter Class Referenceabstract

#include <writer.hpp>

+ Inheritance diagram for q3::VolumetricFieldWriter:

Public Member Functions

virtual ~VolumetricFieldWriter ()=default
 
virtual std::string default_file_name (const std::string &stem) const =0
 
virtual void write (const std::string &path, const VolumetricField &field) const =0
 Write field to path, throwing std::runtime_error if it cannot be written.
 

Detailed Description

Definition at line 19 of file writer.hpp.

Constructor & Destructor Documentation

◆ ~VolumetricFieldWriter()

virtual q3::VolumetricFieldWriter::~VolumetricFieldWriter ( )
virtualdefault

Member Function Documentation

◆ default_file_name()

virtual std::string q3::VolumetricFieldWriter::default_file_name ( const std::string &  stem) const
pure virtual

What a file of this format is conventionally called, given a run's prefix and the field's name. Cube and XSF take a suffix; a format whose file has a fixed name says so by returning that name unchanged.

Implemented in q3::CubeVolumetricFieldWriter, and q3::XsfVolumetricFieldWriter.

◆ write()

virtual void q3::VolumetricFieldWriter::write ( const std::string &  path,
const VolumetricField &  field 
) const
pure virtual

Write field to path, throwing std::runtime_error if it cannot be written.

Implemented in q3::CubeVolumetricFieldWriter, and q3::XsfVolumetricFieldWriter.


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