OGS
List of all members | Public Attributes
ProcessLib::OutputConfig Struct Reference

Detailed Description

Definition at line 27 of file OutputConfig.h.

#include <OutputConfig.h>

Public Attributes

OutputType output_type
 
std::string prefix
 
std::string suffix
 
bool compress_output
 
unsigned int number_of_files
 
unsigned int chunk_size_bytes
 
std::string data_mode
 
std::vector< PairRepeatEachSteps > repeats_each_steps
 
std::set< std::string > output_variables
 
bool output_extrapolation_residuals
 
std::vector< std::string > mesh_names_for_output
 
std::vector< double > fixed_output_times
 
bool output_iteration_results
 

Member Data Documentation

◆ chunk_size_bytes

unsigned int ProcessLib::OutputConfig::chunk_size_bytes

Definition at line 41 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ compress_output

bool ProcessLib::OutputConfig::compress_output

Definition at line 39 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ data_mode

std::string ProcessLib::OutputConfig::data_mode

Definition at line 42 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ fixed_output_times

std::vector<double> ProcessLib::OutputConfig::fixed_output_times

A list of points in time for output. These fixed output times are taken by the simulation independent of what time stepping scheme is specified.

Often used to arrive at some critical points in the simulation like load change.

Definition at line 65 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ mesh_names_for_output

std::vector<std::string> ProcessLib::OutputConfig::mesh_names_for_output

Definition at line 59 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ number_of_files

unsigned int ProcessLib::OutputConfig::number_of_files

Definition at line 40 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ output_extrapolation_residuals

bool ProcessLib::OutputConfig::output_extrapolation_residuals

Definition at line 58 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ output_iteration_results

bool ProcessLib::OutputConfig::output_iteration_results

Definition at line 66 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ output_type

OutputType ProcessLib::OutputConfig::output_type

Supported output types are "VTK" and "XDMF".

For the "VTK" type a .pvd file referencing each time step, which is stored in a .vtu file is written. For the "XDMF" type all time steps are written to a .h5 HDF5 file and a .xdmf file references the actual data in the .h5 file. Both, the .pvd and the .xdmf files can be loaded by Paraview and other VTK based post-processing tools.

Definition at line 36 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ output_variables

std::set<std::string> ProcessLib::OutputConfig::output_variables

A list of variable names for output. If the list is empty, all available variables are written.

The variable names include: primary variables like temperature, displacement, etc., secondary variables like epsilon or sigma, residuals HeatFlux, NodalForces, integration point data (required for restart) for example sigma_ip. Available names are process and material models specific and can not be listed here.

Definition at line 57 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ prefix

std::string ProcessLib::OutputConfig::prefix

Definition at line 37 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ repeats_each_steps

std::vector<PairRepeatEachSteps> ProcessLib::OutputConfig::repeats_each_steps

A list of repeat/step-count pairs. If the list is empty, and no fixed_output_times were specified, a default pair 1/1 will be inserted resulting in all time steps being written.

The last pair is repeated until end of simulation time is reached.

Definition at line 48 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

◆ suffix

std::string ProcessLib::OutputConfig::suffix

Definition at line 38 of file OutputConfig.h.

Referenced by ProcessLib::createOutputConfig().

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