6. Post-processing module
Gmsh's post-processing module can handle multiple scalar, vector or tensor
data sets along with the geometry and the mesh. The data sets should be
given in one of Gmsh's post-processing file formats described in 9. File formats. Once loaded into Gmsh, scalar fields can be displayed as iso-value
lines and surfaces or color maps, whereas vector fields can be represented
either by three-dimensional arrows or by displacement maps. (Tensor fields
are currently displayed as Von-Mises effective stresses. To display other
(combinations of) components, use Plugin(Extract)
: see
6.2 Post-processing plugins.)
In Gmsh's jargon, each data set is called a "view", and can arbitrarily
mix all types of elements and fields. Each view is given a name, and can be
manipulated either individually (each view has its own button in the GUI and
can be referred to by its index in a script) or globally (see the
PostProcessing.Link
option in 6.3 Post-processing options).
By default, Gmsh treats all post-processing views as three-dimensional
plots, i.e., draws the scalar, vector and tensor primitives (points, lines,
triangles, tetrahedra, etc.) in 3D space. But Gmsh can also represent each
post-processing view containing scalar points as two-dimensional
("X-Y") plots, either space- or time-oriented:
-
in a `2D space' plot, the scalar points are taken in the same order as they
are defined in the post-processing view: the abscissa of the 2D graph is
the curvilinear abscissa of the curve defined by the point series, and only
one curve is drawn using the values associated with the points. If several
time steps are available, each time step generates a new curve;
-
in a `2D time' plot, one curve is drawn for each scalar point in the view
and the abscissa is the time step.
Although visualization is usually mostly an interactive task, Gmsh exposes
all the post-processing commands and options to the user in its scripting
language to permit a complete automation of the post-processing process (see
e.g., 7.8 `t8.geo', and 7.9 `t9.geo').
The two following sections summarize all available post-processing commands
and options. Most options apply to both 2D and 3D plots (colormaps,
point/line sizes, interval types, time step selection, etc.), but some are
peculiar to 3D (lightning, element selection, etc.) or 2D plots (abscissa
labels, etc.). Note that 2D plots can be positioned explicitly inside the
graphical window, or be automatically positioned in order to avoid overlaps.
Sample post-processing files in human-readable "parsed" format are
available in the `tutorial' directory of Gmsh's distribution
(`.pos' files).
6.1 Post-processing commands
Alias View[expression];
-
Creates an alias of the expression-th post-processing view.
Note that Alias
creates a logical duplicate of the view without
actually duplicating the data in memory. This is very useful when you want
multiple simultaneous renderings of the same large dataset (usually with
different display options), but you cannot afford to store all copies in
memory. If what you really want is multiple physical copies of the data,
just merge the file containing the post-processing view multiple times.
AliasWithOptions View[expression];
-
Creates an alias of the expression-th post-processing view and copies
all the options of the expression-th view to the new aliased view.
Combine ElementsByViewName;
-
Combines all the post-processing views having the same name into new views.
The combination is done "spatially", i.e., simply by appending the
elements at the end of the new views.
Combine ElementsFromAllViews | Combine Views;
-
Combines all the post-processing views into a single new view. The
combination is done "spatially", i.e., simply by appending the elements at
the end of the new view.
Combine ElementsFromVisibleViews;
-
Combines all the visible post-processing views into a single new view. The
combination is done "spatially", i.e., simply by appending the elements at
the end of the new view.
Combine TimeStepsByViewName | Combine TimeSteps;
-
Combines the data from all the post-processing views having the same name
into new multi-time-step views. The combination is done "temporally",
i.e., as if the data in each view corresponds to a different time
instant. The combination will fail if the meshes in all the views are not
identical.
Combine TimeStepsFromAllViews;
-
Combines the data from all the post-processing views into a new
multi-time-step view. The combination is done "temporally", i.e., as if
the data in each view corresponds to a different time instant. The
combination will fail if the meshes in all the views are not identical.
Combine TimeStepsFromVisibleViews;
-
Combines the data from all the visible post-processing views into a new
multi-time-step view. The combination is done "temporally", i.e., as if
the data in each view corresponds to a different time instant. The
combination will fail if the meshes in all the views are not identical.
Delete View[expression];
-
Deletes (removes) the expression-th post-processing view. Note that
post-processing view numbers start at 0.
Delete Empty Views;
-
Deletes (removes) all the empty post-processing views.
Background Mesh View[expression];
-
Applies the expression-th post-processing view as the current
background mesh. Note that post-processing view numbers start at 0.
Plugin (string) . Run;
-
Executes the plugin string. The list of default plugins is given in
6.2 Post-processing plugins.
Plugin (string) . string = expression | char-expression;
-
Sets an option for a given plugin. See 6.2 Post-processing plugins, for a
list of default plugins and 7.9 `t9.geo', for some examples.
Save View[expression] char-expression;
-
Saves the the expression-th post-processing view in a file named
char-expression. If the path in char-expression is not absolute,
char-expression is appended to the path of the current file.
View "string" { string < ( expression-list ) > { expression-list }; ... };
-
Creates a new post-processing view, named
"string"
. This
is an easy and quite powerful way to import post-processing data: all
the values are expressions, you can embed datasets directly into
your geometrical descriptions (see, e.g., 7.4 `t4.geo'), the data can be
easily generated "on-the-fly" (there is no header containing a
priori information on the size of the dataset). The syntax is also very
permissive, which makes it ideal for testing purposes.
However this "parsed format" is read by Gmsh's script parser, which
makes it inefficient if there are many elements in the dataset. Also,
there is no connectivity information in parsed views and all the
elements are independent (all fields can be discontinuous), so a lot of
information can be duplicated. For large datasets, you should thus use
the mesh-based post-processing file format described in 9. File formats, or use one of the standard formats like MED.
More explicitly, the syntax for a parsed View
is the following
| View "string" {
< TIME { expression-list }; >
type ( list-of-coords ) { list-of-values };
...
};
|
where the 47 object types that can be displayed are:
| type #list-of-coords #list-of-values
--------------------------------------------------------------------
Scalar point SP 3 1 * nb-time-steps
Vector point VP 3 3 * nb-time-steps
Tensor point TP 3 9 * nb-time-steps
Scalar line SL 6 2 * nb-time-steps
Vector line VL 6 6 * nb-time-steps
Tensor line TL 6 18 * nb-time-steps
Scalar triangle ST 9 3 * nb-time-steps
Vector triangle VT 9 9 * nb-time-steps
Tensor triangle TT 9 27 * nb-time-steps
Scalar quadrangle SQ 12 4 * nb-time-steps
Vector quadrangle VQ 12 12 * nb-time-steps
Tensor quadrangle TQ 12 36 * nb-time-steps
Scalar tetrahedron SS 12 4 * nb-time-steps
Vector tetrahedron VS 12 12 * nb-time-steps
Tensor tetrahedron TS 12 36 * nb-time-steps
Scalar hexahedron SH 24 8 * nb-time-steps
Vector hexahedron VH 24 24 * nb-time-steps
Tensor hexahedron TH 24 72 * nb-time-steps
Scalar prism SI 18 6 * nb-time-steps
Vector prism VI 18 18 * nb-time-steps
Tensor prism TI 18 54 * nb-time-steps
Scalar pyramid SY 15 5 * nb-time-steps
Vector pyramid VY 15 15 * nb-time-steps
Tensor pyramid TY 15 45 * nb-time-steps
2nd order scalar line SL2 9 3 * nb-time-steps
2nd order vector line VL2 9 9 * nb-time-steps
2nd order tensor line TL2 9 27 * nb-time-steps
2nd order scalar triangle ST2 18 6 * nb-time-steps
2nd order vector triangle VT2 18 18 * nb-time-steps
2nd order tensor triangle TT2 18 54 * nb-time-steps
2nd order scalar quadrangle SQ2 27 9 * nb-time-steps
2nd order vector quadrangle VQ2 27 27 * nb-time-steps
2nd order tensor quadrangle TQ2 27 81 * nb-time-steps
2nd order scalar tetrahedron SS2 30 10 * nb-time-steps
2nd order vector tetrahedron VS2 30 30 * nb-time-steps
2nd order tensor tetrahedron TS2 30 90 * nb-time-steps
2nd order scalar hexahedron SH2 81 27 * nb-time-steps
2nd order vector hexahedron VH2 81 81 * nb-time-steps
2nd order tensor hexahedron TH2 81 243* nb-time-steps
2nd order scalar prism SI2 54 18 * nb-time-steps
2nd order vector prism VI2 54 54 * nb-time-steps
2nd order tensor prism TI2 54 162* nb-time-steps
2nd order scalar pyramid SY2 42 14 * nb-time-steps
2nd order vector pyramid VY2 42 42 * nb-time-steps
2nd order tensor pyramid TY2 42 126* nb-time-steps
2D text T2 3 arbitrary
3D text T3 4 arbitrary
|
The coordinates are given `by node', i.e.,
-
(coord1, coord2, coord3)
for a point,
-
(coord1-node1, coord2-node1, coord3-node1,
coord1-node2, coord2-node2, coord3-node2)
for a line,
-
(coord1-node1, coord2-node1, coord3-node1,
coord1-node2, coord2-node2, coord3-node2,
coord1-node3, coord2-node3, coord3-node3)
for a triangle,
-
etc.
The ordering of the nodes is given in 9.3 Node ordering.
The values are given by time step, by node and by component, i.e.:
| comp1-node1-time1, comp2-node1-time1, comp3-node1-time1,
comp1-node2-time1, comp2-node2-time1, comp3-node2-time1,
comp1-node3-time1, comp2-node3-time1, comp3-node3-time1,
comp1-node1-time2, comp2-node1-time2, comp3-node1-time2,
comp1-node2-time2, comp2-node2-time2, comp3-node2-time2,
comp1-node3-time2, comp2-node3-time2, comp3-node3-time2,
...
|
For the 2D text objects, the two first expressions in
list-of-coords give the X-Y position of the string in screen
coordinates, measured from the top-left corner of the window. If the first
(respectively second) expression is negative, the position is measured
from the right (respectively bottom) edge of the window. If the value of the
first (respectively second) expression is larger than 99999, the
string is centered horizontally (respectively vertically). If the third
expression is equal to zero, the text is aligned bottom-left and
displayed using the default font and size. Otherwise, the third
expression is converted into an integer whose eight lower bits give
the font size, whose eight next bits select the font (the index corresponds
to the position in the font menu in the GUI), and whose eight next bits
define the text alignment (0=bottom-left, 1=bottom-center, 2=bottom-right,
3=top-left, 4=top-center, 5=top-right, 6=center-left, 7=center-center,
8=center-right).
For the 3D text objects, the three first expressions in
list-of-coords give the XYZ position of the string in model (real
world) coordinates. The fourth expression has the same meaning as the
third expression in 2D text objects.
For both 2D and 3D text objects, the list-of-values can contain an
arbitrary number of char-expressions.
The optional TIME
list can contain a list of expressions giving the
value of the time (or any other variable) for which an evolution was saved.
6.2 Post-processing plugins
Post-processing plugins permit to extend the functionality of Gmsh's
post-processing module. The difference between regular post-processing
options (see section 6.3 Post-processing options) and post-processing plugins is
that regular post-processing options only change the way the data is
displayed, while post-processing plugins either create new post-processing
views, or modify the data stored in a view (in a destructive, non-reversible
way).
Plugins are available in the graphical user interface by right-clicking
on a view button (or by clicking on the black arrow next to the view
button) and then selecting the `Plugin' submenu.
Here is the list of the plugins that are shipped by default with Gmsh:
Plugin(Annotate)
-
Plugin(Annotate) adds the text string `Text',
in font `Font' and size `FontSize', in the view
`iView'. If `ThreeD' is equal to 1, the plugin inserts
the string in model coordinates at the position
(`X',`Y',`Z'). If `ThreeD' is equal to 0, the plugin
inserts the string in screen coordinates at
the position (`X',`Y'). The string is aligned
according to `Align'. If `iView' < 0, the plugin
is run on the current view.
Plugin(Annotate) is executed in-place.
String options:
Text
- Default value:
"My Text"
Font
- Default value:
"Helvetica"
Align
- Default value:
"Left"
Numeric options:
X
- Default value:
50
Y
- Default value:
30
Z
- Default value:
0
ThereD
- Default value:
0
FontSize
- Default value:
14
iView
- Default value:
-1
Plugin(Curl)
-
Plugin(Curl) computes the curl of the field
in the view `iView'. If `iView' < 0, the plugin
is run on the current view.
Plugin(Curl) creates one new view.
Numeric options:
iView
- Default value:
-1
Plugin(CutGrid)
-
Plugin(CutGrid) cuts the view `iView' with a
rectangular grid defined by the 3 points
(`X0',`Y0',`Z0') (origin), (`X1',`Y1',`Z1') (axis of
U) and (`X2',`Y2',`Z2') (axis of V). The number of
points along U and V is set with the options
`nPointsU' and `nPointsV'. If `ConnectPoints' is
zero, the plugin creates points; otherwise, the
plugin generates quadrangles, lines or points
depending on the values of `nPointsU' and
`nPointsV'. If `iView' < 0, the plugin is run on
the current view.
Plugin(CutGrid) creates one new view.
Numeric options:
X0
- Default value:
0
Y0
- Default value:
0
Z0
- Default value:
0
X1
- Default value:
1
Y1
- Default value:
0
Z1
- Default value:
0
X2
- Default value:
0
Y2
- Default value:
1
Z2
- Default value:
0
nPointsU
- Default value:
20
nPointsV
- Default value:
20
ConnectPoints
- Default value:
1
iView
- Default value:
-1
Plugin(CutMap)
-
Plugin(CutMap) extracts the isosurface of value
`A' from the view `iView' and draws the
`dTimeStep'-th value of the view `dView' on the
isosurface. If `iView' < 0, the plugin is run
on the current view. If `dTimeStep' < 0, the
plugin uses, for each time step in `iView', the
corresponding time step in `dView'. If `dView'
< 0, the plugin uses `iView' as the value source.
If `ExtractVolume' is nonzero, the plugin
extracts the isovolume with values greater (if
`ExtractVolume' > 0) or smaller (if `ExtractVolume'
< 0) than the isosurface `A'.
Plugin(CutMap) creates as many views as there
are time steps in `iView'.
Numeric options:
A
- Default value:
0
dTimeStep
- Default value:
-1
dView
- Default value:
-1
ExtractVolume
- Default value:
0
RecurLevel
- Default value:
4
TargetError
- Default value:
0
iView
- Default value:
-1
Plugin(CutParametric)
-
Plugin(CutParametric) cuts the view `iView' with
the parametric function (`X'(u), `Y'(u), `Z'(u)),
using `nPointsU' values of the parameter u in
[`MinU', `MaxU']. If `ConnectPoints' is set, the
plugin creates line elements; otherwise, the
plugin generates points. If `iView' < 0, the plugin
is run on the current view.
Plugin(CutParametric) creates one new view.
String options:
X
- Default value:
"0 + 1 * Cos(u)"
Y
- Default value:
"0 + 1 * Sin(u)"
Z
- Default value:
"0"
Numeric options:
MinU
- Default value:
0
MaxU
- Default value:
6.2832
nPointsU
- Default value:
360
ConnectPoints
- Default value:
0
iView
- Default value:
-1
Plugin(CutPlane)
-
Plugin(CutPlane) cuts the view `iView' with
the plane `A'*X + `B'*Y + `C'*Z + `D' = 0. If
`ExtractVolume' is nonzero, the plugin extracts
the elements on one side of the plane (depending
on the sign of `ExtractVolume'). If `iView' < 0,
the plugin is run on the current view.
Plugin(CutPlane) creates one new view.
Numeric options:
A
- Default value:
1
B
- Default value:
0
C
- Default value:
0
D
- Default value:
-0.01
ExtractVolume
- Default value:
0
RecurLevel
- Default value:
4
TargetError
- Default value:
0
iView
- Default value:
-1
Plugin(CutSphere)
-
Plugin(CutSphere) cuts the view `iView' with the
sphere (X-`Xc')^2 + (Y-`Yc')^2 + (Z-`Zc')^2 = `R'^2.
If `ExtractVolume' is nonzero, the plugin extracts
the elements inside (if `ExtractVolume' < 0) or
outside (if `ExtractVolume' > 0) the sphere. If
`iView' < 0, the plugin is run on the current view.
Plugin(CutSphere) creates one new view.
Numeric options:
Xc
- Default value:
0
Yc
- Default value:
0
Zc
- Default value:
0
R
- Default value:
0.25
ExtractVolume
- Default value:
0
RecurLevel
- Default value:
4
iView
- Default value:
-1
Plugin(Divergence)
-
Plugin(Divergence) computes the divergence of the
field in the view `iView'. If `iView' < 0, the plugin
is run on the current view.
Plugin(Divergence) creates one new view.
Numeric options:
iView
- Default value:
-1
Plugin(Eigenvalues)
-
Plugin(Eigenvalues) computes the three real
eigenvalues of each tensor in the view `iView'.
If `iView' < 0, the plugin is run on the current view.
Plugin(Eigenvalues) creates three new scalar views.
Numeric options:
iView
- Default value:
-1
Plugin(Eigenvectors)
-
Plugin(Eigenvectors) computes the three (right)
eigenvectors of each tensor in the view `iView'
and sorts them according to the value of the
associated eigenvalues. If `ScaleByEigenvalues'
is set, each eigenvector is scaled by its
associated eigenvalue. The plugin gives an error
if the eigenvectors are complex. If `iView' < 0,
the plugin is run on the current view.
Plugin(Eigenvectors) creates three new
vector views.
Numeric options:
ScaleByEigenvalues
- Default value:
1
iView
- Default value:
-1
Plugin(Evaluate)
-
Plugin(Evaluate) sets the `Component'-th
component of the `TimeStep'-th time step in the
view `iView' to the expression `Expression'.
`Expression' can contain:
- the usual mathematical functions (Log, Sqrt,
Sin, Cos, Fabs, ...) and operators (+, -, *, /, ^);
- the symbols x, y and z, to retrieve the
coordinates of the current node;
- the symbols Time and TimeStep, to retrieve the
current time and time step values;
- the symbol v, to retrieve the `Component'-th
component of the field in `iView' at the
`TimeStep'-th time step;
- the symbols v0, v1, v2, ..., v8, to retrieve each
component of the field in `iView' at the
`TimeStep'-th time step;
- the symbol w, to retrieve the `Component'-th
component of the field in `ExternalView' at the
`ExternalTimeStep'-th time step. If `ExternalView'
and `iView' are based on different spatial grids,
or if their data types are different, `ExternalView'
is interpolated onto `iView';
- the symbols w0, w1, w2, ..., w8, to retrieve each
component of the field in `ExternalView' at the
`ExternalTimeStep'-th time step.
If `TimeStep' < 0, the plugin automatically loops
over all the time steps in `iView' and evaluates
`Expression' for each one. If `ExternalTimeStep'
< 0, the plugin uses `TimeStep' instead. If
`Component' < 0, the plugin automatically loops
over all the components in the view and
evaluates `Expression' for each one. If `iView'
< 0, the plugin is run on the current view. If
`ExternalView' < 0, the plugin uses `iView'
instead.
Plugin(Evaluate) is executed in-place.
String options:
Expression
- Default value:
"v0*Sin(x)"
Numeric options:
Component
- Default value:
-1
TimeStep
- Default value:
-1
ExternalView
- Default value:
-1
ExternalTimeStep
- Default value:
-1
iView
- Default value:
-1
Plugin(Extract)
-
Plugin(Extract) extracts a combination of
components from the `TimeStep'th time step
in the view `iView'. If only `Expression0' is
given (and `Expression1', ..., `Expression8' are
all empty), the plugin creates a scalar view.
If `Expression0', `Expression1' and/or
`Expression2' are given (and `Expression3',
..., `Expression8' are all empty) the plugin
creates a vector view. Otherwise the plugin
creates a tensor view. In addition to the usual
mathematical functions (Exp, Log, Sqrt, Sin, Cos,
Fabs, etc.) and operators (+, -, *, /, ^), all
expressions can contain the symbols v0, v1, v2,
..., vn, which represent the n components of the
field, and the symbols x, y and z, which represent
the three spatial coordinates. If `TimeStep' < 0,
the plugin extracts data from all the time steps
in the view. If `iView' < 0, the plugin is run on
the current view.
Plugin(Extract) creates one new view.
String options:
Expression0
- Default value:
"Sqrt(v0^2+v1^2+v2^2)"
Expression1
- Default value:
""
Expression2
- Default value:
""
Expression3
- Default value:
""
Expression4
- Default value:
""
Expression5
- Default value:
""
Expression6
- Default value:
""
Expression7
- Default value:
""
Expression8
- Default value:
""
Numeric options:
TimeStep
- Default value:
-1
iView
- Default value:
-1
Plugin(ExtractElements)
-
Plugin(ExtractElements) extracts the elements
from the view `iView' whose `TimeStep'-th values
(averaged by element) are comprised between
`MinVal' and `MaxVal'. If `iView' < 0, the plugin
is run on the current view.
Plugin(ExtractElements) creates one new view.
Numeric options:
MinVal
- Default value:
0
MaxVal
- Default value:
1
TimeStep
- Default value:
0
iView
- Default value:
-1
Plugin(FieldView)
-
Plugin(FieldView) evaluate a field on the choosen view.
Numeric options:
Component
- Default value:
-1
iView
- Default value:
-1
iField
- Default value:
-1
Plugin(GSHHS)
-
Plugin(GSHHS) import GSHHS data.
String options:
InFileName
- Default value:
"gshhs_c.b"
OutFileName
- Default value:
"earth.geo"
Format
- Default value:
"gshhs"
Coordinate
- Default value:
"cartesian"
Numeric options:
iField
- Default value:
-1
UTMZone
- Default value:
0
UTMEquatorialRadius
- Default value:
6.37814e+06
UTMPolarRadius
- Default value:
6.35675e+06
UTMScale
- Default value:
1
UTMShiftX
- Default value:
0
UTMShiftY
- Default value:
0
WritePolarSphere
- Default value:
1
Plugin(Gradient)
-
Plugin(Gradient) computes the gradient of the
field in the view `iView'. If `iView' < 0, the
plugin is run on the current view.
Plugin(Gradient) creates one new view.
Numeric options:
iView
- Default value:
-1
Plugin(HarmonicToTime)
-
Plugin(HarmonicToTime) takes the values in the
time steps `RealPart' and `ImaginaryPart' of
the view `iView', and creates a new view
containing (`iView'[`RealPart'] * cos(p) -
`iView'[`ImaginaryPart'] * sin(p)), with
p = 2*Pi*k/`nSteps', k = 0, ..., `nSteps'-1.
If `iView' < 0, the plugin is run on the
current view.
Plugin(HarmonicToTime) creates one new view.
Numeric options:
RealPart
- Default value:
0
ImaginaryPart
- Default value:
1
nSteps
- Default value:
20
iView
- Default value:
-1
Plugin(Integrate)
-
Plugin(Integrate) integrates scalar fields over
all the elements in the view `iView', as well
as the circulation/flux of vector fields over
line/surface elements. If `iView' < 0, the
plugin is run on the current view.
Plugin(Integrate) creates one new view.
Numeric options:
iView
- Default value:
-1
Plugin(Lambda2)
-
Plugin(Lambda2) computes the eigenvalues
Lambda(1,2,3) of the tensor (S_ik S_kj +
Om_ik Om_kj), where S_ij = 0.5 (ui,j + uj,i)
and Om_ij = 0.5 (ui,j - uj,i) are respectively
the symmetric and antisymmetric parts of the
velocity gradient tensor. Vortices are well
represented by regions where Lambda(2) is
negative. If `iView' contains tensor elements,
the plugin directly uses the tensors as the
values of the velocity gradient tensor; if
`iView' contains vector elements, the plugin
uses them as the velocities from which to derive
the velocity gradient tensor. If `iView' < 0,
the plugin is run on the current view.
Plugin(Lambda2) creates one new view.
Numeric options:
Eigenvalue
- Default value:
2
iView
- Default value:
-1
Plugin(MakeSimplex)
-
Plugin(MakeSimplex) decomposes all non-
simplectic elements (quadrangles, prisms,
hexahedra, pyramids) in the view `iView' into
simplices (triangles, tetrahedra). If `iView' < 0,
the plugin is run on the current view.
Plugin(MakeSimplex) is executed
in-place.
Numeric options:
iView
- Default value:
-1
Plugin(ModulusPhase)
-
Plugin(ModulusPhase) interprets the time steps
`realPart' and `imaginaryPart' in the view `iView'
as the real and imaginary parts of a complex field
and replaces them with their corresponding
modulus and phase. If `iView' < 0, the plugin is
run on the current view.
Plugin(ModulusPhase) is executed in-place.
Numeric options:
RealPart
- Default value:
0
ImaginaryPart
- Default value:
1
iView
- Default value:
-1
Plugin(Probe)
-
Plugin(Probe) gets the value of the view `iView' at
the point (`X',`Y',`Z'). If `iView' < 0, the plugin is
run on the current view.
Plugin(Probe) creates one new view.
Numeric options:
X
- Default value:
0
Y
- Default value:
0
Z
- Default value:
0
iView
- Default value:
-1
Plugin(Remove)
-
Plugin(Remove) removes the marked items
from the view `iView'. If `iView' < 0, the plugin
is run on the current view.
Plugin(Remove) is executed in-place.
Numeric options:
Text2D
- Default value:
1
Text3D
- Default value:
1
Points
- Default value:
0
Lines
- Default value:
0
Triangles
- Default value:
0
Quadrangles
- Default value:
0
Tetrahedra
- Default value:
0
Hexahedra
- Default value:
0
Prisms
- Default value:
0
Pyramids
- Default value:
0
Scalar
- Default value:
1
Vector
- Default value:
1
Tensor
- Default value:
1
iView
- Default value:
-1
Plugin(Skin)
-
Plugin(Skin) extracts the skin (the boundary) of
the view `iView'. If `iView' < 0, the plugin is run
on the current view.
Plugin(Skin) creates one new view.
Numeric options:
iView
- Default value:
-1
Plugin(Smooth)
-
Plugin(Smooth) averages the values at the nodes
of the scalar view `iView'. If `iView' < 0, the
plugin is run on the current view.
Plugin(Smooth) is executed in-place.
Numeric options:
iView
- Default value:
-1
Plugin(SphericalRaise)
-
Plugin(SphericalRaise) transforms the
coordinates of the elements in the view
`iView' using the values associated with the
`TimeStep'-th time step. Instead of elevating
the nodes along the X, Y and Z axes as in
View[`iView'].RaiseX, View[`iView'].RaiseY
and View[`iView'].RaiseZ, the raise is applied
along the radius of a sphere centered at
(`Xc', `Yc', `Zc'). To produce a standard
radiation pattern, set `Offset' to minus the
radius of the sphere the original data lives on.
If `iView' < 0, the plugin is run on the current
view.
Plugin(SphericalRaise) is executed in-place.
Numeric options:
Xc
- Default value:
0
Yc
- Default value:
0
Zc
- Default value:
0
Raise
- Default value:
1
Offset
- Default value:
0
TimeStep
- Default value:
0
iView
- Default value:
-1
Plugin(StreamLines)
-
Plugin(StreamLines) computes stream lines
from the `TimeStep'-th time step of a vector
view `iView' and optionally interpolates the
scalar view `dView' on the resulting stream
lines. The plugin takes as input a grid defined
by the 3 points (`X0',`Y0',`Z0') (origin),
(`X1',`Y1',`Z1') (axis of U) and (`X2',`Y2',`Z2')
(axis of V). The number of points that are to
be transported along U and V is set with the
options `nPointsU' and `nPointsV'. The equation
DX(t)/dt=V(x,y,z) is then solved with the initial
condition X(t=0) chosen as the grid and with V(x,y,z)
interpolated on the vector view. The time stepping
scheme is a RK44 with step size `DT' and `MaxIter'
maximum number of iterations. If `iView' < 0, the
plugin is run on the current view. If `TimeStep' < 0,
the plugin tries to compute streamlines of the unsteady
flow.
Plugin(StreamLines) creates one new view. This
view contains multi-step vector points if `dView'
< 0, or single-step scalar lines if `dView' >= 0.
Numeric options:
X0
- Default value:
0
Y0
- Default value:
0
Z0
- Default value:
0
X1
- Default value:
1
Y1
- Default value:
0
Z1
- Default value:
0
X2
- Default value:
0
Y2
- Default value:
1
Z2
- Default value:
0
nPointsU
- Default value:
10
nPointsV
- Default value:
1
MaxIter
- Default value:
100
DT
- Default value:
0.1
TimeStep
- Default value:
0
dView
- Default value:
-1
iView
- Default value:
-1
Plugin(Transform)
-
Plugin(Transform) transforms the homogeneous
node coordinates (x,y,z,1) of the elements in
the view `iView' by the matrix
[`A11' `A12' `A13' `Tx']
[`A21' `A22' `A23' `Ty']
[`A31' `A32' `A33' `Tz'].
If `SwapOrientation' is set, the orientation of the
elements is reversed. If `iView' < 0, the plugin
is run on the current view.
Plugin(Transform) is executed in-place.
Numeric options:
A11
- Default value:
1
A12
- Default value:
0
A13
- Default value:
0
A21
- Default value:
0
A22
- Default value:
1
A23
- Default value:
0
A31
- Default value:
0
A32
- Default value:
0
A33
- Default value:
1
Tx
- Default value:
0
Ty
- Default value:
0
Tz
- Default value:
0
SwapOrientation
- Default value:
0
iView
- Default value:
-1
Plugin(TransformLatLon)
-
Plugin(TransformLatLon) transforms the homogeneous
node coordinates (x,y,z,1) of the elements in
the view `iView' by the matrix
[`A11' `A12' `A13' `Tx']
[`A21' `A22' `A23' `Ty']
[`A31' `A32' `A33' `Tz'].
If `SwapOrientation' is set, the orientation of the
elements is reversed. If `iView' < 0, the plugin
is run on the current view.
Plugin(TransformLatLon) is executed in-place.
Numeric options:
iView
- Default value:
-1
Longitude0
- Default value:
0
Plugin(Triangulate)
-
Plugin(Triangulate) triangulates the points in the
view `iView', assuming that all the points belong
to a surface that can be projected one-to-one
onto a plane. If `iView' < 0, the plugin is run on
the current view.
Plugin(Triangulate) creates one new view.
Numeric options:
iView
- Default value:
-1
Plugin(Warp)
-
Plugin(Warp) transforms the elements in the
view `iView' by adding to their node coordinates
the vector field stored in the `TimeStep'-th time
step of the view `dView', scaled by `Factor'. If
`dView' < 0, the vector field is taken as the field
of surface normals multiplied by the `TimeStep'
value in `iView'. (The smoothing of the surface
normals is controlled by the `SmoothingAngle'
parameter.) If `iView' < 0, the plugin is run on
the current view.
Plugin(Warp) is executed in-place.
Numeric options:
Factor
- Default value:
1
TimeStep
- Default value:
0
SmoothingAngle
- Default value:
180
dView
- Default value:
-1
iView
- Default value:
-1
6.3 Post-processing options
General post-processing option names have the form
`PostProcessing.string
'. Options peculiar to post-processing
views take two forms:
- options that should apply to all views can be set through
`
View.string
', before any view is loaded;
- options that should apply only to the n-th
view take the form `
View[n].string
' (n = 0, 1, 2,
...), after the n-th view is loaded.
See 7.8 `t8.geo', and 7.9 `t9.geo', for some examples.
PostProcessing.AnimationDelay
-
Delay (in seconds) between frames in automatic animation mode
Default value: 0.25
Saved in: General.OptionsFileName
PostProcessing.AnimationCycle
-
Cycle through views instead of time steps in automatic animation mode
Default value: 0
Saved in: General.OptionsFileName
PostProcessing.CombineRemoveOriginal
-
Remove original views after a Combine operation
Default value: 1
Saved in: General.OptionsFileName
PostProcessing.Format
-
Default file format for post-processing views (0=ASCII view, 1=binary view, 2=parsed view, 3=STL triangulation, 4=text, 5=mesh)
Default value: 0
Saved in: General.OptionsFileName
PostProcessing.HorizontalScales
-
Display value scales horizontally
Default value: 1
Saved in: General.OptionsFileName
PostProcessing.Link
-
Link post-processing views (0=none, 1/2=changes in visible/all, 3/4=everything in visible/all)
Default value: 0
Saved in: General.OptionsFileName
PostProcessing.NbViews
-
Current number of views merged (read-only)
Default value: 0
Saved in: -
PostProcessing.Plugins
-
Enable default post-processing plugins?
Default value: 1
Saved in: General.OptionsFileName
PostProcessing.Smoothing
-
Apply (non-reversible) smoothing to post-processing view when merged
Default value: 0
Saved in: General.OptionsFileName
View.AxesFormatX
-
Number format for X-axis (in standard C form)
Default value: "%.3g"
Saved in: General.OptionsFileName
View.AxesFormatY
-
Number format for Y-axis (in standard C form)
Default value: "%.3g"
Saved in: General.OptionsFileName
View.AxesFormatZ
-
Number format for Z-axis (in standard C form)
Default value: "%.3g"
Saved in: General.OptionsFileName
View.AxesLabelX
-
X-axis label
Default value: ""
Saved in: General.OptionsFileName
View.AxesLabelY
-
Y-axis label
Default value: ""
Saved in: General.OptionsFileName
View.AxesLabelZ
-
Z-axis label
Default value: ""
Saved in: General.OptionsFileName
View.FileName
-
Default post-processing view file name
Default value: ""
Saved in: -
View.Format
-
Number format (in standard C form)
Default value: "%.3g"
Saved in: General.OptionsFileName
View.GeneralizedRaiseX
-
Generalized elevation of the view along X-axis (in model coordinates)
Default value: "v0"
Saved in: General.OptionsFileName
View.GeneralizedRaiseY
-
Generalized elevation of the view along Y-axis (in model coordinates)
Default value: "v1"
Saved in: General.OptionsFileName
View.GeneralizedRaiseZ
-
Generalized elevation of the view along Z-axis (in model coordinates)
Default value: "v2"
Saved in: General.OptionsFileName
View.Name
-
Default post-processing view name
Default value: ""
Saved in: -
View.Stipple0
-
First stippling pattern
Default value: "1*0x1F1F"
Saved in: General.OptionsFileName
View.Stipple1
-
Second stippling pattern
Default value: "1*0x3333"
Saved in: General.OptionsFileName
View.Stipple2
-
Third stippling pattern
Default value: "1*0x087F"
Saved in: General.OptionsFileName
View.Stipple3
-
Fourth stippling pattern
Default value: "1*0xCCCF"
Saved in: General.OptionsFileName
View.Stipple4
-
Fifth stippling pattern
Default value: "2*0x1111"
Saved in: General.OptionsFileName
View.Stipple5
-
Sixth stippling pattern
Default value: "2*0x0F0F"
Saved in: General.OptionsFileName
View.Stipple6
-
Seventh stippling pattern
Default value: "1*0xCFFF"
Saved in: General.OptionsFileName
View.Stipple7
-
Eighth stippling pattern
Default value: "2*0x0202"
Saved in: General.OptionsFileName
View.Stipple8
-
Ninth stippling pattern
Default value: "2*0x087F"
Saved in: General.OptionsFileName
View.Stipple9
-
Tenth stippling pattern
Default value: "1*0xFFFF"
Saved in: General.OptionsFileName
View.AngleSmoothNormals
-
Threshold angle below which normals are not smoothed
Default value: 30
Saved in: General.OptionsFileName
View.ArrowHeadRadius
-
Relative radius of arrow head
Default value: 0.12
Saved in: General.OptionsFileName
View.ArrowSize
-
Display size of arrows (in pixels)
Default value: 60
Saved in: General.OptionsFileName
View.ArrowSizeProportional
-
Scale the arrows according to the norm of the vector
Default value: 1
Saved in: General.OptionsFileName
View.ArrowStemLength
-
Relative length of arrow stem
Default value: 0.56
Saved in: General.OptionsFileName
View.ArrowStemRadius
-
Relative radius of arrow stem
Default value: 0.02
Saved in: General.OptionsFileName
View.AutoPosition
-
Position the scale or 2D plot automatically
Default value: 1
Saved in: General.OptionsFileName
View.Axes
-
Axes (0=none, 1=simple axes, 2=box, 3=full grid, 4=open grid, 5=ruler)
Default value: 0
Saved in: General.OptionsFileName
View.AxesMikado
-
Mikado axes style
Default value: 0
Saved in: General.OptionsFileName
View.AxesAutoPosition
-
Position the axes automatically
Default value: 1
Saved in: General.OptionsFileName
View.AxesMaxX
-
Maximum X-axis coordinate
Default value: 1
Saved in: General.OptionsFileName
View.AxesMaxY
-
Maximum Y-axis coordinate
Default value: 1
Saved in: General.OptionsFileName
View.AxesMaxZ
-
Maximum Z-axis coordinate
Default value: 1
Saved in: General.OptionsFileName
View.AxesMinX
-
Minimum X-axis coordinate
Default value: 0
Saved in: General.OptionsFileName
View.AxesMinY
-
Minimum Y-axis coordinate
Default value: 0
Saved in: General.OptionsFileName
View.AxesMinZ
-
Minimum Z-axis coordinate
Default value: 0
Saved in: General.OptionsFileName
View.AxesTicsX
-
Number of tics on the X-axis
Default value: 5
Saved in: General.OptionsFileName
View.AxesTicsY
-
Number of tics on the Y-axis
Default value: 5
Saved in: General.OptionsFileName
View.AxesTicsZ
-
Number of tics on the Z-axis
Default value: 5
Saved in: General.OptionsFileName
View.Boundary
-
Draw the `N minus b'-dimensional boundary of the element (N=element dimension, b=option value)
Default value: 0
Saved in: General.OptionsFileName
View.CenterGlyphs
-
Center glyphs (arrows, numbers, etc.)
Default value: 0
Saved in: General.OptionsFileName
View.ColormapAlpha
-
Colormap alpha channel value (used only if != 1)
Default value: 1
Saved in: General.OptionsFileName
View.ColormapAlphaPower
-
Colormap alpha channel power
Default value: 0
Saved in: General.OptionsFileName
View.ColormapBeta
-
Colormap beta parameter (gamma = 1-beta)
Default value: 0
Saved in: General.OptionsFileName
View.ColormapBias
-
Colormap bias
Default value: 0
Saved in: General.OptionsFileName
View.ColormapCurvature
-
Colormap curvature or slope coefficient
Default value: 0
Saved in: General.OptionsFileName
View.ColormapInvert
-
Invert the color values, i.e., replace x with (255-x) in the colormap?
Default value: 0
Saved in: General.OptionsFileName
View.ColormapNumber
-
Default colormap number
Default value: 2
Saved in: General.OptionsFileName
View.ColormapRotation
-
Incremental colormap rotation
Default value: 0
Saved in: General.OptionsFileName
View.ColormapSwap
-
Swap the min/max values in the colormap?
Default value: 0
Saved in: General.OptionsFileName
View.CustomMax
-
User-defined maximum value to be displayed
Default value: 0
Saved in: -
View.CustomMin
-
User-defined minimum value to be displayed
Default value: 0
Saved in: -
View.DisplacementFactor
-
Displacement amplification
Default value: 1
Saved in: General.OptionsFileName
View.DrawHexahedra
-
Display post-processing hexahedra?
Default value: 1
Saved in: General.OptionsFileName
View.DrawLines
-
Display post-processing lines?
Default value: 1
Saved in: General.OptionsFileName
View.DrawPoints
-
Display post-processing points?
Default value: 1
Saved in: General.OptionsFileName
View.DrawPrisms
-
Display post-processing prisms?
Default value: 1
Saved in: General.OptionsFileName
View.DrawPyramids
-
Display post-processing pyramids?
Default value: 1
Saved in: General.OptionsFileName
View.DrawQuadrangles
-
Display post-processing quadrangles?
Default value: 1
Saved in: General.OptionsFileName
View.DrawScalars
-
Display scalar values?
Default value: 1
Saved in: General.OptionsFileName
View.DrawSkinOnly
-
Draw only the skin of 3D scalar views?
Default value: 0
Saved in: General.OptionsFileName
View.DrawStrings
-
Display post-processing annotation strings?
Default value: 1
Saved in: General.OptionsFileName
View.DrawTensors
-
Display tensor values?
Default value: 1
Saved in: General.OptionsFileName
View.DrawTetrahedra
-
Display post-processing tetrahedra?
Default value: 1
Saved in: General.OptionsFileName
View.DrawTriangles
-
Display post-processing triangles?
Default value: 1
Saved in: General.OptionsFileName
View.DrawVectors
-
Display vector values?
Default value: 1
Saved in: General.OptionsFileName
View.Explode
-
Element shrinking factor (between 0 and 1)
Default value: 1
Saved in: General.OptionsFileName
View.ExternalView
-
Index of the view used to color vector fields (-1=self)
Default value: -1
Saved in: General.OptionsFileName
View.FakeTransparency
-
Use fake transparency (cheaper than the real thing, but incorrect)
Default value: 0
Saved in: General.OptionsFileName
View.GeneralizedRaiseFactor
-
Generalized raise amplification factor
Default value: 1
Saved in: General.OptionsFileName
View.GeneralizedRaiseView
-
Index of the view used for generalized raise (-1=self)
Default value: -1
Saved in: General.OptionsFileName
View.GlyphLocation
-
Glyph (arrow, number, etc.) location (1=center of gravity, 2=node)
Default value: 1
Saved in: General.OptionsFileName
View.Height
-
Height (in pixels) of the scale or 2D plot
Default value: 200
Saved in: General.OptionsFileName
View.IntervalsType
-
Type of interval display (1=iso, 2=continuous, 3=discrete, 4=numeric)
Default value: 2
Saved in: General.OptionsFileName
View.Light
-
Enable lighting for the view
Default value: 1
Saved in: General.OptionsFileName
View.LightLines
-
Light element edges
Default value: 1
Saved in: General.OptionsFileName
View.LightTwoSide
-
Light both sides of surfaces (leads to slower rendering)
Default value: 1
Saved in: General.OptionsFileName
View.LineType
-
Display lines as solid color segments (0) or 3D cylinders (1)
Default value: 0
Saved in: General.OptionsFileName
View.LineWidth
-
Display width of lines (in pixels)
Default value: 1
Saved in: General.OptionsFileName
View.MaxRecursionLevel
-
Maximum recursion level for adaptive views
Default value: 0
Saved in: General.OptionsFileName
View.Max
-
Maximum value in the view (read-only)
Default value: 0
Saved in: -
View.MaxX
-
Maximum view coordinate along the X-axis (read-only)
Default value: 0
Saved in: -
View.MaxY
-
Maximum view coordinate along the Y-axis (read-only)
Default value: 0
Saved in: -
View.MaxZ
-
Maximum view coordinate along the Z-axis (read-only)
Default value: 0
Saved in: -
View.Min
-
Minimum value in the view (read-only)
Default value: 0
Saved in: -
View.MinX
-
Minimum view coordinate along the X-axis (read-only)
Default value: 0
Saved in: -
View.MinY
-
Minimum view coordinate along the Y-axis (read-only)
Default value: 0
Saved in: -
View.MinZ
-
Minimum view coordinate along the Z-axis (read-only)
Default value: 0
Saved in: -
View.NbIso
-
Number of intervals
Default value: 15
Saved in: General.OptionsFileName
View.NbTimeStep
-
Number of time steps in the view (do not change this!)
Default value: 1
Saved in: -
View.NormalRaise
-
Elevation of the view along the normal (in model coordinates)
Default value: 0
Saved in: -
View.Normals
-
Display size of normal vectors (in pixels)
Default value: 0
Saved in: General.OptionsFileName
View.OffsetX
-
Translation of the view along X-axis (in model coordinates)
Default value: 0
Saved in: -
View.OffsetY
-
Translation of the view along Y-axis (in model coordinates)
Default value: 0
Saved in: -
View.OffsetZ
-
Translation of the view along Z-axis (in model coordinates)
Default value: 0
Saved in: -
View.PointSize
-
Display size of points (in pixels)
Default value: 3
Saved in: General.OptionsFileName
View.PointType
-
Display points as solid color dots (0) or 3D spheres (1)
Default value: 0
Saved in: General.OptionsFileName
View.PositionX
-
Horizontal position (in pixels) of the upper left corner of the scale or 2D plot
Default value: 100
Saved in: General.OptionsFileName
View.PositionY
-
Vertical position (in pixels) of the upper left corner of the scale or 2D plot
Default value: 50
Saved in: General.OptionsFileName
View.RaiseX
-
Elevation of the view along X-axis (in model coordinates)
Default value: 0
Saved in: -
View.RaiseY
-
Elevation of the view along Y-axis (in model coordinates)
Default value: 0
Saved in: -
View.RaiseZ
-
Elevation of the view along Z-axis (in model coordinates)
Default value: 0
Saved in: -
View.RangeType
-
Value scale range type (1=default, 2=custom, 3=per time step)
Default value: 1
Saved in: General.OptionsFileName
View.SaturateValues
-
Saturate the view values to custom min and max (1=true, 0=false)
Default value: 0
Saved in: General.OptionsFileName
View.ScaleType
-
Value scale type (1=linear, 2=logarithmic, 3=double logarithmic)
Default value: 1
Saved in: General.OptionsFileName
View.ShowElement
-
Show element boundaries?
Default value: 0
Saved in: General.OptionsFileName
View.ShowScale
-
Show value scale?
Default value: 1
Saved in: General.OptionsFileName
View.ShowTime
-
Time display mode (0=hidden, 1=value if multi-step, 2=value always, 3=step if multi-step, 4=step always)
Default value: 1
Saved in: General.OptionsFileName
View.SmoothNormals
-
Smooth the normals?
Default value: 0
Saved in: General.OptionsFileName
View.Stipple
-
Stipple curves in 2D plots?
Default value: 0
Saved in: General.OptionsFileName
View.Tangents
-
Display size of tangent vectors (in pixels)
Default value: 0
Saved in: General.OptionsFileName
View.TargetError
-
Target representation error for adaptive views
Default value: 0.01
Saved in: General.OptionsFileName
View.TensorType
-
Tensor Visualization Type
Default value: 1
Saved in: General.OptionsFileName
View.TimeStep
-
Current time step displayed
Default value: 0
Saved in: -
View.Transform11
-
Element (1,1) of the 3x3 coordinate transformation matrix
Default value: 1
Saved in: -
View.Transform12
-
Element (1,2) of the 3x3 coordinate transformation matrix
Default value: 0
Saved in: -
View.Transform13
-
Element (1,3) of the 3x3 coordinate transformation matrix
Default value: 0
Saved in: -
View.Transform21
-
Element (2,1) of the 3x3 coordinate transformation matrix
Default value: 0
Saved in: -
View.Transform22
-
Element (2,2) of the 3x3 coordinate transformation matrix
Default value: 1
Saved in: -
View.Transform23
-
Element (2,3) of the 3x3 coordinate transformation matrix
Default value: 0
Saved in: -
View.Transform31
-
Element (3,1) of the 3x3 coordinate transformation matrix
Default value: 0
Saved in: -
View.Transform32
-
Element (3,2) of the 3x3 coordinate transformation matrix
Default value: 0
Saved in: -
View.Transform33
-
Element (3,3) of the 3x3 coordinate transformation matrix
Default value: 1
Saved in: -
View.Type
-
Type of plot (1=3D, 2=2D space, 3=2D time)
Default value: 1
Saved in: -
View.UseGeneralizedRaise
-
Use generalized raise?
Default value: 0
Saved in: General.OptionsFileName
View.VectorType
-
Vector display type (1=segment, 2=arrow, 3=pyramid, 4=3D arrow, 5=displacement)
Default value: 4
Saved in: General.OptionsFileName
View.Visible
-
Is the view visible?
Default value: 1
Saved in: -
View.Width
-
Width (in pixels) of the scale or 2D plot
Default value: 300
Saved in: General.OptionsFileName
View.Color.Points
-
Point color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Lines
-
Line color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Triangles
-
Triangle color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Quadrangles
-
Quadrangle color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Tetrahedra
-
Tetrahedron color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Hexahedra
-
Hexahedron color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Prisms
-
Prism color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Pyramids
-
Pyramid color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Tangents
-
Tangent vector color
Default value: {255,255,0}
Saved in: General.OptionsFileName
View.Color.Normals
-
Normal vector color
Default value: {255,0,0}
Saved in: General.OptionsFileName
View.Color.Text2D
-
2D text color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Text3D
-
3D text color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.Color.Axes
-
Axes color
Default value: {0,0,0}
Saved in: General.OptionsFileName
View.ColorTable
-
Color table used to draw the view
Saved in: General.OptionsFileName
Back to geuz.org/gmsh