![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/grid/grid_out.h>
Public Types | |
enum | Background { transparent , white , dealii } |
enum | Coloring { none , material_id , level_number , subdomain_id , level_subdomain_id } |
Public Member Functions | |
Svg (const unsigned int line_thickness=2, const unsigned int boundary_line_thickness=4, const 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=false, const bool label_cell_index=false, const bool label_material_id=false, const bool label_subdomain_id=false, const bool draw_colorbar=false, const bool draw_legend=false, const bool label_boundary_id=false) | |
Public Attributes | |
unsigned int | height |
unsigned int | width |
unsigned int | line_thickness |
unsigned int | boundary_line_thickness |
bool | margin |
Background | background |
int | azimuth_angle |
int | polar_angle |
Coloring | coloring |
bool | convert_level_number_to_height |
float | level_height_factor |
float | cell_font_scaling |
bool | label_level_number |
bool | label_cell_index |
bool | label_material_id |
bool | label_subdomain_id |
bool | label_level_subdomain_id |
bool | label_boundary_id |
bool | draw_colorbar |
bool | draw_legend |
Flags controlling SVG output.
The figure below is a zoomed-in illustration of what the SVG flags are capable of producing. These exact settings are the same as those used in the test tests/grid/grid_out_svg_02.cc
with the addition of the flag svg_flags.label_boundary_id = true;
.
Definition at line 655 of file grid_out.h.
An enum
describing all possible background styles.
Definition at line 686 of file grid_out.h.
Cell coloring.
Definition at line 726 of file grid_out.h.
GridOutFlags::Svg::Svg | ( | const unsigned int | line_thickness = 2, |
const unsigned int | boundary_line_thickness = 4, | ||
const 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 = false, | ||
const bool | label_cell_index = false, | ||
const bool | label_material_id = false, | ||
const bool | label_subdomain_id = false, | ||
const bool | draw_colorbar = false, | ||
const bool | draw_legend = false, | ||
const bool | label_boundary_id = false ) |
Constructor.
Definition at line 409 of file grid_out.cc.
unsigned int GridOutFlags::Svg::height |
Height of the plot in SVG units, computed from width if zero. Defaults to 1000.
Definition at line 661 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 667 of file grid_out.h.
unsigned int GridOutFlags::Svg::line_thickness |
Thickness of the lines between cells.
Definition at line 672 of file grid_out.h.
unsigned int GridOutFlags::Svg::boundary_line_thickness |
Thickness of lines at the boundary.
Definition at line 676 of file grid_out.h.
bool GridOutFlags::Svg::margin |
Margin around the plotted area.
Definition at line 681 of file grid_out.h.
Background GridOutFlags::Svg::background |
The style used for the background of the mesh.
Definition at line 708 of file grid_out.h.
int GridOutFlags::Svg::azimuth_angle |
The azimuth angle measured from ??? in degrees. Default is 0.
Definition at line 716 of file grid_out.h.
int GridOutFlags::Svg::polar_angle |
The angle from vertically above the xy-plane. Default is 0.
Definition at line 721 of file grid_out.h.
Coloring GridOutFlags::Svg::coloring |
Definition at line 740 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 744 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 750 of file grid_out.h.
float GridOutFlags::Svg::cell_font_scaling |
Scaling of the font for cell annotations. Defaults to 1.
Definition at line 755 of file grid_out.h.
bool GridOutFlags::Svg::label_level_number |
Write level number into each cell. Defaults to false.
Definition at line 759 of file grid_out.h.
bool GridOutFlags::Svg::label_cell_index |
Write cell index into each cell. Defaults to false.
Definition at line 764 of file grid_out.h.
bool GridOutFlags::Svg::label_material_id |
Write material id of each cell. Defaults to false.
Definition at line 769 of file grid_out.h.
bool GridOutFlags::Svg::label_subdomain_id |
Write subdomain id of each cell. Defaults to false.
Definition at line 774 of file grid_out.h.
bool GridOutFlags::Svg::label_level_subdomain_id |
Write level subdomain id of each cell. Defaults to false.
Definition at line 779 of file grid_out.h.
bool GridOutFlags::Svg::label_boundary_id |
Write boundary id of each boundary face in a circle on the corresponding boundary edge. Defaults to false.
Note: Depending on the choice of image viewer, the boundary id labels may not appear to be centered in the circle.
Definition at line 788 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 794 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 800 of file grid_out.h.