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
2DArc 2DLine 2DPlanewave 3DArc 3DExpansion 3DLine AXIsymmetric CONnection EXPansion HEXagonal-structure PFD RECtangular-structure SET
Arguments: (iCp ins iDm iCl iCn iOb nE fmin fmax x y)
Meaning: Distribute expansions along an arc by rotating all "prototype expansions" with color iCp around the point (x,y) in the xy plane with angles from fmin to fmax (in degrees). For each prototype expansion, nE new expansions will be created and inserted after expansion number ins. The new expansions obtain the color iCl, domain number iDm, connection flag iCn, object number iOb.
Arguments: (iCp ins iDm iCl iCn iOb nE x0 y0 x y)
Meaning: Distribute expansions along a line by moving all "prototype expansions" with color iCp along the line from point (x0,y0) to point (x,y) in the xy plane. For each prototype expansion, nE new expansions will be created and inserted after expansion number ins. The new expansions obtain the color iCl, domain number iDm, connection flag iCn, object number iOb.
Arguments: (ins iDm iCl iCn iOb nE fmin fmax iHE)
Meaning: Generate nE new plane wave expansions and insert them after expansion number ins. The plane waves propagate in directions with angles from fmin to fmax (in degrees, with respect to the x axis). The new expansions obtain the color iCl, domain number iDm, connection flag iCn, object number iOb. iHE is a flag indicating whether Ez (iHE=0), Hz (iHE=1) or both (iHE=2) types of waves shall be created.
Arguments: (iCp ins iDm iCl iCn iOb nE fmin fmax)
Meaning: Distribute expansions along an arc by rotating all "prototype expansions" with color iCp around the y axis (global coordinates) with angles from fmin to fmax (in degrees). For each prototype expansion, nE new expansions will be created and inserted after expansion number ins. The new expansions obtain the color iCl, domain number iDm, connection flag iCn, object number iOb.
Arguments: n (fact j minexp maxexp maxm col con obj iCol iDelete nMP)
Meaning: Generate 3D multipole expansions for the 3D object number n. This is the same as pressing the Generate !! button in the Generate expansions for 3D objects dialog after
having selected n in the Object box and fact in the Degree fact. Box. The additional parameters specify the following: j: insert new expansions after existing expansion j. Use only expansions with numbers from minexp to maxexp for generating the new expansions. Generate maxm multipoles for each valid 2D multipole. Use the filters col con obj for color, connection number, and object number. Set the color iCol for the new expansions (use the color of the object when this number is missing). Usually, the previously generated 3D expansions are deleted before the new expansions are created. This delete operation may be suppressed, when a zero or negative number is specified for iDelete. nMP specifies the negative of the maximum number of multipoles placed along a line ring or spiral multipole expansion. If nMP=0 is given, OpenMaXwell will evaluate an "appropriate number" from geometry data. For nMP>0, the "appropriate number" is multiplied by nMP. Note that large values of nMP lead to long computation time without significant improvement of the accuracy.
The following default values are inserted for missing arguments fact j minexp maxexp maxm col con obj iCol iDelete nMP: 1.0 -1 0 -1 -32000 0 0 0 0 0 0.
Arguments: (iCp ins iDm iCl iCn iOb nE x0 y0 z0 x y z)
Meaning: Distribute expansions along a line by moving all "prototype expansions" with color iCp along the line from point (x0,y0,z0) to point (x,y,z). For each prototype expansion, nE new expansions will be created and inserted after expansion number ins. The new expansions obtain the color iCl, domain number iDm, connection flag iCn, object number iOb.
Arguments: n (j minexp maxexp iCol iDelete nMP mDeg Resol Over)
Meaning: Generate 3D objects and 3d ring multipole expansions for the boundary number n.
The new 3D object overwrites the object number n if this is existing. Otherwise, a new object is appended to the list of objects. The object is of torus type with Minimum angle 0. The Sector angle is appropriate for the symmetries with respect to the XY and YZ planes defined in the Project dialog. If no symmetries with respect to these planes are present, the Sector angle is 360. If a symmetry with respect to the XY plane is present (either 1 or 2), the Sector angle is reduced to 180. If also a symmetry with respect to the YZ plane is present, it is reduced to 90. Note that symmetry with respect to YZ without symmetry with respect to XY is not supported. In this case, you should rotate the excitation 90 degrees around the Y axis in order to obtain symmetry with respect to XY. The Mat.Pt.aspect ratio of the new object is computed from the maximum degree mDeg of the ring multipoles and Overdetermination value. Usually, Over should be around 1...2. Higher Over values lead to high numbers of 3D matching points in phi direction. The resolution (for 3D graphic representation) of the new object is set to Resol if Resol>0. If Resol<0, it is set to the length of the boundary n divided by -Resol. Resol values in the interval -1...0 make no sense.
The new expansions (ring multipoles) are inserted after expansion j. Only the 2D expansions with numbers from minexp to maxexp are used for generating the new expansions. The new expansions obtain the color iCol. Usually, the previously generated 3D expansions are deleted before the new expansions are created. This delete operation may be suppressed, when a zero or negative number is specified for iDelete. If nMP=0 is given, OpenMaXwell will evaluate an "appropriate number" from geometry data. For nMP>0, the "appropriate number" is multiplied by nMP. Note that large values of nMP lead to long computation time without significant improvement of the accuracy. All expansions obtain the Maximum degree mDeg. The Minimum degree is set to 0 or 1; the Step of degree and the Degree factor are set to 1 or 2, depending on the symmetries of the Project. The Ring radius is set equal to half of the distance of the ringmultipole from the object.
The following default values are inserted for missing arguments j minexp maxexp maxm iCol iDelete nMP Over: -1 1 -1 3 0 1 1 1 1.
Arguments: (ins iCf iDm iCl iCn iOb mO bT F)
Meaning: Insert a new connection in the list of expansions after expansion ins. The connection obtains the flag iCf, domain number iDm, color number iCl, is contained in connection number iCn, belongs to object number iOb, has maximum order mO and basis function type bT. The Fourier factor is set equal to F. Note that standard location and orientation is set for the connection and standard values are set for the remaining properties (symmetry numbers, etc.) of the connection. Use the command SET EXPansion to modify these properties. Note that the connection flag iCf must be higher than iCn.
Arguments: (nB M/d nE Dom Col Con Dmin/D Dmax/D Rfact Splines Finside Foutside Dfl Dfr Dll Dlr Dl Dr Ainside Aoutside WFA WFE)
Meaning: Generate expansions along the boundary nB with the routines described in the Generate expansions along 2D boundary dialog. If nB<0 and –nB< number of boundaries, multipoles along the boundaries 1, 2, … -nB will be set. The parameters nB M/d nE Dom Col Con Dmin/D Dmax/D Rfact Splines Finside Foutside Dfl Dfr Dll Dlr Dl Dr Ainside Aoutside WFA WFE correspond to the values in the boxes as indicated below. Missing or unreadable parameters are replaced by the current values in the Generate expansions along 2D boundary dialog, whereas correctly specified parameters will replace the corresponding parameters in this dialog.
Notes:
The new expansions are inserted in the list of expansions after the "prototype expansion" nE. When you use several prototype expansions for running GENerate EXPansions several times with different prototype expansions, you therefore should always first run the GENerate EXPansions directive with the highest prototype expansion number nE.
You may take advantage of “unreadable” parameters when you want to set only a few parameters. For example, when you would like to set the third parameter equal to 3 and leave all other parameters as specified in the Generate expansions along 2D boundary dialog, you may write the directive “GENerate EXPansions - - 3”. The first and second parameters are then defined by the strings “-“ that do not define an integer as expected, i.e., these strings are “unreadable” and the corresponding parameters remain unchanged.
A new routine - based the finite element mesher GMSH - is used when M/d>999998 is set. This routine only works, when GMSH is available as external code. The corresponding executable file GMSH.EXE should be copied to the directory \OpenMaXwell or \OpenMaXwell\gmsh or \bin or \gmsh. This routine exports the boundary data to a *.geo file that is red by GMSH. GMSH is then called to create a 2D mesh. After this, multipoles are set to the nodes of the mesh close to the boundary. The resulting multipoles are adapted afterwards. It is recommended to further improve the resulting multipole set by using the directive "ADApt EXPansion BALance". Since GMSH requires a bounded domain, this routine does not work when you want to generate multipoles along an open boundary. In this case, you may add fictitious boundaries with the desired domain number on both sides. Multipoles along these fictitous boundaries will be deleted. For steering the mesh generation, you should specify the corresponding characteristic length for each corner of a C-polygon defining a boundary (see "d" box in the Boundary dialog). For checking GMSH, you may use the command WRIte GMSh or press the GMSH... button in the Boundary dialog. This will export the boundary data to GMSH, i.e., write a *.GEO file that can be read by GMSH. The GMSH based multipole setting creates multipoles along the boundaries specified by nB (0 for all boundaries) for the domains specified by Dom. Only boundaries with color number Col (0 for all boundaries!) are considered (and should bound the domain). The color of the resulting expansions is set to Dmin/D, i.e., this argument is "abused". The remaining arguments have no influence.
The following list associates the arguments with the corresponding boxes in the Generate expansions along 2D boundary dialog.
nB: Bound.
M/d: Multipoles/domain, method
nE: Use data of expansion
Dom: Domain number
Col: Color number
Con: Connection flag
Dmin/D: Dmin/D
Dmax/D: Dmax/D
Rfact: Rfact, threshold
Splines: Splines
Finside: Factor of the Inside parameters
Foutside: Factor of the Ouside parameters
Dfl: D first of the Left side parameters
Dfr: D first of the Right side parameters
Dll: D last of the Left side parameters
Dlr: D last of the Right side parameters
Dl: Density of the Left side parameters
Dr: Density of the Right side parameters
Ainside: Angle of the Inside parameters
Aoutside: Angle of the Outside parameters
WFA: Weight function arg.
WFE:Exponent.
Arguments: iCol0 iCol1 nx ny dx dy angle
Meaning: Generate a hexagonal lattice of 2D objects (boundaries and expansions) by copying all 2D boundaries and expansions with color number iCol0 to new positions. The new objects obtain the color number iCol1. The new objects will be on a lattice with nx times ny lines, displacement in x direction is dx, displacement in y direction is dy, the angle between the x and y direction is given in degrees, i.e., the y direction is arbitrary. For a regular hexagonal grid, set angle = 60. For angle = 90 you obtain a rectangular lattice.
Arguments: WHAt (...)
Meaning: Generate a component of the PFD (Predefined Finite Difference) solver.
np dlx drx dly dry dlz drz
np pdlx drx dly dry dlz drz
Arguments: iCol0 iCol1 nx ny dx dy angle
Meaning: Generate a rectangular lattice of 2D objects (boundaries and expansions) by copying all 2D boundaries and expansions with color number iCol0 to new positions. The new objects obtain the color number iCol1. The new objects will be on a lattice with nx times ny lines, displacement in x direction is dx, displacement in y direction (perpendicular to the x direction is dy.
Arguments: PARameter val
Meaning: Set one of the parameters in the Generate expansions along 2D boundary dialog. PARameter is a string with at least 3 characters that defines which of the parameters shall obtain the value val. The list below indicates the box in the Generate expansions along 2D boundary dialog that will be affected for different PARameter strings:
AINside: Angle of the Inside parameters
AOUtside: Angle of the Outside parameters
BOUndary: Bound.
CONnection: Con.
COLor: Col.
DEL: Density of the Left side parameters
DER: Density of the Right side parameters
DFL: D first of the Left side parameters
DFR: D first of the Right side parameters
DLL: D last of the Left side parameters
DLR: D last of the Right side parameters
DMAx: Dmax/D
DMIn: Dmin/D
DOMain: Dom.
EXPansion: Use data of expansion
FINside: Factor of the Inside parameters
FOUtside: Factor of the Ouside parameters
METhod: Multipoles/domain, method
SPLines: Splines
THReshold: Rfact, threshold
WFA: Weight function arg.
WFE:Exponent.
Responsible for this web page: Ch. Hafner, Computational Optics Group, IEF, ETH, 8092 Zurich, Switzerland
Last update
16.04.2016