info gmsh

8.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 Post-processing options list) 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 GUI 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(AnalyseCurvedMesh)

Plugin(AnalyseCurvedMesh) check the jacobian of all elements of dimension ’Dim’ or the greater model dimension if ’Dim’ is either <0 or >3.

Analysis : 0 do nothing +1 find invalid elements (*) +2 compute J_min and J_max of all elements and print some statistics

Effect (for *) : 0 do nothing +1 print a list of invalid elements +2 print some statistics +4 hide valid elements (for GUI)

MaxDepth = 0,1,... 0 : only sample the jacobian 1 : compute Bezier coefficients 2+ : execute a maximum of 1+ subdivision(s)

JacBreak = [0,1[ : if a value of the jacobian <= ’JacBreak’ is found, the element is said to be invalid

BezBreak = [0,JacBreak[ : if all Bezier coefficients are > ’BezBreak’, the element is said to be valid

Tolerance = R+ , << 1 : tolerance (relatively to J_min and J_max) used during the computation of J_min and J_max Numeric options:

Dim: Default value: -1
Analysis: Default value: 2
Effect (1): Default value: 6
JacBreak (1): Default value: 0
BezBreak (1): Default value: 0
MaxDepth (1,2): Default value: 20
Tolerance (2): Default value: 0.001

Plugin(Annotate)

Plugin(Annotate) adds the text string ‘Text’, in font ‘Font’ and size ‘FontSize’, in the view ‘View’. The string is aligned according to ‘Align’.

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’).

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Annotate) is executed in-place for list-based datasets or creates a new view for other datasets. 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
ThreeD: Default value: 0
FontSize: Default value: 14
View: Default value: -1

Plugin(Bubbles)

Plugin(Bubbles) constructs a geometry consisting of ‘bubbles’ inscribed in the Voronoi of an input triangulation. ‘ShrinkFactor’ allows to change the size of the bubbles. The plugin expects a triangulation in the ‘z = 0’ plane to exist in the current model.

Plugin(Bubbles) creates one ‘.geo’ file. String options:

OutputFile: Default value: "bubbles.geo"

Numeric options:

ShrinkFactor: Default value: 0

Plugin(Crack)

Plugin(Crack) creates a crack around the physical group ‘PhysicalGroup’ of dimension ‘Dimension’ (1 or 2). The plugin duplicates the vertices and the elements on the crack and stores them in a new discrete curve (‘Dimension’ = 1) or surface (‘Dimension’ = 2). The elements touching the crack on the negative side are modified to use the newly generated vertices.If ‘OpenBoundaryPhysicalGroup’ is given (> 0), its vertices are duplicated and the crack will be left open on that (part of the) boundary. Otherwise, the lips of the crack are sealed, i.e., its vertices are not duplicated. Numeric options:

Dimension: Default value: 1
PhysicalGroup: Default value: 1
OpenBoundaryPhysicalGroup: Default value: 0

Plugin(Curl)

Plugin(Curl) computes the curl of the field in the view ‘View’.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Curl) creates one new view. Numeric options:

View: Default value: -1

Plugin(CutBox)

Plugin(CutBox) cuts the view ‘View’ with a rectangular box defined by the 4 points (‘X0’,‘Y0’,‘Z0’) (origin), (‘X1’,‘Y1’,‘Z1’) (axis of U), (‘X2’,‘Y2’,‘Z2’) (axis of V) and (‘X3’,‘Y3’,‘Z3’) (axis of W).

The number of points along U, V, W is set with the options ‘NumPointsU’, ‘NumPointsV’ and ‘NumPointsW’.

If ‘ConnectPoints’ is zero, the plugin creates points; otherwise, the plugin generates hexahedra, quadrangles, lines or points depending on the values of ‘NumPointsU’, ‘NumPointsV’ and ‘NumPointsW’.

If ‘Boundary’ is zero, the plugin interpolates the view inside the box; otherwise the plugin interpolates the view at its boundary.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(CutBox) 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
X3: Default value: 0
Y3: Default value: 0
Z3: Default value: 1
NumPointsU: Default value: 20
NumPointsV: Default value: 20
NumPointsW: Default value: 20
ConnectPoints: Default value: 1
Boundary: Default value: 1
View: Default value: -1

Plugin(CutGrid)

Plugin(CutGrid) cuts the view ‘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 with the options ‘NumPointsU’ and ‘NumPointsV’.

If ‘ConnectPoints’ is zero, the plugin creates points; otherwise, the plugin generates quadrangles, lines or points depending on the values of ‘NumPointsU’ and ‘NumPointsV’.

If ‘View’ < 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
NumPointsU: Default value: 20
NumPointsV: Default value: 20
ConnectPoints: Default value: 1
View: Default value: -1

Plugin(CutParametric)

Plugin(CutParametric) cuts the view ‘View’ with the parametric function (‘X’(u,v), ‘Y’(u,v), ‘Z’(u,v)), using ‘NumPointsU’ values of the parameter u in [‘MinU’, ‘MaxU’] and ‘NumPointsV’ values of the parameter v in [‘MinV’, ‘MaxV’].

If ‘ConnectPoints’ is set, the plugin creates surface or line elements; otherwise, the plugin generates points.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(CutParametric) creates one new view. String options:

X: Default value: "2 * Cos(u) * Sin(v)"
Y: Default value: "4 * Sin(u) * Sin(v)"
Z: Default value: "0.1 + 0.5 * Cos(v)"

Numeric options:

MinU: Default value: 0
MaxU: Default value: 6.2832
NumPointsU: Default value: 180
MinV: Default value: 0
MaxV: Default value: 6.2832
NumPointsV: Default value: 180
ConnectPoints: Default value: 0
View: Default value: -1

Plugin(CutPlane)

Plugin(CutPlane) cuts the view ‘View’ 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 ‘View’ < 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
View: Default value: -1

Plugin(CutSphere)

Plugin(CutSphere) cuts the view ‘View’ 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 ‘View’ < 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
TargetError: Default value: 0
View: Default value: -1

Plugin(DiscretizationError)

Plugin(DiscretizationError) computes the error between the mesh and the geometry. It does so by supersampling the elements and computing the distance between the supersampled points dans their projection on the geometry. Numeric options:

SuperSamplingNodes: Default value: 10

Plugin(Distance)

Plugin(Distance) computes distances to physical entities in a mesh.

Define the physical entities to which the distance is computed. If Point=0, Line=0, and Surface=0, then the distance is computed to all the boundaries of the mesh (edges in 2D and faces in 3D).

Computation<0. computes the geometrical euclidian distance (warning: different than the geodesic distance), and Computation=a>0.0 solves a PDE on the mesh with the diffusion constant mu = a*bbox, with bbox being the max size of the bounding box of the mesh (see paper Legrand 2006).

Min Scale and max Scale, scale the distance function. If min Scale<0 and max Scale<0, then no scaling is applied to the distance function.

Plugin(Distance) creates a new distance view and also saves the view in the fileName.pos file. String options:

Filename: Default value: "distance.pos"

Numeric options:

PhysPoint: Default value: 0
PhysLine: Default value: 0
PhysSurface: Default value: 0
Computation: Default value: -1
MinScale: Default value: -1
MaxScale: Default value: -1
Orthogonal: Default value: -1

Plugin(Divergence)

Plugin(Divergence) computes the divergence of the field in the view ‘View’.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Divergence) creates one new view. Numeric options:

