OpenMaXwell Reference Manual

Home  General  Menues  Dialogs  Movie Directives  Formula Interpreter  File Structures

Available directives

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

SET certain values of one of the following objects

BOUndary    CFK(complex-function)    CONnection    CORner     DOMain    EIGenvalue    EXCitation    EXPansion    FIEld    FILe    FREquency    FUNction    GAMma    GRId    INTegral    LEVel    MAXimum    MBPe    MINimum    MMP   OBJect    P2D    P3D    PEI(eigenvalue-problem)    PERiod    PFD     PHI(phase)    PLAne    PFD    REPresentation    RHS    SYMmetry    TIMe    VAA    VARiable    WAVelength    WINdow

 

BOUndary

Argument(s): n WHAt (…)

Meaning: Set the data specified by WHAt (…) for the boundary number n. Special cases: n=0 – do for all boundaries, n<0 – do for boundary numbers 1 up to -n. WHAt (…) can be one of the following:

·         AMPlitude r: Set the amplitude of the boundary formula equal to r.

·         COLor i: Set the color number of the boundary equal to i.

·         CONnection i: Set the connection flag of the boundary equal to i.

·         CORner m x y r: Set the corner number m of the boundary to the location (x,y) and set the radius of this corner equal to r.

·         DOMain j k: Set the left and right domain numbers of the boundary equal to j and  k.

·         PTS m: Set the number of matching points of the boundary equal to m.

·         RADius m r: Set the radius of the corner number m of the boundary equal to r.

·         SPL m: Set the number of spline points of the boundary equal to m.

·         VALues v1 v2: Set the two boundary values of the boundary equal to v1 v2.

·         WEIghts v1 v2: Set the two weights of the boundary equal to v1 v2.

 

CFK

Arguments: Name

Meaning: Set the name of the files used for saving the data of the eigenvalue search equal to Name. Note that the filename should have the structure XXXnnn.CFK, where XXX is a string with at least one character, nnn a number with three digits. During the eigenvalue search, OpenMaXwell will set the extension CFK to FUN or to FLD, depending on the type of file to be written. In order to avoid overwriting, OpenMaXwell will increase the file number nnn automatically when a file with the same name exists.

Special Names:

·         +: increase the number of the current filename by one

·         -: decrease the number of the current filename by one

·         /: use the current filename

·         0: set the number of the current filename equal to 0

·         ?: display a file open dialog where you may select the desired file

·         %: don't save eigenvalue search data anymore on a file

 

CONnection

Argument: iConn

Meaning: Set the MMP connection flag. iConn can be a number or + or -. When iConn is equal to +, the MMP connection flag is increased by 1, when it is equal to -, the connection flag is decreased by 1. Otherwise, iConn becomes the new connection flag.

 

CORner

Argument(s): n m x y r

Meaning: Set the corner number m of the boundary number n to the location (x,y) and set the radius of this corner equal to r. Special cases: n=0 – do for all boundaries, n<0 – do for boundary numbers 1 up to -n.

 

DOMain

Arguments: n WHAt Re (Im)

Meaning: Set the material properties of domain number n equal to the complex number with real part Re and imaginary part Im. When Im is missing, the imaginary part is 0. Note that this directive should not be used when the material properties are defined by a formula. WHAt specifies what property is to be set:

·         EPSilon:   Set the relative permittivity.

·         MUE:   Set the relative permeability.

·         SIGma:   Set the electric conductivity.

·         TAU:   Set the magnetic conductivity.

 

EIGenvalue

Argument(s): WHat (…)

Meaning: Set the data specified by WHat (…) for the eigenvalue search. This directive turns the eigenvalue search flag in the Project dialog on. WHat (…) can be one of the following:

·         1D n: Set the horizontal/vertical fine search number. When you set a negative number, the standard fine search algorithm will be replaced by a downhill simplex algorithm. This is for advanced testing of the search procedure in difficult situations.

·         CLip r1 (i1 r2 i2): Set the clip area of the complex eigenvalue search in the complex plane equal to r1+i*i1 and r2+i*i2. Missing arguments are set to zero.

·         COrners r1 (i1 r2 i2): Set the corners of the complex eigenvalue search in the complex plane equal to r1+i*i1 and r2+i*i2. Missing arguments are set to zero.

·         CX: Set the periodic constant CX  as the eigenvalue to be searched for.

·         DEterminant: Use the determinant of the MMP matrix.

·         DNo: Don't draw eigenvalue search information in the graphics windows.

·         DRaw: Draw eigenvalue search information (arrow) in the graphics windows.

·         DRX (i): Draw more eigenvalue search information (arrow and x marker where the fine search stopped) in the graphics windows. Use color number i for drawing x markers.

·         DRY (i): Draw even more eigenvalue search information (arrow and x marker where an MMP matrix is solved) in the graphics windows. Use color number i for drawing x markers.

·         FIne i (m a f): Set the data for the fine eigenvalue search. i is the eigenvalue number to be searched for, m the number of iterations, a the desired accuracy, and f the flatness parameter. If  arguments are missing parameters are not set, i.e., the old values remain unchanged.

·         FL: Turn "write rough search data on *.FLD file" flag on.

·         FRequency: Set the frequency as the eigenvalue to be searched for.

·         FU: Turn "write rough search data on *.FLD file" flag off.

·         GAmma: Set gamma as the eigenvalue to be searched for.

·         GRid nr (ni): Set the number of grid lines for the eigenvalue search in real and imaginary direction equal to nr and ni. If ni is missing, it is set to zero.

·         NOpet: Turn the PET flag in the Eigenvalue search group of the MMPdialog off, i.e., disable the eigenvalue estimation technique..

·         PEt: Turn the PET flag in the Eigenvalue search group of the MMP dialog on, i.e., enable the eigenvalue estimation technique and initialize it.

·         REad n: Read the rough eigenvalue field information from the current field data (assuming that you previously stored and reloaded this in the field array). n indicates the number of the eigenvalue search function. Currently, up to 9 search functions may be available:

·        scaled residual (residual/amplitude), contained in Re(Ex)

·        1/amplitude, contained in Re(Ey)

·        unscaled residual, contained in Re(Ez)

·        relative error average, contained in Re(Hx)

·        relative error maximum, contained in Im(Hx)

·        absolute error average / field average, contained in Re(Hy)

·        absolute error maximum / field average, contained in Im(Hy)

