ASPECT
Public Member Functions | Public Attributes | List of all members
aspect::Postprocess::Visualization< dim >::OutputHistory Struct Reference

Public Member Functions

 OutputHistory ()
 
 ~OutputHistory ()
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Public Attributes

bool mesh_changed
 
std::string last_mesh_file_name
 
std::vector< std::pair< double, std::string > > times_and_pvtu_names
 
std::vector< std::vector< std::string > > output_file_names_by_timestep
 
std::vector< XDMFEntry > xdmf_entries
 
std::thread background_thread
 

Detailed Description

template<int dim>
struct aspect::Postprocess::Visualization< dim >::OutputHistory

A structure that keeps some history about past output operations. These variables are grouped into a structure because we need them twice: Once for the cell output case (via DataOut) and once for surface output (via DataOutFaces).

Definition at line 607 of file visualization.h.

Constructor & Destructor Documentation

§ OutputHistory()

template<int dim>
aspect::Postprocess::Visualization< dim >::OutputHistory::OutputHistory ( )

Constructor

§ ~OutputHistory()

template<int dim>
aspect::Postprocess::Visualization< dim >::OutputHistory::~OutputHistory ( )

Destructor. Makes sure that any background thread that may still be running writing data to disk finishes before the current object is fully destroyed.

Member Function Documentation

§ serialize()

template<int dim>
template<class Archive >
void aspect::Postprocess::Visualization< dim >::OutputHistory::serialize ( Archive &  ar,
const unsigned int  version 
)

Serialize the contents of this class as far as they are not read from input parameter files.

Member Data Documentation

§ mesh_changed

template<int dim>
bool aspect::Postprocess::Visualization< dim >::OutputHistory::mesh_changed

Whether the mesh changed since the last time we produced cell-based output.

Definition at line 632 of file visualization.h.

§ last_mesh_file_name

template<int dim>
std::string aspect::Postprocess::Visualization< dim >::OutputHistory::last_mesh_file_name

The most recent name of the mesh file, used to avoid redundant mesh output.

Definition at line 638 of file visualization.h.

§ times_and_pvtu_names

template<int dim>
std::vector<std::pair<double,std::string> > aspect::Postprocess::Visualization< dim >::OutputHistory::times_and_pvtu_names

A list of pairs (time, pvtu_filename) that have so far been written and that we will pass to DataOutInterface::write_pvd_record to create a description file that can make the association between simulation time and corresponding file name (this is done because there is no way to store the simulation time inside the .pvtu or .vtu files).

Definition at line 648 of file visualization.h.

§ output_file_names_by_timestep

template<int dim>
std::vector<std::vector<std::string> > aspect::Postprocess::Visualization< dim >::OutputHistory::output_file_names_by_timestep

A list of list of filenames, sorted by timestep, that correspond to what has been created as output. This is used to create a descriptive .visit file for the entire simulation.

Definition at line 655 of file visualization.h.

§ xdmf_entries

template<int dim>
std::vector<XDMFEntry> aspect::Postprocess::Visualization< dim >::OutputHistory::xdmf_entries

A set of data related to XDMF file sections describing the HDF5 heavy data files created. These contain things such as the dimensions and names of data written at all steps during the simulation.

Definition at line 663 of file visualization.h.

§ background_thread

template<int dim>
std::thread aspect::Postprocess::Visualization< dim >::OutputHistory::background_thread

Handle to a thread that is used to write data in the background. The writer() function runs on this background thread when outputting data for the data_out object.

Definition at line 670 of file visualization.h.


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