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
GridOutFlags::Vtk Struct Reference

#include <deal.II/grid/grid_out.h>

Inheritance diagram for GridOutFlags::Vtk:

Public Types

enum  ZlibCompressionLevel { no_compression , best_speed , best_compression , default_compression }

Public Member Functions

 Vtk (const bool output_cells=true, const bool output_faces=true, const bool output_edges=true, const bool output_only_relevant=true)
void parse_parameters (const ParameterHandler &prm)
std::size_t memory_consumption () const

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Public Attributes

bool output_cells
bool output_faces
bool output_edges
bool output_only_relevant
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 for grid output in Vtk format. These flags are the same as those declared in DataOutBase::VtkFlags.

Definition at line 859 of file grid_out.h.

Constructor & Destructor Documentation

◆ Vtk()

GridOutFlags::Vtk::Vtk ( const bool  output_cells = true,
const bool  output_faces = true,
const bool  output_edges = true,
const bool  output_only_relevant = true 

Default constructor.

Definition at line 864 of file grid_out.h.

Member Function Documentation

◆ declare_parameters()

void DataOutBase::OutputFlagsBase< VtkFlags >::declare_parameters ( ParameterHandler prm)

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)

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

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.

Member Data Documentation

◆ output_cells

bool GridOutFlags::Vtk::output_cells

Output cells.

Definition at line 877 of file grid_out.h.

◆ output_faces

bool GridOutFlags::Vtk::output_faces

Output faces.

Definition at line 882 of file grid_out.h.

◆ output_edges

bool GridOutFlags::Vtk::output_edges

Output co-faces/edges.

Definition at line 887 of file grid_out.h.

◆ output_only_relevant

bool GridOutFlags::Vtk::output_only_relevant

Output only faces/co-faces that differ from the default settings (e.g boundary_id).

Definition at line 893 of file grid_out.h.

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