·        absolute error average / field maximum, contained in Re(Hz)

·        absolute error maximum / field maximum, contained in Im(Hz)

·        Note: The numbers 4-9 are only computed during MMP eigenvalue search when Type/exponent > 3 and Use residual is turned on (see MMP dialog). Otherwise, the numbers 1-3 are present and contain some post processing depending on the exponent defined in the Type/exponent box of the MMP dialog.

·         SM: Enable downhill simplex search instead of the standard eigenvalue fine search.

·         SN: No downhill simplex search - use the standard eigenvalue fine search.

·         TEst level: The advanced complex eigenvalue search provides several tests to exclude local minima that are most likely not corresponding to en eigenvalue. level may be 0 (no tests), 1 (simple test),... 4 (most advanced test).

 

EXCitation

Argument(s): n

Meaning: Set the number for the current excitation to n. This only makes sense for scattering problems with multiple excitations, i.e., multiple right hand sides. If n exceeds the number of defined excitations or right hand sides (see Expansion dialog), the excitation number is set equal to the number of right hand sides. If n is 0, the excitation number is set equal to 1.

If n is negative, the number of right hand sides is set to -n. This allows you setting the number of right hand sides to any positive value. Note that the number of right hand sides should always be smaller than the number of the parameters of the defined expansions.

 

EXPansion

Argument(s): n WHAt (…)

