Command

Parameters

Short description

ADDLINE

(x₂, y₂)

Insert line from previous point to point (x2, y2).

ADDX

(dx)

Insert line from previous point (x, y) to point (x+dx, y).

ADDXYZ

(x, y, z)

Insert contour point.

ADDY

(dy)

Insert line from previous point (x, y) to point (x, y+dy)

ADJUSTP

(x, y, z, r)

Move points at level z to position (x, y) if they are in the square with corners (x-r, y-r) and (x+r, y+r).

ALLOWBHM

Switch on BHM mode.

ALLOWHF

Switch on Heat Flow (heat transfer analysis).

AMIGOALLOW

(allow)

Enables or disables AMIGO mesh control.

AMIGOAXES

(meshcontrolX, meshcontrolY, meshcontrolZ)

Sets AMIGO active axes.

AMIGOCELLS

(cells_per_wavelength, avoid_cells below lmin)

Sets AMIGO parameters: number of cells per wavelength and and minimal cell size to avoid generating too small FDTD cells.

AMIGOFREQ

(f1, f2, resolution df, change ports & postprocessing data)

Sets the frequency band of interest for AMIGO mesh creation.

AMIGOSETLMIN

Activates the same action as pressing ‘<’ button in the AMIGO dialogue.

AMIGOSUSP

(allow)

Enables or disables AMIGO mesh control.

ANGVAR

(n)

For 2DVcoa circuits sets modal angular variation (range [0-99]). For 3DP circuits sets phase shift per period

BHMAFTER

(what, after each, after step)

Set Suspend or Freeze for BHM steps.

BHMALLOW

(allow)

Enables or disables BHM module.

BHMCOMP

(what, OnOff, Use)

Sets the additional components and quantities that will be saved in QW-Simulator after each BHM step.

BHMCOMPFORMAT

(Data Format, Include Shape Data, Include FDTD Mesh)

Sets the data format for saving additional components and quantities.

BHMHTIMES

(First EM steady state, Consecutive EM steady states, Heating pattern construction, Total heating time, Heating time step)

Sets BHM Tasker times (accordingly to Heating details dialogue).

BHMHTIMES2

(Use, heating_steps_string)

Defines variable heating steps and switches on or off their usage in simulation.

BHMMVROTA

(oname, Ox, Oy, rpm)

Creates BHM Rotation Axis with speed rpm (in rotations per minute) around the axis parallel to Oz and passing through point (x0, y0) and assigns object oname.

BHMMVTRAN

(oname)

Creates BHM Movement Trajectory with consecutive positions loaded from <oname>.md3 file in the project directory.

BHMOPT

(Allow heat flow, Allow rotation, Movement)

Sets BHM mode options (accordingly to Heating details dialogue).

BHMPORTS

(Allow)

Sets automatic source parameters changing mode for BHM.

BHMROT

(Object name, X0, Y0, Speed, Angular step index)

Sets Rotation parameters (accordingly to Heating details dialogue).

BHMTUN

(manual_tuning)

Switches on or off manual mode of tuning.

CALL

(path, par1, par2, ... , parn, parx, pary, parz, N)

Calls another object to be nested as a subobject in the present object.

CIRTYPE

(type, medium_name)

Sets circuit type and default medium.

CLOSELINE

Inserts line from previous point to (x1, y1) point of the last NEWLINE.

CLOSEOBJ

End of object frame.

CODE

(string, n)

Function returning ASCII code of n-th char in string.

COPY

(xx)

Copies the marked element.

CREATEMESH

Forces mesh creation inside UDO file.

DELETE

(item_type, range)

Deletes element(s) or object(s).

DIAMETER

(dia)

Declaration of wire diameter, allowed only inside the frame of the element declared as WIRE.

DISPERSION

(medium_name, model_name, par1, par2, par3, par4)

Declaration of dispersive electric data.

DISPERSION2

(medium_name, model_name, par1, …, par11)

Declaration of multipole dispersive electric data.

DISPERSIONH

