Reference documentation for deal.II version GIT relicensing-750-gcfa4c29382 2024-05-25 07: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 Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GridOutFlags::Eps< 2 > Struct Reference

#include <deal.II/grid/grid_out.h>

Inheritance diagram for GridOutFlags::Eps< 2 >:
Inheritance graph

Public Types

enum  SizeType { width , height }

Public Member Functions

 Eps (const SizeType size_type=width, const unsigned int size=300, const double line_width=0.5, const bool color_lines_on_user_flag=false, const unsigned int n_boundary_face_points=2, const bool write_cell_numbers=false, const bool write_cell_number_level=true, const bool write_vertex_numbers=false, const bool color_lines_level=false)
void parse_parameters (ParameterHandler &param)

Static Public Member Functions

static void declare_parameters (ParameterHandler &param)

Public Attributes

bool write_cell_numbers
bool write_cell_number_level
bool write_vertex_numbers
SizeType size_type
unsigned int size
double line_width
bool color_lines_on_user_flag
unsigned int n_boundary_face_points
bool color_lines_level

Detailed Description

Flags specific to the output of grids in two space dimensions.

Definition at line 445 of file grid_out.h.

Member Enumeration Documentation

◆ SizeType

Enum denoting the possibilities whether the scaling should be done such that the given size equals the width or the height of the resulting picture.


Scale with the width.


Scale with the height.

Definition at line 313 of file grid_out.h.

Constructor & Destructor Documentation

◆ Eps()

GridOutFlags::Eps< 2 >::Eps ( const SizeType  size_type = width,
const unsigned int  size = 300,
const double  line_width = 0.5,
const bool  color_lines_on_user_flag = false,
const unsigned int  n_boundary_face_points = 2,
const bool  write_cell_numbers = false,
const bool  write_cell_number_level = true,
const bool  write_vertex_numbers = false,
const bool  color_lines_level = false 


Definition at line 272 of file

Member Function Documentation

◆ declare_parameters()

void GridOutFlags::Eps< 2 >::declare_parameters ( ParameterHandler param)

Declare parameters in ParameterHandler.

Definition at line 294 of file

◆ parse_parameters()

void GridOutFlags::Eps< 2 >::parse_parameters ( ParameterHandler param)

Parse parameters of ParameterHandler.

Definition at line 314 of file

Member Data Documentation

◆ write_cell_numbers

bool GridOutFlags::Eps< 2 >::write_cell_numbers

If this flag is set, then we place the number of the cell into the middle of each cell. The default value is to not do this.

The format of the cell number written is level.index, or simply index, depending on the value of the following flag.

Definition at line 454 of file grid_out.h.

◆ write_cell_number_level

bool GridOutFlags::Eps< 2 >::write_cell_number_level

If the cell numbers shall be written, using the above flag, then the value of this flag determines whether the format shall be level.index, or simply index. If true, the first format is taken. Default is true.

The flag has obviously no effect if write_cell_numbers is false.

Definition at line 463 of file grid_out.h.

◆ write_vertex_numbers

bool GridOutFlags::Eps< 2 >::write_vertex_numbers

Vertex numbers can be written onto the vertices. This is controlled by the following flag. Default is false.

Definition at line 469 of file grid_out.h.

◆ size_type

SizeType GridOutFlags::EpsFlagsBase::size_type

See above. Default is width.

Definition at line 328 of file grid_out.h.

◆ size

unsigned int GridOutFlags::EpsFlagsBase::size

Width or height of the output as given in postscript units This usually is given by the strange unit 1/72 inch. Whether this is height or width is specified by the flag size_type.

Default is 300.

Definition at line 337 of file grid_out.h.

◆ line_width

double GridOutFlags::EpsFlagsBase::line_width

Width of a line in postscript units. Default is 0.5.

Definition at line 342 of file grid_out.h.

◆ color_lines_on_user_flag

bool GridOutFlags::EpsFlagsBase::color_lines_on_user_flag

Should lines with a set user_flag be drawn in a different color (red)? See GlossUserFlags for information about user flags.

Definition at line 350 of file grid_out.h.

◆ n_boundary_face_points

unsigned int GridOutFlags::EpsFlagsBase::n_boundary_face_points

The number of points on a boundary face that are plotted in addition to the vertices of the face.

This number is only used if the mapping used is not simply the standard \(Q_1\) mapping (i.e., an object of kind MappingQ(1)) that may describe edges of cells as curved and that will then be approximated using line segments with a number of intermediate points as described by the current variable.

Definition at line 362 of file grid_out.h.

◆ color_lines_level

bool GridOutFlags::EpsFlagsBase::color_lines_level

Should lines be colored according to their refinement level? This overrides color_lines_on_user_flag for all levels except level 0. Colors are: level 0: black, other levels: rainbow scale from blue to red.

Definition at line 370 of file grid_out.h.

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