Reference documentation for deal.II version Git e849c0d71e 2019-06-17 10:40:29 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GridOutFlags::Gnuplot Struct Reference

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

Public Member Functions

 Gnuplot (const bool write_cell_number=false, const unsigned int n_extra_curved_line_points=2, const bool curved_inner_cells=false, const bool write_additional_boundary_lines=true)
 
 Gnuplot (const Gnuplot &flags)
 
Gnuplotoperator= (const Gnuplot &flags)
 
void parse_parameters (ParameterHandler &param)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &param)
 

Public Attributes

bool write_cell_numbers
 
unsigned int n_extra_curved_line_points
 
unsigned int & n_boundary_face_points
 
bool curved_inner_cells
 
bool write_additional_boundary_lines
 

Detailed Description

Flags describing the details of output in GNUPLOT format.

Definition at line 231 of file grid_out.h.

Constructor & Destructor Documentation

◆ Gnuplot() [1/2]

GridOutFlags::Gnuplot::Gnuplot ( const bool  write_cell_number = false,
const unsigned int  n_extra_curved_line_points = 2,
const bool  curved_inner_cells = false,
const bool  write_additional_boundary_lines = true 
)

Constructor.

Definition at line 148 of file grid_out.cc.

◆ Gnuplot() [2/2]

GridOutFlags::Gnuplot::Gnuplot ( const Gnuplot flags)

Copy constructor. Needed since this class (for backwards compatibility) has a reference member variable.

Definition at line 162 of file grid_out.cc.

Member Function Documentation

◆ operator=()

Gnuplot & GridOutFlags::Gnuplot::operator= ( const Gnuplot flags)

Copy operator. Needed since this class (for backwards compatibility) has a reference member variable.

Definition at line 172 of file grid_out.cc.

◆ declare_parameters()

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

Declare parameters in ParameterHandler.

Definition at line 185 of file grid_out.cc.

◆ parse_parameters()

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

Parse parameters of ParameterHandler.

Definition at line 193 of file grid_out.cc.

Member Data Documentation

◆ write_cell_numbers

bool GridOutFlags::Gnuplot::write_cell_numbers

Write the number of each cell into the output file before starting with the lines it is composed of, as a comment. This might be useful if you want to find out details about the grid, for example the position of cells of which you know the number. It enlarges the size of the output significantly, however.

Default: false.

Definition at line 242 of file grid_out.h.

◆ n_extra_curved_line_points

unsigned int GridOutFlags::Gnuplot::n_extra_curved_line_points

Number of points, excluding the vertices, to plot on curved lines. Since GNUPLOT can only plot straight lines, setting this number to a value greater than zero (4 or 5 is usually enough for refined grids) makes the plot look curved even though it is not.

Definition at line 250 of file grid_out.h.

◆ n_boundary_face_points

unsigned int& GridOutFlags::Gnuplot::n_boundary_face_points

Based on the vertices of the face and n_boundary_face_points additional points a tensor product mesh (transformed to the real space) of (n_boundary_face_points+2)dim-1 points is plotted on each boundary face.

Deprecated:
Use n_extra_curved_line_points instead, which has a more precise name. For compatibility this is implemented as a reference to n_extra_curved_line_points.

Definition at line 262 of file grid_out.h.

◆ curved_inner_cells

bool GridOutFlags::Gnuplot::curved_inner_cells

Boolean indicating whether or not interior lines should be plotted with n_extra_curved_line_points line segments.

Definition at line 268 of file grid_out.h.

◆ write_additional_boundary_lines

bool GridOutFlags::Gnuplot::write_additional_boundary_lines

Flag. If true then, when writing spacedim = 3 output, write 2*n_extra_curved_line_points extra lines on boundary faces.

Setting this option has no effect when spacedim = 2 since, in that case, boundary faces are lines and outputting additional lines does not make sense.

Note
This is not yet implemented for the dim = 2 case. For backwards compatibility, however, this will not raise a runtime error.

Definition at line 281 of file grid_out.h.


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