View: Default value: -1

Plugin(Eigenvalues)

Plugin(Eigenvalues) computes the three real eigenvalues of each tensor in the view ‘View’.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Eigenvalues) creates three new scalar views. Numeric options:

View: Default value: -1

Plugin(Eigenvectors)

Plugin(Eigenvectors) computes the three (right) eigenvectors of each tensor in the view ‘View’ 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 ‘View’ < 0, the plugin is run on the current view.

Plugin(Eigenvectors) creates three new vector view. Numeric options:

ScaleByEigenvalues: Default value: 1
View: Default value: -1

Plugin(ExtractEdges)

Plugin(ExtractEdges) extracts sharp edges from a triangular mesh.

Plugin(ExtractEdges) creates one new view. Numeric options:

Angle: Default value: 40
IncludeBoundary: Default value: 1

Plugin(ExtractElements)

Plugin(ExtractElements) extracts some elements from the view ‘View’. If ‘MinVal’ != ‘MaxVal’, it extracts the elements whose ‘TimeStep’-th values (averaged by element) are comprised between ‘MinVal’ and ‘MaxVal’. If ‘Visible’ != 0, it extracts visible elements.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(ExtractElements) creates one new view. Numeric options:

MinVal: Default value: 0
MaxVal: Default value: 0
TimeStep: Default value: 0
Visible: Default value: 1
Dimension: Default value: -1
View: Default value: -1

