|
HyperHDG
|
A class storing options for plotting. More...
#include <plot.hxx>
Public Types | |
| enum | fileType { vtu } |
| Enum for possible file endings. More... | |
Public Attributes | |
| std::string | outputDir = "output" |
| Name of the directory to put the output into. More... | |
| std::string | fileName = "example" |
| Name of the file plotted. More... | |
| fileType | fileEnding = vtu |
| File ending and also way of plotting. More... | |
| unsigned int | fileNumber = 0 |
| Number of the plot file. More... | |
| bool | printFileNumber = true |
Decide whether fileNumber is part of the file name. More... | |
| bool | incrementFileNumber = true |
Decide whether fileNumber is incremented after plotting. More... | |
| bool | plot_edge_boundaries = false |
| Include the edge boundaries with their function values into the plot. More... | |
| bool | plot_edges = true |
| Include the hyperedges with their function values into the plot. More... | |
| unsigned int | n_subintervals = 1 |
| Number of subintervals for plotting. More... | |
| float | scale = 1. |
| A factor for scaling each object of the plot locally. More... | |
| float | boundary_scale = 1. |
| A factor by which to separate two boundaries belonging to different edges. More... | |
| bool | numbers = false |
| Output a cell data array with the number of each edge and/or each node. More... | |
A class storing options for plotting.
| float PlotOptions::boundary_scale = 1. |
A factor by which to separate two boundaries belonging to different edges.
This factor defaults to 1 which results in boundaries of adjacent edges being drawn on top of each other, if scale is less than one a suitable choice would be (1+scale)/2 in order separate different boundaries. A smaller factor results in a wider gap.
File ending and also way of plotting.
This std::string describes the name of the file ending for the output plot. Thus, it also characterizes which applications can read the output files properly. Default and currently only option is "vtu" for Paraview.
| std::string PlotOptions::fileName = "example" |
Name of the file plotted.
This std::string describes the name of the file for the output plot. Default is "example".
| unsigned int PlotOptions::fileNumber = 0 |
Number of the plot file.
This unsigned int describes the number of the plot file which is created. If a problem is solved repeatedly (e.g. parabolic problem, local refinement, ...) this number indicates the number of the file (e.g. time step, refinement step, ...). Default is 0.
| bool PlotOptions::incrementFileNumber = true |
Decide whether fileNumber is incremented after plotting.
This boolean discriminates whether the fileNumber should be incremented after a file has been written (true) or not (false). Default is true.
| unsigned int PlotOptions::n_subintervals = 1 |
Number of subintervals for plotting.
When plotting an interval, it is split into n_subintervals intervals such that higher order polynomials and other functions can be displayed appropriately. When plotting higher dimensional objects, this subdivision is applied accordingly in each direction.
This functionality is implemented such that higher order polynomials can be output as piecewise linear functions giving them sufficient meaning. It will increase the number of cells seen by the visualization tool, such that the cell boundaries there are not the actual cell boundaries anymore. You can still use the parameter scale below to see the separate edges.
Defaults to 1.
| bool PlotOptions::numbers = false |
Output a cell data array with the number of each edge and/or each node.
| std::string PlotOptions::outputDir = "output" |
Name of the directory to put the output into.
This std::string describes the directory the output is created in. Default is "output".
| bool PlotOptions::plot_edge_boundaries = false |
Include the edge boundaries with their function values into the plot.
Defaults to false.
| bool PlotOptions::plot_edges = true |
Include the hyperedges with their function values into the plot.
Defaults to true.
| bool PlotOptions::printFileNumber = true |
Decide whether fileNumber is part of the file name.
This boolean discriminates whether the fileNumber should appear within the name of the file (true) or not (false). Default is true.
| float PlotOptions::scale = 1. |
A factor for scaling each object of the plot locally.
This factor defaults to 1 in order to produce a plot of a contiguous domain. If it is chosen less than 1, each edge or node is scaled by this factor around its center.
1.8.17