Skip to content
Snippets Groups Projects
opt_plugin.texi 10.1 KiB
Newer Older
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@ftable @code
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Plugin(CutGrid)
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Plugin(CutGrid) cuts a tetrahedron view 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
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
with the options `nPointsU' and `nPointsV'. If
`iView' < 0, the plugin is run on the current view.

Plugin(CutGrid) creates one new view.

Numeric options:
@table @code
@item X0
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Y0
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Z0
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item X1
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Y1
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Z1
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item X2
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Y2
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Z2
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item nPointsU
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{20}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item nPointsV
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{20}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@end table

Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Plugin(CutMap)
Plugin(CutMap) extracts the isovalue surface of
value `A' from the view `iView' and draws the
`dTimeStep'-th value of the view `dView' on this
isovalue surface. 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.

Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Plugin(CutMap) creates as many views as there are
time steps in `iView'.
Christophe Geuzaine's avatar
Christophe Geuzaine committed

Numeric options:
@table @code
@item A
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item dTimeStep
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item dView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
@item recurLevel
Default value: @code{4}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Plugin(CutParametric)
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Plugin(CutParametric) cuts a triangle/tetrahedron
scalar view `iView' with the parametric function
(`X'(u), `Y'(u), `Z'(u)), using `nPointsU' values of
the parameter u in [`minU', `maxU']. If `iView' < 0,
the plugin is run on the current view.
Christophe Geuzaine's avatar
Christophe Geuzaine committed

Plugin(CutParametric) creates one new view.

String options:
@table @code
@item X
Default value: @code{"0 + 1 * Cos(u)"}
@item Y
Default value: @code{"0 + 1 * Sin(u)"}
@item Z
Default value: @code{"0"}
@end table
Numeric options:
@table @code
@item minU
Default value: @code{0}
@item maxU
Default value: @code{6.28319}
@item nPointsU
Default value: @code{360}
@item iView
Default value: @code{-1}
@end table

Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Plugin(CutPlane)
Plugin(CutPlane) cuts the view `iView' with
the plane `A'*X + `B'*Y + `C'*Z + `D' = 0. If
`iView' < 0, the plugin is run on the current
view.

Plugin(CutPlane) creates one new view.

