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

REAd data from one of the following files

3DD    3DM    BASis(PET)    BITmap    BMP(file)    BOUndary    DIRectives    DOMain    EXPansion    FIEld    FLF(field-formula)    FLT(field-transform)    FUNction    GRF(grid-formula)    GRT(grid-transform)    INTegral    MMP    OBJect    OGL(openGL)    PALette    PARameter    PFD    PROject    VARiable WINdow

 

3DD

Argument(s): Name (n m i k)

Meaning: Read 3D dipole expansions from the file Name and set their object numbers to m. The parameter i specifies the type of the dipole (0 for electric dipoles with 3 parameters, 1 for magnetic dipoles with 3 parameters, 2 for both electric and magnetic dipoles with 6 parameters). The parameter k specifies the color number for all 3D dipoles. Note: the current expansions are overwritten when n is missing. Otherwise, the expansions contained in the file will be appended after the expansion number n. Default values: n=-1, m=0, i=0, k=1.

The files you read in here are ASCII text files to be created by some external software. They have the following structure (no header!):

Special values of Names:

3DM

Argument(s): Name (n k)

Meaning: Read 3D matching points from the file Name and store them as rectangular 3D objects. In addition to this, a dummy 2D boundary is created because each 3D object must be based on a 2D boundary. The parameter k specifies the grid color number for all 3D rectangles and of the dummy 2D boundary. Note: the current 3D objects are overwritten when n is missing. Otherwise, the objects contained in the file will be appended after the object number n. Default values: n=-1, k=1.

The files you read in here are ASCII text files to be created by some external software. They have the following structure (no header!):

Special values of Names:

BASis

Argument: Name

Meaning: Read the basis functions from the file Name. Note: if the current problem is of the eigenvalue type, the basis will be used for the Eigenvalue Extrapolation Technique EET. Otherwise, it is used for the Parameter Estimation Technique PET. Special values of Names:

BITmap or BMP

Argument: Name

Meaning: Read the bitmap information from the file Name and paste it to the current graphics window. Special Names:

 

BOUndary

Argument: Name

Meaning: Read the boundaries from the file Name. Note: the current boundaries are overwritten when n is missing. Otherwise, the boundaries contained in the file will be appended after the boundary number n. Special Names:

DIRective

Argument: Name

Meaning: Read the directives from the file Name. Note: the current directives are overwritten. Special Names:

 

DOMain

Argument: Name

Meaning: Read the domains from the file Name. Note: the current domains are overwritten. Special Names:

 

EXPansion

Argument: Name (n)

Meaning: Read the expansions from the file Name. Note: the current expansions are overwritten when n is missing. Otherwise, the expansions contained in the file will be appended after the expansion number n. Special Names:

 

FIEld

Arguments: Name (WHAt)

Meaning: Read the original field or the representation data from the file Name. Note: the current field is overwritten. When WHAt is missing, the representation data and the field values are read. When WHAt is REPresentation, only the representation data is read. When WHAt is VALue, only the field values are read. Special Names:

 

FLF

Argument: Name

Meaning: Read the field definition formula from the file Name. Note: the current formula are overwritten. Special Names:

 

FLT

Argument: Name

Meaning: Read the field transformation formula from the file Name. Note: FLT files are created by the MaX-1 software. OpenMaXwell will only read the PFD information contained in these files. Special Names:

 

FUNction

Arguments: Name (WHAt n m i k)

Meaning: Read the function values or the representation data from the file Name. Note: the current functions are overwritten. When WHAt is missing, the representation data and the function values are read. When WHAt is REPresentation, only the representation data is read. When WHAt is VALue, only the function values are read. Special Names:

The additional arguments n m i k specify offset numbers for the rows and columns in the function array and the numbers of rows and columns. If n is set, the first n rows of the function array remain unchanged and the rows n+1, n+2, … are used to store the columns 1, 2, … in the function file, i.e., n is the row offset number. Similarly, m is the column offset number. The default offset numbers are 0. When i an k are set, the function array is assumed to have i rows and k columns. This is important when a function file without header is read, for example, one written by another code.

 

GRF

Argument: Name

Meaning: Read the grid definition formula from the file Name. Note: the current formula are overwritten. Special Names:

 

GRT

Argument: Name

Meaning: Read the grid transformation formula from the file Name. Note: current formula are overwritten. Special Names:

 

INTegral

Argument: Name

Meaning: Read the integral data from the file Name. Note: current data is overwritten. Special Names:

MMP

Arguments: Name (What)

Meaning: Read the MMP data from the file Name. Note: current data is overwritten. What can be one of the following:

When What is missing, only the header is read.

Special Names:

OBJect

Argument: Name

Meaning: Read the 3D object data from the file Name. Note: current data is overwritten when n is missing. Otherwise, the objects contained in the file will be appended after the object number n. Special Names:

OGL

Argument: Name

Meaning: Read the OpenGL window data from the file Name. Note: current data is overwritten. Special Names:

PALette

Argument: Name

Meaning: Read the palette data from the file Name. Note: current data is overwritten. Special Names:

 

PARameter

Argument: Name

Meaning: Read the expansion parameters from the file Name. Note: the current expansion parameters are overwritten. Special Names:

 

PFD

Argument: Name

Meaning: Read the PFD data from the file Name. Special Names:

 

PROject

Argument: Name

Meaning: Read the project data from the file Name. Note: All associated data files (same file name but different file extension) will also be read. All current data is overwritten. Special Names:

 

VARiable

Arguments: n Name l

Meaning: Read the movie variable number n from the file Name. Start reading on line l of the file. Note that several movie variables may be read by this command. For example, when n is 2-5, the variables 2, 3, 4, and 5 will be read.

 

WINdow

Argument: Name

Meaning: Read window data from the file Name. Note: the current data of the current graphic window are overwritten. Special Names:

 

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

Last update 02.02.2017