Meaning: Set the data specified by WHAt (…) of the expansion number n. Special cases: n=0 - do for all expansion s, n<0 - do for expansion numbers 1  to -n. You may also input special strings (with a – sign inside) instead of n. Special strings of the following forms may be used: 123 (same as n=123), -123 (same as n=123), 123- (set all expansions from 123 till the last expansion, 123-456 (set all expansions from 123 till 456). Note that no blanks are admitted in these strings.

WHAt (…) can be one of the following:

·         3DAxis x y z (xx xy xz): Set the axis for the distributed multipole expansion in 3D space as follows: Origin at (x,y,z) direction vector (xx,xy,xz). The direction vector is automatically malized by OpenMaXwell. When the direction vector is missing, (1,0,0) is set.

·         3DLocation x y z (xx xy xz yx yy yz): Set the location of the expansion in 3D space as follows: Origin at (x,y,z) X direction vector (xx,xy,xz), Y direction vector (yx, yy, yz). The direction vectors are automatically orthonormalized by OpenMaXwell. The Z direction vector must not be specified. When the direction vectors are missing, (1,0,0) and (0,1,0) are set.

·         ANGle f: Set the orientation angle of the expansion equal to f.

·         COLor i: Set the color number of the expansion equal to i.

·         CONnection i: Set the connection flag of the expansion equal to i.

·         DEGree i: Set the degree of the expansion equal to i.

·         DOMain i: Set the domain number of the expansion equal to i.

·         GAMma x y: Set the complex propagation constant gamma of the expansion equal to x+iy. This only makes sense for certain 2D expansions.

·         ICS i: Set the Cos/Sin flag of the expansion equal to i. (see c, s, and cs bos of the Expansion dialog) Note: set 0 for cs, 1 for s, 2 for c.

·         IEk i: Set the integer expansion property number k equal to i.  Notes: k should be in the range 1…6, no space between the characters IE and k. The meaning of the integer properties depends on the expansion type. It is displayed in the corresponding box of the Expansion dialog. For example, IE1 is the Minimum order for multipole type expansions. Instead of an integer number i you may also put a character string Factor or Multiply, followed by a real number f. Then the current value of IEk will be multiplied by f.

·         IHE i: Set the wave type of the expansion equal to i. Note: set 0 for E waves, 1 for H waves, 2 for hybrid (HE or EH)waves.

·         LOCation x y: Set the location of the expansion in the xy plane equal to (x,y). Note that this affects the values in the xo and yo bos of the Expansion dialog. Note: Use 3DLocation for setting the location in 3D space.

·         OBJect i: Set the object flag of the expansion equal to i.

·         ORDer i: Set the order of the expansion equal to i.

·         PARameter m (r phi): Set the number of parameters of the expansion(s) equal to m if the argument r is missing. Otherwise, set the parameter number m of the expansion(s) equal to r*exp(i*phi*Pi/180). Special cases: m=0 – do for all parameters, m<0 – do for parameter numbers 1  to -m.

·         REk r: Set the real expansion property number k equal to r. Notes: k should be in the range 1…5, no space between the characters RE and k. The meaning of the real properties depends on the expansion type. It is displayed in the corresponding box of the Expansion dialog. For example, RE1 is the Angle (XY-plane) for multipole type expansions. Instead of an real number r you may also put a character string Factor or Multiply, followed by a real number f. Then the current value of REk will be multiplied by f.

·         TYPe i: Set the type of the expansion equal to i. Note: set 0 for connections, 1 for multipoles, 2 for Bessel expansions, 3 for plane waves, 4 for Rayleigh expansions, 5 for harmonic expansions.

 

FIEld

Argument(s): WHAt (…)

Meaning: Set the field data specified by WHAt (…). WHAt (…) can be one of the following:

·         2-D: Set the original field to 2D, i.e., the z dependence is defined by the propagation constant. Note: the field will be cleared.

·         3-D: Set the original field to 3D, i.e., the z dependence is arbitrary. Note: the field will be cleared.

·         COMplex: Set the original field to be complex valued, i.e., time-harmonic. Note: the field will be cleared.

·         DERived Type (Component (Average)): Set the type and components of the derived field. Note: When an argument is missing, the corresponding parameter is left unchanged.

o        Type can be one of the following: E  H  S  D  B  J  A  V  WE  WM  WT  PE  PM  PT For example, E means that the electric field E is derived from the original field. WE WM WT are the electric, magnetic, and total energy densities, PE PM PT the corresponding power densities.

o        Component can be one of the following: X  Y  Z  XY  XZ  XYZ For example, XZ means that X and Z components are defined.

o        Average indicates that the derived field is averaged and if the phase is to be computed. When the first character is A or a or B or b, the time-average label is turned on, otherwise it is turned off. When the first character is P or p or B or b, the phase label is turned on, otherwise it is turned off.

·         FORmula WHAt value: Set the data in the Field Formula dialog equal to the specified value. Note: when you replace value by Last value, the expansion number nExp-value is used, where nExp is the total number of expansions and Last is a character string. Only the first character of this string is checked. It must be L. For example, L 0 is the last expansion, Last 1 the last but one, and so on WHAt can be one of the following:

o              COLor: color number

o              CONnection: connection number

o              DOMain: domain number

o              EXPansion: expansion number

o              INCident: set the expansion number equal to nExp (last expansion for incident field, i.e., excitation)

o              PARameter: parameter number – without specification of value

o              SCAttered: set the expansion number equal to –nExp+1 (scattered field, i.e., use all expansions, except the last one) – without specification of value

o              TOTal: set the expansion number equal 0 (total field, i.e., use all expansions) – without specification of value

 

·         ORIginal Type (Component): Set the original field according to Type and Component. Note: the field will be cleared.

o        Type can be one of the following: E  H  A  V  EH  EA  EV  HA  HV  AV  EHA  EHV  EHAV For example, EV means that the electric field E and the scalar potential V are defined.

o        Component can be one of the following: X  Y  Z  XY  XZ  XYZ For example, XZ means that X and Z components are defined.

 

·         REAl: Set the original field to be real valued, i.e., not time-harmonic. Note: the field will be cleared.

 

FILe

Arguments: EXTension Name

Meaning: Set the name of the file with EXTension to Name. Note that OpenMaXwell uses the following file extensions: AVI, BAS, BMP, BND, CFK,DIR, DOM, EXP, FLD, FLF, FLT, FUN, GRF, GRT, INT, MMP, OBJ, OGL, PAL, PAR, PRO, WIN. Note that special FUN files are written when integrals are evaluated. In order to set the name of such an "INtegral Function" file, set INF as "EXTension" in this directive. The extension of the "INtegral Function" file will nevertheless be FUN, i.e., "SET FILe INF XXX000" will set the name of the "INtegral Function" file equal to XXX000.FUN. This file will be created when you run the directive "GET INTegral .... /" where "/" stands for the current file name. Similarly,  "GET INTegral .... +" will generate the "INtegral Function" file XXX001.FUN (number increased by one).

 

FREquency

Argument(s): Real (Imaginary)

Meaning: Set the current frequency equal to a complex number with the real part Real and the imaginary part Imaginary. If Imaginary is missing, it is set equal to zero. Real can be the string VARiable. In this case, the frequency is set equal to Var(I)+i*Var(I+1), where Var is the array of the movie variables. The array element number I is stored in the Imaginary argument. If the Imaginary argument is missing, I=0 is set. For example, the commands “SET VARiable 1E8” and “SET FREquency VARiable” have the same effect as “SET FREquency 1E8”. Note that the movie variables are stored in an array. The current number of elements in this array is 1000, i.e., I should be in the range 0…999. Note that 996-999 is usually used for MBPE.

 

FUNction

Argument(s): WHAt (…)

Meaning: Set the function data specified by What (…). What (…) can be one of the following:

·         ARGuments n m (n1 n2): Set the current x and y argument numbers to n m and the minimum/maximum values to be shown to n1 n2 respectively.

·         DLW wmin wmax nw epsD omD gamD epsL omL gamL: Define a function array with 3 columns and fill it as follows: The first column contains the wavelength in the range from wmin up to wmax with nw equidistant values. The second column contains the real part and the third column the imaginary part of the complex permittivity epsC, which is evaluated from the Drude-Lorentz model specified by the OpenMaXwell formula DLW(....).

·         DOMain kD fmin fmax nf : Compute the frequency dependence of the complex permittivity and permeability the domain number nD from frequency fmin to fmax in nf points and write the resulting values into the function array. The function arguments 1-5 will contain the frequency, real part of epsilon, imaginary part of epsilon, real part of mue, imaginary part of mue. If nf is negative, abs(nf) points will be computed and fmin fmax are considered as wavelength values.

·         MARkers i j k l: Set the marker parameters to i j k l. i is a binary string, indicating, which markers are to be turned on. Example: 100 turns the first (square) marker on and the other two markers off. See Function files for more details.

·         POLar i j k l offset scale: Set the properties for polar plots (MAX08A.exe). The values i j k l correspond to the check boxes polar plot, dB, 2, + offset, clip negative values in the Function dialog. A positive integer value turns the corresponding box on. offset and scale specify the values in the Offset and Yscale boxes of the Function dialog..

·         SCAle x : Set the scaling factor Yscale (see Function dialog) to x. If x=0, set Yscale=1/Ymax. Note that Ymax is the maximum value of the current argument number two. (Use SET FUNction ARGuments n m to set the argument number two to m.)

·         SENsor n i WHAt : Write data (frequency dependence) of the PFD sensor n on the function array argument (column) number i. WHAt  may be one of the following: DER (derived field value) EXA EXI EXP EXR EYA EYI EYP EYR EZA EZI EZP EZR FRE (frequency) HXA HXI HXP HXR HYA HYI HYP HYR HZA HZI HZP HZR OME (omega, angular frequency) SXA SXI SXP SXR SYA SYI SYP SYR SZA SZI SZP SZR WAV (wavelength). The strings not specified in brackets denote field values: First character E, H, or S for E, H, or S field, second character X, Y, or Z for the Carthesian field component, third character A (average) I (imaginary part) P (phase in degrees) R (real part).

·         STYle i j k l: Set the style parameters to i j k l.  i is a binary string, indicating, which function styles are to be turned on. Example: 100 turns the first (polygonal line) line style on and the other two off. See Function files for more details.

·         TIMe tmin tmax nt: Set the function argument number 1 to time and fill in nt values from tmin up to tmax. Evaluate the PFD time dependence (defined in the PFD dialog) in these time points and save the values in the function argument number 2. After this you can draw the PFD time dependence using the directive DRAw FUNction 1 2 ic, where ic is a color number.

·         TITle n Name: Compute the time dependence of the PFD source from time tmin to tmax in nt points and write the resulting values into the function array.

GAMma

Argument: Real (Imaginary)

Meaning: Set the current normalized propagation constant gamma or the  half length of the period in z direction equal to a complex number with the real part Real and the imaginary part Imaginary. If Imaginary is missing, it is set equal to zero. Real can be the string VARiable. In this case, the normalized propagation constant is set equal to Var(I)+i*Var(I+1), where Var is the array of the movie variables. The array element number I is stored in the argument Imaginary. If is Imaginary missing, I=0 is set. For example, the commands “SET VARiable 1E8” and “SET GAMma VARiable” have the same effect as “SET GAMma 1E8”. The movie variables are stored in an array. The current number of elements in this array is 1000, i.e., Number should be in the range 0…999. Note that 996-999 is usually used for MBPE. If the eigenvalue search is turned on and if the frequency is searched, the half length of the period in z direction is set, otherwise gamma is set.

 

GRId

Argument(s): WHAt (…)

Meaning: Set the grid data specified by What (…). Note that the grid and field will be cleared. What (…) can be one of the following:

·         IRRegular: Set the grid type to irregular.

·         LINes nx ny (nz): Set the number of grid lines in x, y, z directions to nx ny nz. When nz is missing, it is set equal to 1.

·         REGular: Set the grid type to regular.

·         SPAce Normalize: Make the tangential vectors X Y Z of the regular grid space orthonormal.

·         SPAce Vector x y (z): Set the Cartesian components of the Vector of the grid space for regular grids to x y z. When z is missing, it is set equal to 0. Note that the grid space is defined by the four vectors Origin, X, Y, Z. Therefore, Vector can be one of these. For example “set grid space origin 1 2 3” sets the origin of the grid space to the point (1,2,3).

 

INTegral

Argument(s): WHAt (…)

Meaning: Set the integral data specified by What (…). What (…) can be one of the following:

·         BOUndary (n i j k l a m): Integral over the boundary n. If n is missing: use current boundary. Special cases: n=0 – do for all boundaries, n<0 – do for boundary number nBnd-n, where nBnd is the number of defined boundaries. Use integrand component i, interpolation type j, integrand field k, maximum number of function calls l, desired accuracy a. (For details see Integral files). You may also specify the integral type m as the last argument. The integral type my be 0 for simple sum, 1 for GL, 2 for GK, and 3 for HP integration (see Integral dialog ).

·         OBJect j: Integral over the surface of the 3D object number j.

·         ORIgin x y z: Set the origin for 3D spherical or rectangular integrations to (x,y,z).

·         POWer p: Integrate over f**p instead of integrating over f. When p=0: Integrate over log(f). Set p=1 to return to usual integration without this post processing.

·         RADius r: Set the radius for 3D spherical or rectangular integrations to r.

·         RECtangle (j nx ny xmin xmax, ymin ymax): Integral over a rectangular area, interpolation type j, nx, ny grid lines in x and y direction, limits of the rectangle: xmin xmax, ymin ymax.

·         SCAling s: Scale the field f with factor s before evaluating the integral (affects also the vector components fx,fy,fz, which may be stored in a file). Set s=1 to return to usual integration without scaling.

·         SIDe s: Integrate only the field to the left/right hand side of the boundary if s is +1 (left side) or -1 (right side), when integrating along a boundary with two positive domain numbers. Similarly, only the field on one side of a 3D object is integrated if s is +1 (left side of boundary used to create the object) or -1 (right side). Set s=0 to return to usual integration over the average of the left and right field values.

·         WHAt STR: Set additional parameters for the integration, according to STR: ABS (integrate over absolute values), NAB (turn ABS off), AVE (integrate over average values), NAV (turn AVE off), CUR (integrate field that is currently specified in the Field dialog), EEE (integrate E field), HHH (integrate H field), SSS (integrate S field), FFF (integrate optical forces).

·         XXX x y z: Set the X vector of the space defining 3D rectangular area integration to (x,y,z).

·         YYY x y z: Set the Y vector of the space defining 3D rectangular area integration to (x,y,z).

·         ZZZ x y z: Set the Z vector of the space defining 3D rectangular area integration to (x,y,z).

 

LEVel

Argument: (n)

Meaning: Set the number of the level of the current plane of the grid to n. If n is missing, it is set equal to 1. Note that the current plane is the plane of the grid used for computing the derived field. When the level number is bigger than the number of levels, it is set equal to the number of levels. When it is less than one, is set equal to one.

 

MAXimum

Argument(s): Value (Number)

Meaning: Set the maximum value of the derived field to Value. Note that this value affects the graphic representation of the field. Special cases:

·         Value can be the string VARiable. In this case, the maximum value is set equal to Var(I), where Var is the array of the movie variables. The array element number I is stored in the argument Number. If Number is missing, I=0 is set. For example, the commands “SET VARiable 1E8” and “SET MAXimum VARiable” have the same effect as “SET MAXimum 1E8”. The movie variables are stored in an array. The current number of elements in this array is 1000, i.e., Number should be in the range 0…999. Note that 996-999 is usually used for MBPE.

·         Value can be the string MAXimum. In this case, the maximum value is set = max(abs(minimum value),abs(maximum value)). Furthermore, the minimum value is then set = -maximum value.

·         Value can be the string MINimum. In this case, the maximum value is set equal to minus the minimum value. This should only be done when it is known that the minimum value is negative.

 

MBPe

Argument(s): WHAt (...)

Meaning: Set various parameters for the MBPE approximation of a complex function f(x), where x is usually either the frequency or the wavelength. WHAt may be one of the following:

·         CALculations n: Maximum number of evaluations of the function f(x) during the MBPE computation. Stopping criterion 1.

·         ERRor e: Stop MBP refinement as soon as the estimated relative error is below ERRor %. Stopping criterion 2.

·         LIMits fmin fmax: If you know that the absolute values of f(x) must be within certain limits, specify them here. For example, when you compute a transmission coefficient, you probably have 0<=f(x)<=1. Then, you should specify fmin=0 and fmax=1.

·         ORDer m: Maximum MBPE order

·         OUTput n: Display intermediate MBPE results when n>0.

·         OVErdetermination f: Overdetermination factor (>=1, close to 1 is sufficient when the evaluations of f(x) are accurate).

·         RANge xmin xmax n xminout xmaxout m nFun: Run MBPE analysis in the interval xmin<=x<=xmax. Start with n points and add points until a stopping criterion is met. Evaluate the the MBPE approximation for the interval xminout...xmaxout in m equidistant points. When nFun >1 is specified: MPBE simultaneously evaluates nFun (complex) functions. Currently, nFun is limited to 49. For each of these functions, two movie variables must be specified that contain the real and imaginary part of the functions respectively. This can be done using the directives “%SET VARiable …”. The first two variables should have subsequent numbers that are specified with the directive “SET MBPe VARiables 1 2 3”, where 1 is the x variable along the interval xmi… xmax, 2 and 3 are the real and imaginary parts of the first function. The movie variables of the subsequent functions will then be continuously numbered: 4 and 5 for real and imaginary parts of the second function and so on.

·         VARiable (in io1 io2 ierr): When you use movie directives with % as first character, x, Real(f), and Imag(f) are specified by three different movie variables. Note that the variables with numbers 0 up to 999 may be used. in, io1, io2 are the numbers of the movie variables that specify x, Real(f), Imag(f) respectively. ierr contains an error flag. Default values of in io1 io2 ierr are 996 997 998 999.

 

MINimum

Argument(s): Value (Number)

Meaning: Set the minimum value of the derived field to Value. Note that this value affects the graphic representation of the field.

 Special cases:

·         Value can be the string VARiable. In this case, the minimum value is set equal to Var(I), where Var is the array of the movie variables. The array element number I is stored in the argument Number. If Number is missing, I=0 is set. For example, the commands “SET VARiable 1E8” and “SET MINimum VARiable” have the same effect as “SET MINimum 1E8”. The movie variables are stored in an array. The current number of elements in this array is 1000, i.e., Number should be in the range 0…999. Note that 996-999 is usually used for MBPE.

·         Value can be the string DIV. In this case, the minimum value is set = maximum value / Number.

·         Value can be the string MAXimum. In this case, the minimum value is set = -maximum value. This should only be done when it is known that the maximum value is positive.

·          

MMP

Argument(s): WHAt (…)

Meaning: Set the data specified in the MMP dialog. WHAt (…) can be one of the following:

·         AMPlitude Type (iB): Set the type of the amplitude definition for eigenvalue computations equal to Type, where Type may be 1 (last parameter defines the amplitude),  Boundary (use boundary integral, boundary number iB),  Object (use object integral, object number iB), Point (Use field in the origin of the coordinate system specified for the rectangular area. iB specifies the field type. Currently, the values -9...+9 may be selected. This feature is under construction), Rectangle (use integral over rectangular area).

·         CONnection   n: Set the connection number equal to n.

·         ERRor  s: Set the error scaling factor equal to s.

·         LASt  n: Set the Last column number equal to n.

·         MATching  dmax m p over (dShort lSmooth): Set the data for the matching point definition as follows: 1) Maximum distance between matching points dmax, 2) number of points per segment m, 3) minimum number of points per wavelength p, 4) overdetermination factor over, 5) Short distance factor: Delete matching points with distance smaller than dShort times the boundary length (default is 1.0E-5), 6) smoothen distances between neighbor matching points when lSmooth > 0 (default).

