Reference documentation for deal.II version GIT relicensing-136-gb80d0be4af 2024-03-18 08:20:02+00:00
\(\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\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
DataOutBase::DataOutFilterFlags Struct Reference

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

Public Member Functions

 DataOutFilterFlags (const bool filter_duplicate_vertices=false, const bool xdmf_hdf5_output=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 filter_duplicate_vertices
 
bool xdmf_hdf5_output
 

Detailed Description

Flags controlling the behavior of the DataOutFilter class.

Definition at line 1318 of file data_out_base.h.

Constructor & Destructor Documentation

◆ DataOutFilterFlags()

DataOutBase::DataOutFilterFlags::DataOutFilterFlags ( const bool  filter_duplicate_vertices = false,
const bool  xdmf_hdf5_output = false 
)

Constructor.

Definition at line 1985 of file data_out_base.cc.

Member Function Documentation

◆ declare_parameters()

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

◆ parse_parameters()

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

◆ memory_consumption()

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

Determine an estimate for the memory consumption (in bytes) of this object.

Member Data Documentation

◆ filter_duplicate_vertices

bool DataOutBase::DataOutFilterFlags::filter_duplicate_vertices

Whether or not to filter out duplicate vertices and associated values. Setting this value to true will drastically reduce the output data size but will result in an output file that does not faithfully represent the actual data if the data corresponds to discontinuous fields. In particular, along subdomain boundaries the data will still be discontinuous, while it will look like a continuous field inside of the subdomain.

Definition at line 1329 of file data_out_base.h.

◆ xdmf_hdf5_output

bool DataOutBase::DataOutFilterFlags::xdmf_hdf5_output

Whether the XDMF output refers to HDF5 files. This affects how output is structured.

Definition at line 1335 of file data_out_base.h.


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