Plugin(FaultZone)

Plugin(FaultZone) convert all the embedded lines of an existing surfacic mesh to flat quadrangles. Flat quadrangles represent joint elements suitable to model a fault zone with Code_Aster.

‘SurfaceTag’ must be an existing plane surface containing embedded lines. Embedded lines must have been added to the surface via the command Line In Surface. The surface must be meshed with quadratic incomplete elements.

‘Thickness’ is the thichness of the flat quadrangles. Set a value different to zero can be helpfull to check the connectivity.

‘Prefix’ is the prefix of the name of physicals containing the new embedded. All physicals containing embedded lines are replaced by physicals containing the coresponding joint elements. String options:

Prefix: Default value: "FAMI_"

Numeric options:

SurfaceTag: Default value: 1
Thickness: Default value: 0

Plugin(FieldFromAmplitudePhase)

Plugin(FieldFromAmplitudePhase) builds a complex field ’u’ from amplitude ’a’ (complex) and phase ’phi’ given in two different ’Views’ u = a * exp(k*phi), with k the wavenumber.

The result is to be interpolated in a sufficiently fine mesh: ’MeshFile’.

Plugin(FieldFromAmplitudePhase) generates one new view. String options:

MeshFile: Default value: "fine.msh"

Numeric options:

Wavenumber: Default value: 5
AmplitudeView: Default value: 0
PhaseView: Default value: 1

Plugin(Gradient)

Plugin(Gradient) computes the gradient of the field in the view ‘View’.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Gradient) creates one new view. Numeric options:

View: Default value: -1

Plugin(HarmonicToTime)

Plugin(HarmonicToTime) takes the values in the time steps ‘RealPart’ and ‘ImaginaryPart’ of the view ‘View’, and creates a new view containing

‘View’[‘RealPart’] * cos(p) - ‘View’[‘ImaginaryPart’] * sin(p)

with p = 2*Pi*k/‘NumSteps’, k = 0, ..., ‘NumSteps’-1.

If ‘View’ < 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
NumSteps: Default value: 20
View: Default value: -1

Plugin(HomologyComputation)

Plugin(HomologyComputation) computes representative chains of basis elements of (relative) homology and cohomology spaces.

Define physical groups in order to specify the computation domain and the relative subdomain. Otherwise the whole mesh is the domain and the relative subdomain is empty.

Plugin(HomologyComputation) creates new views, one for each basis element. The resulting basis chains of desired dimension together with the mesh are saved to the given file. String options:

DomainPhysicalGroups: Default value: ""
SubdomainPhysicalGroups: Default value: ""
ReductionImmunePhysicalGroups: Default value: ""
DimensionOfChainsToSave: Default value: "0, 1, 2, 3"
Filename: Default value: "homology.msh"

Numeric options:

ComputeHomology: Default value: 1
ComputeCohomology: Default value: 0
HomologyPhysicalGroupsBegin: Default value: -1
CohomologyPhysicalGroupsBegin: Default value: -1
CreatePostProcessingViews: Default value: 1
ReductionOmit: Default value: 1
ReductionCombine: Default value: 3
PostProcessSimplify: Default value: 1
ReductionHeuristic: Default value: 1

Plugin(HomologyPostProcessing)

Plugin(HomologyPostProcessing) operates on representative basis chains of homology and cohomology spaces. Functionality:

1. (co)homology basis transformation: ’TransformationMatrix’: Integer matrix of the transformation. ’PhysicalGroupsOfOperatedChains’: (Co)chains of a (co)homology space basis to be transformed. Results a new (co)chain basis that is an integer cobination of the given basis.

2. Make basis representations of a homology space and a cohomology space compatible: ’PhysicalGroupsOfOperatedChains’: Chains of a homology space basis. ’PhysicalGroupsOfOperatedChains2’: Cochains of a cohomology space basis. Results a new basis for the homology space such that the incidence matrix of the new basis and the basis of the cohomology space is the identity matrix.

Options: ’PhysicalGroupsToTraceResults’: Trace the resulting (co)chains to the given physical groups. ’PhysicalGroupsToProjectResults’: Project the resulting (co)chains to the complement of the given physical groups. ’NameForResultChains’: Post-processing view name prefix for the results. ’ApplyBoundaryOperatorToResults’: Apply boundary operator to the resulting chains.