·         SEArch STR: Set the eigenvalue and PET search flags depending on the characters in STR. If STR contains the character F, the fine search is turned on. If it contains R, the rough search is turned on and if it contains P, the PET flag is set. For example, STR=R will turn fine search and PET off, rough search on. A blank string turns all flags off.

·         SOLver  TYpe (itCG nPET resCG isc iaccCG fPET thres): Set the matrix solver type depending on TYpPe, which may be CH (cheap solver under test), GUT (Givens Updating with Triangular Matrix), GUR (Givens Updating with Rectangular Matrix), CG (Conjugate Gradients), PEt (Parameter Estimation Technique with GUR and CG), QR (most efficient solver based on QR decomposition). The meaning of the optional arguments is:

o        ItCG: Maximum number of CG iterations.

o        nPET: PET order.

o        resCG: CG stopping criterion: maximum residual.

o        isc: Scaling type of the rectangular MMP matrix.

o        iaccCG: CG stopping criterion: Accuracy of the residual in digits.

o        fPET: Residual factor for stopping the PET-CG.

o        thres: threshold for small matrix elements.

OBJect

Arguments: (n) WHAt …

Meaning: Set the data of 3D objects. Note that there are global data that hold for all 3D objects and individual data that may be different for each object.

When n is missing, global data will be set. In this case, WHAt may be one of the following:

