deal.II version GIT relicensing-2206-gaa53ff9447 2024-12-02 09:10:00+00:00
|
#include <deal.II/base/data_out_base.h>
Public Member Functions | |
VtkFlags (const double time=std::numeric_limits< double >::min(), const unsigned int cycle=std::numeric_limits< unsigned int >::min(), const bool print_date_and_time=true, const CompressionLevel compression_level=CompressionLevel::best_speed, const bool write_higher_order_cells=false, const std::map< std::string, std::string > &physical_units={}) | |
void | parse_parameters (const ParameterHandler &prm) |
std::size_t | memory_consumption () const |
Static Public Member Functions | |
static void | declare_parameters (ParameterHandler &prm) |
Public Attributes | |
double | time |
unsigned int | cycle |
bool | print_date_and_time |
DataOutBase::CompressionLevel | compression_level |
bool | write_higher_order_cells |
std::map< std::string, std::string > | physical_units |
Flags controlling the details of output in VTK format.
Definition at line 1126 of file data_out_base.h.
|
explicit |
Constructor. Initializes the member variables with names corresponding to the argument names of this function.
Definition at line 2428 of file data_out_base.cc.
|
staticinherited |
Declare all flags with name and type as offered by this class, for use in input files.
This method does nothing, but child classes may override this method to add fields to prm
.
Definition at line 574 of file data_out_base.h.
|
inherited |
Read the parameters declared in declare_parameters() and set the flags for this output format accordingly.
This method does nothing, but child classes may override this method to add fields to prm
.
Definition at line 584 of file data_out_base.h.
|
inherited |
Return an estimate for the memory consumption, in bytes, of this object. This is not exact (but will usually be close) because calculating the memory usage of trees (e.g., std::map
) is difficult.
Definition at line 593 of file data_out_base.h.
double DataOutBase::VtkFlags::time |
The time of the time step if this file is part of a time dependent simulation.
The value of this variable is written into the output file according to the instructions provided in http://www.visitusers.org/index.php?title=Time_and_Cycle_in_VTK_files unless it is at its default value of
std::numeric_limits<unsigned int>::min()
.
Definition at line 1138 of file data_out_base.h.
unsigned int DataOutBase::VtkFlags::cycle |
The number of the time step if this file is part of a time dependent simulation, or the cycle within a nonlinear or other iteration.
The value of this variable is written into the output file according to the instructions provided in http://www.visitusers.org/index.php?title=Time_and_Cycle_in_VTK_files unless it is at its default value of
std::numeric_limits<unsigned int>::min()
.
Definition at line 1150 of file data_out_base.h.
bool DataOutBase::VtkFlags::print_date_and_time |
Flag to determine whether the current date and time shall be printed as a comment in the file's second line.
Default is true
.
Definition at line 1158 of file data_out_base.h.
DataOutBase::CompressionLevel DataOutBase::VtkFlags::compression_level |
Flag determining the compression level at which zlib, if available, is run. The default is best_speed
.
Definition at line 1164 of file data_out_base.h.
bool DataOutBase::VtkFlags::write_higher_order_cells |
Flag determining whether to write patches as linear cells or as a high-order Lagrange cell.
Default is false
.
Definition at line 1183 of file data_out_base.h.
std::map<std::string, std::string> DataOutBase::VtkFlags::physical_units |
A map that describes for (some or all) of the output quantities what the physical units are. This field is ignored for VTK file format, but used for VTU format where it is attached to the individual scalar, vector, or tensor fields for use by visualization or other postprocessing tools. The default is to not attach any physical units to fields at all, i.e., an empty map.
If the map does not contain an entry for a specific output variable, then no unit will be written into the output file. In other words, it is not an error to provide units for only some variables.
step-19, step-44 and step-69 all demonstrate how to use this variable.
Definition at line 1206 of file data_out_base.h.