String options:

TransformationMatrix: Default value: "1, 0; 0, 1"
PhysicalGroupsOfOperatedChains: Default value: "1, 2"
PhysicalGroupsOfOperatedChains2: Default value: ""
PhysicalGroupsToTraceResults: Default value: ""
PhysicalGroupsToProjectResults: Default value: ""
NameForResultChains: Default value: "c"

Numeric options:

ApplyBoundaryOperatorToResults: Default value: 0

Plugin(Integrate)

Plugin(Integrate) integrates a scalar field over all the elements of the view ‘View’ (if ‘Dimension’ < 0), or over all elements of the prescribed dimension (if ‘Dimension’ > 0). If the field is a vector field,the circulation/flux of the field over line/surface elements is calculated.

If ‘View’ < 0, the plugin is run on the current view.

If ‘OverTime’ = 1 , the plugin integrates the scalar view over time instead of over space.

Plugin(Integrate) creates one new view. Numeric options:

View: Default value: -1
OverTime: Default value: -1
Dimension: Default value: -1

Plugin(Isosurface)

Plugin(Isosurface) extracts the isosurface of value ‘Value’ from the view ‘View’, and draws the ‘OtherTimeStep’-th step of the view ‘OtherView’ on this isosurface.

If ‘ExtractVolume’ is nonzero, the plugin extracts the isovolume with values greater (if ‘ExtractVolume’ > 0) or smaller (if ‘ExtractVolume’ < 0) than the isosurface ‘Value’.

If ‘OtherTimeStep’ < 0, the plugin uses, for each time step in ‘View’, the corresponding time step in ‘OtherView’. If ‘OtherView’ < 0, the plugin uses ‘View’ as the value source.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Isosurface) creates as many views as there are time steps in ‘View’. Numeric options:

Value: Default value: 0
ExtractVolume: Default value: 0
RecurLevel: Default value: 4
TargetError: Default value: 0
View: Default value: -1
OtherTimeStep: Default value: -1
OtherView: 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 ‘View’ contains tensor elements, the plugin directly uses the tensors as the values of the velocity gradient tensor; if ‘View’ contains vector elements, the plugin uses them as the velocities from which to derive the velocity gradient tensor.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Lambda2) creates one new view. Numeric options:

Eigenvalue: Default value: 2
View: Default value: -1

Plugin(LongitudeLatitude)

Plugin(LongituteLatitude) projects the view ‘View’ in longitude-latitude.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(LongituteLatitude) is executed in place. Numeric options:

View: Default value: -1

Plugin(MakeSimplex)

Plugin(MakeSimplex) decomposes all non-simplectic elements (quadrangles, prisms, hexahedra, pyramids) in the view ‘View’ into simplices (triangles, tetrahedra).

If ‘View’ < 0, the plugin is run on the current view.

Plugin(MakeSimplex) is executed in-place. Numeric options:

View: Default value: -1

Plugin(MathEval)

Plugin(MathEval) creates a new view using data from the time step ‘TimeStep’ in the view ‘View’.

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 in ‘View’;

- the symbols w0, w1, w2, ..., wn, which represent the n components of ‘OtherView’, at time step ‘OtherTimeStep’;

- 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 ‘View’ < 0, the plugin is run on the current view.

Plugin(MathEval) creates one new view.If ‘PhysicalRegion’ < 0, the plugin is run on all physical regions.

Plugin(MathEval) 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
View: Default value: -1
OtherTimeStep: Default value: -1
OtherView: Default value: -1
ForceInterpolation: Default value: 0
PhysicalRegion: Default value: -1

Plugin(MinMax)

Plugin(MinMax) computes the min/max of a view.

If ‘View’ < 0, the plugin is run on the current view.

If ‘OverTime’ = 1, calculates the min/max over space AND time

If ‘Argument’ = 1, calculates the min/max AND the argmin/argmax

Plugin(MinMax) creates two new views. Numeric options:

View: Default value: -1
OverTime: Default value: 0
Argument: Default value: 0

Plugin(ModifyComponent)

Plugin(ModifyComponent) sets the ‘Component’-th component of the ‘TimeStep’-th time step in the view ‘View’ 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 ‘View’ at the ‘TimeStep’-th time step;