·         CHEaphiding: Use the cheap hiding procedure

·         DERivedfield: Draw the derived field on the grid defined in the Field dialog

·         DOMain: Use domain colors for the surfaces of the 3D objects

·         DRAwingheights hmin hmax: Draw within the specified distances hmin and hmax from the view plane.

·         ERRor: Compute and draw the error distribution on the surfaces of the objects

·         FIEld: Compute and draw the derived field distribution on the surfaces of the objects

·         GRIdpoints: Draw the grid points (instead of matching points ) on the surfaces of the 3D objects

·         HIDing: Use the expensive hiding procedure

·         MATchingpoints: Draw the matching points on the surfaces of the 3D objects

·         NOField: Don’t draw the derived field on the grid defined in the Field dialog

·         NUM n: Draw the 3D object number n. Special cases: n=0: all objects, n<0: object number 1, 2,…-n.

·         OBJectcolor: Use object colors for the surfaces of the 3D objects

·         TRAnsparent: Draw transparent, i.e., draw grid lines only

When n is present, individual data of the object number n will be set. In this case, WHAt may be one of the following:

·         AXIs x y z (xx xy xz): Set the axis for generating the 3D object. Origin: (x, y, z), direction vector: (xx, xy, xz). Note that OpenMaXwell will automatically normalize the direction vector. When the direction vector is missing, (1,0,0) is set.

·         COLors g f b: Set the 3D object colors as follows: grid color g, surface front color f, surface back color b

·         INTeger i1 i2 i3 i4 i5: Set the five integer parameters of the 3D object equal to i1 i2 i3 i4 i5. Note that these parameters are specified in the 3D objects dialog. Their meaning depends on the type of the 3D object.

·         LOCation x y z (xx xy xz yx yy yz): Set the location of the 3D object as follows: Origin: (x, y, z), X direction vector: (xx, xy, xz), Y direction vector: (yx, yy, yz). Note that OpenMaXwell will automatically compute the Z direction vector and orthonormalize the direction vectors. When the direction vectors are missing, (1,0,0) and (0,1,0) is set.

·         REAl r1 r2 r3 r4 r5: Set the five real parameters of the 3D object equal to r1 r2 r3 r4 r5. Note that these parameters are specified in the 3D objects dialog. Their meaning depends on the type of the 3D object.

·         RESolution dg: Set the resolution (distance between grid lines on the surface) of the 3D object to dg.

