Reference documentation for deal.II version Git 063e7ff 2014-09-30 18:32:14 -0500
 All Classes Namespaces Files 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 427 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

Determine an estimate for the memory consumption (in bytes) of this object. Since sometimes the size of objects can not be determined exactly (for example: what is the memory consumption of an STL std::map type with a certain number of elements?), this is only an estimate. however often quite close to the true value.

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


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