Reference documentation for deal.II version Git 34859fde61 2019-12-10 11:26:22 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | List of all members
DataOutBase::OutputFlagsBase< FlagsType > Struct Template Reference

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

Inheritance diagram for DataOutBase::OutputFlagsBase< FlagsType >:
[legend]

Public Member Functions

void parse_parameters (const ParameterHandler &prm)
 
std::size_t memory_consumption () const
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 

Detailed Description

template<typename FlagsType>
struct DataOutBase::OutputFlagsBase< FlagsType >

Base class describing common functionality between different output flags.

This is implemented with the "Curiously Recurring Template Pattern"; derived classes use their own type to fill in the typename so that memory_consumption works correctly. See the Wikipedia page on the pattern for more information.

Definition at line 536 of file data_out_base.h.

Member Function Documentation

◆ declare_parameters()

template<typename FlagsType >
void DataOutBase::OutputFlagsBase< FlagsType >::declare_parameters ( ParameterHandler prm)
static

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

This method does nothing, but child classes may override this method to add fields to prm.

Definition at line 571 of file data_out_base.h.

◆ parse_parameters()

template<typename FlagsType >
void DataOutBase::OutputFlagsBase< FlagsType >::parse_parameters ( const ParameterHandler prm)

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

This method does nothing, but child classes may override this method to add fields to prm.

Definition at line 577 of file data_out_base.h.

◆ memory_consumption()

template<typename FlagsType >
std::size_t DataOutBase::OutputFlagsBase< FlagsType >::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.

Definition at line 583 of file data_out_base.h.


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