·         SECtor r1 r2( r3): Set the two first real parameters of the 3D object equal to r1/r3-0.5*r2 and r2. Note that this is convenient for torus shape objects, where the first parameter is the start angle and the second parameter is the sector angle. By SECtor r1 r2 r3: you define a sector with center angle r1/r3 or r1 (if r3 is omitted) and sector angle r2.

 P2D

Arguments: WHAt (...)

Meaning: Set parameters that describe the movement of 2D particles. WHAt may be one of the following:

·         MIRror x y xt yt: Set a mirror line in the point (x,y) with tangential direction (xt,yt).

·         SPEed n v: Set the speed of particle n to v. Note that the direction of the movement is not changed.

·         STEp s: Set the particle step length to s.

·         TIMe dt: Set the time step dt for the evaluation of particle movements. Negative dt values are used for sophisticated step evaluations.

·         VELocity n vx vy: Set the velocity vector of particle n to (vx,vy).

 

P3D

Arguments: WHAt (...)

Meaning:

Set parameters that describe the movement of 2D particles. WHAt may be one of the following:

·         MIRror x y z xt yt zt: Set a mirror line in the point (x,y,z) with tangential direction (xt,yt,zt).

·         SPEed n v: Set the speed of particle n to v. Note that the direction of the movement is not changed.

·         STEp s: Set the particle step length to s.

·         TIMe dt: Set the time step dt for the evaluation of particle movements. Negative dt values are used for sophisticated step evaluations.

·         VELocity n vx vy vz: Set the velocity vector of particle n to (vx,vy,vz).

 

PEIeigenvalue

Arguments: T

Meaning: Turn the eigenvalue flag of the current project on (T='t') or off (T different from 't').

 

PERiod

Arguments: What …

Meaning: Set data of periodic problems. What specifies what is to be set. What can be one of the following:

·         Constant: Arguments: Rex (Imx Rey Imyx Rez Imz): Set the complex constants in the x, y, and z directions equal to Rex+i*Imx, Rey+i*Imy, and Rez+i*Imz. Missing arguments are set equal to zero.

·         Distance: Arguments: dx (dy): Set the periodic direction vectors (Xx,0,0), (Yx,Yy,0) and (Zx,Zy,Zz) equal to the vectors (dx,0,0), (dyx,dyy,0) and (dzx,dzy,dzz) respectively. Note that the periodic direction vectors are defined in the Project dialog.

·         Phase: Arguments: dx (dy dz): Set the complex constants Cx, Cy, and Cz in x, y, and z directions equal to (Pi/180)*dx/xPeriod, (Pi/180)*dy/yPeriod, and (Pi/180)*dz/zPeriod. Missing arguments are set equal to zero. Since the complex factor between neighbor cells in x, y, and directions are exp(i*Cx*xPeriod), exp(i*Cy*yPeriod), and exp(i*Cz*zPeriod), dx, dy, and dz set the phase of these factors in degrees. Missing arguments are set equal to zero.

 

PFD

Arguments: WHAt ...

Meaning: Set one of the PFD (Predefined Finite Difference solver) parameters. WHAt may be one of the following:

·         EFFective: Arguments n i: Set the characteristic integer numbers for the effective material parameter computation to n and i.

·         FREquency: Arguments n fmin fmax: Set the Fourier frequency range for the PFD sensors to n values from fmin to fmax.

·         GRId: Arguments C n min max: Set the PFD grid in x, y, or z direction to n values from min to max. The direction is specified by the character C that may be x, y, or z.

·         PML: Arguments C n min max: Set the PFD PML layer number to n on the lower side and m values on the higer side. The direction is specified by the character C that may be x, y, or z. Special case: When C is d, the PML decay value is set equal to n.

·         SCAttered: Argument n: Set the number of scattered field layers equal to n.

·         SENsor: Arguments n x y z t d: Set the values of the PFD sensor n.

·         SOUrce: Arguments TYPe (i j k): Set the PFD source arguments according to the string TYPe that may be one of the following:

1.     AMPlitude (additional arguments n formula: Set the complex amplitude of the source point n according to the formula string - For the meaning of the formula string see movie command ADD PFD SOUrce!)

2.     EOFf (E field off),

3.     EON (E field on),

4.     HARd (hard source),

5.     HOFf (H field off),

6.     HON (H field on),

7.     MMP (MMP excitation as source),

8.     PLAne (plane wave source)

9.     POInt (point source, additional arguments n i j k: set point source number n on the grid point i j k.)

10. SCAttered (scattered field formulation),

11. SOFt (soft source),

12. TOTal (total field formualtion),

13. XOFf (x component of the field off),

14. XON (x component of the field on),

15. YOFf (y component of the field off),

16. YON (y component of the field on),

17. ZOFf (z component of the field off),

18. ZON (z component of the field on).

·         STOp: Arguments (d f): Stop PFD iterations before the requested number of iterations is reached, when the energy in the first sensor point is decaying and below f times the maximum energy value that was recoded in the first sensor point - provided that a plane wave in free space would have propagated d times the diagonal of the PFD space during the elapsed time. The distance factor d should be bigger than 1. Usually, f should be a small, positive value, e.g., 1.0e-8. When f is smaller than 1.0e-14, the stopping criterion might never be reached. When f is missing, it is set to 1e-8.When d is also missing, it is set to 4. Note: Both d and f may only be set by this directive. When the directive is not present, the initial values of  d and f are 3 and 0. In this case the PFD iterations are never stopped.

·         TIMe: Arguments TYPe (Tmax Tau): Set the time dependence of the PFD source according to the string TYPe than may be one of the following: COS (cos-square shape), EXP (exponential-square), GAUss (Gaussian, same as exponential-square), PULse (pulse), RAMp (ramp). For all cases you also may specify the parameters Tmax and Tau.

 

PHI

Argument(s): Value (Number)

Meaning: Set the phase (of time-harmonic fields) equal to Value. Value can be the string VARiable. In this case, the phase is set equal to Var(I), where Var is the array of the movie variables. The array element number I is stored in the argument Number. If Number is missing, I=0 is set. For example, the commands “SET VARiable 45” and “SET PHI VARiable” have the same effect as “SET PHI 45”. The movie variables are stored in an array. The current number of elements in this array is 1000, i.e., Number should be in the range 0…999. Note that 996-999 is usually used for MBPE.

 

