precice::io::Export Class Reference

Abstract base class of all classes exporting container data structures. More...

#include <Export.hpp>

Inheritance diagram for precice::io::Export:

Collaboration diagram for precice::io::Export:

Classes
struct	Record

Public Types
enum struct	ExportKind : bool { TimeWindows , Iterations }

Public Member Functions
virtual	~Export ()=default
	Export (std::string_view participantName, std::string_view location, const mesh::Mesh &mesh, ExportKind kind, int frequency, int rank, int size)
	Export (const Export &)=delete
	Export (Export &&)=delete
Export &	operator= (const Export &)=delete
Export &	operator= (Export &&)=delete
virtual void	doExport (int index, double time)=0
	Export the mesh and writes files.
virtual void	exportSeries () const =0

Protected Member Functions
bool	isParallel () const
std::string	formatIndex (int index) const
bool	keepExport (int index) const
void	writeSeriesFile (std::string_view filename) const
void	recordExport (std::string filename, double time)

Protected Attributes
std::string	_participantName
std::string	_location
const mesh::Mesh *const	_mesh
ExportKind	_kind
int	_frequency
int	_rank
int	_size
std::vector< Record >	_records

Detailed Description

Abstract base class of all classes exporting container data structures.

Definition at line 14 of file Export.hpp.

Member Enumeration Documentation

ExportKind

enum struct precice::io::Export::ExportKind : bool

strong

Enumerator
TimeWindows
Iterations

Definition at line 18 of file Export.hpp.

Constructor & Destructor Documentation

~Export()

virtual precice::io::Export::~Export ( )

virtualdefault

Export() [1/3]

precice::io::Export::Export ( std::string_view participantName, std::string_view location, const mesh::Mesh & mesh, ExportKind kind, int frequency, int rank, int size )

inline

Definition at line 23 of file Export.hpp.

Export() [2/3]

precice::io::Export::Export ( const Export & )

delete

Export() [3/3]

precice::io::Export::Export ( Export && )

delete

Member Function Documentation

doExport()

virtual void precice::io::Export::doExport ( int index, double time )

pure virtual

Export the mesh and writes files.

Parameters

[in]	index	the index of this iteration or time window
[in]	time	the associated time of this time window

Implemented in precice::io::ExportCSV, precice::io::ExportVTK, and precice::io::ExportXML.

exportSeries()

virtual void precice::io::Export::exportSeries ( ) const

pure virtual

Implemented in precice::io::ExportCSV, precice::io::ExportVTK, and precice::io::ExportXML.

formatIndex()

std::string precice::io::Export::formatIndex ( int index ) const

protected

Definition at line 12 of file Export.cpp.

Here is the call graph for this function:

isParallel()

bool precice::io::Export::isParallel ( ) const

protected

Definition at line 7 of file Export.cpp.

keepExport()

bool precice::io::Export::keepExport ( int index ) const

inlineprotected

Definition at line 59 of file Export.hpp.

operator=() [1/2]

Export & precice::io::Export::operator= ( const Export & )

delete

operator=() [2/2]

Export & precice::io::Export::operator= ( Export && )

delete

recordExport()

void precice::io::Export::recordExport ( std::string filename, double time )

protected

Definition at line 44 of file Export.cpp.

writeSeriesFile()

void precice::io::Export::writeSeriesFile ( std::string_view filename ) const

protected

Definition at line 21 of file Export.cpp.

Here is the call graph for this function:

Member Data Documentation

_frequency

int precice::io::Export::_frequency

protected

Definition at line 68 of file Export.hpp.

_kind

ExportKind precice::io::Export::_kind

protected

Definition at line 67 of file Export.hpp.

_location

std::string precice::io::Export::_location

protected

Definition at line 65 of file Export.hpp.

_mesh

const mesh::Mesh* const precice::io::Export::_mesh

protected

Definition at line 66 of file Export.hpp.

_participantName

std::string precice::io::Export::_participantName

protected

Definition at line 64 of file Export.hpp.

_rank

int precice::io::Export::_rank

protected

Definition at line 69 of file Export.hpp.

_records

std::vector<Record> precice::io::Export::_records

protected

Definition at line 77 of file Export.hpp.

_size

int precice::io::Export::_size

protected

Definition at line 70 of file Export.hpp.

---

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

• src/io/Export.hpp
• src/io/Export.cpp