(medium_name, model_name, par1, par2, par3, par4)

Declaration of dispersive magnetic data.

DISPERSIONH2

(medium_name, model_name, par1, …, par11)

Declaration of multipole dispersive magnetic data.

do

Keyword for if and while commands.

ELEMENT

(level, height, type, medname, name, spin/wire)

Start of element frame.

ENDELEM

End of element frame.

ENDHEADER

Separates header and body of the UDO program.

endif

End if command.

ENDPORT

End of port frame.

ENDSECTION

End of section frame.

endwhile

Ends while command.

ENERGYALLOW

(allow)

Switches on or off energy stop criterion that will be used in simulation.

ENERGYOPT

(saveSParametersWhenFinished, freezeWhenFinished, suspendWhenFinished, continueAfterPulsesNbLimit)

Sets options for energy stop criterion.

ENERGYPAR

(energyLevelDescentDB, energyLevelLogEveryDB, energyProbingEvery, sParametersAccuracy, pulsesNbLimit)

Sets parameters for energy stop criterion.

EPSEFF

(value)

Port effective permittivity setting.

EXHTIMEINTEGRAL

(Sx, Sy, Sz, sparsityX, sparsityY, sparsityZ)

Activates ExH time integral postprocessing, sets components and spatial sparsity for X, Y and Z direction

EXPANDMESH

(lowerlevel, upperlevel)

Expands mesh limits in z-direction.

EXPOPT

(Suppress singularity corrections, Suppress density/SAR, Allow BHM)

Sets export options.

EXPOPT2

(<what>, <OnOff>)

Sets advanced export options.

FDPROB

(lower_freq, upper_freq, freq_step)

Enables frequency domain probing.

FDPROBPAV

(lower_freq, upper_freq, freq_step)

Enables frequency domain probing for power available from the source.

FDM

(fdm_freq_list)

Sets frequency domain monitor frequencies.

FDM3DSPARS

(sparsity)

Sets spatial sparsity.

FDMCOMP

(Ex,Ey,Ez,Hx,Hy,Hz)

Sets on/off components for Fields Monitor post-processing.

FDMLOCALCOMP

