![]() |
Reference documentation for deal.II version Git 99efdf013c 2021-02-27 20:52:41 -0500
|
#include <deal.II/base/data_out_base.h>
Public Types | |
enum | ZlibCompressionLevel { no_compression, best_speed, best_compression, default_compression } |
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 ZlibCompressionLevel compression_level=best_compression, const bool write_higher_order_cells=false) | |
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 |
ZlibCompressionLevel | compression_level |
bool | write_higher_order_cells |
Flags controlling the details of output in VTK format.
Definition at line 1087 of file data_out_base.h.
A data type providing the different possible zlib compression levels. These map directly to constants defined by zlib.
Definition at line 1125 of file data_out_base.h.
DataOutBase::VtkFlags::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 ZlibCompressionLevel | compression_level = best_compression , |
||
const bool | write_higher_order_cells = false |
||
) |
Constructor.
Definition at line 2504 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 577 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 583 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 589 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 1099 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 1111 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 1119 of file data_out_base.h.
ZlibCompressionLevel DataOutBase::VtkFlags::compression_level |
Flag determining the compression level at which zlib, if available, is run. The default is best_compression
.
Definition at line 1151 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 1170 of file data_out_base.h.