SPH
Public Member Functions | Protected Attributes | List of all members
IOutput Class Referenceabstract

Interface for saving quantities of SPH particles to a file. More...

#include <Output.h>

Inheritance diagram for IOutput:
Polymorphic BinaryOutput CompressedOutput NullOutput PkdgravOutput SodOutput TextOutput VtkOutput GnuplotOutput

Public Member Functions

 IOutput (const OutputFile &fileMask)
 Constructs output given the file name of the output. More...
 
virtual Expected< Pathdump (const Storage &storage, const Statistics &stats)=0
 Saves data from particle storage into the file. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Protected Attributes

OutputFile paths
 

Detailed Description

Interface for saving quantities of SPH particles to a file.

Saves all values in the storage or selected few quantities, depending on implementation. It is also implementation-defined whether the saved representation of storage is lossless, i.e. whether the storage can be loaded without a loss in precision.

Definition at line 76 of file Output.h.

Constructor & Destructor Documentation

◆ IOutput()

IOutput::IOutput ( const OutputFile fileMask)
explicit

Constructs output given the file name of the output.

Definition at line 98 of file Output.cpp.

Member Function Documentation

◆ dump()

virtual Expected<Path> IOutput::dump ( const Storage storage,
const Statistics stats 
)
pure virtual

Saves data from particle storage into the file.

Returns the filename of the dump, generated from file mask given in constructor, or an error message in case writing the output file failed.

Implemented in PkdgravOutput, VtkOutput, CompressedOutput, BinaryOutput, GnuplotOutput, TextOutput, and SodOutput.

Member Data Documentation

◆ paths

OutputFile IOutput::paths
protected

Definition at line 78 of file Output.h.


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