PLAne

Argument: n

Meaning: Set the number of the current plane of the grid to n. Note that the current plane is the plane of the grid used for computing the derived field. There are three planes. 1: xy, 2: xz, 3: yz.

 

REPresentation

Argument(s): WHAt (…)

Meaning: Set the graphic representation data of the derived field. What (…). specifies what parts of the representations are set. What (…) can be one of the following:

·         ARRow TYPe x: Set the arrow representation TYPe to x. TYPe x can be one of the following:

·        FILl:  Fill arrows with color.

·        FILl False: Do not fill arrows with color.

·        LENgth x: Set maximum arrow length to x.

·        MAX x: Set the maximum color number to x.

·        MIN x: Set the minimum color number to x.

·        SCAling x: Set the arrow scaling to x.

·        STEp x: Set the arrow grid step to x.

·        TYPe x: Set the arrow type to x.

·         INTensity TYPe x: Set the iso line and intensity representation TYPe to x. TYPe x can be one of the following:

·        3-D  x:  Set the 3D representation scale to x.

·        FILl:  Fill with color.

·        FILl False: Do not fill with color.

·        GRId:  Show grid lines.

·        GRId False: Do not show grid lines.

·        ISO:  Show iso lines.

·        ISO False: Do not show iso lines.

·        MAX x: Set the maximum color number to x.

·        MIN x: Set the minimum color number to x.

·        SCAling x: Set the intensity scaling to x.

·        STEp x: Set the iso line step to x.

·        STEp DIV x: Set the iso line step to (max-min)/x, where max and min denote the current maximum and minimum values of the derived field.

·        TYPe x: Set the intensity representation type to x.

·         ISO TYPe x: Same as INTensity TYPe x.

·         PLAne TYpe (Level): Set the view plane to XY, XZ, or YZ. TYpe can be one of these. Level denotes the number of the level.

·         POWer p: Post processing of the derived field f:  f**p instead of f. When p=0: log(f) instead of f. Note that post processing remains active until you set p=1.0.

·         SCAle s: Scale (multiply) the derived field with factor s . This is done before the post processing step with the power factor p. Note that scaling remains active until you set s=1.0.

·         SCI s: Inverse scaling: Divide the derived field by s . This is done before the post processing step with the power factor p. Note that scaling remains active until you set s=1.0.

·         VIEw Distance d: Set the distance of the eye from the view plane equal to d. For example “set view distance 10” sets the eye point in a distance 10 from the view plane. Note that OpenMaXwell always uses perspective projection. When you select a large distance, this is almost the same as parallel projection.

·         VIEw Normalize: Make the tangential vectors of the view space orthonormal.

·         VIEw Vector x y z: Set the Cartesian components of the Vector of the view to x y z. Note that the view space is defined by the four vectors Origin, X, Y, Z. Therefore, Vector can be one of these. For example “set view space origin 1 2 3” sets the origin of the view space to the point (1,2,3).

 

RHS

Argument(s): n

Meaning: Set the number of right hand sides for the MMP problem to n. This only makes sense for scattering problems with multiple excitations. If the number of the excitation exceeds the number of defined parameters-1 (see Expansion dialog), the current expansion is set equal to the number of parameters - 1. If n is less then 1, it is set equal to 1.

 

SYMmetry

Arguments: ixy ixz iyz

Meaning: Set the symmetry numbers with respect to the XY, XZ, and YZ planes equal to ixy ixz iyz respectively. Note that the symmetry numbers must be in the range 0…2. Numbers smaller than 0 are set equal to 0 and numbers bigger than 2 are set equal to 2.

 

TIMe

Argument(s): Value (Number)

Meaning: Set the current time equal to Value. Value can be the string VARiable. In this case, the current time is set equal to Var(I), where Var is the array of the movie variables. The array element number I is stored in the argument Number. If Number is missing, I=0 is set. For example, the commands “SET VARiable 1.5” and “SET TIMe VARiable” have the same effect as “SET TIMe 1.5”. The movie variables are stored in an array. The current number of elements in this array is 1000, i.e., Number should be in the range 0…999. Note that 996-999 is usually used for MBPE.

OpenMaXwell allows you also to set the time step of the FDTD (PFD) algorithms. In this case, the arguments must be the string STEp (instead of Value) and a real Number that specifies the time step in second. When Number is negative, the time step is evaluated from the stability criterion for free space: dt < dt0 = 1/(c*sqrt(1/sqr(dx)+1/sqr(dy)+1/sqr(dz))), where dx, dy, dz are the grid steps in x, y, z direction respectively. for 2D, the dz term is missing. In the evaluation, c (speed of light) is approximated by 3E8 m/s and dt=dt0/abs(Number) is set. Thus, you should obtain stability for abs(Number) > 1, i.e., Number < -1. This only holds for free space propagation. It is often wise to set abs(Number) slightly above 1, for example, Number = -2.

 

VAA

Argument(s): imin imax v1 (v2 v3 ...)

Meaning: Set the movie variables with numbers imin up to imax equal to the values v1, v2 etc.

 

VARiable

Argument(s): Value (Number) OR: Number Value OR: VN Value OR: VN FOR formula-string

Meaning: Set the current movie variable with the index Number equal to Value. When Number is missing, it is set equal to 0. Note that the variable can have any meaning. It is defined and manipulated by the user only. Its main purpose is for display on a graphics window. The movie variables are stored in an array. The current number of elements in this array is 1000, i.e., Number should be in the range 0…999. Note that 996-999 is usually used for MBPE. The alternative syntax that specifies the variable number first, is more flexible (see below). In order to make sure that this syntax is used, you may specify the string VN, where N is the Number of the variable. For example "SET V12 3.45" will set the variable number 12 equal to 3.45.

If you use the alternative VN syntax for the variable, you may also replace Value by a string, starting with the three characters FOR and add a formula string that defines how to evaluate the value of VN. In this Formula string, you may use all previously defined values as variables in the formula to be interpreted by the OpenMaXwell formula interpreter. For example, when V0,V1,V2 are defined, you may write "SET VARiable V3 FORmula div(add(v0,v1),v2)". Then V3 will be set equal to (V0+V1)/V2.

When the alternative syntax is used, both Number and Value must be present. In case of the syntax "SET Number Variable" Value may not be an integer number - otherwise the old syntax is assumed. For the new syntax, Value may also be a more sophisticated character string WHAt ... to access OpenMaXwell data as follows:

