Reference documentation for deal.II version Git a6ccdbf 2015-05-27 12:17:21 +0200
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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>

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

Constructor & Destructor Documentation

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

Constructor.

Member Function Documentation

static 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.

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.

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

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.

Member Data Documentation

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


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