Overview

This page summarizes script functions available in the software.

The software offers a variety of built-in script functions that meet to the needs of numerical calculations.

Basic Syntax

The basic syntax includes:

Script Variables: definitions of script variables and usage instructions, including the creation of numbers, strings, structs, datasets, etc., and related commands;
Data Input and Output: script initialization, saving, importing, and exporting data.
Program Control Flow: functions used to implement flow control structures such as branch structure and loop structure;
Basic Operations: including various operations on variables and files such as querying the type and members of a variable, and switching workpath;
Functions: use and description of user functions, as well as the introductions of the functions for far field analysis and chromaticity analysis;
Basic Maths: elementary functions including trigonometric, logarithmic, exponential and power functions, and basic mathematical operations such as calculating absolute value, getting real part or imaginary part;
Advanced Maths: functions used for advanced calculations such as differential and integral calculation, Fourier analysis, and interpolation;
Matrix Calculations: including functions for basic matrix operations and solving matrix equations.

Functions for Getting Data include:

Querying data-getting commands: list all the names of the results that the specific object has;
Checking whether the selected object has desirable data;
Getting property value from the solver, source, etc.;
Getting results from sources, monitors or analysis groups.

Functions for Setting Objects are used to add, set and operate objects, as well as add and set materials:

Adding objects: add structures, sources, monitors, structure groups, analysis groups, etc.;
Querying setting commands: return property lists for selected object;
Set objects: set parameters for structures, sources, monitors, structure groups, analysis groups, etc.;
Operate objects: perform operations on the selected objects, such as view conversion, pinning, hiding and deleting;
Add and set materials: add desired materials, and set material parameters.

Functions for Simulation are mainly used to set parameters related to the simulation and control the running for specific project:

Set simulation parameters;
Control simulation: control the running of the specific project;
Solve modes: solve modes in mode sources;
Add customized meshes;
Pre- and post-process functions such as the function controlling the running of the analysis group script.

Script commands for Data Visualization include:

Various operations in the workspace: In the script workspace, users can perform basic operations such as printing and drawing on existing variables through the GUI.