DiFfRG::OutputFrame< dim, VectorType > Class Template Reference

#include <output_session.hh>

Classes
class	FieldCollector
class	Hdf5Record
class	TableRecord

Public Member Functions
	OutputFrame (const OutputFrame &)=delete
OutputFrame &	operator= (const OutputFrame &)=delete
	OutputFrame (OutputFrame &&)=delete
OutputFrame &	operator= (OutputFrame &&)=delete
FieldCollector	fields ()
FieldCollector	fields (const std::string &name)
TableRecord	table (const std::string &name)
Hdf5Record	hdf5 (const std::string &name)
Hdf5Record	hdf5 ()
DiagnosticPort	diagnostics () const
template<typename Name >
CsvOutput &	csv (Name &&name)
template<typename Lambda >
void	set_Lambda (Lambda &&)
template<typename LegacyVectorType = VectorType>
FEOutput< dim, VectorType > &	fe_output ()
void	attach_eom_potential (EoMResult< dim, typename VectorType::value_type > result)
void	attach_raw_potential (ReconstructedRawPotential< dim, typename VectorType::value_type > potential)
void	dump_table (const std::string &name, const std::vector< std::vector< double > > &values, bool append=false, const std::vector< std::string > &header={})
const std::string &	run_name () const noexcept
void	register_readout (const std::string &id)

Private Member Functions
	OutputFrame (OutputSession_impl< dim, VectorType > &session)

Private Attributes
OutputSession_impl< dim, VectorType > &	session
std::set< std::string >	readout_ids

Friends
class	OutputSession_impl< dim, VectorType >

Detailed Description

template<uint dim, typename VectorType>
class DiFfRG::OutputFrame< dim, VectorType >

Scoped collection surface for one complete output event.

Frames cannot be copied, stored, or committed independently. OutputSession_impl creates one inside write_frame() and validates the complete contribution before flushing the frame sinks. A contribution or flush error makes the session fail-stop so partially staged state can never leak into a later frame.

Constructor & Destructor Documentation

OutputFrame() [1/3]

template<uint dim, typename VectorType >

DiFfRG::OutputFrame< dim, VectorType >::OutputFrame ( const OutputFrame< dim, VectorType > & )

delete

OutputFrame() [2/3]

template<uint dim, typename VectorType >

DiFfRG::OutputFrame< dim, VectorType >::OutputFrame ( OutputFrame< dim, VectorType > && )

delete

OutputFrame() [3/3]

template<uint dim, typename VectorType >

DiFfRG::OutputFrame< dim, VectorType >::OutputFrame ( OutputSession_impl< dim, VectorType > & session )

inlineexplicitprivate

Member Function Documentation

attach_eom_potential()

template<uint dim, typename VectorType >

void DiFfRG::OutputFrame< dim, VectorType >::attach_eom_potential ( EoMResult< dim, typename VectorType::value_type > result )

inline

attach_raw_potential()

template<uint dim, typename VectorType >

void DiFfRG::OutputFrame< dim, VectorType >::attach_raw_potential ( ReconstructedRawPotential< dim, typename VectorType::value_type > potential )

inline

csv()

template<uint dim, typename VectorType >

template<typename Name >

CsvOutput & DiFfRG::OutputFrame< dim, VectorType >::csv ( Name && name )

inline

diagnostics()

template<uint dim, typename VectorType >

DiagnosticPort DiFfRG::OutputFrame< dim, VectorType >::diagnostics ( ) const

inline

dump_table()

template<uint dim, typename VectorType >

void DiFfRG::OutputFrame< dim, VectorType >::dump_table ( const std::string & name, const std::vector< std::vector< double > > & values, bool append = false, const std::vector< std::string > & header = {} )

inline

fe_output()

template<uint dim, typename VectorType >

template<typename LegacyVectorType = VectorType>

FEOutput< dim, VectorType > & DiFfRG::OutputFrame< dim, VectorType >::fe_output ( )

inline

fields() [1/2]

template<uint dim, typename VectorType >

FieldCollector DiFfRG::OutputFrame< dim, VectorType >::fields ( )

inline

Collect fields for the run's primary field series.

fields() [2/2]

template<uint dim, typename VectorType >

FieldCollector DiFfRG::OutputFrame< dim, VectorType >::fields ( const std::string & name )

inline

Collect fields for an additional named series owned by this session.

The series is created on first use and automatically follows the run's /output/vtk and /output/hdf5 settings. VTK uses <run>_<name>.pvd plus its VTU frames; HDF5 uses /<name>/<frame> in the run's single file.

hdf5() [1/2]

template<uint dim, typename VectorType >

Hdf5Record DiFfRG::OutputFrame< dim, VectorType >::hdf5 ( )

inline

hdf5() [2/2]

template<uint dim, typename VectorType >

Hdf5Record DiFfRG::OutputFrame< dim, VectorType >::hdf5 ( const std::string & name )

inline

operator=() [1/2]

template<uint dim, typename VectorType >

OutputFrame & DiFfRG::OutputFrame< dim, VectorType >::operator= ( const OutputFrame< dim, VectorType > & )

delete

operator=() [2/2]

template<uint dim, typename VectorType >

OutputFrame & DiFfRG::OutputFrame< dim, VectorType >::operator= ( OutputFrame< dim, VectorType > && )

delete

register_readout()

template<uint dim, typename VectorType >

void DiFfRG::OutputFrame< dim, VectorType >::register_readout ( const std::string & id )

inline

run_name()

template<uint dim, typename VectorType >

const std::string & DiFfRG::OutputFrame< dim, VectorType >::run_name ( ) const

inlinenoexcept

set_Lambda()

template<uint dim, typename VectorType >

template<typename Lambda >

void DiFfRG::OutputFrame< dim, VectorType >::set_Lambda ( Lambda && )

inline

table()

template<uint dim, typename VectorType >

TableRecord DiFfRG::OutputFrame< dim, VectorType >::table ( const std::string & name )

inline

Friends And Related Symbol Documentation

OutputSession_impl< dim, VectorType >

template<uint dim, typename VectorType >

friend class OutputSession_impl< dim, VectorType >

friend

Member Data Documentation

readout_ids

template<uint dim, typename VectorType >

std::set<std::string> DiFfRG::OutputFrame< dim, VectorType >::readout_ids

private

session

template<uint dim, typename VectorType >

OutputSession_impl<dim, VectorType>& DiFfRG::OutputFrame< dim, VectorType >::session

private

---

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

• /home/runner/work/DiFfRG_current/DiFfRG_current/DiFfRG/include/DiFfRG/discretization/data/output_session.hh