Reference documentation for deal.II version Git ac8d010384 2020-11-27 19:49:05 +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::DXFlags Struct Reference

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

Inheritance diagram for DataOutBase::DXFlags:
[legend]

Public Member Functions

 DXFlags (const bool write_neighbors=false, const bool int_binary=false, const bool coordinates_binary=false, const bool data_binary=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_neighbors
 
bool int_binary
 
bool coordinates_binary
 
bool data_binary
 
bool data_double
 

Detailed Description

Flags controlling the details of output in OpenDX format.

Definition at line 600 of file data_out_base.h.

Constructor & Destructor Documentation

◆ DXFlags()

DataOutBase::DXFlags::DXFlags ( const bool  write_neighbors = false,
const bool  int_binary = false,
const bool  coordinates_binary = false,
const bool  data_binary = false 
)

Constructor.

Definition at line 2082 of file data_out_base.cc.

Member Function Documentation

◆ declare_parameters()

void DataOutBase::DXFlags::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 2095 of file data_out_base.cc.

◆ parse_parameters()

void DataOutBase::DXFlags::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 2126 of file data_out_base.cc.

◆ memory_consumption()

std::size_t DataOutBase::OutputFlagsBase< DXFlags >::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_neighbors

bool DataOutBase::DXFlags::write_neighbors

Write neighbor information. This information is necessary for instance, if OpenDX is supposed to compute integral curves (streamlines). If it is not present, streamlines end at cell boundaries.

Definition at line 607 of file data_out_base.h.

◆ int_binary

bool DataOutBase::DXFlags::int_binary

Write integer values of the Triangulation in binary format.

Definition at line 611 of file data_out_base.h.

◆ coordinates_binary

bool DataOutBase::DXFlags::coordinates_binary

Write coordinate vectors in binary format.

Definition at line 615 of file data_out_base.h.

◆ data_binary

bool DataOutBase::DXFlags::data_binary

Write data vectors in binary format.

Definition at line 620 of file data_out_base.h.

◆ data_double

bool DataOutBase::DXFlags::data_double

Write binary coordinate vectors as double (64 bit) numbers instead of float (32 bit).

Definition at line 626 of file data_out_base.h.


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