Numeric options:
@table @code
@item A
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item B
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item C
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item D
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-0.01}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
@item recurLevel
Default value: @code{4}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@item Plugin(CutSphere)
Plugin(CutSphere) cuts the view `iView' with the
sphere (X-`Xc')^2 + (Y-`Yc')^2 + (Z-`Zc')^2 = `R'^2.
If `iView' < 0, the plugin is run on the current
view.

Plugin(CutSphere) creates one new view.

Numeric options:
@table @code
@item Xc
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Yc
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Zc
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item R
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0.25}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
@item recurLevel
Default value: @code{4}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@item Plugin(DecomposeInSimplex)
Plugin(DecomposeInSimplex) decomposes all
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
non-simplectic elements (quadrangles, prisms,
hexahedra, pyramids) in the view `iView' into
Christophe Geuzaine's avatar
Christophe Geuzaine committed
simplices (triangles, tetrahedra). If `iView' < 0,
the plugin is run on the current view.

Plugin(DecomposeInSimplex) is executed
in-place.

Numeric options:
@table @code
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@item Plugin(DisplacementRaise)
Plugin(DisplacementRaise) transforms the
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
coordinates of the elements in the view `iView'
Christophe Geuzaine's avatar
Christophe Geuzaine committed
using the vectorial values (the displacements)
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
stored in the `dTimeStep'-th time step of the
view `dView'. If `iView' < 0, the plugin is
run on the current view. If `dView' < 0, the
Christophe Geuzaine's avatar
Christophe Geuzaine committed
plugin looks for the displacements in the
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
view located just after `iView' in the view
Christophe Geuzaine's avatar
Christophe Geuzaine committed
list.

Plugin(DisplacementRaise) is executed in-place.

Numeric options:
@table @code
@item Factor
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item dTimeStep
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item dView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
@end table

@item Plugin(Evaluate)
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Plugin(Evaluate) sets the `Component'-th
component of the `TimeStep'-th time step
in the view `iView' to the expression
`Expression'. In addition to the usual
mathematical functions (Exp, Log, Sqrt, Sin,
Cos, Fabs, etc.) and operators (+, -, *, /, ^),
`Expression' can contain the symbols x, y, z
and v, which represent the three spatial
coordinates and the value of the field,
respectively. If `iView' < 0, the plugin is run
on the current view.
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed

Plugin(Evaluate) is executed in-place.

String options:
@table @code
@item Expression
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{"0.01*(Fabs(Sin(30*y)*Fabs(Cos(30*x)))+0.3)"}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@end table
Numeric options:
@table @code
@item TimeStep
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Component
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item iView
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@item Plugin(Extract)
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Plugin(Extract) extracts a combination of
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
components from the view `iView'. If
`Expression1' or `Expression2' is empty, the
plugin creates a scalar view using
`Expression0'; otherwise the plugin creates
a vector view. In addition to the usual
mathematical functions (Exp, Log, Sqrt, Sin,
Cos, Fabs, etc.) and operators (+, -, *, /, ^),
the 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 `iView' < 0, the plugin is
run on the current view.
Christophe Geuzaine's avatar
Christophe Geuzaine committed

Plugin(Extract) creates one new view.

Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
String options:
@table @code
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Expression0
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{"v0"}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Expression1
Default value: @code{""}
@item Expression2
Default value: @code{""}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@end table
Christophe Geuzaine's avatar
Christophe Geuzaine committed
Numeric options:
@table @code
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item 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:
@table @code
@item realPart
Default value: @code{0}
@item imaginaryPart
Default value: @code{1}
@item nSteps
Default value: @code{20}
@item iView
Default value: @code{-1}
@end table

Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item 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:
@table @code
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@item 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:
@table @code
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@item 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
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
 along the radius of a sphere centered at (`Xc',
`Yc', `Zc'). If `iView' < 0, the plugin is run
Christophe Geuzaine's avatar
Christophe Geuzaine committed
on the current view.

Plugin(SphericalRaise) is executed in-place.

Numeric options:
@table @code
@item Xc
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Yc
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Zc
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Raise
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item TimeStep
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Plugin(StreamLines)
Plugin(StreamLines) computes stream lines
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
from a triangle/tetrahedron vector view `iView'
and optionally interpolates the scalar view `dView'
on the resulting stream lines. It takes as input a
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
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
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
that are going to be transported along U and V is
set with the options `nPointsU' and `nPointsV'.
Then, we solve the equation DX(t)/dt = V(x,y,z)
with X(t=0) chosen as the grid and V(x,y,z)
interpolated on the vector view. The timestep and
the maximum number of iterations are set with
the options `MaxIter' and `DT'. The time stepping
scheme is a RK44. If `iView' < 0, the plugin is run
on the current view.

Plugin(StreamLines) creates one new view. This
view contains multi-step vector points if `dView'
< 0, or single-step scalar lines if `dView' >= 0.
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed

Numeric options:
@table @code
@item X0
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{2.39}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Y0
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0.445}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Z0
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item X1
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{2.39}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Y1
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0.94}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Z1
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item X2
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{2.39}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Y2
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0.445}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item Z2
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item nPointsU
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{20}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item nPointsV
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item MaxIter
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{100}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item DT
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0.1}
@item dView
Default value: @code{-1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
@end table

Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item Plugin(Transform)
Plugin(Transform) transforms the coordinates of
the nodes of the view `iView' by the matrix
[`A11' `A12' `A13']
[`A21' `A22' `A23']
[`A31' `A32' `A33'].
If `iView' < 0, the plugin is run on the current
view.

Plugin(Transform) is executed in-place.

Numeric options:
@table @code
@item A11
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A12
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A13
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A21
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A22
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A23
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A31
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A32
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{0}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item A33
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@item Plugin(Triangulate)
Plugin(Triangulate) triangulates the points
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
in the view `iView', assuming that all the
points belong to a surface that can be
Christophe Geuzaine's avatar
Christophe Geuzaine committed
univoquely projected into a plane. If `iView'
< 0, the plugin is run on the current view.

Plugin(Triangulate) creates one new view.

Numeric options:
@table @code
@item iView
Christophe Geuzaine's avatar
 
Christophe Geuzaine committed
Default value: @code{-1}
Christophe Geuzaine's avatar
Christophe Geuzaine committed
@end table

@end ftable