Changes

Glossary of EM.Cube's Python Functions

4,184 bytes added, 22:22, 11 June 2018
<table>
<tr>
<td>[[image:Cube-icon.png | link=Getting_Started_with_EM.Cube]] [[image:cad-ico.png | link=Building_Geometrical_Constructions_in_CubeCAD]] [[image:fdtd-ico.png | link=EM.Tempo]] [[image:prop-ico.png | link=EM.Terrano]] [[image:static-ico.png | link=EM.Ferma]] [[image:planar-ico.png | link=EM.Picasso]] [[image:metal-ico.png | link=EM.Libera]] [[image:po-ico.png | link=EM.Illumina]]</td>
<tr>
</table>
[[Image:Back_icon.png|30px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''
<br />
 
== Standard Python Operators ==
|}
== Standard Basic Mathematical Python Functions ==
{| class="wikitable"
| Hyperbolic tangent function
| -
|-
| np.floor(x)
| Std. Python function
| Floor function
| nearest integer <= x
|-
| np.arcsinh(x)
| Inverse hyperbolic tangent function
| -
|-
| np.floor(x)
| Std. Python function
| Floor function
| nearest integer <= x
|}
|}
== EM.Cube's Miscellaneous Native Python Functions ==
{| class="wikitable"!scope="col"| Syntax!scope="col"| Type!scope="col"| Description!scopeactivate="col"| Notes|-| style="width:80px;" | rect(x)| style="width:150px;" | EMAG Python function| style="width:270px;" | Rectangle function| style="width:270px;" | 1 if |x|&le;0.5, 0 elsewhere |-| tri(x)| EMAG Python function| Triangle function| 1 if |1-x|&le;1, 0 elsewhere |-| spline2(x)| EMAG Python function| Quadratic spline function| -|-| spline3(x)| EMAG Python function| Cubic spline function| -|-| step(x)| EMAG Python function| Step function| 1 if x>0, 0 if x<0|-| sgn(x)| Std. Python function| Sign function| 1 if x>0, -1 if x<0|-| ramp(x)| EMAG Python function| Ramp function| x if x>0, 0 if x<0|-| sqr_wave(x)| EMAG Python function| Square wave function| -|-| tri_wave(x)| EMAG Python function| Triangle wave function| -|-| sawtooth(x)| EMAG Python function| Sawtooth wave function| -|-| sinc(x)| EMAG Python function| Sinc function| sin(pi*x)/(pi*x)|-| gauss(x,mu,sigma)| EMAG Python function| Gaussian function of mean mu and standard deviation sigma| exp(-0.5*((x-mu)/sigma)**2)/sigma/sqrt(2*pi)|-| msin(x,r)| EMAG Python function| super-quadratic sine function of order r| -|-| mcos(x,r)| EMAG Python function| super-quadratic cosine function of order r| -|-| sigmoid(x,a)| EMAG Python function| Sigmoid function of slope a| 2/(1 + exp(-a*x)) - 1|-| bh_window(x,T)| EMAG Python function| Blackman-Harris window function| -|-| bh_step(x,T)| EMAG Python function| Blackman-Harris step function| -|-| rand(x,y)| EMAG Python function| Random function| -|-| rosen(x,y,a,b)| EMAG Python function| Rosenbrock function| (a-x)**2 + b*(y-x**2)**2|-| mean(x,y)| EMAG Python function| arithmetic mean of x and y| 0.5*(x+y)|-| geo(x,y)| EMAG Python function| geometric mean of x and y| sqrt(x*y)|-| harm(x,y)| EMAG Python function| harmonic mean of x and y| 2/(1/x+1/y)|-| sqr2(x,y)| EMAG Python function| sum of squares of x and y| x**2 + y**2|-| sqr3(x,y,z)| EMAG Python function| sum of squares of x and y and z| x**2 + y**2 + z**3|-| sqrt2(x,y)| EMAG Python function| radius of 2D point (x,y)| sqrt(x**2 + y**2)|-| sqrt3(x,y,z)| EMAG Python function| radius of 3D point (x,y,z)| sqrt(x**2 + y**2 + z**3)|}
== EM.Cube's Design Python Functions ==SYNTAX: activate({{ArgTypeString}} group_node_label)
{| class="wikitable"!scope="col"| Syntax!scope="col"| Type!scope="col"| Description!scope="col"| Notes|-| style="widthEXAMPLE:100px;" | microstrip_design''activate(z0,er)| style="width:150px;Color_1" | EMAG Python function| style="width:250px;" | Returns the width-to-height ratio of a microstrip transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, er: substrate permittivity|-| style="width:100px;" | microstrip_z0(w,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the characteristic impedance of a microstrip transmission line in Ohms | style="width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity|-| style="width:100px;" | microstrip_eps_eff(w,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the effective permittivity of a microstrip transmission line | style="width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity|-| style="width:100px;" | microstrip_lambda_g(w,h,er,freq_hertz)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the guide wavelength of a microstrip transmission line in meters| style="width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity, freq_hertz: frequency in Hz|-| style="width:100px;" | cpw_design_w(z0,s,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the slot width of a coplanar waveguide (CPW) transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, s: center strip width (or slot spacing), h: substrate height, er: substrate permittivity|-| style="width:100px;" | cpw_design_s(z0,w,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the center strip width (or slot spacing) of a coplanar waveguide (CPW) transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, w: slot width, h: substrate height, er: substrate permittivity|-| style="width:100px;" | coaxial_design(z0,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the ratio of radius of the outer conductor to the radius of the inner conductor of a coaxial transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, er: core permittivity|-| style="width:100px;" | waveguide_design(er,freq_hertz)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the minimum larger dimension in meter of the cross section of a hollow rectangular waveguide above cutoff | style="width:250px;" | er: filling permittivity, freq_hertz: frequency in Hz|-| style="width:100px;" | horn_design_a(D0_dB,a_lambda,b_lambda)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the wavelength-normalized larger dimension of the aperture of an optimal pyramidal horn antenna | style="width:250px;" | D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide |-| style="width:100px;" | horn_design_b(D0_dB,a_lambda,b_lambda)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the wavelength-normalized smaller dimension of the aperture of an optimal pyramidal horn antenna | style="width:250px;" | D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide |-| style="width:100px;" | horn_design_l(D0_dB,a_lambda,b_lambda)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the wavelength-normalized length of an optimal pyramidal horn antenna | style="width:250px;" | D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide |}''
== DESCRIPTION: Activates a color, material or object group in the current active [[EM.Cube's Python Functions ]] module for Geometric Object Creation ==insertion of new objects.
====activateadd_variable====
SYNTAX: activateadd_variable({{ArgTypeString}} group_node_labelvar_name, {{ArgTypeAny}} value)
EXAMPLE: ''activateadd_variable("Color_1MyVar",1)''
DESCRIPTION: Activates Adds a color, material or object group in the current active new variable to [[EM.Cube]] module's variable list.
====array====
DESCRIPTION: Creates or modifies an array object and sets its local coordinate system and rotation angles.
 
====background_layer====
 
SYNTAX: background_layer({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thickness)
 
EXAMPLE: ''background_layer("Mid_Layer",3.3,0.001,1,1.5)''
 
DESCRIPTION: Adds a new substrate layer to [[EM.Picasso]]'s background layer stackup.
 
====base_point_group====
 
SYNTAX: base_point_group({{ArgTypeString}} label)
 
EXAMPLE: ''base_point_set("BP_Set_1")''
 
DESCRIPTION: Creates a base point set in [[EM.Terrano]]. If the base point set group 'label' already exists, the group is activated.
 
====bh_step====
 
SYNTAX: bh_step({{ArgTypeReal}} x, {{ArgTypeReal}} T)
 
EXAMPLE: ''bh_step(0.5,1)''
 
DESCRIPTION: Computes and returns the Blackman-Harris step function.
 
====bh_window====
 
SYNTAX: bh_window({{ArgTypeReal}} x, {{ArgTypeReal}} T)
 
EXAMPLE: ''bh_window(0.5,1)''
 
DESCRIPTION: Computes and returns the Blackman-Harris window function.
====box====
DESCRIPTION: Draws a box object in the project workspace under the currently activated material group node, or modifies the box named 'label' if it already exists.
 
====capacitance====
 
SYNTAX: capacitance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)
 
EXAMPLE: ''capacitance("FI_1",-10,-10,5,10,10,10,0,0,-10,0,0,10)''
 
DESCRIPTION: Creates a capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
 
====capacitor====
 
SYNTAX: capacitor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} capacitance_pF)
 
EXAMPLE: ''capacitor("Cap_1","Line_1",25,10)''
 
DESCRIPTION: Creates a capacitor in [[EM.Tempo]]. If the capacitor 'label' already exists, its properties are modified.
 
====charge_group====
 
SYNTAX: charge_group({{ArgTypeString}} label, {{ArgTypeAny}} density)
 
EXAMPLE: ''charge_group("Charge_1",-1e-5)''
 
DESCRIPTION: Creates a volume charge source group in [[EM.Ferma]]. If the charge group 'label' already exists, the group is activated.
====circ_strip====
DESCRIPTION: Sets the open/close state of a polyline or NURBS curve. Use 0 for open curve and 1 for close curve.
 
====coaxial_design====
 
SYNTAX: coaxial_design({{ArgTypeReal}} z0, {{ArgTypeReal}} er)
 
EXAMPLE: ''coaxial_design(50,2.2)''
 
DESCRIPTION: Computes and returns the ratio of the radius of the outer conductor to the radius of the inner conductor of a coaxial transmission line of characteristic impedance z0 (in Ohms) with core relative permittivity er.
 
====coaxial_src====
 
SYNTAX: coaxial_src({{ArgTypeString}} label, {{ArgTypeAny}} cylinder_object, {{ArgTypeAny}} outer_radius, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
 
EXAMPLE: ''coaxial_src("COAX_1","Cyl_1",1.5,"+z")''
 
DESCRIPTION: Creates a coaxial port source in [[EM.Tempo]]. If the coaxial port 'label' already exists, its properties are modified.
====color_group====
DESCRIPTION: Creates a color group in CubeCAD module. If the color group 'label' already exists, the group is activated.
 
====conduction_current_integral====
 
SYNTAX: conduction_current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
 
EXAMPLE: ''conduction_current_integral("FI_1",-10,-10,0,10,10,0)''
 
DESCRIPTION: Creates a conduction current integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
 
====conductive_sheet_group====
 
SYNTAX: conductive_sheet_group({{ArgTypeString}} label, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)
 
EXAMPLE: ''conductive_sheet_group("Cond_1",100, 0.01)''
 
DESCRIPTION: Creates a conductive sheet group in [[EM.Picasso]]. If the conductive sheet group 'label' already exists, the group is activated.
====cone====
DESCRIPTION: Consolidates a specified object.
 
====cpw_design_s====
 
SYNTAX: cpw_design_s({{ArgTypeReal}} z0, {{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
 
EXAMPLE: ''cpw_design_s(50,2,0.5,2.2)''
 
DESCRIPTION: Computes and returns the center strip width (in meters) of a CPW transmission line of characteristic impedance z0 with slot width w, substrate height h and substrate relative permittivity er.
 
====cpw_design_w====
 
SYNTAX: cpw_design_w({{ArgTypeReal}} z0, {{ArgTypeReal}} s, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
 
EXAMPLE: ''cpw_design_w(50,1,0.5,2.2)''
 
DESCRIPTION: Computes and returns the slot width (in meters) of a CPW transmission line of characteristic impedance z0 with center strip width s, substrate height h and substrate relative permittivity er.
 
====cpw_src====
 
SYNTAX: cpw_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} spacing, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
 
EXAMPLE: ''cpw_src("CPW_1","Rect_1",1.5,"+x")''
 
DESCRIPTION: Creates a CPW port source in [[EM.Tempo]]. If the CPW port 'label' already exists, its properties are modified.
====cubecad_mesh_settings====
DESCRIPTION: Sets the parameters of CubeCAD's mesh generator.
 
====current_dist====
 
SYNTAX: current_dist({{ArgTypeString}} label)
 
EXAMPLE: ''current_dist("CD_1")''
 
DESCRIPTION: Creates a current distribution observable. If the observable 'label' already exists, its properties are modified.
 
====current_integral====
 
SYNTAX: current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
 
EXAMPLE: ''current_integral("FI_1",-10,-10,0,10,10,0)''
 
DESCRIPTION: Creates a current integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
====cylinder====
DESCRIPTION: Draws a cylinder object in the project workspace under the currently activated material group node, or modifies the cylinder named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the cylinder's azimuth axis.
 
====delete====
 
SYNTAX: delete({{ArgTypeString}} node_name)
 
EXAMPLE: ''delete("Box_1")''
 
DESCRIPTION: Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.
 
====delete_background_layer====
 
SYNTAX: delete_background_layer({{ArgTypeString}} label)
 
EXAMPLE: ''delete_background_layer("Mid_Layer")''
 
DESCRIPTION: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup.
 
====dielectric_group====
 
SYNTAX: dielectric_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)
 
EXAMPLE: ''dielectric_group("Dielectric_1","my_eps",0,1,0)''
 
DESCRIPTION: Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'label' already exists, the group is activated.
 
====diode====
 
SYNTAX: diode({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} polarity, {{ArgTypeAny}} is_fA, {{ArgTypeAny}} temperature_K, {{ArgTypeAny}} ideality_factor)
 
EXAMPLE: ''diode("Diode_1","Line_1",25,0,10,300,1)''
 
DESCRIPTION: Creates a diode in [[EM.Tempo]]. If the diode 'label' already exists, its properties are modified.
 
====distributed_src====
 
SYNTAX: distributed_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} field_dir, {{ArgTypeAny}} profile[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
 
EXAMPLE: ''distributed_src("DS_1","Rect_1","+y","uniform")''
 
DESCRIPTION: Creates a distributed source in [[EM.Tempo]]. If the distributed source 'label' already exists, its properties are modified.
====ellipse_strip====
DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s facet mesh generator.
 
====energy_electric====
 
SYNTAX: energy_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
 
EXAMPLE: ''energy_electric("FI_1",-10,-10,-10,10,10,10)''
 
DESCRIPTION: Creates an electric energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
 
====energy_magnetic====
 
SYNTAX: energy_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
 
EXAMPLE: ''energy_magnetic("FI_1",-10,-10,-10,10,10,10)''
 
DESCRIPTION: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
====explode====
DESCRIPTION: Creates or modifies an extrusion object from a specified object by the specified height. If modifying an existing extrusion object, the pre-existing primitive is used. This command can only extrude objects that have a single face and will extrude along the face's normal.
 
====farfield====
 
SYNTAX: farfield({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)
 
EXAMPLE: ''farfield("FF_1",1,1)''
 
DESCRIPTION: Creates a far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.
 
====field_probe====
 
SYNTAX: field_probe({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)
 
EXAMPLE: ''field_probe("FS_1",0,0,50)''
 
DESCRIPTION: Creates a temporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
 
====field_sensor====
 
SYNTAX: field_sensor({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)
 
EXAMPLE: ''field_sensor("FS_1","z",0,0,0,100,100,0,25,25,0)''
 
DESCRIPTION: Creates a near-field sensor observable. If the observable 'label' already exists, its properties are modified.
 
====field_sensor_grid====
 
SYNTAX: field_sensor_grid({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)
 
EXAMPLE: ''field_sensor_grid("FS_1","z",0,0,0)''
 
DESCRIPTION: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
====fill_curve====
DESCRIPTION: Fillets the corners of the specified surface or curve object by the specified radius.
 
====flux_electric====
 
SYNTAX: flux_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
 
EXAMPLE: ''flux_electric("FI_1",-10,-10,5,10,10,10)''
 
DESCRIPTION: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
 
====flux_magnetic====
 
SYNTAX: flux_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
 
EXAMPLE: ''flux_magnetic("FI_1",0,0,-10,10,0,10)''
 
DESCRIPTION: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
====fractal_tree====
DESCRIPTION: Sets the freeze state of an object (0/1).
 
====gauss====
 
SYNTAX: gauss({{ArgTypeReal}} x, ArgTypeReal}} mu, ArgTypeReal}} sigma)
 
EXAMPLE: ''gauss(0.5,0,1)''
 
DESCRIPTION: Computes and returns the Gaussian function of mean mu and standard deviation sigma: exp(-0.5*((x-mu)/sigma)**2)/sigma/sqrt(2*pi).
 
====gauss_beam====
 
SYNTAX: gauss_beam({{ArgTypeString}} label, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization, {{ArgTypeAny}} focus_x, {{ArgTypeAny}} focus_y, {{ArgTypeAny}} focus_z, {{ArgTypeAny}} radius, {{ArgTypeAny}} p_mode, {{ArgTypeAny}} q_mode)
 
EXAMPLE: ''gauss_beam("PW_1",180,0,"tm",0,0,0,20,0,0)''
 
DESCRIPTION: Creates a Gaussian beam source in [[EM.Tempo]]. If the Gaussian beam source 'label' already exists, its properties are modified.
 
====generate_input_files====
 
SYNTAX: generate_input_files()
 
EXAMPLE: ''generate_input_files()''
 
DESCRIPTION: Generates all the input files for the simulation engine of the current module without running a simulation.
 
====geo====
 
SYNTAX: geo({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''geo(1,2)''
 
DESCRIPTION: Computes and returns the geometric mean of x and y: sqrt(x*y).
====get_area====
DESCRIPTION: Returns the specified coordinate of the unit vector along the specified local axis of an object.
 
====get_domain_extent====
 
SYNTAX: get_domain_extent({{ArgTypeString}} coordinate)
 
EXAMPLE: ''get_domain_extent("x")''
 
DESCRIPTION: Returns the size of the computational domain along the specified direction.
====get_extent====
DESCRIPTION: Returns the specified rotation angle of an object.
 
====get_standard_output====
 
SYNTAX: get_standard_output({{ArgTypeString}} output_name)
 
EXAMPLE: ''get_standard_output("S11M")''
 
DESCRIPTION: Returns the computed value of the specified standard output parameter at the end of a simulation.
====get_vertex====
DESCRIPTION: Returns the volume of a solid object.
 
====global_ground====
 
SYNTAX: global_ground({{ArgTypeAny}} ground_on, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
 
EXAMPLE: ''global_ground(1,3.3,0.001)''
 
DESCRIPTION: Set the state of [[EM.Terrano]]'s global ground and its material properties. A zero value for ground_on means to no global ground assumed at Z = 0.
====group====
DESCRIPTION: Groups a number of objects into a composite object with the given label.
 
====harm====
 
SYNTAX: harm({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''harm(1,2)''
 
DESCRIPTION: Computes and returns the harmonic mean of x and y: 2/(1/x+1/y).
====helix====
EXAMPLE: ''helix("Helix_1",0,0,0,15,15,10,0)''
DESCRIPTION: Draws a helical curve in the project workspace under the currently activated material group node, or modifies the helix named 'label' if it already exists. The parameter "radius_inner" specifies the helix's radius at the beginning of the helix, and radius_outer specifies the radius at the end of the helix. If the Boolean parameter "helixl_dir" is 1, the helical curve will be drawn counter-clockwise. ====horn_design_a==== SYNTAX: horn_design_a({{ArgTypeReal}} D0_dB, {{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda) EXAMPLE: ''horn_design_a(15,0.4,0.3)'' DESCRIPTION: Computes and returns the wavelength-normalized larger dimension of the aperture of an optimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda. ====horn_design_b==== SYNTAX: horn_design_b({{ArgTypeReal}} D0_dB, {{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda) EXAMPLE: ''horn_design_b(15,0.4,0.3)'' DESCRIPTION: Computes and returns the wavelength-normalized smaller dimension of the aperture of an optimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda. ====horn_design_l==== SYNTAX: horn_design_l({{ArgTypeReal}} D0_dB, {{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda) EXAMPLE: ''horn_design_l(15,0.4,0.3)'' DESCRIPTION: Computes and returns the wavelength-normalized length of an optimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda. ====huygens_src==== SYNTAX: huygens_src({{ArgTypeString}} label, {{ArgTypeAny}} filename[, {{ArgTypeAny}} set_lcs, {{ArgTypeAny}} polarization, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} x_rot, {{ArgTypeAny}} y_rot, {{ArgTypeAny}} z_rot]) EXAMPLE: ''huygens_src("HS_1","Huygens_1.HUY",1,100,100,0,0,0,0)'' DESCRIPTION: Creates a Huygens source. If the Huygens source 'label' already exists, its properties are modified. ====huygens_surface==== SYNTAX: huygens_surface({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples) EXAMPLE: ''huygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)'' DESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, its properties are modified. ====huygens_surface_grid==== SYNTAX: huygens_surface_grid({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''huygens_surface_grid("HS_1",-10,-10,-10,10,10,10)'' DESCRIPTION: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label' already exists, its properties are modified.
====hyperbola====
DESCRIPTION: Draws a hyperbola object in the project workspace under the currently activated material group node, or modifies the hyperbola named 'label' if it already exists. If the Boolean parameter "half_only" is 1, only half of the hyperbola will be drawn.
 
====impedance_surface_group====
 
SYNTAX: impedance_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag)
 
EXAMPLE: ''impedance_surface_group("IMP_1",100,-100)''
 
DESCRIPTION: Creates a impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'label' already exists, the group is activated.
 
====impenetrable_surface_group====
 
SYNTAX: impenetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
 
EXAMPLE: ''impenetrable_surface_group("Impenet_1",2.2,0.0001)''
 
DESCRIPTION: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'label' already exists, the group is activated.
====import_dxf====
DESCRIPTION: Imports an external STEP model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.
 
====inductance====
 
SYNTAX: inductance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)
 
EXAMPLE: ''inductance("FI_1",0,0,-10,10,0,10,2.5,-2.5,0,7.5,2.5,0)''
 
DESCRIPTION: Creates a inductance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
 
====inductor====
 
SYNTAX: inductor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} inductance_nH)
 
EXAMPLE: ''inductor("Cap_1","Line_1",25,10)''
 
DESCRIPTION: Creates a inductor in [[EM.Tempo]]. If the inductor 'label' already exists, its properties are modified.
====intersect====
DESCRIPTION: Creates or modifies a loft object from a specified object by the specified height. If modifying an existing loft object, the pre-existing primitive is used. This command can only loft objects that have a single face and will loft along the face's normal.
====merge_curvelumped_src====
SYNTAX: merge_curvelumped_src({{ArgTypeString}} object_1label, {{ArgTypeStringArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} object_2resistance])
EXAMPLE: ''merge_curvelumped_src("Curve_1LS_1","Curve_2Line_1",50,0)''
DESCRIPTION: Merges two specified curve objects into Creates a single curvelumped source in [[EM.Tempo]]. If the lumped source 'label' already exists, its properties are modified.
====mirrormagnet_group====
SYNTAX: mirrormagnet_group({{ArgTypeString}} objectlabel, {{ArgTypeAny}} x0mu, {{ArgTypeAny}} y0Mx, {{ArgTypeAny}} z0My, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZMz)
EXAMPLE: ''mirrormagnet_group("pyramid_1Magnet_1",01,0,0,1,0,0100)''
DESCRIPTION: Mirrors an object in Creates a plane defined by permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already exists, the specified point coordinates and specified normal vector componentsgroup is activated.
====move_tomcos====
SYNTAX: move_tomcos({{ArgTypeStringArgTypeReal}} objectx, {{ArgTypeStringArgTypeReal}} group_node_label[, {{ArgTypeString}} module_name]r)
EXAMPLE: ''move_tomcos("NewObj"0.5,"MyObj",10,10,02)''
DESCRIPTION: Transfers an object from its current material/object group node in Computes and returns the navigation tree to another node or optionally to another [[EM.Cube]] modulesuper-quadratic cosine function of order r.
====nurbs_curvemean====
SYNTAX: nurbs_curvemean({{ArgTypeStringArgTypeReal}} labelx, {{ArgType| 3x1 Python tupleArgTypeReal}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pny)
EXAMPLE: ''nurbs_curve("nc_1",(0,0,0),mean(1,0,0),(1,0,0)2)''
DESCRIPTION: Creates or modifies a NURBS Curve object in Computes and returns the project workspacearithmetic mean of x and y: 0. Each point is represented with a Python tuple type. The curve is closed if p0 is specified again as pn, otherwise, it is open5*(x+y).
====nurbs_stripmerge_curve====
SYNTAX: nurbs_stripmerge_curve({{ArgTypeString}} labelobject_1, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tupleArgTypeString}} pnobject_2)
EXAMPLE: ''nurbs_stripmerge_curve("ns_1Curve_1",(0,0,0),(1,0,0),(1,0,0)"Curve_2")''
DESCRIPTION: Creates or modifies Merges two specified curve objects into a NURBS Strip object in the project workspace. Each point is represented with a Python tuple type. The nurbs_strip function is 'self-closing' -- there is no need to supply the first point again at the end of the point listsingle curve.
====parabolamesh====
SYNTAX: parabolamesh({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)
EXAMPLEDESCRIPTION: ''parabola("Parabola _1",0,0,0,50,20,0)''Generates and displays the mesh of the physical structure.
DESCRIPTION: Draws a parabola object in the project workspace under the currently activated material group node, or modifies the parabola named 'label' if it already exists. If the Boolean parameter "half_only" is 1, only half of the parabola will be drawn. ====microstrip_design====
====param_curve====SYNTAX: microstrip_design({{ArgTypeReal}} z0, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: param_curve''microstrip_design({{ArgTypeString}} label50, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} model, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start, {{ArgTypeAny}} stop, {{ArgTypeAny}} step, {{ArgTypeAny}} function[, {{ArgTypeAny}} y(t), {{ArgTypeAny}} z(t)]2.2)''
EXAMPLEDESCRIPTION: ''param_curve("Curve_1",0,0,0,"parametric","xy",0,10,0Computes and returns the width-to-height ratio of a microstrip transmission line with characteristic impedance z0 in Ohms and substrate relative permittivity er.1,"cos(t)","sin(t)","t")''
DESCRIPTION: Generates a parametric curve in the project workspace under the currently activated material group node, or modifies the parametric curve named 'label' if it already exists.====microstrip_eps_eff====
====param_surface====SYNTAX: microstrip_eps_eff({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: param_surface''microstrip_eps_eff({{ArgTypeString}} label2, {{ArgTypeAny}} x00.5, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start1, {{ArgTypeAny}} stop1, {{ArgTypeAny}} step1, , {{ArgTypeAny}} start2, {{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} function2.2)''
EXAMPLEDESCRIPTION: ''param_surface("Surf_1"Computes and returns the effective permittivity of a microstrip transmission line with width w,0,0,0,"xy",0,10,0substrate height h and substrate relative permittivity er.1,0,10,0.1,"sin(x)*sin(y)")''
DESCRIPTION: Generates a parametric surface in the project workspace under the currently activated material group node, or modifies the parametric surface named 'label' if it already exists.====microstrip_lambda_g====
====pipe_sweep====SYNTAX: microstrip_lambda_g({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
SYNTAXEXAMPLE: pipe_sweep''microstrip_lambda_g({{ArgTypeString}} object2, {{ArgTypeAny}} radius0.5,2.2,2e9)''
EXAMPLEDESCRIPTION: ''pipe_sweepComputes and returns the guide wavelength ("Curve_1",5in meters)''of a microstrip transmission line with width w, substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
DESCRIPTION: Creates a pipe version of a given curve object.====microstrip_src====
====point====SYNTAX: microstrip_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} height, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
SYNTAXEXAMPLE: point''microstrip_src({{ArgTypeString}} label"MS_1", {{ArgTypeAny}} x0"Rect_1", {{ArgTypeAny}} y01.5, {{ArgTypeAny}} z0"+x")''
EXAMPLEDESCRIPTION: Creates a microstrip port source in [[EM.Tempo]]. If the microstrip port 'label'point("Point_1"already exists,0,0,10)''its properties are modified.
DESCRIPTION: Draws a point in the project workspace under the currently activated material group node, or modifies the point named 'label' if it already exists.====microstrip_z0====
====polygon_reg====SYNTAX: microstrip_z0({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: polygon_reg''microstrip_z0({{ArgTypeString}} label2, {{ArgTypeAny}} x00.5, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} n_sides2.2)''
EXAMPLEDESCRIPTION: ''polygon_regComputes and returns the characteristic impedance ("ts_1"in Ohms) of a microstrip transmission line with width w,0,0,0,50,100,80,1)''substrate height h and substrate relative permittivity er.
DESCRIPTION: Draws a regular polygon object in the project workspace under the currently activated material group node, or modifies the regular polygon object named 'label' if it already exists. ====microstrip_zoc====
====polygonize====SYNTAX: microstrip_zoc({{ArgTypeReal}} w, {{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
SYNTAXEXAMPLE: polygonize''microstrip_zoc({{ArgTypeString}} object2, {{ArgTypeAny}} side_length25,0.5,2.2,2e9)''
EXAMPLEDESCRIPTION: ''polygonizeComputes and returns the input reactance ("Cric_1",2in Ohms)''of an open-circuited microstrip transmission line with width w, length l, substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
DESCRIPTION: Polygonizes the specified surface or curve object by the specified side length. The results is a polystrip or a polyline.====microstrip_zsc====
====polyline====SYNTAX: microstrip_zsc({{ArgTypeReal}} w, {{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
SYNTAXEXAMPLE: polyline''microstrip_zsc({{ArgTypeString}} label2, {{ArgType| 3x1 Python tuple}} p025, {{ArgType| 3x1 Python tuple}} p10.5, 2... {{ArgType| 3x1 Python tuple}} pn2,2e9)''
EXAMPLEDESCRIPTION: ''polylineComputes and returns the input reactance ("pl_1",(0,0,0in Ohms)of a short-circuited microstrip transmission line with width w,(1length l,0,0),(1,0,0))''substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
DESCRIPTION: Creates or modifies a PolyLine object in the project workspace. Each point is represented with a Python tuple type. The poly_line is closed if p0 is specified again as pn, otherwise, it is open.====mirror====
====polymesh====SYNTAX: mirror({{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)
SYNTAXEXAMPLE: polymesh''mirror({{ArgTypeString}} label"pyramid_1", {{ArgTypeString}} object0, {{ArgTypeAny}} edge_length0,0,1,0,0)''
EXAMPLEDESCRIPTION: ''polymesh("Poly_1","Cric_1",2)''Mirrors an object in a plane defined by the specified point coordinates and specified normal vector components.
DESCRIPTION: Discretizes the specified solid or surface object by the specified edge length. The results is a polymesh object.====move_to====
====polystrip====SYNTAX: move_to({{ArgTypeString}} object, {{ArgTypeString}} group_node_label[, {{ArgTypeString}} module_name])
SYNTAXEXAMPLE: polystrip''move_to({{ArgTypeString}} label"NewObj", {{ArgType| 3x1 Python tuple}} p0"MyObj", {{ArgType| 3x1 Python tuple}} p110, ... {{ArgType| 3x1 Python tuple}} pn10,0)''
EXAMPLEDESCRIPTION: ''polystrip("ps_1",(0,0,0),(1,0,0),(1,0,0))''Transfers an object from its current material/object group node in the navigation tree to another node or optionally to another [[EM.Cube]] module.
DESCRIPTION: Creates or modifies a Polystrip object in the project workspace. Each point is represented with a Python tuple type. The poly_strip function is 'self-closing' -- there is no need to supply the first point again at the end of the point list.====msin====
====pyramid====SYNTAX: msin({{ArgTypeReal}} x, {{ArgTypeReal}} r)
SYNTAXEXAMPLE: pyramid''msin({{ArgTypeString}} label0.5, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} height2)''
EXAMPLEDESCRIPTION: ''pyramid("Pyramid_1",0,0,0,10,10,100)''Computes and returns the super-quadratic sine function of order r.
DESCRIPTION: Draws a pyramid object in the project workspace under the currently activated material group node, or modifies the pyramid named 'label' if it already exists.====nurbs_curve====
====radial_strip====SYNTAX: nurbs_curve({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)
SYNTAXEXAMPLE: radial_strip''nurbs_curve({{ArgTypeString}} label"nc_1", {{ArgTypeAny}} x0(0, {{ArgTypeAny}} y00, {{ArgTypeAny}} z00), {{ArgTypeAny}} radius(1, {{ArgTypeAny}} base_length0, {{ArgTypeAny}} angle0),(1,0,0))''
EXAMPLEDESCRIPTION: ''radial_strip("Radial_1"Creates or modifies a NURBS Curve object in the project workspace. Each point is represented with a Python tuple type. The curve is closed if p0 is specified again as pn,0otherwise,0,0,50,0,90)''it is open.
DESCRIPTION: Draws a radial strip object in the project workspace under the currently activated material group node, or modifies the radial strip object named 'label' if it already exists. ====nurbs_strip====
====rail_sweep====SYNTAX: nurbs_strip({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)
SYNTAXEXAMPLE: rail_sweep''nurbs_strip({{ArgTypeString}} rail_object"ns_1", {{ArgTypeString}} sweep_object(0,0,0),(1,0,0),(1,0,0))''
EXAMPLEDESCRIPTION: Creates or modifies a NURBS Strip object in the project workspace. Each point is represented with a Python tuple type. The nurbs_strip function is 'self-closing'rail_sweep("Curve_1","Curve_2")''-- there is no need to supply the first point again at the end of the point list.
DESCRIPTION: Rail-sweeps the specified sweep object along the specified curve object.====ohmic_loss====
====random_group====SYNTAX: ohmic_loss({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
SYNTAXEXAMPLE: random_group''ohmic_loss({{ArgTypeString}} label"FI_1", {{ArgTypeString}} key_object-10, {{ArgTypeString}} container_object-10, {{ArgTypeAny}} element_count-10,10,10,10)''
EXAMPLEDESCRIPTION: Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'label'random_group("Rand_1"already exists,"Rect_1","Box_1",100)''its properties are modified.
DESCRIPTION: Creates a random group using the specified key object and confines them in the specified container object.====parabola====
====rect_strip====SYNTAX: parabola({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)
SYNTAXEXAMPLE: rect_strip''parabola({{ArgTypeString}} label"Parabola _1", {{ArgTypeAny}} x00, {{ArgTypeAny}} y00, {{ArgTypeAny}} z00, {{ArgTypeAny}} side_x50, {{ArgTypeAny}} side_y20,0)''
EXAMPLEDESCRIPTION: Draws a parabola object in the project workspace under the currently activated material group node, or modifies the parabola named 'label'rect_strip(if it already exists. If the Boolean parameter "my_rectanglehalf_only"is 1,0,0,0,50,20)''only half of the parabola will be drawn.
DESCRIPTION: Draws a rectangle Strip object in the project workspace under the currently activated material group node, or modifies the rectangle strip object named 'label' if it already exists.====param_curve====
====revolve====SYNTAX: param_curve({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} model, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start, {{ArgTypeAny}} stop, {{ArgTypeAny}} step, {{ArgTypeAny}} function[, {{ArgTypeAny}} y(t), {{ArgTypeAny}} z(t)])
SYNTAXEXAMPLE: revolve''param_curve({{ArgTypeString}} label"Curve_1", {{ArgTypeString}} object0, {{ArgTypeAny}} x00, {{ArgTypeAny}} y00, {{ArgTypeAny}} z0"parametric", {{ArgTypeAny}} uX"xy", {{ArgTypeAny}} uY0, {{ArgTypeAny}} uZ10, {{ArgTypeAny}} rot_angle0.1,"cos(t)","sin(t)","t")''
EXAMPLEDESCRIPTION: ''revolve("Rev1","Line_1",0,0,0,0,0,1Generates a parametric curve in the project workspace under the currently activated material group node,360)or modifies the parametric curve named 'label'if it already exists.
DESCRIPTION: Creates or modifies a revolution object from a specified object. If modifying an existing revolution object, the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. The revolution angle "rot_angle" is given in degrees.====param_surface====
====rotate====SYNTAX: param_surface({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start1, {{ArgTypeAny}} stop1, {{ArgTypeAny}} step1, , {{ArgTypeAny}} start2, {{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} function)
SYNTAXEXAMPLE: rotate''param_surface({{ArgTypeString}} object"Surf_1", {{ArgTypeAny}} rot_angle_degree0, {{ArgTypeAny}} rot_axis_x0, {{ArgTypeAny}} rot_axis_y0, {{ArgTypeAny}} rot_axis_z"xy",0,10,0.1,0,10,0.1,"sin(x)*sin(y)")''
EXAMPLEDESCRIPTION: ''rotate("pyramid_1",45,1,1Generates a parametric surface in the project workspace under the currently activated material group node,0)or modifies the parametric surface named 'label'if it already exists.
DESCRIPTION: Rotates an object about a line passing through its LCS center and aligned along the specified direction vector (rot_axis) by the specified angle.====pec_group====
====roughen====SYNTAX: pec_group({{ArgTypeString}} label)
SYNTAXEXAMPLE: roughen''pec_group({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length"PEC_1")''
EXAMPLEDESCRIPTION: Creates a PEC material group in the current module. If the PEC group 'label'roughen("Rect_1"already exists,1,5)''the group is activated.
DESCRIPTION: Roughens the surface of the specified object based on the specified RMS height and correlation length.====pec_via_group====
====scale====SYNTAX: pec_via_group({{ArgTypeString}} label, {{ArgTypeAny}} host_layer)
SYNTAXEXAMPLE: scale''pec_via_group({{ArgTypeString}} object"PEC_1", {{ArgTypeAny}} scale_factor10)''
EXAMPLEDESCRIPTION: Creates an embedded PEC via set group in the current module. If the PEC via group 'label'scale("pyramid_1"already exists,2)''the group is activated.
DESCRIPTION: Scales an object by the specified scale factor.====pec_voltage_group====
====set_lcs_link====SYNTAX: pec_voltage_group({{ArgTypeString}} label, {{ArgTypeAny}} voltage)
SYNTAXEXAMPLE: set_lcs_link''pec_voltage_group({{ArgTypeString}} object"PEC_1", {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off10)''
EXAMPLEDESCRIPTION: Creates a fixed-potential PEC object group in the current module. If the PEC group 'label'set_lcs_link("pyramid_1"already exists,"box_1",50,50,0)''the group is activated.
DESCRIPTION: Links the LCS of the first object to the LCS of the second object by the specified offset values along the three axes.====penetrable_surface_group====
====set_rot====SYNTAX: penetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)
SYNTAXEXAMPLE: set_rot''penetrable_surface_group({{ArgTypeString}} object"Penet_1", {{ArgTypeAny}} rot_x2.2, {{ArgTypeAny}} rot_y0.0001, {{ArgTypeAny}} rot_z1)''
EXAMPLEDESCRIPTION: Creates a penetrable surface group in [[EM.Terrano]]. If the penetrable surface group 'label'set_rot("pyramid_1"already exists,0,0,45)''the group is activated.
DESCRIPTION: Sets the three rotation angles of an object.====penetrable_volume_group====
====set_rot_link====SYNTAX: penetrable_volume_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
SYNTAXEXAMPLE: set_rot_link''penetrable_volume_group({{ArgTypeString}} object"Vol_Penet_1", {{ArgTypeString}} lcs_obj2.2, {{ArgTypeAny}} x_off_deg, {{ArgTypeAny}} y_off_deg, {{ArgTypeAny}} z_off_deg0.0001)''
EXAMPLEDESCRIPTION: Creates a penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'label'set_rot_link("pyramid_1"already exists,"box_1",0,0,45)''the group is activated.
DESCRIPTION: Links the rotation angles of the LCS of the first object to the rotation angles of the LCS of the second object by the specified angle offset values in degrees along the three axes.====pipe_sweep====
====slice====SYNTAX: pipe_sweep({{ArgTypeString}} object, {{ArgTypeAny}} radius)
SYNTAXEXAMPLE: slice''pipe_sweep({{ArgTypeString}} object"Curve_1", {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ5)''
EXAMPLEDESCRIPTION: ''slice("Rect_1",5)''Creates a pipe version of a given curve object.
DESCRIPTION: Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.====planewave====
====sphere====SYNTAX: planewave({{ArgTypeString}} label, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization)
SYNTAX'EXAMPLE: sphere''planewave({{ArgTypeString}} label"PW_1", {{ArgTypeAny}} x0180, {{ArgTypeAny}} y00, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]"tm")''
EXAMPLEDESCRIPTION: Creates a plane wave source. If the plane wave source 'label'sphere("Sphere_1"already exists,0,0,0,10,0,180)''its properties are modified.
DESCRIPTION: Draws a sphere object in the project workspace under the currently activated Material Group node, or modifies the sphere named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the sphere's azimuth axis.====plot_file====
====spiral_curve====SYNTAX: plot_file({{ArgTypeString}} filename)
SYNTAXEXAMPLE: spiral_curve''plot_file({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual"D0.DAT")''
EXAMPLEDESCRIPTION: ''spiral_curve("Spiral _1",0,0,0,10,50,5,0,0)''Plots the contents of a specified data file in EM.Grid.
DESCRIPTION: Draws a spiral curve object in the project workspace under the currently activated material group node, or modifies the spiral curve named 'label' if it already exists. If the Boolean parameter "spiral_dir" is 1, the spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1, a dual-arm spiral curve will be drawn. ====pmc_group====
====spiral_strip====SYNTAX: pmc_group({{ArgTypeString}} label)
SYNTAXEXAMPLE: spiral_strip''pmc_group({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} width, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual"PMC_1")''
EXAMPLEDESCRIPTION: Creates a PMC material group in the current module. If the PMC group 'label'spiral_strip("Spiral _1"already exists,0,0,0,10,50,5,0,0)''the group is activated.
DESCRIPTION: Draws a spiral strip object in the project workspace under the currently activated material group node, or modifies the spiral strip named 'label' if it already exists. If the Boolean parameter "spiral_dir" is 1, the spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1, a dual-arm spiral curve will be drawn. ====point====
====spline_fit====SYNTAX: point({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)
SYNTAXEXAMPLE: spline_fit''point({{ArgTypeString}} object"Point_1",0,0,10)''
EXAMPLEDESCRIPTION: Draws a point in the project workspace under the currently activated material group node, or modifies the point named 'label'spline_fit("Poly_1")''if it already exists.
DESCRIPTION: Applies spline fit transformation on a specified polymesh, polyline or polystrip object.====polygon_reg====
====strip_sweep====SYNTAX: polygon_reg({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} n_sides)
SYNTAXEXAMPLE: strip_sweep''polygon_reg({{ArgTypeString}} object"ts_1", {{ArgTypeAny}} width0,0,0,50,100,80,1)''
EXAMPLEDESCRIPTION: ''strip_sweep("Curve_1"Draws a regular polygon object in the project workspace under the currently activated material group node,5)or modifies the regular polygon object named 'label'if it already exists.
DESCRIPTION: Creates a strip version of a given curve object.====polygonize====
====subtract====SYNTAX: polygonize({{ArgTypeString}} object, {{ArgTypeAny}} side_length)
SYNTAXEXAMPLE: subtract''polygonize({{ArgTypeString}} label"Cric_1", {{ArgTypeString}} object_1, {{ArgTypeString}} object_22)''
EXAMPLEDESCRIPTION: ''subtract("Subtract_Object","Rect_Strip1","Rect_Strip2")''Polygonizes the specified surface or curve object by the specified side length. The results is a polystrip or a polyline.
DESCRIPTION: Creates a Boolean object named 'label' by subtracting object_2 from object_1. An error will be thrown if a Boolean object named 'label' already exists.====polyline====
====superquad====SYNTAX: polyline({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)
SYNTAXEXAMPLE: superquad''polyline({{ArgTypeString}} label"pl_1", {{ArgTypeAny}} x0(0, {{ArgTypeAny}} y00, {{ArgTypeAny}} z00), {{ArgTypeAny}} diam_x(1, {{ArgTypeAny}} diam_y0, {{ArgTypeAny}} order0),(1,0,0))''
EXAMPLEDESCRIPTION: ''superquad("SuperQuad_1"Creates or modifies a PolyLine object in the project workspace. Each point is represented with a Python tuple type. The poly_line is closed if p0 is specified again as pn,0otherwise,0,0,50,20,4)''it is open.
DESCRIPTION: Draws a super-quadratic curve object in the project workspace under the currently activated material group node, or modifies the super-quadratic curve named 'label' if it already exists. If order = 2, the curve reduces to an ellipse. Higher order makes the round edges sharper. An infinite order reduces the curve to a rectangle. ===polymesh====
====taper_strip====SYNTAX: polymesh({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} edge_length)
SYNTAXEXAMPLE: taper_strip''polymesh({{ArgTypeString}} label"Poly_1", {{ArgTypeAny}} x0"Cric_1", {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAny}} is_expo2)''
EXAMPLEDESCRIPTION: ''taper_strip("ts_1",0,0,0,50,100,80,1)''Discretizes the specified solid or surface object by the specified edge length. The results is a polymesh object.
DESCRIPTION: Draws a taper strip object in the project workspace under the currently activated material group node, or modifies the taper strip object named 'label' if it already exists. If the Boolean parameters "is_expo" is 1, an exponential taper will be drawn. ====polystrip====
====torus====SYNTAX: polystrip({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)
SYNTAXEXAMPLE: torus''polystrip({{ArgTypeString}} label"ps_1", {{ArgTypeAny}} x0(0, {{ArgTypeAny}} y00, {{ArgTypeAny}} z00), {{ArgTypeAny}} radius_major(1, {{ArgTypeAny}} radius_minor[0, {{ArgTypeAny}} start_angle0), {{ArgTypeAny}} end_angle](1,0,0))''
EXAMPLEDESCRIPTION: Creates or modifies a Polystrip object in the project workspace. Each point is represented with a Python tuple type. The poly_strip function is 'self-closing'torus("Torus_1",0,0,0,50,20)''-- there is no need to supply the first point again at the end of the point list.
DESCRIPTION: Draws an torus object in the project workspace under the currently activated material group node, or modifies the torus named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the torus's azimuth axis.====port_definition_custom====
====translate_by====SYNTAX: port_definition_custom({{ArgTypeString}} label, ({{ArgTypeString}} port_1_src_1, {{ArgTypeString}} port_1_src_2, ..., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance), ...)
SYNTAXEXAMPLE: translate_by''port_definition_custom({{ArgTypeString}} object"PD_1", {{ArgTypeReal}} x_dist("LS_1", {{ArgTypeReal}} y_dist"LS_2", {{ArgTypeReal}} z_dist50),,("LS_3","LS_4",50))''
EXAMPLEDESCRIPTION: Creates a custom port definition observable. If the observable 'label'translate_by("MyObj"already exists,10,10,x)''its properties are modified.
DESCRIPTION: Translates an object by the specified distances in each direction.====port_definition_default====
====translate_to====SYNTAX: port_definition_default({{ArgTypeString}} label)
SYNTAXEXAMPLE: translate_to''port_definition_default({{ArgTypeString}} object, {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest"PD_1")''
EXAMPLEDESCRIPTION: Creates a default port definition observable. If the observable 'label'translate_to("MyObj"already exists,20,20,x2)''its properties are modified.
DESCRIPTION: Translates an object to the specified destination.====probe_gap_src====
====triangle_strip====SYNTAX: probe_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} via_object, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
SYNTAXEXAMPLE: triangle_strip''probe_gap_src({{ArgTypeString}} label"Probe_1", {{ArgTypeAny}} x0"Via_1", {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAny}} angle0)''
EXAMPLEDESCRIPTION: Creates a probe gap circuit source in [[EM.Picasso]]. If the probe gap source 'label'triangle_strip("ts_1"already exists,0,0,0,50,100,90)''its properties are modified.
DESCRIPTION: Draws a triangle strip object in the project workspace under the currently activated material group node, or modifies the triangle strip object named 'label' if it already exists. ====pyramid====
====union====SYNTAX: pyramid({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} height)
SYNTAXEXAMPLE: union''pyramid({{ArgTypeString}} label"Pyramid_1", {{ArgTypeString}} object_10, {{ArgTypeString}} object_20,0,10,10,100)''
EXAMPLEDESCRIPTION: ''union("Union_Object","Rect_Strip1"Draws a pyramid object in the project workspace under the currently activated material group node,"Rect_Strip2")or modifies the pyramid named 'label'if it already exists.
DESCRIPTION: Creates a Boolean object named 'label' by unioning object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.====radial_strip====
== EM.Cube's Python Functions for Material or Object Group Creation ==SYNTAX: radial_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} base_length, {{ArgTypeAny}} angle)
====pec_group====EXAMPLE: ''radial_strip("Radial_1",0,0,0,50,0,90)''
SYNTAXDESCRIPTION: pec_group({{ArgTypeString}} Draws a radial strip object in the project workspace under the currently activated material group node, or modifies the radial strip object named 'label)' if it already exists.
EXAMPLE: ''pec_group("PEC_1")''====rail_sweep====
DESCRIPTIONSYNTAX: Creates a PEC material group in the current module. If the PEC group 'label' already existsrail_sweep({{ArgTypeString}} rail_object, the group is activated.{{ArgTypeString}} sweep_object)
====pec_voltage_group====EXAMPLE: ''rail_sweep("Curve_1","Curve_2")''
SYNTAXDESCRIPTION: pec_voltage_group({{ArgTypeString}} label, {{ArgTypeAny}} voltage)Rail-sweeps the specified sweep object along the specified curve object.
EXAMPLE: ''pec_voltage_group("PEC_1",10)''====ramp====
DESCRIPTIONSYNTAX: Creates a fixed-potential PEC object group in the current module. If the PEC group 'label' already exists, the group is activated.ramp({{ArgTypeReal}} x)
====pec_via_group====EXAMPLE: ''ramp(0.5)''
SYNTAXDESCRIPTION: pec_via_group({{ArgTypeString}} labelComputes and returns the ramp function: x if x>0, {{ArgTypeAny}} host_layer)0 if x<0.
EXAMPLE: ''pec_via_group("PEC_1",10)''====rand====
DESCRIPTIONSYNTAX: Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already existsrand({{ArgTypeReal}} x, the group is activated.{{ArgTypeReal}} y)
====thinwire_group====EXAMPLE: ''rand(0,1)''
SYNTAXDESCRIPTION: thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)Computes and returns a random number between x and y using an uniform distribution.
EXAMPLE: ''thinwire_group("Thinwire_1",4)''====random_group====
DESCRIPTIONSYNTAX: Creates a Thinwire material group in the current module. If the thin wire group 'random_group({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeString}} key_object, {{ArgTypeString}} container_object, {{ArgTypeAny}} element_count)
====pmc_group====EXAMPLE: ''random_group("Rand_1","Rect_1","Box_1",100)''
SYNTAXDESCRIPTION: pmc_group({{ArgTypeString}} label)Creates a random group using the specified key object and confines them in the specified container object.
EXAMPLE: ''pmc_group("PMC_1")''====rcs_bistatic====
DESCRIPTIONSYNTAX: Creates a PMC material group in the current module. If the PMC group 'rcs_bistatic({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])
====slot_group====EXAMPLE: ''rcs_bistatic("RCS_1",1,1)''
SYNTAXDESCRIPTION: slot_group({{ArgTypeString}} Creates a bistatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the observable 'label)' already exists, its properties are modified.
EXAMPLE: ''slot_group("PMC_1")''====rcs_monostatic====
DESCRIPTIONSYNTAX: Creates a slot trace group in the current module. If the slot trace group 'rcs_monostatic({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])
====dielectric_group====EXAMPLE: ''rcs_monostatic("RCS_1",1,1)''
SYNTAXDESCRIPTION: dielectric_group({{ArgTypeString}} Creates a monostatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the observable 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)its properties are modified.
EXAMPLE: ''dielectric_group("Dielectric_1","my_eps",0,1,0)''====receiver_set====
DESCRIPTIONSYNTAX: Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'receiver_set({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)
====impenetrable_surface_group====EXAMPLE: ''receiver_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)''
SYNTAXDESCRIPTION: impenetrable_surface_group({{ArgTypeString}} Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)its properties are modified.
EXAMPLE: ''impenetrable_surface_group("Impenet_1",2.2,0.0001)''====rect====
DESCRIPTIONSYNTAX: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'label' already exists, the group is activated.rect({{ArgTypeReal}} x)
====penetrable_surface_group====EXAMPLE: ''rect(0.1)''
SYNTAXDESCRIPTION: penetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigmaComputes and returns the rectangular window function: 1 if x<0.5, {{ArgTypeAny}} thickness)0 elsewhere.
EXAMPLE: ''penetrable_surface_group("Penet_1",2.2,0.0001, 1)''====rect_gap_src====
DESCRIPTIONSYNTAX: Creates a penetrable surface group in [[EM.Terrano]]. If the penetrable surface group 'rect_gap_src({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
====penetrable_volume_group====EXAMPLE: ''rect_gap_src("GAP_1","Rect_1",0,0)''
SYNTAXDESCRIPTION: penetrable_volume_group({{ArgTypeString}} Creates a strip gap circuit source in [[EM.Picasso]] or [[EM.Libera]]. If the strip gap source 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)its properties are modified.
EXAMPLE: ''penetrable_volume_group("Vol_Penet_1",2.2,0.0001)''====rect_strip====
DESCRIPTIONSYNTAX: Creates a penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'rect_strip({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side_x, {{ArgTypeAny}} side_y)
====terrain_group====EXAMPLE: ''rect_strip("my_rectangle",0,0,0,50,20)''
SYNTAXDESCRIPTION: terrain_group({{ArgTypeString}} Draws a rectangle Strip object in the project workspace under the currently activated material group node, or modifies the rectangle strip object named 'label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)' if it already exists.
EXAMPLE: ''terrain_group("Terrain_1",5.0,0.0001)''====rename====
DESCRIPTIONSYNTAX: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label' already existsrename({{ArgTypeString}} new_label, the group is activated.{{ArgTypeString}} old_label)
====base_point_group====EXAMPLE: ''rename("Box_2","Box_1")''
SYNTAXDESCRIPTION: base_point_group({{ArgTypeString}} label)Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.
EXAMPLE: ''base_point_set("BP_Set_1")''====resistance====
DESCRIPTIONSYNTAX: Creates a base point set in [[EM.Terrano]]. If the base point set group 'resistance({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)
====virtual_group====EXAMPLE: ''resistance("FI_1",0,0,-10,0,0,10,-10,-10,0,10,10,0)''
SYNTAXDESCRIPTION: virtual_group({{ArgTypeString}} Creates a resistance integral observable in [[EM.Ferma]]. If the observable 'label)' already exists, its properties are modified.
EXAMPLE: ''virtual_group("VIR_1")''====resistor====
DESCRIPTIONSYNTAX: Creates a virtual object group in [[EM.Terrano]]. If the virtual group 'resistor({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} resistance)
====impedance_surface_group====EXAMPLE: ''resistor("Res_1","Line_1",25,50)''
SYNTAXDESCRIPTION: impedance_surface_group({{ArgTypeString}} Creates a resistor in [[EM.Tempo]]. If the resistor 'label' already exists, {{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag)its properties are modified.
EXAMPLE: ''impedance_surface_group("IMP_1",100,-100)''====revolve====
DESCRIPTIONSYNTAX: Creates a impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'revolve({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle)
====conductive_sheet_group====EXAMPLE: ''revolve("Rev1","Line_1",0,0,0,0,0,1,360)''
SYNTAXDESCRIPTION: conductive_sheet_groupCreates or modifies a revolution object from a specified object. If modifying an existing revolution object, the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and ({{ArgTypeString}} labeluX, {{ArgTypeAny}} sigmauY, {{ArgTypeAny}} thicknessuZ)specifies the revolution axis. The revolution angle "rot_angle" is given in degrees.
EXAMPLE: ''conductive_sheet_group("Cond_1",100, 0.01)''====rosen====
DESCRIPTIONSYNTAX: Creates rosen({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} a conductive sheet group in [[EM.Picasso]]. If the conductive sheet group 'label' already exists, the group is activated.{{ArgTypeReal}} b)
====charge_group====EXAMPLE: ''rosen(0.5,0,1,2)''
SYNTAXDESCRIPTION: charge_groupComputes and returns the Rosenbrock function: (a-x)**2 + b*({{ArgTypeString}} label, {{ArgTypeAny}} densityy-x**2)**2.
EXAMPLE: ''charge_group("Charge_1",-1e-5)''====rotate====
DESCRIPTIONSYNTAX: Creates a volume charge source group in [[EM.Ferma]]. If the charge group 'label' already existsrotate({{ArgTypeString}} object, the group is activated.{{ArgTypeAny}} rot_angle_degree, {{ArgTypeAny}} rot_axis_x, {{ArgTypeAny}} rot_axis_y, {{ArgTypeAny}} rot_axis_z)
====magnet_group====EXAMPLE: ''rotate("pyramid_1",45,1,1,0)''
SYNTAXDESCRIPTION: magnet_groupRotates an object about a line passing through its LCS center and aligned along the specified direction vector ({{ArgTypeString}} label, {{ArgTypeAny}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mzrot_axis)by the specified angle.
EXAMPLE: ''magnet_group("Magnet_1",1,0,0,100)''====roughen====
DESCRIPTIONSYNTAX: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'roughen({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeString}} object, {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length)
====volume_current_group====EXAMPLE: ''roughen("Rect_1",1,5)''
SYNTAXDESCRIPTION: volume_current_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz)Roughens the surface of the specified object based on the specified RMS height and correlation length.
EXAMPLE: ''volume_current_group("Magnet_1",0,0,1e6)''====run_analysis====
DESCRIPTIONSYNTAX: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'label' already exists, the group is activated.run_analysis()
====wire_current_group====DESCRIPTION: Runs a simulation in the current active [[EM.Cube]] computational module.
SYNTAX: wire_current_group({{ArgTypeString}} label, {{ArgTypeAny}} current, {{ArgTypeAny}} wire_radius)====save_data====
EXAMPLESYNTAX: ''wire_current_groupsave_data("Magnet_1",1,0.5{{ArgTypeString}} directory_name)''
DESCRIPTIONEXAMPLE: Creates a wire current source group in [[EM.Ferma]]. If the wire current group 'label' already exists, the group is activated.save_data("Simulation_Data")''
== DESCRIPTION: Saves [[EM.Cube]]'s Python Functions for Source & Lumped Device Definition ==output simulation data files under the specified directory.
====lumped_srcsawtooth====
SYNTAX: lumped_srcsawtooth({{ArgTypeStringArgTypeReal}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]x)
EXAMPLE: ''lumped_srcsawtooth("LS_1","Line_1",50,0.5)''
DESCRIPTION: Creates a lumped source in [[EM.Tempo]]. If Computes and returns the lumped source 'label' already existsascending periodic sawtooth function of period T = 2, its properties are modifiedoscillating between two values +1 and -1 and having a zero value of at x = 0.
====distributed_srcscale====
SYNTAX: distributed_srcscale({{ArgTypeString}} labelobject, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} field_dir, {{ArgTypeAny}} profile[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]scale_factor)
EXAMPLE: ''distributed_srcscale("DS_1pyramid_1","Rect_1","+y","uniform"2)''
DESCRIPTION: Creates a distributed source in [[EM.Tempo]]. If Scales an object by the distributed source 'label' already exists, its properties are modifiedspecified scale factor.
====microstrip_srcselect_module====
SYNTAX: microstrip_srcselect_module({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} height, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]module_name)
EXAMPLE: ''microstrip_srcselect_module("MS_1","Rect_1",1[[EM.5,"+xTempo]]")''
DESCRIPTION: Creates a microstrip port source in Selects and sets [[EM.TempoCube]]. If the microstrip port 'label' already exists, its properties are modifieds active module.
====cpw_srcset_bandwidth====
SYNTAX: cpw_srcset_bandwidth({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} spacing, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]value)
EXAMPLE: ''cpw_srcset_bandwidth("CPW_1","Rect_1",1.5,"+x"1e9)''
DESCRIPTION: Creates a CPW port source in Sets [[EM.TempoCube]]. If the CPW port 'label' already exists, its properties are modifieds frequency bandwidth.
====coaxial_srcset_boundary_conditions====
SYNTAX: coaxial_srcset_boundary_conditions({{ArgTypeString}} labelxn_type, {{ArgTypeAnyArgTypeString}} cylinder_objectxp_type, {{ArgTypeAnyArgTypeString}} outer_radiusyn_type, {{ArgTypeAnyArgTypeString}} edge[yp_type, {{ArgTypeAnyArgTypeString}} amplitudezn_type, {{ArgTypeAny}} phase, {{ArgTypeAnyArgTypeString}} resistance]zp_type)
EXAMPLE: ''coaxial_srcset_domain_offset_lambda("COAX_1pml","Cyl_1pml",1.5"pml","pml","pec","+zpml")''
DESCRIPTION: Creates a coaxial port source in Sets [[EM.Tempo]]. If the coaxial port 'label' already existss domain boundary conditions domain offset on the &plusmn;X, its properties &plusmn;Y and &plusmn;Z boundary walls. The options are modified"pec", "pmc" and "pml".
====waveguide_srcset_domain_offset====
SYNTAX: waveguide_srcset_domain_offset({{ArgTypeString}} label, {{ArgTypeAny}} box_objectdxn_offset, {{ArgTypeAny}} offsetdxp_offset, {{ArgTypeAny}} is_negative[dyn_offset, {{ArgTypeAny}} amplitudedyp_offset, {{ArgTypeAny}} phasedzn_offset, {{ArgTypeAny}} resistance]dzp_offset)
EXAMPLE: ''waveguide_srcset_domain_offset("WG_1"20,"Box_1"20,5020,20,0,10)''
DESCRIPTION: Creates a waveguide port source in [[EM.Tempo]]. If Sets the waveguide port 'label' already existsdomain offset values along the &plusmn;X, its properties are modified&plusmn;Y and &plusmn;Z directions in project units.
====wire_gap_srcset_domain_offset_lambda====
SYNTAX: wire_gap_srcset_domain_offset_lambda({{ArgTypeString}} label, {{ArgTypeAny}} line_objectdxn_offset, {{ArgTypeAny}} offsetdxp_offset, {{ArgTypeAny}} polarity[dyn_offset, {{ArgTypeAny}} amplitudedyp_offset, {{ArgTypeAny}} phasedzn_offset, {{ArgTypeAny}} resistance]dzp_offset)
EXAMPLE: ''wire_gap_srcset_domain_offset_lambda("WIG_1"0.1,"Line_1"0.1,500.1,0.1,0,0.25)''
DESCRIPTION: Creates a wire gap circuit source in [[EM.Libera]]. If Sets the wire gap source 'label' already existsdomain offset values along the &plusmn;X, its properties are modified&plusmn;Y and &plusmn;Z directions in free-space wavelengths.
====rect_gap_srcset_frequency====
SYNTAX: rect_gap_srcset_frequency({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]value)
EXAMPLE: ''rect_gap_srcset_frequency("GAP_1","Rect_1",0,02.4e9)''
DESCRIPTION: Creates a strip gap circuit source in Sets [[EM.PicassoCube]] or [[EM.Libera]]. If the strip gap source 'label' already exists, its properties are modifieds center frequency.
====probe_gap_srcset_lcs_link====
SYNTAX: probe_gap_srcset_lcs_link({{ArgTypeString}} labelobject, {{ArgTypeAny}} via_object, {{ArgTypeAnyArgTypeString}} polarity[lcs_obj, {{ArgTypeAny}} amplitudex_off, {{ArgTypeAny}} phasey_off, {{ArgTypeAny}} resistance]z_off)
EXAMPLE: ''probe_gap_srcset_lcs_link("Probe_1pyramid_1","Via_1box_1",50,50,0)''
DESCRIPTION: Creates a probe gap circuit source in [[EM.Picasso]]. If Links the probe gap source 'label' already exists, its properties are modifiedLCS of the first object to the LCS of the second object by the specified offset values along the three axes.
====wave_portset_periodic====
SYNTAX: wave_portset_periodic({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitudeis_periodic, {{ArgTypeAny}} phasespacingX, {{ArgTypeAny}} resistance]spacingY)
EXAMPLE: ''wave_portset_periodic("WP_1"1,"Rect_1"50,0,050)''
DESCRIPTION: Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If Designates the wave port 'label' already exists, its properties are modifiedphysical structure as periodic and sets the periods along the X and Y directions.
====short_dipoleset_rot====
SYNTAX: short_dipoleset_rot({{ArgTypeString}} labelobject, {{ArgTypeAny}} x0rot_x, {{ArgTypeAny}} y0rot_y, {{ArgTypeAny}} z0, {{ArgTypeAny}} length, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phaserot_z)
EXAMPLE: ''short_dipoleset_rot("SD_1pyramid_1",0,0,50,3,0,0,1,1,045)''
DESCRIPTION: Creates a Hertzian short dipole source. If Sets the short dipole source 'label' already exists, its properties are modifiedthree rotation angles of an object.
====planewaveset_rot_link====
SYNTAX: planewaveset_rot_link({{ArgTypeString}} labelobject, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} thetax_off_deg, {{ArgTypeAny}} phiy_off_deg, {{ArgTypeAny}} polarizationz_off_deg)
'EXAMPLE: ''planewaveset_rot_link("PW_1pyramid_1",180"box_1",0,"tm"0,45)''
DESCRIPTION: Creates a plane wave source. If Links the plane wave source 'label' already exists, its properties are modifiedrotation angles of the LCS of the first object to the rotation angles of the LCS of the second object by the specified angle offset values in degrees along the three axes.
====gauss_beamset_stackup_order====
SYNTAX: gauss_beamset_stackup_order("THS", {{ArgTypeString}} labellabel_1, {{ArgTypeAnyArgTypeString}} thetalabel_2, {{ArgTypeAny}} phi..., {{ArgTypeAnyArgTypeString}} polarizationlabel_n, {{ArgTypeAny}} focus_x, {{ArgTypeAny}} focus_y, {{ArgTypeAny}} focus_z, {{ArgTypeAny}} radius, {{ArgTypeAny}} p_mode, {{ArgTypeAny}} q_mode"BHS")
EXAMPLE: ''gauss_beambackground_layer("PW_1THS",180"Top_Layer",0"Mid_Layer","tmBottom_Layer",0,0,0,20,0,0"BHS")''
DESCRIPTION: Creates a Gaussian beam source in Sets the hierarchy of [[EM.TempoPicasso]]'s background layer stackup from top to bottom. If The sequence should always start with "THS" standing for the Gaussian beam source 'label' already exists, its properties are modifiedtop half-space and must end in "BHS" standing for the bottom half-space. All the intermediate finite-thickness substrate layers must be included and listed in the right order.
====huygens_srcset_units====
SYNTAX: huygens_srcset_units({{ArgTypeString}} label, {{ArgTypeAny}} filename[, {{ArgTypeAny}} set_lcs, {{ArgTypeAny}} polarization, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} x_rot, {{ArgTypeAny}} y_rot, {{ArgTypeAny}} z_rot]units)
EXAMPLE: ''huygens_srcset_units("HS_1meter","Huygens_1.HUY",1,100,100,0,0,0,0)''
DESCRIPTION: Creates a Huygens sourceSets [[EM. If the Huygens source Cube]]'label' already exists, its properties are modifieds project length units.
====transmitter_setsgn====
SYNTAX: transmitter_setsgn({{ArgTypeStringArgTypeReal}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_zx)
EXAMPLE: ''transmitter_setsgn("TX_1","PT_1","DPL_STD-1.RAD",0,90,0)''
DESCRIPTION: Creates a transmitter set in [[EM.Terrano]]. If Computes and returns the transmitter set 'label' already existssignum function: 1 if x>0, its properties are modified-1 if x<0.
====resistorshort_dipole====
SYNTAX: resistorshort_dipole({{ArgTypeString}} label, {{ArgTypeAny}} line_objectx0, {{ArgTypeAny}} offsety0, {{ArgTypeAny}} resistancez0, {{ArgTypeAny}} length, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase)
EXAMPLE: ''resistorshort_dipole("Res_1SD_1","Line_1"0,250,50,3,0,0,1,1,0)''
DESCRIPTION: Creates a resistor in [[EM.Tempo]]Hertzian short dipole source. If the resistor short dipole source 'label' already exists, its properties are modified.
====capacitorsigmoid====
SYNTAX: capacitorsigmoidnc({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} capacitance_pFa)
EXAMPLE: ''capacitorsigmoid("Cap_1"0.5,"Line_1",25,101)''
DESCRIPTION: Creates a capacitor in [[EM.Tempo]]. If Computes and returns the capacitor 'label' already exists, its properties are modifiedsigmoid function of slope a: 2/(1 + exp(-a*x)) - 1.
====inductorsinc====
SYNTAX: inductorsinc({{ArgTypeStringArgTypeReal}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} inductance_nHx)
EXAMPLE: ''inductorsinc("Cap_1","Line_1",25,100.5)''
DESCRIPTION: Creates a inductor in [[EM.Tempo]]. If Computes and returns the inductor 'label' already exists, its properties are modifiedsinc function: sin(pi*x)/(pi*x).
====diodeslice====
SYNTAX: diodeslice({{ArgTypeString}} labelobject, {{ArgTypeAny}} line_objectx0, {{ArgTypeAny}} polarityy0, {{ArgTypeAny}} is_fAz0, {{ArgTypeAny}} temperature_KuX, {{ArgTypeAny}} ideality_factoruY, {{ArgTypeAny}} uZ)
EXAMPLE: ''diodeslice("Diode_1Rect_1","Line_1",25,0,10,300,15)''
DESCRIPTION: Creates a diode in [[EM.Tempo]]. If Slices the diode 'label' already exists, its properties are modifiedspecified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.
== EM.Cube's Python Functions for Observable Definition ==slot_group====
====port_definition_default====SYNTAX: slot_group({{ArgTypeString}} label)
SYNTAXEXAMPLE: port_definition_default''slot_group({{ArgTypeString}} label"PMC_1")''
EXAMPLEDESCRIPTION: Creates a slot trace group in the current module. If the slot trace group 'label'port_definition_default("PD_1")''already exists, the group is activated.
DESCRIPTION: Creates a default port definition observable. If the observable 'label' already exists, its properties are modified.====solution_plane====
====port_definition_custom====SYNTAX: solution_plane({{ArgTypeString}} label, {{ArgTypeAny}} field_sensor_label, {{ArgTypeAny}} is_quasi)
SYNTAXEXAMPLE: port_definition_custom''solution_plane({{ArgTypeString}} label"FI_1", ({{ArgTypeString}} port_1_src_1, {{ArgTypeString}} port_1_src_2, ..., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance)"FS_1", ...1)''
EXAMPLEDESCRIPTION: Creates a 2D solution plane observable in [[EM.Ferma]]. If the observable 'label'port_definition_custom("PD_1"already exists,("LS_1","LS_2",50),,("LS_3","LS_4",50))''its properties are modified.
DESCRIPTION: Creates a custom port definition observable. If the observable 'label' already exists, its properties are modified.====sphere====
====farfield====SYNTAX: sphere({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])
SYNTAXEXAMPLE: farfield''sphere({{ArgTypeString}} label"Sphere_1", {{ArgTypeAny}} theta_incr0, {{ArgTypeAny}} phi_incr0,0,10,0,180)''
EXAMPLEDESCRIPTION: Draws a sphere object in the project workspace under the currently activated Material Group node, or modifies the sphere named 'label'farfield("FF_1",1,1)'if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the sphere's azimuth axis.
DESCRIPTION: Creates a far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.====spiral_curve====
====rcs_bistatic====SYNTAX: spiral_curve({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual)
SYNTAXEXAMPLE: rcs_bistatic''spiral_curve({{ArgTypeString}} label"Spiral _1", {{ArgTypeAny}} theta_incr0, {{ArgTypeAny}} phi_incr0,0,10,50,5,0,0)''
EXAMPLEDESCRIPTION: Draws a spiral curve object in the project workspace under the currently activated material group node, or modifies the spiral curve named 'label'rcs_bistatic(if it already exists. If the Boolean parameter "RCS_1spiral_dir",is 1,the spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1)'', a dual-arm spiral curve will be drawn.
DESCRIPTION: Creates a bistatic RCS observable. If the observable 'label' already exists, its properties are modified.====spiral_strip====
====current_dist====SYNTAX: spiral_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} width, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual)
SYNTAXEXAMPLE: current_dist''spiral_strip({{ArgTypeString}} label"Spiral _1",0,0,0,10,50,5,0,0)''
EXAMPLEDESCRIPTION: Draws a spiral strip object in the project workspace under the currently activated material group node, or modifies the spiral strip named 'label'current_dist(if it already exists. If the Boolean parameter "CD_1spiral_dir")''is 1, the spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1, a dual-arm spiral curve will be drawn.
DESCRIPTION: Creates a current distribution observable. If the observable 'label' already exists, its properties are modified.====spline_fit====
====field_sensor====SYNTAX: spline_fit({{ArgTypeString}} object)
SYNTAXEXAMPLE: field_sensor''spline_fit({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples"Poly_1")''
EXAMPLEDESCRIPTION: ''field_sensor("FS_1"Applies spline fit transformation on a specified polymesh,"z",0,0,0,100,100,0,25,25,0)''polyline or polystrip object.
DESCRIPTION: Creates a near-field sensor observable. If the observable 'label' already exists, its properties are modified.====spline2====
====field_sensor_grid====SYNTAX: spline2({{ArgTypeReal}} x)
SYNTAXEXAMPLE: field_sensor_grid''spline2({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z01.0)''
EXAMPLEDESCRIPTION: ''field_sensor_grid("FS_1","z",0,0,0)''Computes and returns the quadratic B-spline function.
DESCRIPTION: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====spline3====
====field_probe====SYNTAX: spline3({{ArgTypeReal}} x)
SYNTAXEXAMPLE: field_probe''spline3({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z01.0)''
EXAMPLEDESCRIPTION: ''field_probe("FS_1",0,0,50)''Computes and returns the cubic B-spline function.
DESCRIPTION: Creates a temporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====sqr_wave====
====receiver_set====SYNTAX: sqr_wave({{ArgTypeReal}} x)
SYNTAXEXAMPLE: receiver_set''sqr_wave({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z0.5)''
EXAMPLEDESCRIPTION: ''receiver_set("TX_1"Computes and returns the periodic square wave function of period T = 2,"PT_1","DPL_STDoscillating between two values +1 and -1 and having a value of +1 at x = 0.RAD",0,90,0)''
DESCRIPTION: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label' already exists, its properties are modified.====sqr2====
====huygens_surface====SYNTAX: sqr2({{ArgTypeReal}} x, {{ArgTypeReal}} y)
SYNTAXEXAMPLE: huygens_surface''sqr2({{ArgTypeString}} label0, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples1)''
EXAMPLEDESCRIPTION: ''huygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)''Computes and returns the sum of squares of x and y: x**2 + y**2.
DESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, its properties are modified.====sqr3====
====huygens_surface_grid====SYNTAX: sqr2({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} z)
SYNTAXEXAMPLE: huygens_surface_grid''sqr2({{ArgTypeString}} label0, {{ArgTypeAny}} x11, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z22)''
EXAMPLEDESCRIPTION: ''huygens_surface_grid("HS_1"Computes and returns the sum of squares of x,-10,-10,-10,10,10,10)''y and z: x**2 + y**2 + z**2.
DESCRIPTION: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label' already exists, its properties are modified.====sqrt2====
====voltage_integral====SYNTAX: sqrt2({{ArgTypeReal}} x, {{ArgTypeReal}} y)
SYNTAXEXAMPLE: voltage_integral''sqrt2({{ArgTypeString}} label0, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z21)''
EXAMPLEDESCRIPTION: ''voltage_integralComputes and returns the radius of the 2D point ("FI_1"x,0,0,-10,0,0,10y): sqrt(x**2 + y**2)''.
DESCRIPTION: Creates a voltage integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====sqrt3====
====current_integral====SYNTAX: sqrt3({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} z)
SYNTAXEXAMPLE: current_integral''sqrt3({{ArgTypeString}} label0, {{ArgTypeAny}} x11, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z22)''
EXAMPLEDESCRIPTION: ''current_integralComputes and returns the radius of the 3D point ("FI_1"x,-10y,-10,0,10,10,0z): sqrt(x**2 + y**2 + z**2)''.
DESCRIPTION: Creates a current integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====step====
====conduction_current_integral====SYNTAX: step({{ArgTypeReal}} x)
SYNTAXEXAMPLE: conduction_current_integral''step({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z21.0)''
EXAMPLEDESCRIPTION: ''conduction_current_integral("FI_1",-10,-10Computes and returns the unit step function: 1 if x>0,0,10,10,if x<0)''.
DESCRIPTION: Creates a conduction current integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====strip_sweep====
====capacitance====SYNTAX: strip_sweep({{ArgTypeString}} object, {{ArgTypeAny}} width)
SYNTAXEXAMPLE: capacitance''strip_sweep({{ArgTypeString}} label"Curve_1", {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z45)''
EXAMPLEDESCRIPTION: ''capacitance("FI_1",-10,-10,5,10,10,10,0,0,-10,0,0,10)''Creates a strip version of a given curve object.
DESCRIPTION: Creates a capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====subtract====
====inductance====SYNTAX: subtract({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)
SYNTAXEXAMPLE: inductance''subtract({{ArgTypeString}} label"Subtract_Object", {{ArgTypeAny}} x1"Rect_Strip1", {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4"Rect_Strip2")''
EXAMPLEDESCRIPTION: Creates a Boolean object named 'label'inductance("FI_1",0,0,-10,10,0,10,2by subtracting object_2 from object_1.5,-2.5,0,7.5,2.5,0) An error will be thrown if a Boolean object named 'label'already exists.
DESCRIPTION: Creates a inductance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====superquad====
====resistance====SYNTAX: superquad({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} order)
SYNTAXEXAMPLE: resistance''superquad({{ArgTypeString}} label"SuperQuad_1", {{ArgTypeAny}} x10, {{ArgTypeAny}} y10, {{ArgTypeAny}} z10, {{ArgTypeAny}} x250, {{ArgTypeAny}} y220, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z44)''
EXAMPLEDESCRIPTION: ''resistance("FI_1",0,0,Draws a super-10,0,0,10quadratic curve object in the project workspace under the currently activated material group node,or modifies the super-10,-10,0,10,10,0)quadratic curve named 'label'if it already exists. If order = 2, the curve reduces to an ellipse. Higher order makes the round edges sharper. An infinite order reduces the curve to a rectangle.
DESCRIPTION: Creates a resistance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====taper_strip====
====flux_electric====SYNTAX: taper_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAny}} is_expo)
SYNTAXEXAMPLE: flux_electric''taper_strip({{ArgTypeString}} label"ts_1", {{ArgTypeAny}} x10, {{ArgTypeAny}} y10, {{ArgTypeAny}} z10, {{ArgTypeAny}} x250, {{ArgTypeAny}} y2100, {{ArgTypeAny}} z280,1)''
EXAMPLEDESCRIPTION: Draws a taper strip object in the project workspace under the currently activated material group node, or modifies the taper strip object named 'label'flux_electric(if it already exists. If the Boolean parameters "FI_1is_expo"is 1,-10,-10,5,10,10,10)''an exponential taper will be drawn.
DESCRIPTION: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====terrain_group====
====flux_magnetic====SYNTAX: terrain_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
SYNTAXEXAMPLE: flux_magnetic''terrain_group({{ArgTypeString}} label"Terrain_1", {{ArgTypeAny}} x15.0, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z20.0001)''
EXAMPLEDESCRIPTION: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label'flux_magnetic("FI_1"already exists,0,0,-10,10,0,10)''the group is activated.
DESCRIPTION: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====thinwire_group====
====energy_electric====SYNTAX: thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)
SYNTAXEXAMPLE: energy_electric''thinwire_group({{ArgTypeString}} label"Thinwire_1", {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z24)''
EXAMPLEDESCRIPTION: Creates a Thinwire material group in the current module. If the thin wire group 'label'energy_electric("FI_1"already exists,-10,-10,-10,10,10,10)''the group is activated.
DESCRIPTION: Creates an electric energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====torus====
====energy_magnetic====SYNTAX: torus({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_major, {{ArgTypeAny}} radius_minor[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])
SYNTAXEXAMPLE: energy_magnetic''torus({{ArgTypeString}} label"Torus_1", {{ArgTypeAny}} x10, {{ArgTypeAny}} y10, {{ArgTypeAny}} z10, {{ArgTypeAny}} x250, {{ArgTypeAny}} y2, {{ArgTypeAny}} z220)''
EXAMPLEDESCRIPTION: Draws an torus object in the project workspace under the currently activated material group node, or modifies the torus named 'label'energy_magnetic("FI_1",-10,-10,-10,10,10,10)'if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the torus's azimuth axis.
DESCRIPTION: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====translate_by====
====ohmic_loss====SYNTAX: translate_by({{ArgTypeString}} object, {{ArgTypeReal}} x_dist, {{ArgTypeReal}} y_dist, {{ArgTypeReal}} z_dist)
SYNTAXEXAMPLE: ohmic_loss''translate_by({{ArgTypeString}} label"MyObj", {{ArgTypeAny}} x110, {{ArgTypeAny}} y110, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2x)''
EXAMPLEDESCRIPTION: ''ohmic_loss("FI_1",-10,-10,-10,10,10,10)''Translates an object by the specified distances in each direction.
DESCRIPTION: Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====translate_to====
====solution_plane====SYNTAX: translate_to({{ArgTypeString}} object, {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest)
SYNTAXEXAMPLE: solution_plane''translate_to({{ArgTypeString}} label"MyObj", {{ArgTypeAny}} field_sensor_label20, {{ArgTypeAny}} is_quasi20,x2)''
EXAMPLEDESCRIPTION: ''solution_plane("FI_1","FS_1",1)''Translates an object to the specified destination.
DESCRIPTION: Creates a 2D solution plane observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====transmitter_set====
== EM.Cube's Python Functions for Simulation-Related Functions & Operations ==SYNTAX: transmitter_set({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)
====select_module====EXAMPLE: ''transmitter_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)''
SYNTAXDESCRIPTION: select_module({{ArgTypeString}} module_name)Creates a transmitter set in [[EM.Terrano]]. If the transmitter set 'label' already exists, its properties are modified.
EXAMPLE: ''select_module("[[EM.Tempo]]")''====tri====
DESCRIPTIONSYNTAX: Selects and sets [[EM.Cube]]'s active module.tri({{ArgTypeReal}} x)
====set_units====EXAMPLE: ''tri(0.1)''
SYNTAXDESCRIPTION: set_units({{ArgTypeString}} units)Computes and returns the triangular window function: 1-|x| if x<1, 0 elsewhere.
EXAMPLE: ''set_units("meter")''====tri_wave====
DESCRIPTIONSYNTAX: Sets [[EM.Cube]]'s project length units.tri_wave({{ArgTypeReal}} x)
====set_frequency====EXAMPLE: ''tri_wave(0.5)''
SYNTAXDESCRIPTION: set_frequency({{ArgTypeAny}} Computes and returns the periodic triangular wave function of period T = 2, oscillating between two values +1 and -1 and having a value)of +1 at x = 0.
EXAMPLE: ''set_frequency(2.4e9)''====triangle_strip====
DESCRIPTIONSYNTAX: Sets [[EM.Cube]]'s center frequency.triangle_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAny}} angle)
====set_bandwidth====EXAMPLE: ''triangle_strip("ts_1",0,0,0,50,100,90)''
SYNTAXDESCRIPTION: set_bandwidth({{ArgTypeAny}} value)Draws a triangle strip object in the project workspace under the currently activated material group node, or modifies the triangle strip object named 'label' if it already exists.
EXAMPLE: ''set_bandwidth(1e9)''====union====
DESCRIPTIONSYNTAX: Sets [[EM.Cube]]'s frequency bandwidth.union({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)
====background_layer====EXAMPLE: ''union("Union_Object","Rect_Strip1","Rect_Strip2")''
SYNTAXDESCRIPTION: background_layer({{ArgTypeString}} Creates a Boolean object named 'label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thickness)' by unioning object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.
EXAMPLE: ''background_layer("Mid_Layer",3.3,0.001,1,1.5)''====virtual_group====
DESCRIPTIONSYNTAX: Adds a new substrate layer to [[EM.Picasso]]'s background layer stackup.virtual_group({{ArgTypeString}} label)
====delete_background_layer====EXAMPLE: ''virtual_group("VIR_1")''
SYNTAXDESCRIPTION: delete_background_layer({{ArgTypeString}} Creates a virtual object group in [[EM.Terrano]]. If the virtual group 'label)' already exists, the group is activated.
EXAMPLE: ''delete_background_layer("Mid_Layer")''====voltage_integral====
DESCRIPTIONSYNTAX: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup.voltage_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====set_stackup_order====EXAMPLE: ''voltage_integral("FI_1",0,0,-10,0,0,10)''
SYNTAXDESCRIPTION: set_stackup_order("THS", {{ArgTypeString}} label_1, {{ArgTypeString}} label_2, Creates a voltage integral observable in [[EM.Ferma]].If the observable 'label' already exists, its properties are modified., {{ArgTypeString}} label_n, "BHS")
EXAMPLE: ''background_layer("THS","Top_Layer","Mid_Layer","Bottom_Layer","BHS")''====volume_current_group====
DESCRIPTIONSYNTAX: Sets the hierarchy of [[EM.Picasso]]'s background layer stackup from top to bottom. The sequence should always start with "THS" standing for the top half-space and must end in "BHS" standing for the bottom half-space. All the intermediate finite-thickness substrate layers must be included and listed in the right order. volume_current_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz)
====global_ground====EXAMPLE: ''volume_current_group("Magnet_1",0,0,1e6)''
SYNTAXDESCRIPTION: global_ground({{ArgTypeAny}} ground_onCreates a volume current source group in [[EM.Ferma]]. If the volume current group 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)the group is activated.
EXAMPLE: ''global_ground(1,3.3,0.001)''====wave_port====
DESCRIPTIONSYNTAX: Set the state of wave_port({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[[EM.Terrano], {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]'s global ground and its material properties. A zero value for ground_on means to no global ground assumed at Z = 0. )
====delete====EXAMPLE: ''wave_port("WP_1","Rect_1",0,0)''
SYNTAXDESCRIPTION: delete({{ArgTypeString}} node_name)Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If the wave port 'label' already exists, its properties are modified.
EXAMPLE: ''delete("Box_1")''====waveguide_design====
DESCRIPTIONSYNTAX: Deletes a node name from the navigation tree. The node can be any geometric objectwaveguide_design({{ArgTypeReal}} er, source, observable or material group. {{ArgTypeReal}} freq_hertz)
====rename====EXAMPLE: ''waveguide_design(1.0,2e9)''
SYNTAXDESCRIPTION: renameComputes and returns the minimum larger dimension ({{ArgTypeString}} new_label, {{ArgTypeString}} old_labelin meters)of the cross section of a hollow rectangular waveguide above cutoff with a material filling of relative permittivity er at an operating frequency of freq_hertz.
EXAMPLE: ''rename("Box_2","Box_1")''====waveguide_src====
DESCRIPTIONSYNTAX: Deletes a node name from the navigation tree. The node can be any geometric objectwaveguide_src({{ArgTypeString}} label, source{{ArgTypeAny}} box_object, observable or material group. {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
====zoom_extents====EXAMPLE: ''waveguide_src("WG_1","Box_1",50,0)''
SYNTAXDESCRIPTION: zoom_extents()Creates a waveguide port source in [[EM.Tempo]]. If the waveguide port 'label' already exists, its properties are modified.
DESCRIPTION: Zooms to fit the extents of the physical structure into the screen.====wire_current_group====
====get_domain_extent====SYNTAX: wire_current_group({{ArgTypeString}} label, {{ArgTypeAny}} current, {{ArgTypeAny}} wire_radius)
SYNTAXEXAMPLE: get_domain_extent''wire_current_group({{ArgTypeString}} coordinate"Magnet_1",1,0.5)''
EXAMPLEDESCRIPTION: Creates a wire current source group in [[EM.Ferma]]. If the wire current group 'label'get_domain_extent("x")''already exists, the group is activated.
DESCRIPTION: Returns the size of the computational domain along the specified direction.====wire_gap_src====
====set_domain_offset====SYNTAX: wire_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
SYNTAXEXAMPLE: set_domain_offset''wire_gap_src({{ArgTypeAny}} dxn_offset"WIG_1", {{ArgTypeAny}} dxp_offset"Line_1", {{ArgTypeAny}} dyn_offset50, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset0)''
EXAMPLEDESCRIPTION: Creates a wire gap circuit source in [[EM.Libera]]. If the wire gap source 'label'set_domain_offset(20already exists,20,20,20,0,10)''its properties are modified.
DESCRIPTION: Sets the domain offset values along the &plusmn;X, &plusmn;Y and &plusmn;Z directions in project units.====zoom_extents====
====set_domain_offset_lambda====SYNTAX: zoom_extents()
SYNTAX: set_domain_offset_lambda({{ArgTypeAny}} dxn_offset, {{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset) EXAMPLE: ''set_domain_offset_lambda(0.1,0.1,0.1,0.1,0,0.25)'' DESCRIPTION: Sets the domain offset values along the &plusmn;X, &plusmn;Y and &plusmn;Z directions in free-space wavelengths. ====set_boundary_conditions==== SYNTAX: set_boundary_conditions({{ArgTypeString}} xn_type, {{ArgTypeString}} xp_type, {{ArgTypeString}} yn_type, {{ArgTypeString}} yp_type, {{ArgTypeString}} zn_type, {{ArgTypeString}} zp_type) EXAMPLE: ''set_domain_offset_lambda("pml","pml","pml","pml","pec","pml")'' DESCRIPTION: Sets [[EM.Tempo]]'s domain boundary conditions domain offset on the &plusmn;X, &plusmn;Y and &plusmn;Z boundary walls. The options are "pec", "pmc" and "pml". ====add_variable==== SYNTAX: add_variable({{ArgTypeString}} var_name, {{ArgTypeAny}} value) EXAMPLE: ''add_variable("MyVar",1)'' DESCRIPTION: Adds a new variable Zooms to [[EM.Cube]]'s variable list. ====run_analysis==== SYNTAX: run_analysis() DESCRIPTION: Runs a simulation in fit the current active [[EM.Cube]] computational module. ====set_periodic==== SYNTAX: set_periodic({{ArgTypeAny}} is_periodic, {{ArgTypeAny}} spacingX, {{ArgTypeAny}} spacingY)  EXAMPLE: ''set_periodic(1,50,50)'' DESCRIPTION: Designates extents of the physical structure as periodic and sets into the periods along the X and Y directions. ====get_standard_output==== SYNTAX: get_standard_output({{ArgTypeString}} output_name)  EXAMPLE: ''get_standard_output("S11M")'' DESCRIPTION: Returns the computed value of the specified standard output parameter at the end of a simulation. ====save_data==== SYNTAX: save_data({{ArgTypeString}} directory_name)  EXAMPLE: ''save_data("Simulation_Data")'' DESCRIPTION: Saves [[EM.Cube]]'s output simulation data files under the specified directory. ====plot_file==== SYNTAX: plot_file({{ArgTypeString}} filename)  EXAMPLE: ''plot_file("D0.DAT")'' DESCRIPTION: Plots the contents of a specified data file in EM.Grid. ====mesh==== SYNTAX: mesh() DESCRIPTION: Generates and displays the mesh of the physical structurescreen.
<br />
<hr>
[[Image:Top_icon.png|48px30px]] '''[[#Standard Python Functions Standard_Python_Operators | Back to the Top of the Page]]'''
[[Image:Back_icon.png|40px30px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''
Kazem Sabet
28,333
edits