What (…) can be one of the following:

·         ANGle n: Write the orientation angle of the expansion n to the movie variable.

·         BOUndary n: Write the number of 2D boundaries + n to the movie variable.

·         CND: Write the current condition number of the rectangular MMP matrix to the movie variable.

·         CONstant c1 (c2 …): Write the constants c1, c2,… to the movie variable. The maximum number of constants is 40.

·         CPU (n): Write the CPU time (since the previous call of the CPU time) to the movie variable. If n is present and <1: write the elapsed time instead of the CPU time to the movie variable.

·         CXI: Write the imaginary part of CX (see periodic cell data of the Project dialog) to the movie variable.

·         CXR: Write the real part of CX (see periodic cell data of the Project dialog) to the movie variable.

·         CYI: Write the imaginary part of CY (see periodic cell data of the Project dialog) to the movie variable.

·         CYR: Write the real part of CY (see periodic cell data of the Project dialog) to the movie variable.

·         CZI: Write the imaginary part of CZ (see periodic cell data of the Project dialog) to the movie variable.

·         CZR: Write the real part of CZ (see periodic cell data of the Project dialog) to the movie variable.

·         DOMain n WHat: Write material properties of the domain number n to the movie variable. 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): Write the efficiency of the Rayleigh expansion number n on the movie variable. 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. This is essentially the same as when you use the directive WRIte movie variable PARameter n m SQUare. When m is missing, the sum of all efficiencies of all non-evanescent parts (orders) of expansion n is written on the movie variable. 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): Write the current error on the movie variable. 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: Write the square root of the quadratic error of the field to the movie variable.

·         EXPansion n: Write the number of 2D expansions + n to the movie variable.

·         FIEld TYPE (x y z Dom n m): Write the specified field component in the point with the Cartesian (or cylindrical) coordinates x y z to the movie variable. 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

·        C: Both, the real and imaginary parts of the scalar s. Warning: In this case, the movie command writes two values on the movie variable! Keep this in mind when you define the header data, namely the number of arguments!

·        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: Write the current frequency to the movie variable. PARt specifies the part of the complex frequency that is used. It can be ABS, IMAginary, or REAl.

·         GAMma PARt: Write the propagation constant gamma to the movie variable. PARt specifies the part of the complex propagation constant that is saved. It can be ABS, IMAginary, or REAl.

·         IMA: Write the maximum integrand value that was detected during the integral evaluation to the movie variable.

·         IMI: Write the minimum integrand value that was detected during the integral evaluation to the movie variable.

·         INTegral: Write the value of the integral to the movie variable.

·         IXA: Write the x coordinate of the point where the maximum integrand value that was detected during the integral evaluation to the movie variable.

·         IXI: Write the x coordinate of the point where the minimum integrand value that was detected during the integral evaluation to the movie variable.

·         IYA: Write the y coordinate of the point where the maximum integrand value that was detected during the integral evaluation to the movie variable.

·         IYI: Write the y coordinate of the point where the minimum integrand value that was detected during the integral evaluation to the movie variable.

·         IZA: Write the z coordinate of the point where the maximum integrand value that was detected during the integral evaluation to the movie variable.

·         IZI: Write the z coordinate of the point where the minimum integrand value that was detected during the integral evaluation to the movie variable.

·         KW0: Write the free-space wave number to the movie variable.

·         LA0: Write the free-space wave length to the movie variable.

·         LAM: Write the wave length of the current waveguide mode to the movie variable.

·         LEN: Write the propagation length of the current waveguide mode to the movie variable.

·         MAXimum: Write the maximum value of the derived field to the movie variable.

·         MINimum: Write the minimum value of the derived field to the movie variable.

·         MMP WHAt: Write the MMP data to the movie variable. 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: Write the angular frequency omega to the movie variable. Note that omega is complex in general, i.e., the real and imaginary parts may be written to the movie variable. WHAt may be one of the following: ABS (write the absolute value of omega), IMA (write the imaginary part of omega), REA (write the real part of omega).

·         P2D n WHat: Write information on the 2D particle number n to the movie variable. 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: Write information on the 3D particle number n to the movie variable. 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): Write the specified PARt of the complex parameter number m of the expansion number n on the movie variable. 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. When PARt  is missing or  COMplex, both, the real and imaginary parts are saved.

·         PFD n WHat: Write PFD sensor information to the movie variable. n denotes the sensor number and WHat may be one of the following: EA, EX, EY, EZ, HA, HX, HY, HZ, where the first character stands for E or H field and the second one indicates the Cartesian component. When the second character is A, all three components are written.

·         PHI: Write the phase (of time-harmonic fields) to the movie variable.

·         REPresentation: Write the function representation data to the movie variable.

·         RAYleigh n m: Write the angle (in degrees) of the Rayleigh term with expansion number n and parameter number m on the movie variable. Note that two angles are written for 3D Rayleigh expansions, whereas a single angle is written in the 2D case.

·         TIMe: Write the current time to the movie variable.

·         VARiable (n): Write the variable number n to the movie variable. Default n=0.

·         WAVelength: Write the current free space wavelength to the movie variable.

 

WAVelength

Argument: Value

Meaning: Set the frequency in such a way that the free-space wavelength becomes equal to Value.

 

WINdow

Argument(s): n (WHAt (…))

Meaning: Set the graphic window data of the derived field. What (…). specifies what parts of the window are set. The window number n gets the focus and is modified. All other windows remain unchanged.  What (…) can be one of the following:

·         LIMits xmin xmax ymin ymax: Set the limits xmin, xmax, ymin, ymax of the graphics window.

·         LIMits AUTomatic: Compute and set the limits xmin, xmax, ymin, ymax of the graphics window automatically from the current function values. Note that this is only useful for drawing functions.

·         LIMits FUNction m WHAt: Set the limits according to the values of the function array in column m. WHAt may be one of the following: XMA (set the maximum value of the x direction equal to the maximum function value of column m), XMI (set the maximum value of the x direction equal to the maximum function value of column m), XMM (same as XMA plus XMI: set maximum and minimum values), YMA, YMI, YMM (same as XMA, XMI, XMM for the y direction).

 

Responsible for this web page:  Ch. Hafner, Computational Optics Group, IEF, ETH, 8092 Zurich, Switzerland

Last update 09.11.2016