Reference documentation for deal.II version GIT relicensing-693-g4fb6c325db 2024-05-21 16: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\}}\)
No Matches
Public Member Functions | Public Attributes | List of all members
MatrixOut::Options Struct Reference

#include <deal.II/lac/matrix_out.h>

Public Member Functions

 Options (const bool show_absolute_values=false, const unsigned int block_size=1, const bool discontinuous=false)

Public Attributes

bool show_absolute_values
unsigned int block_size
bool discontinuous

Detailed Description

Class holding various variables which are used to modify the output of the MatrixOut class.

Definition at line 82 of file matrix_out.h.

Constructor & Destructor Documentation

◆ Options()

MatrixOut::Options::Options ( const bool  show_absolute_values = false,
const unsigned int  block_size = 1,
const bool  discontinuous = false 

Default constructor. Set all elements of this structure to their default values.

Definition at line 20 of file

Member Data Documentation

◆ show_absolute_values

bool MatrixOut::Options::show_absolute_values

If true, only show the absolute values of the matrix entries, rather than their true values including the sign. Default value is false.

Definition at line 88 of file matrix_out.h.

◆ block_size

unsigned int MatrixOut::Options::block_size

If larger than one, do not show each element of the matrix, but rather an average over a number of entries. The number of output patches is accordingly smaller. This flag determines how large each shown block shall be (in rows/columns). For example, if it is two, then always four entries are collated into one.

Default value is one.

Definition at line 99 of file matrix_out.h.

◆ discontinuous

bool MatrixOut::Options::discontinuous

If true, plot discontinuous patches, one for each entry.

Definition at line 104 of file matrix_out.h.

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