Reference documentation for deal.II version GIT relicensing-12-g89ba5bf9db 2024-02-24 00:00:03+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\}}\)
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
DataOutBase::GnuplotFlags Struct Reference

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

Inheritance diagram for DataOutBase::GnuplotFlags:
Inheritance graph

Public Member Functions

 GnuplotFlags ()
 GnuplotFlags (const std::vector< std::string > &space_dimension_labels)
std::size_t memory_consumption () const
void parse_parameters (const ParameterHandler &prm)

Static Public Member Functions

static ::ExceptionBaseExcNotEnoughSpaceDimensionLabels ()
static void declare_parameters (ParameterHandler &prm)

Public Attributes

std::vector< std::string > space_dimension_labels

Detailed Description

Flags controlling the details of output in Gnuplot format.

Definition at line 720 of file data_out_base.h.

Constructor & Destructor Documentation

◆ GnuplotFlags() [1/2]

DataOutBase::GnuplotFlags::GnuplotFlags ( )

Default constructor. Sets up the dimension labels with the default values of "x", "y", and "z".

Definition at line 1953 of file

◆ GnuplotFlags() [2/2]

DataOutBase::GnuplotFlags::GnuplotFlags ( const std::vector< std::string > &  space_dimension_labels)

Constructor which sets up non-default values for the dimension labels.

Definition at line 1962 of file

Member Function Documentation

◆ memory_consumption()

std::size_t DataOutBase::GnuplotFlags::memory_consumption ( ) const

Return an estimate for the memory consumption, in bytes, of this object.

Definition at line 1969 of file

◆ declare_parameters()

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

◆ parse_parameters()

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

Member Data Documentation

◆ space_dimension_labels

std::vector<std::string> DataOutBase::GnuplotFlags::space_dimension_labels

Labels to use in each spatial dimension. These default to "x", "y", and "z". Labels are printed to the Gnuplot file surrounded by angle brackets: For example, if the space dimension is 2 and the labels are "x" and "t", then the relevant line will start with

* # <x> <t>

Any extra labels will be ignored.

If you specify these labels yourself then there should be at least spacedim labels, where spacedim is the spatial dimension of the output data.

Definition at line 748 of file data_out_base.h.

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