- the symbols v0, v1, v2, ..., v8, to retrieve each component of the field in ‘View’ at the ‘TimeStep’-th time step;

- the symbol w, to retrieve the ‘Component’-th component of the field in ‘OtherView’ at the ‘OtherTimeStep’-th time step. If ‘OtherView’ and ‘View’ are based on different spatial grids, or if their data types are different, ‘OtherView’ is interpolated onto ‘View’;

- the symbols w0, w1, w2, ..., w8, to retrieve each component of the field in ‘OtherView’ at the ‘OtherTimeStep’-th time step.

If ‘TimeStep’ < 0, the plugin automatically loops over all the time steps in ‘View’ and evaluates ‘Expression’ for each one.

If ‘OtherTimeStep’ < 0, the plugin uses ‘TimeStep’ instead.

If ‘Component’ < 0, the plugin automatically ops over all the components in the view and evaluates ‘Expression’ for each one.

If ‘View’ < 0, the plugin is run on the current view.

If ‘OtherView’ < 0, the plugin uses ‘View’ instead.

Plugin(ModifyComponent) is executed in-place. String options:

Expression: Default value: "v0 * Sin(x)"

Numeric options:

Component: Default value: -1
TimeStep: Default value: -1
View: Default value: -1
OtherTimeStep: Default value: -1
OtherView: Default value: -1
ForceInterpolation: Default value: 0

Plugin(ModulusPhase)

Plugin(ModulusPhase) interprets the time steps ‘realPart’ and ‘imaginaryPart’ in the view ‘View’ as the real and imaginary parts of a complex field and replaces them with their corresponding modulus and phase.

If ‘View’ < 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
View: Default value: -1

Plugin(NearToFarField)

Plugin(NearToFarField) computes the far field pattern from the near electric E and magnetic H fields on a surface enclosing the radiating device (antenna).

Parameters: the wavenumber, the angular discretisation (phi in [0, 2*Pi] and theta in [0, Pi]) of the far field sphere and the indices of the views containing the complex-valued E and H fields. If ‘Normalize’ is set, the far field is normalized to 1. If ‘dB’ is set, the far field is computed in dB. If ‘NegativeTime’ is set, E and H are assumed to have exp(-iwt) time dependency; otherwise they are assume to have exp(+iwt) time dependency. If ‘MatlabOutputFile’ is given the raw far field data is also exported in Matlab format.

Plugin(NearToFarField) creates one new view. String options:

MatlabOutputFile: Default value: "farfield.m"

Numeric options:

Wavenumber: Default value: 1
PhiStart: Default value: 0
PhiEnd: Default value: 6.28319
NumPointsPhi: Default value: 60
ThetaStart: Default value: 0
ThetaEnd: Default value: 3.14159
NumPointsTheta: Default value: 30
EView: Default value: 0
HView: Default value: 1
Normalize: Default value: 1
dB: Default value: 1
NegativeTime: Default value: 0
RFar: Default value: 0

Plugin(NearestNeighbor)

Plugin(NearestNeighbor) computes the distance from each point in ‘View’ to its nearest neighbor.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(NearestNeighbor) is executed in-place. Numeric options:

View: Default value: -1

Plugin(NewView)

Plugin(NewView) creates a new view from a mesh. Numeric options:

View: Default value: -1

Plugin(Particles)

Plugin(Particles) computes the trajectory of particules in the force field given by the ‘TimeStep’-th time step of a vector view ‘View’.

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 particles along U and V that are to be transported is set with the options ‘NumPointsU’ and ‘NumPointsV’. The equation

A2 * d^2X(t)/dt^2 + A1 * dX(t)/dt + A0 * X(t) = F

is then solved with the initial conditions X(t=0) chosen as the grid, dX/dt(t=0)=0, and with F interpolated from the vector view.

Time stepping is done using a Newmark scheme with step size ‘DT’ and ‘MaxIter’ maximum number of iterations.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Particles) creates one new view containing multi-step vector points. 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
NumPointsU: Default value: 10
NumPointsV: Default value: 1
A2: Default value: 1
A1: Default value: 0
A0: Default value: 0
DT: Default value: 0.1
MaxIter: Default value: 100
TimeStep: Default value: 0
View: Default value: -1

Plugin(Probe)

Plugin(Probe) gets the value of the view ‘View’ at the point (‘X’,‘Y’,‘Z’).

If ‘View’ < 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
View: Default value: -1

Plugin(Remove)

