Reference documentation for deal.II version Git 354f154960 2021-01-18 17:44:59 +0100
\(\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 Member Functions | Static Public Member Functions | Public Attributes | List of all members
DataOutBase::UcdFlags Struct Reference

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

Inheritance diagram for DataOutBase::UcdFlags:
[legend]

Public Member Functions

 UcdFlags (const bool write_preamble=false)
 
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 write_preamble
 

Detailed Description

Flags controlling the details of output in UCD format for AVS.

Definition at line 658 of file data_out_base.h.

Constructor & Destructor Documentation

◆ UcdFlags()

DataOutBase::UcdFlags::UcdFlags ( const bool  write_preamble = false)

Constructor.

Definition at line 2008 of file data_out_base.cc.

Member Function Documentation

◆ declare_parameters()

void DataOutBase::UcdFlags::declare_parameters ( ParameterHandler prm)
static

Declare all flags with name and type as offered by this class, for use in input files.

Definition at line 2153 of file data_out_base.cc.

◆ parse_parameters()

void DataOutBase::UcdFlags::parse_parameters ( const ParameterHandler prm)

Read the parameters declared in declare_parameters() and set the flags for this output format accordingly.

The flags thus obtained overwrite all previous contents of this object.

Definition at line 2167 of file data_out_base.cc.

◆ memory_consumption()

std::size_t DataOutBase::OutputFlagsBase< UcdFlags >::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 589 of file data_out_base.h.

Member Data Documentation

◆ write_preamble

bool DataOutBase::UcdFlags::write_preamble

Write a comment at the beginning of the file stating the date of creation and some other data. While this is supported by the UCD format and AVS, some other programs get confused by this, so the default is to not write a preamble. However, a preamble can be written using this flag.

Default: false.

Definition at line 669 of file data_out_base.h.


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