Reference documentation for deal.II version 9.4.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Static 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, 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
 
ZlibCompressionLevel compression_level
 
bool write_higher_order_cells
 
std::map< std::string, std::string > physical_units
 

Detailed Description

Flags controlling the details of output in VTK format.

Definition at line 1090 of file data_out_base.h.

Member Function Documentation

◆ declare_parameters()

void DataOutBase::OutputFlagsBase< VtkFlags >::declare_parameters ( ParameterHandler prm)
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 555 of file data_out_base.h.

◆ parse_parameters()

void DataOutBase::OutputFlagsBase< VtkFlags >::parse_parameters ( const ParameterHandler prm)
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 565 of file data_out_base.h.

◆ memory_consumption()

std::size_t DataOutBase::OutputFlagsBase< VtkFlags >::memory_consumption
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 574 of file data_out_base.h.


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