GridOutFlags::Svg Struct Reference

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

Public Types

Public Member Functions
	Svg (const unsigned int line_thickness=2, const unsigned int boundary_line_thickness=4, bool margin=true, const Background background=white, const int azimuth_angle=0, const int polar_angle=0, const Coloring coloring=level_number, const bool convert_level_number_to_height=false, const bool label_level_number=true, const bool label_cell_index=true, const bool label_material_id=false, const bool label_subdomain_id=false, const bool draw_colorbar=true, const bool draw_legend=true)

Public Attributes
unsigned int	height
unsigned int	width
unsigned int	line_thickness
	Thickness of the lines between cells.
unsigned int	boundary_line_thickness
	Thickness of lines at the boundary.
bool	margin
	Margin around the plotted area.
int	azimuth_angle
int	polar_angle
bool	convert_level_number_to_height
float	level_height_factor
float	cell_font_scaling
	Scaling of the font for cell annotations. Defaults to 1.
bool	label_level_number
	Write level number into each cell. Defaults to true.
bool	label_cell_index
	Write cell index into each cell. Defaults to true.
bool	label_material_id
	Write material id of each cell. Defaults to false.
bool	label_subdomain_id
	Write subdomain id of each cell. Defaults to false.
bool	label_level_subdomain_id
	Write level subdomain id of each cell. Defaults to false.
bool	draw_colorbar
bool	draw_legend

Detailed Description

Flags controlling SVG output.

Definition at line 670 of file grid_out.h.

Member Enumeration Documentation

enum GridOutFlags::Svg::Background

Background style.

Enumerator
transparent	Use transparent value of SVG.
white	Use white background.
dealii	Use a gradient from white (top) to steelblue (bottom), and add date and time plus a deal.II logo. Automatically draws a margin.

Definition at line 689 of file grid_out.h.

enum GridOutFlags::Svg::Coloring

Cell coloring.

Enumerator
none	No cell coloring.
material_id	Convert the material id into the cell color (default)
level_number	Convert the level number into the cell color.
subdomain_id	Convert the subdomain id into the cell color.
level_subdomain_id	Convert the level subdomain id into the cell color.

Definition at line 716 of file grid_out.h.

Constructor & Destructor Documentation

GridOutFlags::Svg::Svg	(	const unsigned int	line_thickness = 2,
		const unsigned int	boundary_line_thickness = 4,
		bool	margin = true,
		const Background	background = white,
		const int	azimuth_angle = 0,
		const int	polar_angle = 0,
		const Coloring	coloring = level_number,
		const bool	convert_level_number_to_height = false,
		const bool	label_level_number = true,
		const bool	label_cell_index = true,
		const bool	label_material_id = false,
		const bool	label_subdomain_id = false,
		const bool	draw_colorbar = true,
		const bool	draw_legend = true
	)

Constructor.

Definition at line 427 of file grid_out.cc.

Member Data Documentation

unsigned int GridOutFlags::Svg::height

Height of the plot in SVG units, computed from width if zero. Defaults to 1000

Definition at line 674 of file grid_out.h.

unsigned int GridOutFlags::Svg::width

The width of the plot. Computed automatically from height if zero (default)

Definition at line 677 of file grid_out.h.

int GridOutFlags::Svg::azimuth_angle

The azimuth angle measured from ??? in degrees. Default is 0.

Definition at line 707 of file grid_out.h.

int GridOutFlags::Svg::polar_angle

The angle from vertically above the xy-plane. Default is 0.

Definition at line 711 of file grid_out.h.

bool GridOutFlags::Svg::convert_level_number_to_height

Interpret the level number of the cells as altitude over the x-y-plane (useful in the perspective view).

Definition at line 734 of file grid_out.h.

float GridOutFlags::Svg::level_height_factor

The factor determining the vertical distance between levels (default = 0.3)

Definition at line 738 of file grid_out.h.

bool GridOutFlags::Svg::draw_colorbar

Draw a colorbar next to the plotted grid with respect to the chosen coloring of the cells

Definition at line 755 of file grid_out.h.

bool GridOutFlags::Svg::draw_legend

Draw a legend next to the plotted grid, explaining the label of the cells

Definition at line 758 of file grid_out.h.

---

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

• deal.II/grid/grid_out.h
• /mnt/data/darndt/Sources/dealii-clang-6.0.0/source/grid/grid_out.cc