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

CLEar one of the following objects

ALL    CPU    DOMain    FIEld    FUNction    GRId    PFD    P2D    P3D    WINdow

ALL

Arguments: (n col con dom par f)

Meaning: Clear grid, domain, and field data. i.e., allocate memory and recompute the grid points, the domain numbers, and the fields according to the current settings. The argument n sets the use expansion number in the Field formula dialog.

The arguments col, con, dom, par, and f correspond to the values in the col., con., dom., and par. boxes of the Field formula dialog. The argument f is a character that may either be e (for "use expansions") or f for "use Formulae"). This argument sets the flag in the Ignore formula box of the Field formula dialog. OpenMaXwell ignores missing arguments, i.e., it leaves the corresponding boxes of the Field formula dialog unchanged.

CPU

No argument

Meaning: Clear the timer for the CPU and elapsed time evaluation.

DOMain

No argument

Meaning: Clear domain data. i.e., allocate memory and recompute according to the current settings.

FIEld

Arguments: (n col con dom par f)

Meaning: Clear field data. i.e., allocate memory and recompute according to the current settings. The argument n sets the use expansion number in the Field formula dialog.

The arguments col, con, dom, par, and f correspond to the values in the col., con., dom., and par. boxes of the Field formula dialog. The argument f is a character that may either be e (for "use expansions") or f for "use formula"). This argument sets the flag in the Ignore formula box of the Field formula dialog. OpenMaXwell ignores missing arguments, i.e., it leaves the corresponding boxes of the Field formula dialog unchanged.

FUNction

Arguments: (n m)

Meaning: Clear the function array (see Function dialog) and allocate memory for an array with n columns (arguments) and m rows (values).

GRId

No argument

Meaning: Clear grid data, i.e., allocate memory and recompute according to the current settings.

PFD

No argument

Meaning: Deallocate all PFD arrays. This frees memory. When PFD iterations are started, the arrays are allocated and initialized again before the first iteration.

P2D

No argument

Meaning: Clear all 2D particles and set the number of 2D particles to 0.

P3D

No argument

Meaning: Clear all 3D particles and set the number of 3D particles to 0.

WINdow

Argument(s): (n TYPe)

Meaning: Clear and redraw the graphic window number n. Special cases: n=0 clear all windows, n<0 clear window number 1 up to number -n. If window n doesn’t exist, the current window is cleared. 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