Reference documentation for deal.II version GIT relicensing-16-gf4f69b3b42 2024-02-27 08:20:02+00:00
\(\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\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
DataOutBase::Hdf5Flags Struct Reference

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

Inheritance diagram for DataOutBase::Hdf5Flags:
Inheritance graph
[legend]

Public Member Functions

 Hdf5Flags (const CompressionLevel compression_level=CompressionLevel::best_speed)
 
void parse_parameters (const ParameterHandler &prm)
 
std::size_t memory_consumption () const
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 

Public Attributes

DataOutBase::CompressionLevel compression_level
 

Detailed Description

Flags controlling the details of output in HDF5 format.

Definition at line 1075 of file data_out_base.h.

Constructor & Destructor Documentation

◆ Hdf5Flags()

DataOutBase::Hdf5Flags::Hdf5Flags ( const CompressionLevel  compression_level = CompressionLevel::best_speed)
explicit

Definition at line 2402 of file data_out_base.cc.

Member Function Documentation

◆ declare_parameters()

void DataOutBase::OutputFlagsBase< Hdf5Flags >::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 574 of file data_out_base.h.

◆ parse_parameters()

void DataOutBase::OutputFlagsBase< Hdf5Flags >::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 584 of file data_out_base.h.

◆ memory_consumption()

std::size_t DataOutBase::OutputFlagsBase< Hdf5Flags >::memory_consumption ( ) const
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.

Member Data Documentation

◆ compression_level

DataOutBase::CompressionLevel DataOutBase::Hdf5Flags::compression_level

Flag determining the compression level at which zlib, if available, is run. The default is best_speed.

Definition at line 1081 of file data_out_base.h.


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