DataOutBase::SvgFlags Struct Reference

#include <deal.II/base/data_out_base.h>

Inheritance diagram for DataOutBase::SvgFlags:

Public Member Functions
	SvgFlags (const unsigned int height_vector=0, const int azimuth_angle=37, const int polar_angle=45, const unsigned int line_thickness=1, const bool margin=true, const bool draw_colorbar=true)
void	parse_parameters (const ParameterHandler &prm)
std::size_t	memory_consumption () const

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm)

Public Attributes
unsigned int	height
unsigned int	width
unsigned int	height_vector
int	azimuth_angle
int	polar_angle
unsigned int	line_thickness
bool	margin
bool	draw_colorbar

Detailed Description

Flags for SVG output.

Definition at line 1227 of file data_out_base.h.

Constructor & Destructor Documentation

SvgFlags()

DataOutBase::SvgFlags::SvgFlags	(	const unsigned int	height_vector = 0,
		const int	azimuth_angle = 37,
		const int	polar_angle = 45,
		const unsigned int	line_thickness = 1,
		const bool	margin = true,
		const bool	draw_colorbar = true
	)

Constructor.

Definition at line 2119 of file data_out_base.cc.

Member Function Documentation

declare_parameters()

void DataOutBase::OutputFlagsBase< SvgFlags >::declare_parameters ( ParameterHandler &  prm )

staticinherited

Declare all flags with name and type as offered by this class, for use in input files.

This method does nothing, but child classes may override this method to add fields to prm.

Definition at line 574 of file data_out_base.h.

parse_parameters()

void DataOutBase::OutputFlagsBase< SvgFlags >::parse_parameters ( const ParameterHandler &  prm )

inherited

Read the parameters declared in declare_parameters() and set the flags for this output format accordingly.

This method does nothing, but child classes may override this method to add fields to prm.

Definition at line 584 of file data_out_base.h.

memory_consumption()

std::size_t DataOutBase::OutputFlagsBase< SvgFlags >::memory_consumption ( ) const

inherited

Return an estimate for the memory consumption, in bytes, of this object. This is not exact (but will usually be close) because calculating the memory usage of trees (e.g., std::map) is difficult.

Definition at line 593 of file data_out_base.h.

Member Data Documentation

height

unsigned int DataOutBase::SvgFlags::height

Height of the image in SVG units. Default value is 4000.

Definition at line 1232 of file data_out_base.h.

width

unsigned int DataOutBase::SvgFlags::width

Width of the image in SVG units. If left zero, the width is computed from the height.

Definition at line 1238 of file data_out_base.h.

height_vector

unsigned int DataOutBase::SvgFlags::height_vector

This denotes the number of the data vector which shall be used for generating the height information. By default, the first data vector is taken, i.e. height_vector==0, if there is any data vector. If there is no data vector, no height information is generated.

Definition at line 1246 of file data_out_base.h.

azimuth_angle

int DataOutBase::SvgFlags::azimuth_angle

Angles for the perspective view

Definition at line 1251 of file data_out_base.h.

polar_angle

int DataOutBase::SvgFlags::polar_angle

Definition at line 1251 of file data_out_base.h.

line_thickness

unsigned int DataOutBase::SvgFlags::line_thickness

Definition at line 1253 of file data_out_base.h.

margin

bool DataOutBase::SvgFlags::margin

Draw a margin of 5% around the plotted area

Definition at line 1258 of file data_out_base.h.

draw_colorbar

bool DataOutBase::SvgFlags::draw_colorbar

Draw a colorbar encoding the cell coloring

Definition at line 1263 of file data_out_base.h.

---

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

• include/deal.II/base/data_out_base.h
• source/base/data_out_base.cc