![]() |
Reference documentation for deal.II version 8.1.0
|
#include <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) | |
void | parse_parameters (const ParameterHandler &prm) const |
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 |
Flags controlling the details of output in VTK format.
Definition at line 951 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 |
||
) |
Default constructor.
|
static |
Declare the flags with name and type as offered by this class, for use in input files.
Unlike the flags in many of the other classes similar to this one, we do not actually declare parameters for the cycle and time member variables of this class. The reason is that there wouldn't appear to be a case where one would want to declare these parameters in an input file. Rather, these are typically values that change during the course of a simulation and can only reasonably be set as part of the execution of a program, rather than a priori by a user who runs this program.
void DataOutBase::VtkFlags::parse_parameters | ( | const ParameterHandler & | prm | ) | const |
Read the parameters declared in declare_parameters() and set the flags for this output format accordingly.
The flags thus obtained overwrite all previous contents of this object.
std::size_t DataOutBase::VtkFlags::memory_consumption | ( | ) | const |
Determine an estimate for the memory consumption (in bytes) of this object. Since sometimes the size of objects can not be determined exactly (for example: what is the memory consumption of an STL std::map
type with a certain number of elements?), this is only an estimate. however often quite close to the true value.
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<double>::min().
Definition at line 964 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 977 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 985 of file data_out_base.h.