((Ex,Ey,Ez,Hx,Hy,Hz)

Sets on/off components for frequency domain monitor.

FDMLOCALFREQ

(frequencies_string)

Sets frequencies for frequency domain monitor.

FDMLOCALSPARS

(sparsX, sparsY, sparsZ)

Sets spatial sparsity in X, Y, and Z direction for frequency domain monitor.

FDMSPARS

(sparsX, sparsY, sparsZ)

Sets sparsity in X, Y, and Z direction for Fields Monitor post-processing.

FERRITEPAR

(mediumname, eps, mu, sigma, sigmaM, alpha, Ms, Hi, dens)

Ferrite material parameters setting.

GETIOPAR

(file_name)

The I/O port parameters are read from the file.

GETMESHPAR

(n)

Function returning the n-th mesh parameter.

GRIDHV

(orientation_h, orientation_v)

Declaration of wire grid, allowed only inside the frame of the element declared as WIRE.

HTIMES

(First EM steady state, Consecutive EM steady states, Heating pattern construction, Total heating time, Heating time step)

Sets BHM Tasker times (accordingly to Heating details dialogue).

if

Standard control command.

INSERTMEDIUM

(name, type)

Inserts a medium into the project.

JOIN

(operation)

CUT, INTERSECT, GLUE

Joining elements.

LOSSES

(text string)

Controlls losses suppression and metal loss bandwidth.

LUMPED

(component, options, impedance)

Parameters of lumped port.

LUMPIMPPAR

(type, component, Rp, Lp, Cp, Rs, Ls, Cs)

Parameters of lumped impedance.

MARK

(item_type, range, command)

Used to Mark or Unmark elements or objects for further operations of movement or reproduction.

MARKFJ

(item_type,range,command)

Used to Mark or Unmark elements or objects as Passive or Active for subsequent JOIN operation.

MEDIUMCOL

(medname, pen_R, pen_G, pen_B, pen_style, pen_width, brush_pen_R, brush_pen_G, brush_pen_B, brush_bkg_R, brush_bkg_G, brush_bkg_B, brush_style)

Material pen/brush colour/style setting.

MEDIUMPAR

(medname, epsx, mux, sigx, msigx, psy, muy, sigy, msigy, epsz, muz, sigz, msigz, density)

Material parameters setting.

MESH

(n)

Function returning the z-level of the n-th sublayer of the FDTD mesh.

MESHINDEX

(level)

Function returning the ordinal number of the sublayer of FDTD mesh situated at or below level.

MESHPAR

(arg1, ..., arg10)

Permits to make global mesh settings.

MESHX

(n)

Function returning the x-coordinate of the n-th mesh line of the FDTD mesh.

MESHXINDEX

(level)

Function returning the ordinal number of the border between FDTD cells at or below level (in –X direction).

MESHY

(n)

Function returning the y-coordinate of the n-th mesh line of the FDTD mesh.

MESSAGE

(text)

Displays text message in QW Project Info window.

MESHYINDEX

(level)

Function returning the ordinal number of the border between FDTD cells at or below level (in –Y direction).

MIRROR

(xy, xz, yz)

Performs a mirror reflection of all the marked elements or objects with respect to the planes z=0 or/and y=0 or/and x=0.

MIRRORX

(xmirror)

Performs a mirror reflection of all the marked elements or objects with respect to the plane x=xmirror.

MIRRORY

(ymirror)

Performs a mirror reflection of all the marked elements or objects with respect to the plane y=ymirror.

MIRRORZ

(zmirror)

Performs a mirror reflection of all the marked elements or objects with respect to the plane z=zmirror.

MODE

(port_mode_index)

Sets port mode.

MTEM

(medium_name, potential₂)

Assigns potential to medium in port.

MULTIPOINT

(enable, size|shape)

Sets multipoint option.

MV_CLEAR

Clears all previously defined movements and their parameters.

MV_ROTA

(oname, Ox, Oy, rpm)

Creates BHM Rotation Axis with speed rpm (in rotations per minute) around the axis parallel to Oz and passing through point (x0, y0) and assign object oname.

MV_TRAN

(oname)

Selects object oname for translation.

NEWLINE

(x₁, y₁, x₂, y₂)

Creates the first segment of a broken line.

NONLINEARITY

(mediumname, model_name, hi3, tau1, tau2, alpha)

Declaration of nonlinearity.

NTF

(frequencies_string)

Enables NTF postprocessing and sets NTF frequencies.

NTFBAND

(lower_freq, upper_freq, freq_step)

Enables NTF postprocessing and sets NTF frequencies with a band.

NTFBKG

(eps, mu, sig, msig)

Defines NTF and PlaneWave background dielectric.

NTFFA

(f1, f2, df, phi_theta_strings)

Sets NTF FixAng. Parameters.

NTFFAWALLS

(x₁, x₂, y₁, y₂, z₁, z₂)

Turns on/off NTFFA walls.

OPENF

(file_name)

Opens a disk text file for reading.

OPENOBJECT

(name)

Start of object frame.

PAR

(description, name, val_default)

Parameter definition.

PARL

(description, name, val1_default,val2,...,valN)

Parameter definition with values choice as a list.

PERIODIC

(activity_x, activity_y, activity_z, beta_x, beta_y, beta_z)

Defines features for periodic circuits.

PLWAVE

(phi, theta, polarisation)

Defines plane wave data.

PLWBEAM

(beam_type, neck_origin_X, neck_origin_Y, neck_origin_Z, neck_dia, angle_of_variation)

Defines beam data.

PORT

(level, height, type, activity, name, reference)

Start of port frame.

PORTEXC

(point1z, point2z)

Moves the excitation points to arbitrary z-level.

PORTPAR

(size-, size+, activity-, activity+, port_plane, port_circumf.)

Sets mesh snapping and mesh enforcing properties of the port.

PORTPAR2

(subcircuits_margin, active_walls, dummy, dummy)

Sets subcircuits_margin property of the port.

PORTPOSTP

(arg1, arg2)

Refers to lumped source/probe and determines in which postprocessing it is to be included.

POSTP

(index, int)

Turns on/off post-processings.

PROFILE

(type, par_a, par_b, file_name)

Defines PML profile.

PROFILE2

(thickness, type, par_a, par_b, file_name)

Defines PML thickness and profile.

PRONY

(take_every, below)

Enables Prony post-processing.

READF

Function returning the value of the next number read from the file defined by OPENF command.

READS

Function returning the next string read from the file defined by OPENF.

REDRAW

(delay)

Redraws all the elements on the screen with a specified delay.

RENAME

(item_type, range, new_name)

Changes the name of an element or an object.

ROTATE

(angle, x0, y0)

Rotates all the marked elements or objects with respect to the specified axis of symmetry, by a specified angle.

SECTION

(level, height, height2, medium_name,element_name)

Start of section frame

SETATTR

(which_attribute, attr_value_1, attr_value2)

Sets a property for element.

SETOBJMED

(obj_name, med_name)

Changes object material.

SETPEN

(colour_R, colour_G, colour_B, width, style)

Defines the pen colour, line width and style for drawing the elements marked with the MARK command.

SETSUSPFLAGS

(draw_suspended, skip_EXPANDMESH, slicing_phase)

Sets internal QW-Editor flags.

SFM

(sfm)

Sets stability factor modifier.

SHIFTM

(dx, dy, dz)

Shifts all the marked elements or objects.

SK1DIFF

(low_freq, upper_freq, freq_step, assumptions)

Activates SK1 differential postprocessing.

SLICINGPHASE

Function returning 0 when QW-Editor is in the DRAFT phase and 1 when QW-Editor is in the FINAL phase.

SMNDIFF

(low_freq, upper_freq, freq_step, assumptions, mode,

IterForS)

Activates Smn differential post-procesing.

SNAP

(value)

Function returning value snapped to geometry resolution (1E-5).

STL

(x₁, y₁, z₁, x₂, y₂, z₂)

Inserts STL format section.

STR

(arithmetic_expression)

Function converting arithmetic expression into string.

SYMMETRY

(symm_v, symm_h)

Defines port symmetry.

TEMPA

(mode, m, n, freq, dummy)

Defines analitic template data.

TEMPD

(method, match_freq, within, from, to, step, component, iter)

Defines dynamic template data.

TEMPDP

(method, match_freq, within, from, to, step, component, periods)

Defines dynamic template data with periods.

TEST

(logical expression, text)

Tests and validates expression.

THERMALPAR

(med_name,ini_temp,spec_heat,therm_cond_X,_Y,_Z)

Material thermal parameters setting.

UNITS

(space, freq)

Defines project units.

UNITSGEOMETRY

(space)

Defines project’s geometry units.

UNITSFREQUENCY

(freq)

Defines project’s frequencyunits.

VAR

(text_expression)

Function returning value of the variable given as the text expression.

VISCOSITY

(medname, viscosity)

Sets material viscosity parameter.

WAVEFORM

(shape, f1, f2, duration, amplitude, delay, file_name)

Defines waveform parameters.

WAVEFORM2

(amplitude_im, delay_im)

Defines additional waveform parameters for periodic circuits.

while

Standard control command.

WIRER1

(R1)

Declaration of wire resistance, allowed only inside the frame of the element declared as WIRE.

WRITEF

(value)

Writes value into udodebug.txt file (located in the project directory).

WRITES

(string)

Writes string into udodebug.txt file (located in the project directory).

VERSION

(n)

Returns a number of current base version of QW-Editor.

XCOORD

(item_type,name,n)

Function returning x-coordinate of n-th point of the element.

YCOORD

(item_type,name,n)

Function returning y-coordinate of n-th point of the element.

ZCOORD

(item_type,name,n)

Function returning z-coordinate of n-th point of the element.