ADApt ADD BLOw CLEar CONvert COPy DELete DRAw END EXChange EXIt GENerate GET GOTo IF> IF< IF= INCrease ITEterate LABel LOOp MMP MOVe MULtiply PROcess REAd REFlect REName ROTate RUN SET SORt SUBtract WRIte
BOUndary CIRcle COLor CONnection DERived-field DOMain EXPansion FIEld FUNction LINe OBJect OGL(openGL) PFD TEXt VARiable WINdow
Arguments: (n scale)
Meaning: Draw the boundary number n. If the first argument is missing, n=0 is set. Special cases: n=0 – do for all boundaries, n<0 – do for boundary numbers 1 up to -n. If scale is specified, the error scaling factor for drawing the MMP errors along the boundaries is set equal to scale.
Arguments: x y r (n)
Meaning: Draw a circle with center (x,y) and radius r, color number n. If the last argument is missing, n=1 (black) is set.
Arguments: (n)
Meaning: Draw all 2D boundaries and expansions with color number n. If the first argument is missing, n=0 is set. Special cases: n=0 – do for all colors, n<0 – do for color numbers 1 up to -n.
Arguments: (n)
Meaning: Draw all 2D boundaries and expansions with connection flagr n. If the first argument is missing, n=0 is set. Special cases: n=0 – do for all connections, n<0 – do for connection numbers 1 up to -n.
No argument
Meaning: Draw the current derived field without recomputing it. This is especially important for movies generated within the OpenGL window.
Argument: (n)
Meaning: Draw the boundaries and expansions of domain number n. If the argument is missing, n=0 is set. Special cases: n=0 – do for all domains, n<0 – do for domain numbers 1 up to -n.
Argument: (n)
Meaning: Draw the expansion number n. If the argument is missing, n=0 is set. Special cases: n=0 – do for all expansions, n<0 – do for expansion numbers 1 up to -n.
Argument(s): (Type Component Average)
Meaning: Compute and draw the derived field.
Type denotes the field type and can be one of the following: E, H, S, D, B, J, A, V, We, Wm, Wt, Pe, Pm, Pt (according to the notation in the Field dialog) and Current, Gradient, Line. Current means that the type that is currently defined in the Field dialog is used. Gradient means that the gradient of the current field type is evaluated numerically (finite difference approximation) and displayed. This only makes sense when the current field is a scalar field. It may be used for a rough estimate of the optical force.
Component denotes the field components of vector fields and can be one of the following: X, Y, Z, XY, XZ, YZ, XYZ. Average denotes the average field if its first character is equal to A or a or B or b. When the first character is P or p or B or b, the phase is drawn. Otherwise, the time-dependent field is drawn. When an argument is missing, the current settings are used.
Special case:
Type=Line: Draw field line or field tube. After the Type argument you may specify the following arguments: x y z r d nx ny col. i.e., the Cartesian coordinates of the start point, the radius of the tube, its step size along the line or tube, numbers of grid lines around and along the tube, and the color number. A field line is a tube with r =0 and ny=1.
Arguments: x-argument y-argument (color x-scale y-scale ix1 ix2)
Meaning: Draw the function y(x) in the current graphic window using color number color and the scaling factors x-scale, y-scale. Use the row numbers ix1 up to ix2 of the function array. When color, x-scale, y-scale, ix1, ix2 are missing, these parameters are set equal to 1 except ix2 that is set equal to the number of rows of the function array, i.e., color is set to black, no scaling is applied, and the all values stored in the function array are used for drawing. Note that OpenMaXwell stores function values and the argument values in an array. The two arguments denote the numbers of the columns of this array that store the corresponding values in x and y directions. OpenMaXwell does not differentiate between function values and argument values.
If x-scale is negative, the maximum absolute x value xMax is searched and all x values are multiplied with -x-scale/xMax before plotting. Similarly, if y-scale is negative, the maximum absolute y value yMax is searched and all y values are multiplied with -y-scale/yMax before plotting. For example, when you set y-scale=-1, all plotted y values will fit into the window range -1<=y<=+1 - provided that the Yscale in the Function dialog is set to 1. If the original y values are all positive, the plotted y values will fit into the window range 0<=y<=+Yscale. Note that such scaled plotting is only available by this directive.
Arguments: C ... col
Meaning: Draw a line using color number col. C may be one of the following characters:
H: additional argument y: draw horizontal line at y.
V: additional argument x: draw vertical line at x.
When C is character belonging to a real number, it is considered as x1 and three additional values y1 x2 y2 are expected before the color number. Then, a line is drawn from the point (x1,y1) to the point (x2,y2).
Argument: (n)
Meaning: Draw the 3D object number n. If the argument is missing, n=0 is set. Special cases: n=0 – do for all 3D objects, n<0 – do for 3D object numbers 1 up to -n.
Argument: (n list)
Meaning: Draw the 3D objects number n in the OpenGL graphics window. When n is missing, all 3D objects are drawn. Special cases: n=0 – do for all 3D objects, n<0 – do for 3D object numbers 1 up to -n.
The OpenGL window may contain: 1) the Axes of the global coordinate system, 2) the Surfaces of the 3D objects, 3) the Grid lines of the 3D objects, 4) the Iso lines of the 3D objects, 5) the field Vectors, 6) the markers of the Expansions, 7) field tubes, 8) PFD point sources, 9) PFD sensors. The argument list is a character string with up to 6 characters. It defines what is visible. When list is missing or when it is ASGIVETPX, all of the above is visible. To make the Axes invisible, replace the first character A by any other character. Similarly, you may replace any character in list by another character to make the corresponding graphic object invisible. For example, to visualize only the Axes, the Grid lines, and the expansions, set list=ANGNNENNN.
Arguments: WHAt n
Meaning: Draw a component of the PFD (Predefined Finite Difference) solver.
Argument(s): ix iy color text
Meaning: Draw the text string text with the color number color on the current graphic window, starting at position (ix,iy) (in pixel coordinates - (0,0) is the upper right corner). The text string should be written between quotes.
Arguments: ix iy color variable (…)
Meaning: Draw variable with the color number color on the current graphic window, starting at position (ix,iy) (in pixel coordinates - (0,0) is the upper right corner). (…) denotes additional arguments that depend on the variable. variable (…) can be one of the following:
ANGle n: The orientation angle of the expansion n.
BOUndary n: The number of 2D boundaries + n.
CND: The current condition number of the rectangular MMP matrix.
CONstant c1 (c2 …): The constants c1, c2,…. The maximum number of constants is 40.
CPU (n): The CPU time (since the previous call of the CPU time). If n is present and <1: the elapsed time instead of the CPU time.
CXI: The imaginary part of CX (see periodic cell data of the Project dialog).
CXR: The real part of CX (see periodic cell data of the Project dialog).
CYI: The imaginary part of CY (see periodic cell data of the Project dialog).
CYR: The real part of CY (see periodic cell data of the Project dialog).
CZI: The imaginary part of CZ (see periodic cell data of the Project dialog).
CZR: The real part of CZ (see periodic cell data of the Project dialog).
DOMain n WHat: Write material properties of the domain number n. WHatspecifies what property shall be written. When the domain property is defined by a formula, the formula is evaluated and the resulting complex or real value is written. WHatmay be one of the following: EC, EI, ER, SC, SI, SR, UC, UI, UR, TC, TI, TR, where the first character stands for Epsilon, Sigma, mUe, Tau and the second one for Complex (write 2 real values), Imaginary, or Real.
EFFiciency (n m): The efficiency of the Rayleigh expansion number n Note that this directive makes no sense when expansion n is not a Rayleigh expansion. When the number m is given, the efficiency of the m-th parameter of expansion n is written. When m is missing, the sum of all efficiencies of all non-evanescent parts (orders) of expansion n is written. When both n and m are missing, the sum of all efficiencies of all Rayleigh expansions of all non-evanescent orders is written. This number can be used as an error check. For a standard grating with an incident plane wave and two Rayleigh expansions (one for the transmitted and one for the reflected waves), the sum should be 1 – provided that the incident plane wave and the Rayleigh expansion are scaled correctly.
ERRor (X Y): The current error. The optional attributes X and Y specify the kind of the error. When these attributes are missing, the error of the field is used. Otherwise, the error of the MMP computation is used. X may be A for "absolute" or R for "relative" and Y may be A for "average" or M for "maximum". Note that the relative MMP errors are given in percent.
ER2: The square root of the quadratic error of the field.
EXPansion n: The number of 2D expansions + n.
FIEld TYPE (x y z Dom n m): The specified field component in the point with the Cartesian (or cylindrical) coordinates x y z. Missing coordinates are set equal to zero. Dom specifies the domain number of the field point. If it is missing, it is computed from the current boundary data.
n specifies the interpolation type for field points that are not on the grid when the derived field is written. When an original field or the complex Poynting field is written, no interpolation is used and the MMP expansion is evaluated in the point x,y,z. In this case, you may specify n and m. n denotes the expansion number to be used for the field evaluation and m is the parameter number of this expansion. Default values are n=0 and m=0, which corresponds to "all expansions" and "all parameters".
TYPE is a string with up to 4 characters.
The first character describes a (complex) vector v. It can be one of the following:
A: The original vector potential A
E: The original E field
H: The original H field
R: The derived field (In this case, the vector v is real!)
S: The complex Poynting field S (original E ´ conjugate complex of original H)
V: The original scalar potential V (in this case the y and z components of the vector v are 0)
The second character describes how the vector v is manipulated in order to obtain a (complex) scalar s. It can be one of the following:
F: The angular (phi) component the vector v in the xy plane
R: The radial (r) component of the vector v in the xy plane
X: The x component of the vector v
Y: The y component of the vector v
Z: The z component of the vector v
1: The square root of the scalar product of the vector v with its conjugate complex
2: The scalar product of the vector v with its conjugate complex
The third character describes how the scalar s is manipulated. It can be one of the following:
A: The absolute value of the scalar s
I: The imaginary part of the scalar s
R: The real part of the scalar s
2: The square of the absolute value of the scalar s
If the fourth character is equal to P, x y are considered to be the polar coordinates r and phi in the xy plane rather than the Cartesian coordinates.
The default TYPE string is S1C, i.e., the vector v is the Poynting vector S, the scalar s is the square root of the scalar product of the vector v with its conjugate complex, and both real and imaginary parts are written. Since the fourth character P is missing by default, x y are Cartesian coordinates. Note that the default characters of the default TYPE string are also used when unknown characters are in the given string. For example, T3F would be the same as S1C.
FREquency PARt: The current frequency PARt specifies the part of the complex frequency that is used. It can be ABS, IMAginary, or REAl.
GAMma PARt: The propagation constant gamma. PARt specifies the part of the complex propagation constant that is saved. It can be ABS, IMAginary, or REAl.
IMA: The maximum integrand value that was detected during the integral evaluation.
IMI: The minimum integrand value that was detected during the integral evaluation.
INTegral: The value of the integral.
IXA: The x coordinate of the point where the maximum integrand value that was detected during the integral evaluation.
IXI: The x coordinate of the point where the minimum integrand value that was detected during the integral evaluation.
IYA: The y coordinate of the point where the maximum integrand value that was detected during the integral evaluation.
IYI: The y coordinate of the point where the minimum integrand value that was detected during the integral evaluation.
IZA: The z coordinate of the point where the maximum integrand value that was detected during the integral evaluation.
IZI: The z coordinate of the point where the minimum integrand value that was detected during the integral evaluation.
KW0: The free-space wave number.
LA0: The free-space wave length.
LAM: The wave length of the current waveguide mode.
LEN: The propagation length of the current waveguide mode.
LOCation (n): The location of the expansion number n.
MAXimum: The maximum value of the derived field.
MINimum: The minimum value of the derived field.
MMP WHAt: The MMP data. WHAt specifies the data. It may be one of the following:
AMPlitude: amplitude of MMP eigenvalue computations
AVEr: average error on the boundaries
CGIter: number of CG iterations that were performed
CND: condition number of the MMP matrix (should have been computed first!)
COLumns: number of columns of the MMP matrix
EIGen: number of iterations of the eigenvalue search
MATching: number of matching points
MAXimum: maximum error on the boundaries
RESidual (n): residual of the MMP solver (if n not present or <1) or eigenvalue search function value (n=1...9, depending on the search type)
ROWs: number of rows of the MMP matrix
OMEga WHAt: The angular frequency omega. Note that omega is complex in general. WHAt may be one of the following: ABS (the absolute value of omega), IMA (the imaginary part of omega), REA (the real part of omega).
P2D n WHat: Information on the 2D particle number n. WHat may be one of the following: AX (x coordinate of the acceleration), AY (y coordinate of the acceleration), FX (x coordinate of the force), FY (y coordinate of the force), MAss (mass), PX (x coordinate of the position), PY (y coordinate of the position), VX (x coordinate of the velocity), VY (y coordinate of the velocity).
P3D n WHat: Information on the 3D particle number n. WHat may be one of the following: AX (x coordinate of the acceleration), AY (y coordinate of the acceleration), AZ (z coordinate of the acceleration), FX (x coordinate of the force), FY (y coordinate of the force), FZ (z coordinate of the force), MAss (mass), PX (x coordinate of the position), PY (y coordinate of the position), PZ (z coordinate of the position), VX (x coordinate of the velocity), VY (y coordinate of the velocity), VZ (z coordinate of the velocity).
PARameter n m PARt: The specified PARt of the complex parameter number m of the expansion number n. PARt can be ABSolute, ANGle, COMplex, IMAginary, REAl, or SQA. ANGle denotes the arctg(Imag/Real) in degrees and SQA denotes the square of the absolute value.
PFD n WHat: Write PFD sensor information
PHI: The phase (of time-harmonic fields)
REPresentation: The function representation data.
RAYleigh n m: The angle (in degrees) of the Rayleigh term with expansion number n and parameter number m Note that two angles are written for 3D Rayleigh expansions, whereas a single angle is written in the 2D case.
TIMe: The current time.
VARiable (n): The variable number n. Default n=0.
WAVelength: The current free space wavelength.
Argument(s): (n TYPe)
Meaning: Draw the standard graphic window number n. If n is omitted: Draw the current graphic window. Special cases: n=0 – do for all windows, n<0 – do for windows numbers 1 up to number -n.. TYPe specifies the graphic content of the window. If TYPe is FUNction, it is assumed that a function will be drawn in the window. Otherwise, it is assumed that the window will be used for drawing the field, boundaries, or expansions. TYPe influences the labeling of the window axes.
Responsible for this web page: Ch. Hafner, Computational Optics Group, IEF, ETH, 8092 Zurich, Switzerland
Last update
17.03.2016