Reference documentation for deal.II version Git cb0bd54b52 2019-09-21 16:31:22 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GridOutFlags::EpsFlagsBase Struct Reference

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

Inheritance diagram for GridOutFlags::EpsFlagsBase:
[legend]

Public Types

enum  SizeType { width, height }
 

Public Member Functions

 EpsFlagsBase (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 color_lines_level=false)
 
void parse_parameters (ParameterHandler &param)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &param)
 

Public Attributes

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 describing the details of output for encapsulated postscript. In this structure, the flags common to all dimensions are listed. Flags which are specific to one space dimension only are listed in derived classes.

By default, the size of the picture is scaled such that the width equals 300 units.

Definition at line 331 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.

Enumerator
width 

Scale with the width.

height 

Scale with the height.

Definition at line 338 of file grid_out.h.

Constructor & Destructor Documentation

◆ EpsFlagsBase()

GridOutFlags::EpsFlagsBase::EpsFlagsBase ( 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  color_lines_level = false 
)

Constructor.

Definition at line 200 of file grid_out.cc.

Member Function Documentation

◆ declare_parameters()

void GridOutFlags::EpsFlagsBase::declare_parameters ( ParameterHandler param)
static

Declare parameters in ParameterHandler.

Definition at line 216 of file grid_out.cc.

◆ parse_parameters()

void GridOutFlags::EpsFlagsBase::parse_parameters ( ParameterHandler param)

Parse parameters of ParameterHandler.

Definition at line 249 of file grid_out.cc.

Member Data Documentation

◆ size_type

SizeType GridOutFlags::EpsFlagsBase::size_type

See above. Default is width.

Definition at line 353 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 362 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 367 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 375 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 MappingQGeneric(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 387 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 395 of file grid_out.h.


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