Plugin(Remove) removes the marked items from the view ‘View’.

If ‘View’ < 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
View: Default value: -1

Plugin(Scal2Vec)

Plugin(Scal2Vec) converts the scalar fields of ’ViewX’, ’ViewY’ and/or ’ViewZ’ into a vectorial field. The new view ’NameNewView’ contains it.

If the value of ’ViewX’, ’ViewY’ or ’ViewZ’ is -1, the value of the vectorial field in the corresponding direction is 0. String options:

NameNewView: Default value: "NewView"

Numeric options:

ViewX: Default value: -1
ViewY: Default value: -1
ViewZ: Default value: -1

Plugin(SimplePartition)

Plugin(SimplePartition) partitions the current mesh into ‘NumSlices’ slices, along the X-, Y- or Z-axis depending on the value of ‘Direction’ (0,1,2). The plugin creates partition boundaries if ‘CreateBoundaries’ is set. String options:

Mapping: Default value: "t"

Numeric options:

NumSlices: Default value: 4
Direction: Default value: 0
CreateBoundaries: Default value: 1

Plugin(Skin)

Plugin(Skin) extracts the boundary (skin) of the current mesh (if ‘FromMesh’ = 1), or from the the view ‘View’ (in which case it creates a new view). If ‘View’ < 0 and ‘FromMesh’ = 0, the plugin is run on the current view. If ‘Visible’ is set, the plugin only extracts the skin of visible entities. Numeric options:

Visible: Default value: 1
FromMesh: Default value: 0
View: Default value: -1

Plugin(Smooth)

Plugin(Smooth) averages the values at the nodes of the view ‘View’.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Smooth) is executed in-place. Numeric options:

View: Default value: -1

Plugin(SphericalRaise)

Plugin(SphericalRaise) transforms the coordinates of the elements in the view ‘View’ using the values associated with the ‘TimeStep’-th time step.

Instead of elevating the nodes along the X, Y and Z axes as with the View[‘View’].RaiseX, View[‘View’].RaiseY and View[‘View’].RaiseZ options, 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 ‘View’ < 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
View: Default value: -1

Plugin(StreamLines)

Plugin(StreamLines) computes stream lines from the ‘TimeStep’-th time step of a vector view ‘View’ and optionally interpolates the scalar view ‘OtherView’ 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 along U and V that are to be transported is set with the options ‘NumPointsU’ and ‘NumPointsV’. 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 ‘TimeStep’ < 0, the plugin tries to compute streamlines of the unsteady flow.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(StreamLines) creates one new view. This view contains multi-step vector points if ‘OtherView’ < 0, or single-step scalar lines if ‘OtherView’ >= 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
NumPointsU: Default value: 10
NumPointsV: Default value: 1
DT: Default value: 0.1
MaxIter: Default value: 100
TimeStep: Default value: 0
View: Default value: -1
OtherView: Default value: -1

Plugin(Tetrahedralize)

Plugin(Tetrahedralize) tetrahedralizes the points in the view ‘View’.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Tetrahedralize) creates one new view. Numeric options:

View: Default value: -1

Plugin(Transform)

Plugin(Transform) transforms the homogeneous node coordinates (x,y,z,1) of the elements in the view ‘View’ 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 ‘View’ < 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
View: Default value: -1

Plugin(Triangulate)

Plugin(Triangulate) triangulates the points in the view ‘View’, assuming that all the points belong to a surface that can be projected one-to-one onto a plane.

If ‘View’ < 0, the plugin is run on the current view.

Plugin(Triangulate) creates one new view. Numeric options:

View: Default value: -1

Plugin(Warp)

Plugin(Warp) transforms the elements in the view ‘View’ by adding to their node coordinates the vector field stored in the ‘TimeStep’-th time step of the view ‘OtherView’, scaled by ‘Factor’.

If ‘View’ < 0, the plugin is run on the current view.

If ‘OtherView’ < 0, the vector field is taken as the field of surface normals multiplied by the ‘TimeStep’ value in ‘View’. (The smoothing of the surface normals is controlled by the ‘SmoothingAngle’ parameter.)

Plugin(Warp) is executed in-place. Numeric options:

Factor: Default value: 1
TimeStep: Default value: 0
SmoothingAngle: Default value: 180
View: Default value: -1
OtherView: Default value: -1

This document was generated on February 9, 2014 using texi2html 5.0.