Reference documentation for deal.II version Git b458b3a 2015-09-01 15:11:43 -0500
Public Types | Public Member Functions | Public Attributes | List of all members
DataOutBase::VtkFlags Struct Reference

#include <deal.II/base/data_out_base.h>

Inheritance diagram for DataOutBase::VtkFlags:
[legend]

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)
 
- Public Member Functions inherited from DataOutBase::OutputFlagsBase< VtkFlags >
void parse_parameters (const ParameterHandler &prm)
 
std::size_t memory_consumption () const
 

Public Attributes

double time
 
unsigned int cycle
 
bool print_date_and_time
 
ZlibCompressionLevel compression_level
 

Additional Inherited Members

- Static Public Member Functions inherited from DataOutBase::OutputFlagsBase< VtkFlags >
static void declare_parameters (ParameterHandler &prm)
 

Detailed Description

Flags controlling the details of output in VTK format.

Definition at line 862 of file data_out_base.h.

Constructor & Destructor Documentation

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 
)

Constructor.

Definition at line 2001 of file data_out_base.cc.

Member Data Documentation

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 874 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 886 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 894 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 911 of file data_out_base.h.


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