Reference documentation for deal.II version Git 053e5b2 2017-07-21 22:33:36 -0600
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:

Public Member Functions

 GnuplotFlags ()
 GnuplotFlags (const std::vector< std::string > &space_dimension_labels)
std::size_t memory_consumption () const
- Public Member Functions inherited from DataOutBase::OutputFlagsBase< GnuplotFlags >
void parse_parameters (const ParameterHandler &prm)
std::size_t memory_consumption () const

Static Public Member Functions

static::ExceptionBase & ExcNotEnoughSpaceDimensionLabels ()
- Static Public Member Functions inherited from DataOutBase::OutputFlagsBase< GnuplotFlags >
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 526 of file data_out_base.h.

Constructor & Destructor Documentation

DataOutBase::GnuplotFlags::GnuplotFlags ( )

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

Definition at line 1643 of file

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 1652 of file

Member Function Documentation

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

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

Definition at line 1659 of file

Member Data Documentation

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 554 of file data_out_base.h.

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