<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 ==Â {| class="wikitable"!scope="col"| Syntax!scope="col"| Type!scope="col"| Description|-| style="width:80px;" | -p| style="width:150px;" | Std. Python operator| style="width:270px;" | negative of p|-| style="width:80px;" | p=q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is equal to q|-| style="width:80px;" | p+q| style="width:150px;" | Std. Python operator| style="width:270px;" | sum of p and q|-| style="width:80px;" | p-q| style="width:150px;" | Std. Python operator| style="width:270px;" | difference p and q|-| style="width:80px;" | p*q| style="width:150px;" | Std. Python operator| style="width:270px;" | product of p and q|-| style="width:80px;" | p/q| style="width:150px;" | Std. Python operator| style="width:270px;" | quotient of p over q|-| style="width:80px;" | p**q| style="width:150px;" | Std. Python operator| style="width:270px;" | p to the power of q|-| style="width:80px;" | p%q| style="width:150px;" | Std. Python operator| style="width:270px;" | p modulus q|-| style="width:80px;" | p==q| style="width:150px;" | Std. Python operator| style="width:270px;" | p logically equal to q|-| style="width:80px;" | p>q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is greater than q|-| style="width:80px;" | p>=q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is greater than or equal to q|-| style="width:80px;" | p<q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is less than q|-| style="width:80px;" | p<=q| style="width:150px;" | Std. Python operator| style="width:270px;" | p is less than or equal to q|-| style="width:80px;" | !p| style="width:150px;" | Std. Python operator| style="width:270px;" | Logical not p|-| style="width:80px;" | p and q| style="width:150px;" | Std. Python operator| style="width:270px;" | p Boolean and q|-| style="width:80px;" | p or q| style="width:150px;" | Std. Python operator| style="width:270px;" | p Boolean or q|-|}Â == Basic Mathematical Python Functions ==
{| class="wikitable"
| style="width:270px;" | Absolute value function
| style="width:270px;" | x if x>0, -x if x<0
|-
| ceiling(x)
| Std. Python function
| Ceiling function
| Nearest integer >= x
|-
| floor(x)
| Std. Python function
| Floor function
| Nearest integer <= x
|-
| pow(x,y)
| Std. Python function
| Factorial
| For for integer values of x: n! = n(n-1)(n-2)...3.2.1
|-
| max(x,y)
| -
|-
| asinhnp.arcsinh(x)
| Std. Python function
| Inverse hyperbolic sine function
| -
|-
| acoshnp.arccosh(x)
| Std. Python function
| Inverse hyperbolic cosine function
| -
|-
| atanhnp.arctanh(x)
| Std. Python function
| Inverse hyperbolic tangent function
| -
|-
| np.floor(x)
| Std. Python function
| Floor function
| nearest integer <= x
|}
| style="width:150px;" | Std. Python function
| style="width:270px;" | Sine and cosine integral functions
| style="width:270px;" | See see [https://en.wikipedia.org/wiki/Trigonometric_integral Trigonometric Integrals on Wikipedia.]
|-
| sp.fresnel(x)
| Std. Python function
| Sine and cosine Fresnel integral functions
| See see [https://en.wikipedia.org/wiki/Fresnel_integral Fresnel Integrals on Wikipedia.]
|-
| sp.ellipe(x)
| Std. Python function
| Elliptic function of the first kind
| See see [https://en.wikipedia.org/wiki/Elliptic_integral Elliptic Integrals on Wikipedia.]
|-
| sp.ellipk(x)
| Std. Python function
| Elliptic function of the second kind
| See see [https://en.wikipedia.org/wiki/Elliptic_integral Elliptic Integrals on Wikipedia.]
|-
| sp.expi(x)
| Std. Python function
| Exponential integral function
| See see [https://en.wikipedia.org/wiki/Exponential_integral Exponential Integrals on Wikipedia.]
|-
| sp.expn(n,x)
| Std. Python function
| Generalized exponential integral function of order n
| See see [https://en.wikipedia.org/wiki/Exponential_integral Exponential Integrals on Wikipedia.]
|-
| sp.erf(x)
| Std. Python function
| Error function
| See see [https://en.wikipedia.org/wiki/Error_function Error Function on Wikipedia.]
|-
| sp.erfc(x)
| Std. Python function
| Complementary error function
| See see [https://en.wikipedia.org/wiki/Error_function Error Function on Wikipedia.]
|-
| sp.gamma(x)
| Std. Python function
| Gamma function
| See see [https://en.wikipedia.org/wiki/Gamma_function Gamma Function on Wikipedia.]
|-
| sp.airy(x)
| Std. Python function
| Airy function of the first (Ai) and second (Bi) kind and their derivatives
| See see [https://en.wikipedia.org/wiki/Airy_function Airy Functions on Wikipedia.]
|-
| sp.j0(x)
| Std. Python function
| Bessel function of the first kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.j1(x)
| Std. Python function
| Bessel function of the first kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.jv(n,x)
| Std. Python function
| Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.y0(x)
| Std. Python function
| Bessel function of the second kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.y1(x)
| Std. Python function
| Bessel function of the second kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.yv(n,x)
| Std. Python function
| Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.i0(x)
| Std. Python function
| Modified Bessel function of the first kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.i1(x)
| Std. Python function
| Modified Bessel function of the first kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.iv(n,x)
| Std. Python function
| Modified Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.k0(x)
| Std. Python function
| Modified Bessel function of the second kind and order 0
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.k1(x)
| Std. Python function
| Modified Bessel function of the second kind and order 1
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.kv(n,x)
| Std. Python function
| Modified Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_jn(n,x)
| Std. Python function
| Spherical Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_yn(n,x)
| Std. Python function
| Spherical Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_in(n,x)
| Std. Python function
| Modified spherical Bessel function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.sph_kn(n,x)
| Std. Python function
| Modified spherical Bessel function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Bessel_function Bessel Functions on Wikipedia.]
|-
| sp.lpn(n,x)
| Std. Python function
| Legendre function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomial Legendre Polynomials on Wikipedia.]
|-
| sp.lqn(n,x)
| Std. Python function
| Legendre function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomials Legendre Polynomials on Wikipedia.]
|-
| sp.lpmn(m,n,x)
| Std. Python function
| Associated Legendre function of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomial Legendre Polynomials on Wikipedia.]
|-
| sp.lqmn(m,n,x)
| Std. Python function
| Associated Legendre function of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomials Legendre Polynomials on Wikipedia.]
|-
| sp.eval_chebyt(n,x)
| Std. Python function
| Chebyshev polynomial of the first kind and order n
| See see [https://en.wikipedia.org/wiki/Chebyshev_polynomials Chebyshev Polynomials on Wikipedia.]
|-
| sp.eval_chebyu(n,x)
| Std. Python function
| Chebyshev polynomial of the second kind and order n
| See see [https://en.wikipedia.org/wiki/Chebyshev_polynomials Chebyshev Polynomials on Wikipedia.]
|-
| sp.eval_legendre(n,x)
| Std. Python function
| Legendre polynomial of order n
| See see [https://en.wikipedia.org/wiki/Legendre_polynomials Legendre Polynomials on Wikipedia.]
|-
| sp.eval_laguerre(n,x)
| Std. Python function
| Laguerre polynomial of order n
| See see [https://en.wikipedia.org/wiki/Laguerre_polynomials Laguerre Polynomials on Wikipedia.]
|-
| sp.eval_hermite(n,x)
| Std. Python function
| Hermite polynomial of order n
| See see [https://en.wikipedia.org/wiki/Hermite_polynomials Hermite Polynomials on Wikipedia.]
|-
| Math_cesp.mathieu_cem(n,rq,x)
| Std. Python function
| Even periodic (cosine) Mathieu function of order nand its derivative| See see [https://en.wikipedia.org/wiki/Mathieu_function Mathieu Functions on Wikipedia.]
|-
| Math_sesp.mathieu_sem(n,rq,x)
| Std. Python function
| Odd periodic (sine) Mathieu function of order nand its derivative| See see [https://en.wikipedia.org/wiki/Mathieu_function Mathieu Functions on Wikipedia.]
|}
== 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|≤0.5, 0 elsewhere |-| tri(x)| EMAG Python function| Triangle function| 1 if |1-x|≤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=EXAMPLE: ''activate("wikitableColor_1")''!scope="col"| Syntax!scope="col"| TypeDESCRIPTION: Activates a color, material or object group in the current active [[EM.Cube]] module for insertion of new objects. !scope="col"| Description!scope="col"| Notes===add_variable====|-| style="widthSYNTAX:100px;" | microstrip_designadd_variable(z0{{ArgTypeString}} var_name,er{{ArgTypeAny}} value)| style="widthEXAMPLE:150px;''add_variable(" | EMAG Python function| style=MyVar"width,1)'' DESCRIPTION:250px;" | Returns the width-Adds a new variable to-height ratio of a microstrip transmission line [[EM.Cube]]'s variable list. | style="width:250px;" | z0: characteristic impedance in Ohms, er: substrate permittivity===array====|-| style="widthSYNTAX:100px;" | microstrip_z0array(w{{ArgTypeString}} label,h{{ArgTypeString}} object,er{{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing)| style="width:150px;" | EMAG Python function| style="widthEXAMPLE:250px;''array(" | Returns the characteristic impedance of a microstrip transmission line in Ohms | style=Array_1"width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity|-| style="width:100px;Rect_Strip_1" | microstrip_eps_eff(w,h4,4,er1,50,50,0)''| style="width:150px;" | EMAG Python function| style="widthDESCRIPTION:250px;" | Returns the effective permittivity of a microstrip transmission line Creates or modifies an array object.| style====array_custom===="width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity|-| style="widthSYNTAX:100px;" | microstrip_lambda_garray_custom(w{{ArgTypeString}} label,h{{ArgTypeString}} object,er{{ArgTypeAny}} x_count,freq_hertz{{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)| style="widthEXAMPLE:150px;''array_custom(" | EMAG Python function| style=Array_1"width:250px;," | Returns the guide wavelength of a microstrip transmission line in meters| style=Rect_Strip_1"width:250px;" | w: microstrip width, h: substrate height4, er: substrate permittivity4, freq_hertz: frequency in Hz|-| style="width:100px;" | cpw_design_w(z01,s50,50,0,h100,er100,20,0,0,45)''| style="widthDESCRIPTION:150px;" | EMAG Python functionCreates or modifies an array object and sets its local coordinate system and rotation angles. | 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==background_layer====|-| style="widthSYNTAX:100px;" | cpw_design_sbackground_layer(z0{{ArgTypeString}} label,w{{ArgTypeAny}} eps,h{{ArgTypeAny}} sigma,er{{ArgTypeAny}} mu, {{ArgTypeAny}} thickness)| style="width:150px;" | EMAG Python function| style="widthEXAMPLE:250px;" | Returns the center strip width ''background_layer(or slot spacing) of a coplanar waveguide (CPW) transmission line | style="width:250px;Mid_Layer" | z0: characteristic impedance in Ohms, w: slot width3.3, h: substrate height0.001, er: substrate permittivity|-| style="width:100px;" | coaxial_design(z01,er1.5)''| style="width:150px;" | EMAG Python function| style="widthDESCRIPTION:250px;" | Returns the ratio of radius of the outer conductor Adds a new substrate layer to the radius of the inner condutcor of a coaxial transmission line [[EM.Picasso]]'s background layer stackup.| style====base_point_group===="width:250px;" | z0: characteristic impedance in Ohms, er: core permittivity|-| style="widthSYNTAX:100px;" | waveguide_designbase_point_group(er,freq_hertz{{ArgTypeString}} label)| style="widthEXAMPLE:150px;''base_point_set(" | EMAG Python functionBP_Set_1")''| style="widthDESCRIPTION:250px;" | Returns the minimum larger dimension Creates a base point set in meter of [[EM.Terrano]]. If the cross section of a hollow rectangular waveguide above cutoff | style="width:250px;" | er: filling permittivitybase point set group 'label' already exists, freq_hertz: frequency in Hzthe group is activated.|-| 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 =bh_step====| style="widthSYNTAX:250px;" | D0_dB: directivity dbh_step({{ArgTypeReal}} x, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide {{ArgTypeReal}} T)|-| style="widthEXAMPLE:100px;" | horn_design_b''bh_step(D0_dB,a_lambda0.5,b_lambda1)''| style="width:150px;" | EMAG Python function| style="widthDESCRIPTION:250px;" | Returns Computes and returns the wavelengthBlackman-normalized smaller dimension of the aperture of an optimal pyramidal horn antenna Harris step function.| style====bh_window===="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="widthSYNTAX:100px;" | horn_design_lbh_window(D0_dB{{ArgTypeReal}} x,a_lambda,b_lambda{{ArgTypeReal}} T)| style="width:150px;" | EMAG Python function| style="widthEXAMPLE:250px;" | Returns the wavelength-normalized length of an optimal pyramidal horn antenna | style="width:250px;" | D0_dB: directivity d''bh_window(0.5, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide |}1)''
== EMDESCRIPTION: Computes and returns the Blackman-Harris window function.Cube's Python Functions for Geometric Object Creation ==
====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.
====cylindercapacitance====
SYNTAX: cylindercapacitance({{ArgTypeString}} label, {{ArgTypeAny}} x0x1, {{ArgTypeAny}} y0y1, {{ArgTypeAny}} z0z1, {{ArgTypeAny}} radiusx2, {{ArgTypeAny}} height[y2, {{ArgTypeAny}} start_anglez2, {{ArgTypeAny}} end_anglex3, {{ArgTypeAny}} cap_topy3, {{ArgTypeAny}} cap_bottom]z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)
EXAMPLE: ''cylindercapacitance("Cylinder_1FI_1",0-10,-10,5,10,10,10,0,0,-10,1000,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==== SYNTAX: circ_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} inner_radius, {{ArgTypeAny}} outer_radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]) EXAMPLE: ''circ_strip("cs_1",0,0,0,50,0)'' DESCRIPTION: Draws a cylinder circle strip object in the project workspace under the currently activated material group node, or modifies the cylinder circle strip object named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the cylindercircle strip's azimuth axis. ====circle==== SYNTAX: circle({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle) EXAMPLE: ''circle("pyramid_1",0,0,0,10,10,100)'' DESCRIPTION: Draws a circular curve object in the project workspace under the currently activated material group node, or modifies the circle named 'label' if it already exists. The parameters start_angle and end_angle are in degrees. ====clone==== SYNTAX: clone({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeReal}} x0, {{ArgTypeReal}} y0, {{ArgTypeReal}} z0) EXAMPLE: ''clone("NewObj","MyObj",10,10,0)'' DESCRIPTION: Creates a copy of the specified object and repositions it at the given coordinates.  ====close_curve==== SYNTAX: close_curve({{ArgTypeString}} label, {{ArgTypeString}} close_state) EXAMPLE: ''close_curve("Curve_1",1)'' 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==== SYNTAX: color_group({{ArgTypeString}} label) EXAMPLE: ''color_group("Color_1")'' 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: Draws a cone object in the project workspace under the currently activated material group node, or modifies the cone named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the cone's azimuth axis.
====pyramidconsolidate====
SYNTAX: pyramidconsolidate({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} heightobject)
EXAMPLE: ''pyramidconsolidate("Pyramid_1Poly_1",0,0,0,10,10,100)''
DESCRIPTION: Draws Consolidates a pyramid specified object in the project workspace under the currently activated material group node, or modifies the pyramid named 'label' if it already exists.
====spherecpw_design_s====
SYNTAX: spherecpw_design_s({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAnyArgTypeReal}} z0, {{ArgTypeAnyArgTypeReal}} radius[w, {{ArgTypeAnyArgTypeReal}} start_angleh, {{ArgTypeAnyArgTypeReal}} end_angle]er)
EXAMPLE: ''spherecpw_design_s("Sphere_1"50,0,0,0,102,0.5,1802.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==== SYNTAX: cubecad_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol) EXAMPLE: ''cubecad_mesh_settings(5,10)'' 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==== SYNTAX: cylinder({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} height[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom]) EXAMPLE: ''cylinder("Cylinder_1",0,0,0,10,100)'' DESCRIPTION: Draws a sphere cylinder object in the project workspace under the currently activated Material Group material group node, or modifies the sphere 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==== SYNTAX: ellipse_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]) EXAMPLE: ''ellipse_strip("es_1",0,0,0,50,0)'' DESCRIPTION: Draws a ellipse strip object in the project workspace under the currently activated material group node, or modifies the ellipse strip object named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the sphereellipse strip's azimuth axis.
====ellipsoid====
DESCRIPTION: Draws an ellipsoid object in the project workspace under the currently activated material group node, or modifies the ellipsoid named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the ellipsoid's azimuth axis.
====torusemferma_engine_settings====
SYNTAX: torusemferma_engine_settings({{ArgTypeString}} labelmatrix_solver, {{ArgTypeAny}} x0error_tol, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_major, {{ArgTypeAny}} radius_minor[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]max_iterations)
EXAMPLE: ''torusemferma_engine_settings("Torus_1bicg-stab",01e-3,0,0,50,20100)''
DESCRIPTION: Draws an torus object in Sets the project workspace under the currently activated material group node, or modifies the torus named 'label' if it already existsparameters of [[EM. The arguments start_angle and end_angle are in degrees and specify a sweep about the torusFerma]]'s azimuth axiselectrostatic and magnetostatic simulation engines.
====rect_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side_x, {{ArgTypeAny}} side_y)emferma_mesh_settings====
''ExampleSYNTAX: rect_stripemferma_mesh_settings("my_rectangle"{{ArgTypeAny}} cell_size_x,0{{ArgTypeAny}} cell_size_y,0,0,50,20{{ArgTypeAny}} cell_size_z)''
DescriptionEXAMPLE: 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 existsemferma_mesh_settings(0.5,0.5,0.5)''
====circ_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} inner_radius, {{ArgTypeAny}} outer_radiusDESCRIPTION: Sets the parameters of [, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle[EM.Ferma]])===='s fixed-cell mesh generator.
''Example: circ_strip("cs_1",0,0,0,50,0)''====emillumina_engine_settings====
DescriptionSYNTAX: Draws a circle strip object in the project workspace under the currently activated material group nodeemillumina_engine_settings({{ArgTypeString}} engine, or modifies the circle strip object named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the circle strip's azimuth axis.{{ArgTypeAny}} is_fixed_iteration, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)
====radial_stripEXAMPLE: ''emillumina_engine_settings({{ArgTypeString}} label"ipo", {{ArgTypeAny}} x00, {{ArgTypeAny}} y01e-2, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} base_length, {{ArgTypeAny}} angle20)====''
''ExampleDESCRIPTION: radial_strip("Radial_1",0,0,0,50,0,90)'Sets the parameters of [[EM.Illumina]]'s Physical Optics simulation engine.
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. ====emillumina_mesh_settings====
====ellipse_stripSYNTAX: emillumina_mesh_settings({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]cells_per_lambda)====
EXAMPLE: ''Example: ellipse_stripemillumina_mesh_settings("es_1",0,0,0,50,030)''
DescriptionDESCRIPTION: Draws a ellipse strip object in Sets the project workspace under the currently activated material group node, or modifies the ellipse strip object named 'label' if it already existsparameters of [[EM. The arguments start_angle and end_angle are in degrees and specify a sweep about the ellipse stripIllumina]]'s azimuth axismesh generator.
====triangle_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAny}} angle)emlibera_engine_settings_smom====
''ExampleSYNTAX: triangle_stripemlibera_engine_settings_smom("ts_1"{{ArgTypeString}} matrix_solver,0{{ArgTypeAny}} error_tol,0{{ArgTypeAny}} max_iterations,0{{ArgTypeAny}} ncpus,50{{ArgTypeString}} formulation,100,90{{ArgTypeAny}} alpha)''
DescriptionEXAMPLE: 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 existsemlibera_engine_settings_smom("bicg",1e-3,1000,4,"efie",0. 4)''
====taper_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAny}} is_expo)====DESCRIPTION: Sets the parameters of [[EM.Libera]]'s surface MoM simulation engines.
''Example: taper_strip("ts_1",0,0,0,50,100,80,1)''====emlibera_engine_settings_wmom====
DescriptionSYNTAX: Draws a taper strip object in the project workspace under the currently activated material group nodeemlibera_engine_settings_wmom({{ArgTypeString}} matrix_solver, or modifies the taper strip object named 'label' if it already exists. If the Boolean parameters "is_expo" is 1{{ArgTypeAny}} error_tol, an exponential taper will be drawn. {{ArgTypeAny}} max_iterations)
====polygon_regEXAMPLE: ''emlibera_engine_settings_wmom({{ArgTypeString}} label"bicg", {{ArgTypeAny}} x01e-3, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} n_sides1000)====''
''ExampleDESCRIPTION: polygon_reg("ts_1",0,0,0,50,100,80,1)'Sets the parameters of [[EM.Libera]]'s wire MoM simulation engines.
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. ====emlibera_mesh_settings====
====spiral_stripSYNTAX: emlibera_mesh_settings({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} width, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dualcells_per_lambda)====
EXAMPLE: ''Example: spiral_stripemlibera_mesh_settings("Spiral _1",0,0,0,10,50,5,0,030)''
DescriptionDESCRIPTION: Draws a spiral strip object in Sets the project workspace under the currently activated material group node, or modifies the spiral strip named parameters of [[EM.Libera]]'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 drawns mesh generator.
====polystrip({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)empicasso_engine_settings====
''ExampleSYNTAX: polystripempicasso_engine_settings("ps_1"{{ArgTypeString}} matrix_solver,(0{{ArgTypeAny}} error_tol,0,0),(1,0,0),(1,0,0){{ArgTypeAny}} max_iterations)''
DescriptionEXAMPLE: 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' empicasso_engine_settings("bicg",1e-- there is no need to supply the first point again at the end of the point list.3,1000)''
====nurbs_strip({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, DESCRIPTION: Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine.. {{ArgType| 3x1 Python tuple}} pn)====
''Example: nurbs_strip("ns_1",(0,0,0),(1,0,0),(1,0,0))''====empicasso_mesh_settings====
DescriptionSYNTAX: 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' -- there is no need to supply the first point again at the end of the point list.empicasso_mesh_settings({{ArgTypeAny}} cells_per_lambda)
====lineEXAMPLE: ''empicasso_mesh_settings({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length[, {{ArgTypeAny}} dir]30)====''
''ExampleDESCRIPTION: line("my_line",0,0,0,100,"x")'Sets the parameters of [[EM.Picasso]]'s planar hybrid mesh generator.
Description: Draws a Line object in the project workspace under the currently activated material group node, or modifies the line named 'label' if it already exists. Without the argument "dir", a vertical line is drawn by default. ====emtempo_engine_settings====
====circleSYNTAX: emtempo_engine_settings({{ArgTypeString}} labelengine, {{ArgTypeAny}} x0power_threshhold, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_anglemax_timesteps)====
EXAMPLE: ''Example: circleemtempo_engine_settings("pyramid_1single-precision",0,0,0,10,10-50,10020000)''
DescriptionDESCRIPTION: Draws a circular curve object in Sets the project workspace under the currently activated material group node, or modifies the circle named parameters of [[EM.Tempo]]'label' if it already exists. The parameters start_angle and end_angle are in degreess FDTD simulation engine.
====superquad({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} order)emtempo_mesh_settings====
''ExampleSYNTAX: superquademtempo_mesh_settings("SuperQuad_1"{{ArgTypeAny}} cells_per_lambda,0{{ArgTypeAny}} ratio_contour,0{{ArgTypeAny}} ratio_thin,0,50,20,4{{ArgTypeAny}} ratio_abs)''
DescriptionEXAMPLE: 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 existsemtempo_mesh_settings(30,0. If order = 21, the curve reduces to an ellipse0. Higher order make the round edges sharper. An infinite order reduces the curve to a rectangle1,0. 02)''
====parabola({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)====DESCRIPTION: Sets the parameters of [[EM.Tempo]]'s adaptive mesh generator.
''Example: parabola("Parabola _1",0,0,0,50,20,0)''====emterrano_engine_settings====
DescriptionSYNTAX: Draws a parabola object in the project workspace under the currently activated material group nodeemterrano_engine_settings({{ArgTypeAny}} bounce_count, or modifies the parabola named 'label' if it already exists. If the Boolean parameter "half_only" is 1{{ArgTypeAny}} do_edge_diffraction, only half of the parabola will be drawn. {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshhold)
====hyperbolaEXAMPLE: ''emterrano_engine_settings({{ArgTypeString}} label5, {{ArgTypeAny}} x01, {{ArgTypeAny}} y01, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only-100)====''
''ExampleDESCRIPTION: hyperbola("Hyperbola _1",0,0,0,50,40,20,0)'Sets the parameters of [[EM.Terrano]]'s SBR simulation engine.
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. ====emterrano_mesh_settings====
====spiral_curveSYNTAX: emterrano_mesh_settings({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_diredge_length, {{ArgTypeAny}} is_dualangle_tol)====
EXAMPLE: ''Example: spiral_curveemterrano_mesh_settings("Spiral _1",0,0,05,10,50,5,0,0)''
DescriptionDESCRIPTION: Draws a spiral curve object in Sets the project workspace under the currently activated material group node, or modifies the spiral curve named parameters of [[EM.Terrano]]'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 drawns facet mesh generator.
====helix({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} helix_dir)energy_electric====
''ExampleSYNTAX: helixenergy_electric("Helix_1"{{ArgTypeString}} label,0{{ArgTypeAny}} x1,0{{ArgTypeAny}} y1,0{{ArgTypeAny}} z1,15{{ArgTypeAny}} x2,15{{ArgTypeAny}} y2,10,0{{ArgTypeAny}} z2)''
DescriptionEXAMPLE: 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 energy_electric("radius_innerFI_1" 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-10, the helical curve will be drawn counter-clockwise. 10,-10,10,10,10)''
====polyline({{ArgTypeString}} DESCRIPTION: Creates an electric energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ..its properties are modified. {{ArgType| 3x1 Python tuple}} pn)====
''Example: polyline("pl_1",(0,0,0),(1,0,0),(1,0,0))''====energy_magnetic====
DescriptionSYNTAX: 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 pnenergy_magnetic({{ArgTypeString}} label, otherwise{{ArgTypeAny}} x1, it is open.{{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====nurbs_curveEXAMPLE: ''energy_magnetic({{ArgTypeString}} label"FI_1", {{ArgType| 3x1 Python tuple}} p0-10, {{ArgType| 3x1 Python tuple}} p1-10, ... {{ArgType| 3x1 Python tuple}} pn-10,10,10,10)====''
DESCRIPTION: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label'Example: nurbs_curve("nc_1"already exists,(0,0,0),(1,0,0),(1,0,0))''its properties are modified.
Description: 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, otherwise, it is open.====explode====
====pointSYNTAX: explode({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0object)====
EXAMPLE: ''Example: pointexplode("Point_1MyArray",0,0,10)''
DescriptionDESCRIPTION: Draws a point in the project workspace under the currently activated material group node, or modifies the point named 'label' if it already existsExplodes an object into its basic primitives.
====fractal_tree({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} key_type, {{ArgTypeAny}} key_size, {{ArgTypeAny}} n_level, {{ArgTypeAny}} sep_angle, {{ArgTypeAny}} n_gen, {{ArgTypeAny}} prune_factor, {{ArgTypeAny}} thickness, {{ArgTypeAny}} thick_factor)export_dxf====
''ExampleSYNTAX: fractal_treeexport_dxf("Fractal_1",0,0,0,"line",10,3,30,3,0,0,0{{ArgTypeString}} file_name)''
DescriptionEXAMPLE: Generates a fractal tree in the project workspace under the currently activated material group node, or modifies the fractal tree named 'label' if it already existsexport_dxf("MyDXFModel.DXF")''
====param_curve({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} DESCRIPTION: Exports the physical structure of the project workspacean to a DXF modelfile. If the file path is not specified, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start, {{ArgTypeAny}} stop, {{ArgTypeAny}} step, {{ArgTypeAny}} function[, {{ArgTypeAny}} y(t), {{ArgTypeAny}} z(t)])====the current project folder is assumed as the path.
''Example: param_curve("Curve_1",0,0,0,"parametric","xy",0,10,0.1,"cos(t)","sin(t)","t")''====export_py====
DescriptionSYNTAX: 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.export_py({{ArgTypeString}} file_name)
====param_surfaceEXAMPLE: ''export_py({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start1, {{ArgTypeAny}} stop1, {{ArgTypeAny}} step1, , {{ArgTypeAny}} start2, {{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} function"MyPYModel.PY")====''
''ExampleDESCRIPTION: param_surface(Exports the physical structure of the project workspace or the current object selection to a Python geometry file. The default path is the Python subfolder under "Surf_1Documents → EMAG",0,0,0,"xy",0,10,0.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.====export_stl====
====import_stlSYNTAX: export_stl({{ArgTypeString}} file_name)====
EXAMPLE: ''Example: import_stlexport_stl("MySTLModel.STL")''
DescriptionDESCRIPTION: Imports Exports the physical structure of the project workspacean to an external STL model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.
====import_dxf({{ArgTypeString}} file_name)extrude====
''ExampleSYNTAX: import_dxfextrude("MyDXFModel.DXF"{{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} extrude_height, {{ArgTypeAny}} cap_ends)''
DescriptionEXAMPLE: Imports an external DXF model file to the project workspace. If the file path is not specified''extrude("Extrude_1", the current project folder is assumed as the path."Rect_Strip1",50)''
====import_stp({{ArgTypeString}} file_name)====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.
''Example: import_stp("MySTPModel.STP")''====farfield====
DescriptionSYNTAX: Imports an external STEP model file to the project workspace. If the file path is not specifiedfarfield({{ArgTypeString}} label, the current project folder is assumed as the path.{{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)
====import_igsEXAMPLE: ''farfield({{ArgTypeString}} file_name"FF_1",1,1)====''
''ExampleDESCRIPTION: import_igs("MyIGSModelCreates a far-field radiation pattern observable.IGS")If the observable 'label'already exists, its properties are modified.
Description: Imports an external IGES model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.====field_probe====
====import_pySYNTAX: field_probe({{ArgTypeString}} file_namelabel, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)====
EXAMPLE: ''Example: import_pyfield_probe("MyPYModel.PYFS_1",0,0,50)''
DescriptionDESCRIPTION: Imports Creates a Python geometry file to the project workspacetemporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. The default path is If the Python subfolder under "Documents → EMAG"observable 'label' already exists, its properties are modified.
====export_stl({{ArgTypeString}} file_name)field_sensor====
''ExampleSYNTAX: export_stlfield_sensor("MySTLModel.STL"{{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)''
DescriptionEXAMPLE: Exports the physical structure of the project workspacean to an STL model file. If the file path is not specified''field_sensor("FS_1", the current project folder is assumed as the path."z",0,0,0,100,100,0,25,25,0)''
====export_dxf({{ArgTypeString}} file_name)====DESCRIPTION: Creates a near-field sensor observable. If the observable 'label' already exists, its properties are modified.
''Example: export_dxf("MyDXFModel.DXF")''====field_sensor_grid====
DescriptionSYNTAX: Exports the physical structure of the project workspacean to a DXF model file. If the file path is not specifiedfield_sensor_grid({{ArgTypeString}} label, the current project folder is assumed as the path.{{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)
====export_pyEXAMPLE: ''field_sensor_grid({{ArgTypeString}} file_name"FS_1","z",0,0,0)====''
''ExampleDESCRIPTION: export_py("MyPYModelCreates a near-field sensor observable in [[EM.PY")Tempo]] or [[EM.Ferma]]. If the observable 'label'already exists, its properties are modified.
Description: Exports the physical structure of the project workspace or the current object selection to a Python geometry file. The default path is the Python subfolder under "Documents → EMAG".====fill_curve====
== EM.Cube's Python Functions for Geometric Object Transformation ==SYNTAX: fill_curve({{ArgTypeString}} object)
====freezeEXAMPLE: ''fill_curve({{ArgTypeString}} object, {{ArgTypeReal}} freeze_state"Curve_1")====''
''ExampleDESCRIPTION: freeze("MyObj",1)''Fill the interior of the specified closed curve object.
Description: Sets the freeze state of an object (0/1). ====fillet====
====move_tofillet({{ArgTypeString}} object, {{ArgTypeString}} group_node_label[, {{ArgTypeStringArgTypeAny}} module_name]radius)====
EXAMPLE: ''Example: move_tofillet("NewObjRect_1","MyObj",10,10,05)''
DescriptionDESCRIPTION: Transfers an object from its current material/object group node in Fillets the navigation tree to another node corners of the specified surface or optionally to another [[EM.Cube]] modulecurve object by the specified radius.
====clone({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeReal}} x0, {{ArgTypeReal}} y0, {{ArgTypeReal}} z0)flux_electric====
''ExampleSYNTAX: cloneflux_electric("NewObj"{{ArgTypeString}} label,"MyObj"{{ArgTypeAny}} x1,10{{ArgTypeAny}} y1,10{{ArgTypeAny}} z1,0{{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)''
DescriptionEXAMPLE: Creates a copy of the specified object and repositions it at the given coordinates. ''flux_electric("FI_1",-10,-10,5,10,10,10)''
====translate_by({{ArgTypeString}} objectDESCRIPTION: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeReal}} x_dist, {{ArgTypeReal}} y_dist, {{ArgTypeReal}} z_dist)====its properties are modified.
''Example: translate_by("MyObj",10,10,x)''====flux_magnetic====
DescriptionSYNTAX: Translates an object by the specified distances in each direction.flux_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====translate_toEXAMPLE: ''flux_magnetic({{ArgTypeString}} object"FI_1", {{ArgTypeReal}} x_dest0, {{ArgTypeReal}} y_dest0, {{ArgTypeReal}} z_dest-10,10,0,10)====''
DESCRIPTION: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label'Example: translate_to("MyObj"already exists,20,20,x2)''its properties are modified.
Description: Translates an object to the specified destination.====fractal_tree====
====rotateSYNTAX: fractal_tree({{ArgTypeString}} objectlabel, {{ArgTypeAny}} rot_angle_degreex0, {{ArgTypeAny}} rot_axis_xy0, {{ArgTypeAny}} rot_axis_yz0, {{ArgTypeAny}} rot_axis_zkey_type, {{ArgTypeAny}} key_size, {{ArgTypeAny}} n_level, {{ArgTypeAny}} sep_angle, {{ArgTypeAny}} n_gen, {{ArgTypeAny}} prune_factor, {{ArgTypeAny}} thickness, {{ArgTypeAny}} thick_factor)====
EXAMPLE: ''Example: rotatefractal_tree("pyramid_1Fractal_1",450,0,0,"line",10,3,30,3,10,10,0)''
DescriptionDESCRIPTION: Rotates an object about Generates a line passing through its LCS center and aligned along fractal tree in the specified direction vector (rot_axis) by project workspace under the specified anglecurrently activated material group node, or modifies the fractal tree named 'label' if it already exists.
====scale({{ArgTypeString}} object, {{ArgTypeAny}} scale_factor)freeze====
''ExampleSYNTAX: scalefreeze("pyramid_1"{{ArgTypeString}} object,2 {{ArgTypeReal}} freeze_state)''
DescriptionEXAMPLE: Scales an object by the specified scale factor.''freeze("MyObj",1)''
====get_length({{ArgTypeString}} DESCRIPTION: Sets the freeze state of an object(0/1)====.
''Example: get_length("helix_1")''====gauss====
DescriptionSYNTAX: Returns the length of a curve object.gauss({{ArgTypeReal}} x, ArgTypeReal}} mu, ArgTypeReal}} sigma)
====get_areaEXAMPLE: ''gauss({{ArgTypeString}} object0.5,0,1)====''
''ExampleDESCRIPTION: get_areaComputes and returns the Gaussian function of mean mu and standard deviation sigma: exp(-0.5*((x-mu)/sigma)**2)/sigma/sqrt("ellipse_1"2*pi)''.
Description: Returns the area of a surface object or the total surface area of a solid object.====gauss_beam====
====get_volumeSYNTAX: gauss_beam({{ArgTypeString}} objectlabel, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization, {{ArgTypeAny}} focus_x, {{ArgTypeAny}} focus_y, {{ArgTypeAny}} focus_z, {{ArgTypeAny}} radius, {{ArgTypeAny}} p_mode, {{ArgTypeAny}} q_mode)====
EXAMPLE: ''Example: get_volumegauss_beam("pyramid_1PW_1",180,0,"tm",0,0,0,20,0,0)''
DescriptionDESCRIPTION: Returns the volume of Creates a solid objectGaussian beam source in [[EM.Tempo]]. If the Gaussian beam source 'label' already exists, its properties are modified.
====get_lcs({{ArgTypeString}} object, {{ArgTypeString}} coordinate)generate_input_files====
''ExampleSYNTAX: get_lcsgenerate_input_files("pyramid_1","x")''
DescriptionEXAMPLE: Returns the specified coordinate of the LCS of an object.''generate_input_files()''
====get_rot({{ArgTypeString}} object, {{ArgTypeString}} coordinate)====DESCRIPTION: Generates all the input files for the simulation engine of the current module without running a simulation.
''Example: get_rot("pyramid_1","x")''====geo====
DescriptionSYNTAX: Returns the specified rotation angle of an object.geo({{ArgTypeReal}} x, {{ArgTypeReal}} y)
====get_axisEXAMPLE: ''geo({{ArgTypeString}} object1, {{ArgTypeString}} axis, {{ArgTypeString}} coordinate2)====''
''ExampleDESCRIPTION: get_axisComputes and returns the geometric mean of x and y: sqrt("pyramid_1","x","*y")''.
Description: Returns the specified coordinate of the unit vector along the specified local axis of an object.====get_area====
====get_lcs_offsetSYNTAX: get_area({{ArgTypeString}} object, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off, {{ArgTypeString}} coordinate)====
EXAMPLE: ''Example: get_lcs_offsetget_area("box_1",50,50,0,"xellipse_1")''
DescriptionDESCRIPTION: Returns the specified coordinate area of a surface object or the LCS total surface area of an a solid object after being translated by the specified offset values along the three principal axes.
====get_extent({{ArgTypeString}} object, {{ArgTypeString}} coordinate)get_axis====
''ExampleSYNTAX: get_extentget_axis("pyramid_1"{{ArgTypeString}} object,"x"{{ArgTypeString}} axis, {{ArgTypeString}} coordinate)''
DescriptionEXAMPLE: Returns the size of the bounding box of an object along the specified direction.''get_axis("pyramid_1","x","y")''
====get_vertex({{ArgTypeString}} object, {{ArgTypeAny}} node_index, {{ArgTypeString}} DESCRIPTION: Returns the specified coordinate)====of the unit vector along the specified local axis of an object.
''Example: get_vertex("pyramid_1",0,"x")''====get_domain_extent====
DescriptionSYNTAX: Returns the specified get_domain_extent({{ArgTypeString}} coordinate of the specified vertex of the bounding box of an object. The vertices are specified by node indices. The lower front left corner has an index of 0, while the upper back right corner has an index of 7. The indices are numbered counterclockwise, with the bottom face first and top face next. )
====set_rotEXAMPLE: ''get_domain_extent({{ArgTypeString}} object, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z"x")====''
''ExampleDESCRIPTION: set_rot("pyramid_1",0,0,45)''Returns the size of the computational domain along the specified direction.
Description: Sets the three rotation angles of an object.====get_extent====
====set_lcs_linkSYNTAX: get_extent({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_offcoordinate)====
EXAMPLE: ''Example: set_lcs_linkget_extent("pyramid_1","box_1x",50,50,0)''
DescriptionDESCRIPTION: Links Returns the LCS size of the first object to the LCS bounding box of the second an object by along the specified offset values along the three axesdirection.
====set_rot_link({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off_deg, {{ArgTypeAny}} y_off_deg, {{ArgTypeAny}} z_off_deg)get_lcs====
''ExampleSYNTAX: set_rot_linkget_lcs("pyramid_1"{{ArgTypeString}} object,"box_1",0,0,45{{ArgTypeString}} coordinate)''
DescriptionEXAMPLE: 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.''get_lcs("pyramid_1","x")''
====mirror({{ArgTypeString}} DESCRIPTION: Returns the specified coordinate of the LCS of an object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)====.
''Example: mirror("pyramid_1",0,0,0,1,0,0)''====get_lcs_offset====
DescriptionSYNTAX: Mirrors an get_lcs_offset({{ArgTypeString}} object in a plane defined by the specified point coordinates and specified normal vector components., {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off, {{ArgTypeString}} coordinate)
====groupEXAMPLE: ''get_lcs_offset({{ArgTypeString}} label"box_1", {{ArgTypeString}} object_150, {{ArgTypeString}} object_250, ...0,"x")====''
''ExampleDESCRIPTION: group("Composite_1","Box_1","Box_2","Box_3")''Returns the specified coordinate of the LCS of an object after being translated by the specified offset values along the three principal axes.
Description: Groups a number of objects into a composite object with the given label.====get_length====
====arraySYNTAX: get_length({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing)====
EXAMPLE: ''Example: arrayget_length("Array_1","Rect_Strip_1helix_1",4,4,1,50,50,0)''
DescriptionDESCRIPTION: Creates or modifies an array Returns the length of a curve object.
====array_custom({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)get_rot====
''ExampleSYNTAX: array_customget_rot("Array_1"{{ArgTypeString}} object,"Rect_Strip_1",4,4,1,50,50,0,100,100,20,0,0,45{{ArgTypeString}} coordinate)''
DescriptionEXAMPLE: Creates or modifies an array object and sets its local coordinate system and rotation angles.''get_rot("pyramid_1","x")''
====explode({{ArgTypeString}} DESCRIPTION: Returns the specified rotation angle of an object)====.
''Example: explode("MyArray")''====get_standard_output====
DescriptionSYNTAX: Explodes an object into its basic primitives.get_standard_output({{ArgTypeString}} output_name)
====subtractEXAMPLE: ''get_standard_output({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2"S11M")====''
''ExampleDESCRIPTION: subtract("Subtract_Object","Rect_Strip1","Rect_Strip2")''Returns the computed value of the specified standard output parameter at the end of a simulation.
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.====get_vertex====
====unionSYNTAX: get_vertex({{ArgTypeString}} labelobject, {{ArgTypeStringArgTypeAny}} object_1node_index, {{ArgTypeString}} object_2coordinate)====
EXAMPLE: ''Example: unionget_vertex("Union_Objectpyramid_1","Rect_Strip1"0,"Rect_Strip2x")''
DescriptionDESCRIPTION: Creates a Boolean Returns the specified coordinate of the specified vertex of the bounding box of an object named 'label' . The vertices are specified by unioning object_1 node indices. The lower front left corner has an index of 0, while the upper back right corner has an index of 7. The indices are numbered counterclockwise, with the bottom face first and object_2top face next. An error will be thrown if a Boolean object named 'label' already exists.
====intersect({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)get_volume====
''ExampleSYNTAX: intersectget_volume("Intersection_Object","Rect_Strip1","Rect_Strip2"{{ArgTypeString}} object)''
DescriptionEXAMPLE: Creates a Boolean object named 'label' by intersecting object_1 and object_2. An error will be thrown if a Boolean object named get_volume("pyramid_1")'label' already exists.
====extrude({{ArgTypeString}} label, {{ArgTypeString}} DESCRIPTION: Returns the volume of a solid object, {{ArgTypeAny}} extrude_height, {{ArgTypeAny}} cap_ends)====.
''Example:extrude("Extrude_1","Rect_Strip1",50)''====global_ground====
DescriptionSYNTAX: Creates or modifies an extrusion object from a specified object by the specified height. If modifying an existing extrusion objectglobal_ground({{ArgTypeAny}} ground_on, 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.{{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
====loftEXAMPLE: ''global_ground({{ArgTypeString}} label1, {{ArgTypeString}} object3.3, {{ArgTypeAny}} loft_height, {{ArgTypeAny}} cap_base0.001)====''
''ExampleDESCRIPTION: loft("Loft_1","Rect_Strip1",50)'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.
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.====group====
====revolveSYNTAX: group({{ArgTypeString}} label, {{ArgTypeString}} objectobject_1, {{ArgTypeAnyArgTypeString}} x0object_2, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle...)====
EXAMPLE: ''Example: revolvegroup("Rev1Composite_1","Line_1Box_1",0"Box_2",0,0,0,0,1,360"Box_3")''
DescriptionDESCRIPTION: Creates or modifies Groups a revolution object from number of objects into a specified composite 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 with the revolution axis. The revolution angle "rot_angle" is given in degreeslabel.
====consolidate({{ArgTypeString}} object)harm====
''ExampleSYNTAX: consolidateharm("Poly_1"{{ArgTypeReal}} x, {{ArgTypeReal}} y)''
DescriptionEXAMPLE: Consolidates a specified object.''harm(1,2)''
====spline_fitDESCRIPTION: Computes and returns the harmonic mean of x and y: 2/({{ArgTypeString}} object1/x+1/y)====.
''Example: spline_fit("Poly_1")''====helix====
DescriptionSYNTAX: Applies spline fit transformation on a specified polymeshhelix({{ArgTypeString}} label, polyline or polystrip object.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} helix_dir)
====fill_curveEXAMPLE: ''helix({{ArgTypeString}} object"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'Example: fill_curve(if it already exists. The parameter "Curve_1radius_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.
Description: Fill the interior of the specified closed curve object.====horn_design_a====
====merge_curveSYNTAX: horn_design_a({{ArgTypeStringArgTypeReal}} object_1D0_dB, {{ArgTypeStringArgTypeReal}} object_2a_lambda, {{ArgTypeReal}} b_lambda)====
EXAMPLE: ''Example: merge_curvehorn_design_a("Curve_1"15,0.4,"Curve_2"0.3)''
DescriptionDESCRIPTION: Merges two specified curve objects into a single curveComputes 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.
====close_curve({{ArgTypeString}} label, {{ArgTypeString}} close_state)horn_design_b====
''ExampleSYNTAX: close_curvehorn_design_b("Curve_1"{{ArgTypeReal}} D0_dB,1{{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda)''
DescriptionEXAMPLE: Sets the open/close state of a polyline or NURBS curve''horn_design_b(15,0. Use 4,0 for open curve and 1 for close curve.3)''
====polygonize({{ArgTypeString}} object, {{ArgTypeAny}} side_length)====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.
''Example: polygonize("Cric_1",2)''====horn_design_l====
DescriptionSYNTAX: Polygonizes the specified surface or curve object by the specified side length. The results is a polystrip or a polyline.horn_design_l({{ArgTypeReal}} D0_dB, {{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda)
====polymeshEXAMPLE: ''horn_design_l({{ArgTypeString}} label15, {{ArgTypeString}} object0.4, {{ArgTypeAny}} edge_length0.3)====''
''ExampleDESCRIPTION: polymesh("Poly_1","Cric_1",2)''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.
Description: Discretizes the specified solid or surface object by the specified edge length. The results is a polymesh object.====huygens_src====
====filletSYNTAX: huygens_src({{ArgTypeString}} objectlabel, {{ArgTypeAny}} radiusfilename[, {{ArgTypeAny}} set_lcs, {{ArgTypeAny}} polarization, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} x_rot, {{ArgTypeAny}} y_rot, {{ArgTypeAny}} z_rot])====
EXAMPLE: ''Example: fillethuygens_src("Rect_1HS_1",5"Huygens_1.HUY",1,100,100,0,0,0,0)''
DescriptionDESCRIPTION: Fillets Creates a Huygens source. If the corners of the specified surface or curve object by the specified radiusHuygens source 'label' already exists, its properties are modified.
====slice({{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)huygens_surface====
''ExampleSYNTAX: fillethuygens_surface("Rect_1"{{ArgTypeString}} label,5{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)''
DescriptionEXAMPLE: Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.''huygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)''
====roughen({{ArgTypeString}} DESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, {{ArgTypeString}} object, {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length)====its properties are modified.
''Example: roughen("Rect_1",1,5)''====huygens_surface_grid====
DescriptionSYNTAX: Roughens the surface of the specified object based on the specified RMS height and correlation length.huygens_surface_grid({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====random_groupEXAMPLE: ''huygens_surface_grid({{ArgTypeString}} label"HS_1", {{ArgTypeString}} key_object-10, {{ArgTypeString}} container_object-10, {{ArgTypeAny}} element_count-10,10,10,10)====''
DESCRIPTION: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label'Example: 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.====hyperbola====
====strip_sweepSYNTAX: hyperbola({{ArgTypeString}} objectlabel, {{ArgTypeAny}} widthx0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)====
EXAMPLE: ''Example: strip_sweephyperbola("Curve_1Hyperbola _1",50,0,0,50,40,20,0)''
DescriptionDESCRIPTION: Creates Draws a strip version of a given curve hyperbola objectin 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.
====pipe_sweep({{ArgTypeString}} object, {{ArgTypeAny}} radius)impedance_surface_group====
''ExampleSYNTAX: pipe_sweepimpedance_surface_group("Curve_1"{{ArgTypeString}} label,5{{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag)''
DescriptionEXAMPLE: Creates a pipe version of a given curve object.''impedance_surface_group("IMP_1",100,-100)''
====rail_sweep({{ArgTypeString}} rail_objectDESCRIPTION: Creates a impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'label' already exists, {{ArgTypeString}} sweep_object)====the group is activated.
''Example: rail_sweep("Curve_1","Curve_2")''====impenetrable_surface_group====
DescriptionSYNTAX: Rail-sweeps the specified sweep object along the specified curve object.impenetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
== EMEXAMPLE: ''impenetrable_surface_group("Impenet_1",2.Cube2,0.0001)''s Python Functions for Material or Object Group Creation ==
====activate({{ArgTypeString}} group_node_label)====DESCRIPTION: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'label' already exists, the group is activated.
''Example: activate("Color_1")''====import_dxf====
DescriptionSYNTAX: Activates a color, material or object group in the current active [[EM.Cube]] module. import_dxf({{ArgTypeString}} file_name)
====color_groupEXAMPLE: ''import_dxf({{ArgTypeString}} label"MyDXFModel.DXF")====''
''ExampleDESCRIPTION: color_group("Color_1")''Imports an external DXF model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.
Description: Creates a color group in CubeCAD module. If the color group 'label' already exists, the group is activated.====import_igs====
====pec_groupSYNTAX: import_igs({{ArgTypeString}} labelfile_name)====
EXAMPLE: ''Example: pec_groupimport_igs("PEC_1MyIGSModel.IGS")''
DescriptionDESCRIPTION: Creates a PEC material group in Imports an external IGES model file to the current moduleproject workspace. If the PEC group 'label' already existsfile path is not specified, the group current project folder is activatedassumed as the path.
====pec_voltage_group({{ArgTypeString}} label, {{ArgTypeAny}} voltage)import_py====
''ExampleSYNTAX: pec_voltage_groupimport_py("PEC_1",10{{ArgTypeString}} file_name)''
DescriptionEXAMPLE: Creates a fixed-potential PEC object group in the current module. If the PEC group 'label' already exists, the group is activatedimport_py("MyPYModel.PY")''
====pec_via_group({{ArgTypeString}} label, {{ArgTypeAny}} host_layer)====DESCRIPTION: Imports a Python geometry file to the project workspace. The default path is the Python subfolder under "Documents → EMAG".
''Example: pec_via_group("PEC_1",10)''====import_stl====
DescriptionSYNTAX: Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already exists, the group is activated.import_stl({{ArgTypeString}} file_name)
====thinwire_groupEXAMPLE: ''import_stl({{ArgTypeString}} label, {{ArgTypeAny}} radius"MySTLModel.STL")====''
''ExampleDESCRIPTION: thinwire_group("Thinwire_1"Imports an external STL model file to the project workspace. If the file path is not specified,4)''the current project folder is assumed as the path.
Description: Creates a Thinwire material group in the current module. If the thin wire group 'label' already exists, the group is activated.====import_stp====
====pmc_groupSYNTAX: import_stp({{ArgTypeString}} labelfile_name)====
EXAMPLE: ''Example: pmc_groupimport_stp("PMC_1MySTPModel.STP")''
DescriptionDESCRIPTION: Creates a PMC material group in Imports an external STEP model file to the current moduleproject workspace. If the PMC group 'label' already existsfile path is not specified, the group current project folder is activatedassumed as the path.
====slot_group({{ArgTypeString}} label)inductance====
''ExampleSYNTAX: slot_groupinductance("PMC_1"{{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)''
DescriptionEXAMPLE: Creates a slot trace group in the current module. If the slot trace group 'label' already existsinductance("FI_1", the group is activated0,0,-10,10,0,10,2.5,-2.5,0,7.5,2.5,0)''
====dielectric_group({{ArgTypeString}} DESCRIPTION: Creates a inductance integral observable in [[EM.Ferma]]. 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)''====inductor====
DescriptionSYNTAX: Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'inductor({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} inductance_nH)
====impenetrable_surface_groupEXAMPLE: ''inductor({{ArgTypeString}} label"Cap_1", {{ArgTypeAny}} eps"Line_1", {{ArgTypeAny}} sigma25,10)====''
''ExampleDESCRIPTION: impenetrable_surface_group("Impenet_1",2Creates a inductor in [[EM.2,0Tempo]].0001)If the inductor 'label'already exists, its properties are modified.
Description: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'label' already exists, the group is activated.====intersect====
====penetrable_surface_groupSYNTAX: intersect({{ArgTypeString}} label, {{ArgTypeAnyArgTypeString}} epsobject_1, {{ArgTypeAny}} sigma, {{ArgTypeAnyArgTypeString}} thicknessobject_2)====
EXAMPLE: ''Example: penetrable_surface_groupintersect("Penet_1Intersection_Object",2.2"Rect_Strip1",0.0001, 1"Rect_Strip2")''
DescriptionDESCRIPTION: Creates a penetrable surface group in [[EMBoolean object named 'label' by intersecting object_1 and object_2.Terrano]]. If the penetrable surface group An error will be thrown if a Boolean object named 'label' already exists, the group is activated.
====penetrable_volume_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)line====
''ExampleSYNTAX: penetrable_volume_groupline("Vol_Penet_1"{{ArgTypeString}} label,2.2{{ArgTypeAny}} x0,0.0001{{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length[, {{ArgTypeAny}} dir])''
DescriptionEXAMPLE: Creates a penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'label' already existsline("my_line", the group is activated.0,0,0,100,"x")''
====terrain_group({{ArgTypeString}} labelDESCRIPTION: Draws a Line object in the project workspace under the currently activated material group node, {{ArgTypeAny}} epsor modifies the line named 'label' if it already exists. Without the argument "dir", {{ArgTypeAny}} sigma)====a vertical line is drawn by default.
''Example: terrain_group("Terrain_1",5.0,0.0001)''====loft====
DescriptionSYNTAX: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'loft({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeString}} object, {{ArgTypeAny}} loft_height, {{ArgTypeAny}} cap_base)
====base_point_groupEXAMPLE: ''loft({{ArgTypeString}} label"Loft_1","Rect_Strip1",50)====''
''ExampleDESCRIPTION: base_point_set("BP_Set_1")' 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.
Description: Creates a base point set in [[EM.Terrano]]. If the base point set group 'label' already exists, the group is activated.====lumped_src====
====virtual_groupSYNTAX: lumped_src({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])====
EXAMPLE: ''Example: virtual_grouplumped_src("VIR_1LS_1","Line_1",50,0)''
DescriptionDESCRIPTION: Creates a virtual object group lumped source in [[EM.TerranoTempo]]. If the virtual group lumped source 'label' already exists, the group is activatedits properties are modified.
====impedance_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag)magnet_group====
''ExampleSYNTAX: impedance_surface_groupmagnet_group("IMP_1"{{ArgTypeString}} label,100{{ArgTypeAny}} mu,-100{{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mz)''
DescriptionEXAMPLE: Creates a impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'label' already existsmagnet_group("Magnet_1", the group is activated.1,0,0,100)''
====conductive_sheet_group({{ArgTypeString}} DESCRIPTION: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already exists, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)====the group is activated.
''Example: conductive_sheet_group("Cond_1",100, 0.01)''====mcos====
DescriptionSYNTAX: Creates a conductive sheet group in [[EM.Picasso]]. If the conductive sheet group 'label' already existsmcos({{ArgTypeReal}} x, the group is activated.{{ArgTypeReal}} r)
====charge_groupEXAMPLE: ''mcos({{ArgTypeString}} label0.5, {{ArgTypeAny}} density2)====''
''ExampleDESCRIPTION: charge_group("Charge_1",Computes and returns the super-1e-5)''quadratic cosine function of order r.
Description: Creates a volume charge source group in [[EM.Ferma]]. If the charge group 'label' already exists, the group is activated.====mean====
====magnet_groupSYNTAX: mean({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mzy)====
EXAMPLE: ''Example: magnet_groupmean("Magnet_1",1,0,0,1002)''
DescriptionDESCRIPTION: Creates a permanent magnet source group in [[EMComputes and returns the arithmetic mean of x and y: 0.Ferma]]. If the magnet group 'label' already exists, the group is activated5*(x+y).
====volume_current_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz)merge_curve====
''ExampleSYNTAX: volume_current_groupmerge_curve("Magnet_1"{{ArgTypeString}} object_1,0,0,1e6{{ArgTypeString}} object_2)''
DescriptionEXAMPLE: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'label' already existsmerge_curve("Curve_1", the group is activated."Curve_2")''
====wire_current_group({{ArgTypeString}} label, {{ArgTypeAny}} current, {{ArgTypeAny}} wire_radius)====DESCRIPTION: Merges two specified curve objects into a single curve.
''Example: wire_current_group("Magnet_1",1,0.5)''====mesh====
DescriptionSYNTAX: Creates a wire current source group in [[EM.Ferma]]. If the wire current group 'label' already exists, the group is activated.mesh()
== EMDESCRIPTION: Generates and displays the mesh of the physical structure.Cube's Python Functions for Source & Lumped Device Definition ==
====lumped_src({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])microstrip_design====
''ExampleSYNTAX: lumped_srcmicrostrip_design("LS_1"{{ArgTypeReal}} z0,"Line_1",50,0{{ArgTypeReal}} er)''
DescriptionEXAMPLE: Creates a lumped source in [[EM.Tempo]]. If the lumped source 'label' already existsmicrostrip_design(50, its properties are modified2.2)''
====distributed_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} field_dir, {{ArgTypeAny}} profile[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])====DESCRIPTION: Computes and returns the width-to-height ratio of a microstrip transmission line with characteristic impedance z0 in Ohms and substrate relative permittivity er.
''Example: distributed_src("DS_1","Rect_1","+y","uniform")''====microstrip_eps_eff====
DescriptionSYNTAX: Creates a distributed source in [[EM.Tempo]]. If the distributed source 'label' already existsmicrostrip_eps_eff({{ArgTypeReal}} w, its properties are modified.{{ArgTypeReal}} h, {{ArgTypeReal}} er)
====microstrip_srcEXAMPLE: ''microstrip_eps_eff({{ArgTypeString}} label2, {{ArgTypeAny}} rect_object0.5, {{ArgTypeAny}} height, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]2.2)====''
''ExampleDESCRIPTION: microstrip_src("MS_1"Computes and returns the effective permittivity of a microstrip transmission line with width w,"Rect_1",1substrate height h and substrate relative permittivity er.5,"+x")''
Description: Creates a microstrip port source in [[EM.Tempo]]. If the microstrip port 'label' already exists, its properties are modified.====microstrip_lambda_g====
====cpw_srcSYNTAX: microstrip_lambda_g({{ArgTypeStringArgTypeReal}} labelw, {{ArgTypeAnyArgTypeReal}} rect_objecth, {{ArgTypeAnyArgTypeReal}} spacinger, {{ArgTypeAnyArgTypeReal}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]freq_hertz)====
EXAMPLE: ''Example: cpw_srcmicrostrip_lambda_g("CPW_1"2,"Rect_1",10.5,"+x"2.2,2e9)''
DescriptionDESCRIPTION: Creates a CPW port source in [[EM.Tempo]]. If Computes and returns the CPW port 'label' already existsguide wavelength (in meters) of a microstrip transmission line with width w, its properties are modifiedsubstrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
====coaxial_src({{ArgTypeString}} label, {{ArgTypeAny}} cylinder_object, {{ArgTypeAny}} outer_radius, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])microstrip_src====
''ExampleSYNTAX: coaxial_srcmicrostrip_src("COAX_1"{{ArgTypeString}} label,"Cyl_1"{{ArgTypeAny}} rect_object,1.5{{ArgTypeAny}} height,"+z"{{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])''
DescriptionEXAMPLE: Creates a coaxial port source in [[EM.Tempo]]. If the coaxial port 'label' already existsmicrostrip_src("MS_1", its properties are modified"Rect_1",1.5,"+x")''
====waveguide_src({{ArgTypeString}} DESCRIPTION: Creates a microstrip port source in [[EM.Tempo]]. If the microstrip port 'label' already exists, {{ArgTypeAny}} box_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])====its properties are modified.
''Example: waveguide_src("WG_1","Box_1",50,0)''====microstrip_z0====
DescriptionSYNTAX: Creates a waveguide port source in [[EM.Tempo]]. If the waveguide port 'label' already existsmicrostrip_z0({{ArgTypeReal}} w, its properties are modified.{{ArgTypeReal}} h, {{ArgTypeReal}} er)
====wire_gap_srcEXAMPLE: ''microstrip_z0({{ArgTypeString}} label2, {{ArgTypeAny}} line_object0.5, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]2.2)====''
''ExampleDESCRIPTION: wire_gap_srcComputes and returns the characteristic impedance ("WIG_1"in Ohms) of a microstrip transmission line with width w,"Line_1",50,0)''substrate height h and substrate relative permittivity er.
Description: Creates a wire gap circuit source in [[EM.Libera]]. If the wire gap source 'label' already exists, its properties are modified.====microstrip_zoc====
====rect_gap_srcSYNTAX: microstrip_zoc({{ArgTypeStringArgTypeReal}} labelw, {{ArgTypeAnyArgTypeReal}} rect_objectl, {{ArgTypeAnyArgTypeReal}} offseth, {{ArgTypeAnyArgTypeReal}} polarity[er, {{ArgTypeAnyArgTypeReal}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]freq_hertz)====
EXAMPLE: ''Example: rect_gap_srcmicrostrip_zoc("GAP_1"2,"Rect_1"25,0.5,02.2,2e9)''
DescriptionDESCRIPTION: Creates a strip gap circuit source in [[EM.Picasso]] or [[EM.Libera]]. If Computes and returns the strip gap source 'label' already existsinput reactance (in Ohms) of an open-circuited microstrip transmission line with width w, length l, its properties are modifiedsubstrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
====probe_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} via_object, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])microstrip_zsc====
''ExampleSYNTAX: probe_gap_srcmicrostrip_zsc("Probe_1"{{ArgTypeReal}} w,"Via_1"{{ArgTypeReal}} l,0{{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)''
DescriptionEXAMPLE: Creates a probe gap circuit source in [[EM.Picasso]]. If the probe gap source 'label' already existsmicrostrip_zsc(2, its properties are modified25,0.5,2.2,2e9)''
====wave_portDESCRIPTION: Computes and returns the input reactance ({{ArgTypeString}} labelin Ohms) of a short-circuited microstrip transmission line with width w, {{ArgTypeAny}} rect_objectlength l, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])====substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
''Example: wave_port("WP_1","Rect_1",0,0)''====mirror====
DescriptionSYNTAX: Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If the wave port 'label' already existsmirror({{ArgTypeString}} object, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)
====short_dipoleEXAMPLE: ''mirror({{ArgTypeString}} label"pyramid_1", {{ArgTypeAny}} x00, {{ArgTypeAny}} y00, {{ArgTypeAny}} z00, {{ArgTypeAny}} length1, {{ArgTypeAny}} uX0, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase0)====''
''ExampleDESCRIPTION: wave_port("SD_1",0,0,50,3,0,0,1,1,0)''Mirrors an object in a plane defined by the specified point coordinates and specified normal vector components.
Description: Creates a Hertzian short dipole source. If the short dipole source 'label' already exists, its properties are modified.====move_to====
====planewaveSYNTAX: move_to({{ArgTypeString}} labelobject, {{ArgTypeAnyArgTypeString}} thetagroup_node_label[, {{ArgTypeAny}} phi, {{ArgTypeAnyArgTypeString}} polarizationmodule_name])====
EXAMPLE: ''Example: planewavemove_to("PW_1NewObj",180,0,"tmMyObj",10,10,0)''
DescriptionDESCRIPTION: Creates a plane wave source. If the plane wave source 'label' already exists, Transfers an object from its properties are modifiedcurrent material/object group node in the navigation tree to another node or optionally to another [[EM.Cube]] module.
====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)msin====
''ExampleSYNTAX: gauss_beammsin("PW_1"{{ArgTypeReal}} x,180,0,"tm",0,0,0,20,0,0{{ArgTypeReal}} r)''
DescriptionEXAMPLE: Creates a Gaussian beam source in [[EM.Tempo]]. If the Gaussian beam source 'label' already exists, its properties are modifiedmsin(0.5,2)''
====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])====DESCRIPTION: Computes and returns the super-quadratic sine function of order r.
''Example: huygens_src("HS_1","Huygens_1.HUY",1,100,100,0,0,0,0)''====nurbs_curve====
DescriptionSYNTAX: Creates a Huygens source. If the Huygens source 'nurbs_curve({{ArgTypeString}} label' already exists, its properties are modified{{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ...{{ArgType| 3x1 Python tuple}} pn)
====transmitter_setEXAMPLE: ''nurbs_curve({{ArgTypeString}} label"nc_1", {{ArgTypeAny}} base_point_set[(0, {{ArgTypeAny}} pattern_file0, {{ArgTypeAny}} rot_x0), {{ArgTypeAny}} rot_y(1, {{ArgTypeAny}} rot_z0,0),(1,0,0))====''
''ExampleDESCRIPTION: transmitter_set("TX_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,"PT_1"otherwise,"DPL_STDit is open.RAD",0,90,0)''
Description: Creates a transmitter set in [[EM.Terrano]]. If the transmitter set 'label' already exists, its properties are modified.====nurbs_strip====
====resistorSYNTAX: nurbs_strip({{ArgTypeString}} label, {{ArgTypeAnyArgType| 3x1 Python tuple}} line_objectp0, {{ArgTypeAnyArgType| 3x1 Python tuple}} offsetp1, ... {{ArgTypeAnyArgType| 3x1 Python tuple}} resistancepn)====
EXAMPLE: ''Example: resistornurbs_strip("Res_1ns_1","Line_1"(0,0,0),(1,0,0),(1,250,500))''
DescriptionDESCRIPTION: Creates or modifies a resistor NURBS Strip object in [[EMthe project workspace.Tempo]]Each point is represented with a Python tuple type. If the resistor The nurbs_strip function is 'labelself-closing' already exists, its properties are modified-- there is no need to supply the first point again at the end of the point list.
====capacitor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} capacitance_pF)ohmic_loss====
''ExampleSYNTAX: capacitorohmic_loss("Cap_1"{{ArgTypeString}} label,"Line_1"{{ArgTypeAny}} x1,25{{ArgTypeAny}} y1,10{{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)''
DescriptionEXAMPLE: Creates a capacitor in [[EM.Tempo]]. If the capacitor 'label' already existsohmic_loss("FI_1", its properties are modified.-10,-10,-10,10,10,10)''
====inductor({{ArgTypeString}} DESCRIPTION: Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} inductance_nH)====its properties are modified.
''Example: inductor("Cap_1","Line_1",25,10)''====parabola====
DescriptionSYNTAX: Creates a inductor in [[EM.Tempo]]. If the inductor 'parabola({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)
====diodeEXAMPLE: ''parabola({{ArgTypeString}} label"Parabola _1", {{ArgTypeAny}} line_object0, {{ArgTypeAny}} polarity0, {{ArgTypeAny}} is_fA0, {{ArgTypeAny}} temperature_K50, {{ArgTypeAny}} ideality_factor20,0)====''
DESCRIPTION: Draws a parabola object in the project workspace under the currently activated material group node, or modifies the parabola named 'label'Example: diode(if it already exists. If the Boolean parameter "Diode_1half_only"is 1,"Line_1",25,0,10,300,1)''only half of the parabola will be drawn.
Description: Creates a diode in [[EM.Tempo]]. If the diode 'label' already exists, its properties are modified.====param_curve====
== EM.Cube's Python Functions for Observable Definition ==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)])
====port_definition_defaultEXAMPLE: ''param_curve({{ArgTypeString}} label"Curve_1",0,0,0,"parametric","xy",0,10,0.1,"cos(t)","sin(t)","t")====''
''ExampleDESCRIPTION: port_definition_default("PD_1")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.
Description: Creates a default port definition observable. If the observable 'label' already exists, its properties are modified.====param_surface====
====port_definition_customSYNTAX: param_surface({{ArgTypeString}} label, ({{ArgTypeStringArgTypeAny}} port_1_src_1x0, {{ArgTypeStringArgTypeAny}} port_1_src_2y0, ...{{ArgTypeAny}} z0, {{ArgTypeStringArgTypeAny}} port_1_impedance)orientation, ({{ArgTypeStringArgTypeAny}} port_2_src_1start1, {{ArgTypeStringArgTypeAny}} port_2_src_2stop1, {{ArgTypeAny}} step1, ..., {{ArgTypeStringArgTypeAny}} port_2_impedance)start2, ...{{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} function)====
EXAMPLE: ''Example: port_definition_customparam_surface("PD_1Surf_1",("LS_1"0,0,0,"LS_2xy",50)0,10,("LS_3"0.1,"LS_4"0,5010,0.1,"sin(x)*sin(y)")''
DescriptionDESCRIPTION: Creates Generates a custom port definition observable. If parametric surface in the observable project workspace under the currently activated material group node, or modifies the parametric surface named 'label' if it already exists, its properties are modified.
====farfield({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)pec_group====
''ExampleSYNTAX: farfieldpec_group("FF_1",1,1{{ArgTypeString}} label)''
DescriptionEXAMPLE: Creates a far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.pec_group("PEC_1")''
====rcs_bistatic({{ArgTypeString}} DESCRIPTION: Creates a PEC material group in the current module. If the PEC group 'label' already exists, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)====the group is activated.
''Example: rcs_bistatic("RCS_1",1,1)''====pec_via_group====
DescriptionSYNTAX: Creates a bistatic RCS observable. If the observable 'pec_via_group({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} host_layer)
====current_distEXAMPLE: ''pec_via_group({{ArgTypeString}} label"PEC_1",10)====''
''ExampleDESCRIPTION: current_dist("CD_1")Creates an embedded PEC via set group in the current module. If the PEC via group 'label'already exists, the group is activated.
Description: Creates a current distribution observable. If the observable 'label' already exists, its properties are modified.====pec_voltage_group====
====field_sensorSYNTAX: pec_voltage_group({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamplesvoltage)====
EXAMPLE: ''Example: field_sensorpec_voltage_group("FS_1PEC_1","z",0,0,0,100,100,0,25,25,010)''
DescriptionDESCRIPTION: Creates a nearfixed-field sensor observablepotential PEC object group in the current module. If the observable PEC group 'label' already exists, its properties are modifiedthe group is activated.
====field_sensor_grid({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)penetrable_surface_group====
''ExampleSYNTAX: field_sensor_gridpenetrable_surface_group("FS_1"{{ArgTypeString}} label,"z"{{ArgTypeAny}} eps,0{{ArgTypeAny}} sigma,0,0{{ArgTypeAny}} thickness)''
DescriptionEXAMPLE: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already existspenetrable_surface_group("Penet_1", its properties are modified2.2,0.0001, 1)''
====field_probe({{ArgTypeString}} DESCRIPTION: Creates a penetrable surface group in [[EM.Terrano]]. If the penetrable surface group 'label' already exists, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)====the group is activated.
''Example: field_probe("FS_1",0,0,50)''====penetrable_volume_group====
DescriptionSYNTAX: Creates a temporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'penetrable_volume_group({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
====receiver_setEXAMPLE: ''penetrable_volume_group({{ArgTypeString}} label"Vol_Penet_1", {{ArgTypeAny}} base_point_set[2.2, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z0.0001)====''
DESCRIPTION: Creates a penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'label'Example: receiver_set("TX_1"already exists,"PT_1","DPL_STDthe group is activated.RAD",0,90,0)''
Description: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label' already exists, its properties are modified.====pipe_sweep====
====huygens_surfaceSYNTAX: pipe_sweep({{ArgTypeString}} labelobject, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamplesradius)====
EXAMPLE: ''Example: huygens_surfacepipe_sweep("HS_1Curve_1",-10,-10,-10,10,10,10,40,40,405)''
DescriptionDESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, its properties are modifiedpipe version of a given curve object.
====huygens_surface_grid({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)planewave====
''ExampleSYNTAX: huygens_surface_gridplanewave("HS_1"{{ArgTypeString}} label,-10{{ArgTypeAny}} theta,-10{{ArgTypeAny}} phi,-10,10,10,10{{ArgTypeAny}} polarization)''
Description'EXAMPLE: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label' already existsplanewave("PW_1", its properties are modified.180,0,"tm")''
====voltage_integral({{ArgTypeString}} DESCRIPTION: Creates a plane wave source. If the plane wave source 'label' already exists, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====its properties are modified.
''Example: voltage_integral("FI_1",0,0,-10,0,0,10)''====plot_file====
DescriptionSYNTAX: Creates a voltage integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.plot_file({{ArgTypeString}} filename)
====current_integralEXAMPLE: ''plot_file({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2"D0.DAT")====''
''ExampleDESCRIPTION: current_integral("FI_1",-10,-10,0,10,10,0)''Plots the contents of a specified data file in EM.Grid.
Description: Creates a current integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====pmc_group====
====conduction_current_integralSYNTAX: pmc_group({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====
EXAMPLE: ''Example: conduction_current_integralpmc_group("FI_1PMC_1",-10,-10,0,10,10,0)''
DescriptionDESCRIPTION: Creates a conduction current integral observable PMC material group in [[EM.Ferma]]the current module. If the observable PMC group 'label' already exists, its properties are modifiedthe group is activated.
====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)point====
''ExampleSYNTAX: capacitancepoint("FI_1"{{ArgTypeString}} label,-10{{ArgTypeAny}} x0,-10{{ArgTypeAny}} y0,5,10,10,10,0,0,-10,0,0,10{{ArgTypeAny}} z0)''
DescriptionEXAMPLE: Creates a capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already existspoint("Point_1", its properties are modified.0,0,10)''
====inductance({{ArgTypeString}} DESCRIPTION: Draws a point in the project workspace under the currently activated material group node, or modifies the point named '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)====' if it already exists.
''Example: inductance("FI_1",0,0,-10,10,0,10,2.5,-2.5,0,7.5,2.5,0)''====polygon_reg====
DescriptionSYNTAX: Creates a inductance integral observable in [[EM.Ferma]]. If the observable 'polygon_reg({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} n_sides)
====resistanceEXAMPLE: ''polygon_reg({{ArgTypeString}} label"ts_1", {{ArgTypeAny}} x10, {{ArgTypeAny}} y10, {{ArgTypeAny}} z10, {{ArgTypeAny}} x250, {{ArgTypeAny}} y2100, {{ArgTypeAny}} z280, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z41)====''
''ExampleDESCRIPTION: resistance("FI_1",0,0,-10,0,0,10,-10,-10,0,10,10Draws a regular polygon object in the project workspace under the currently activated material group node,0)or modifies the regular polygon object named 'label'if it already exists.
Description: Creates a resistance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====polygonize====
====flux_electricSYNTAX: polygonize({{ArgTypeString}} labelobject, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2side_length)====
EXAMPLE: ''Example: flux_electricpolygonize("FI_1Cric_1",-10,-10,5,10,10,102)''
DescriptionDESCRIPTION: Creates an electric flux integral observable in [[EM.Ferma]]. If Polygonizes the observable 'label' already exists, its properties are modifiedspecified surface or curve object by the specified side length. The results is a polystrip or a polyline.
====flux_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)polyline====
''ExampleSYNTAX: flux_magneticpolyline("FI_1"{{ArgTypeString}} label,0{{ArgType| 3x1 Python tuple}} p0,0{{ArgType| 3x1 Python tuple}} p1,-10,10,0,10... {{ArgType| 3x1 Python tuple}} pn)''
DescriptionEXAMPLE: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label' already existspolyline("pl_1", its properties are modified.(0,0,0),(1,0,0),(1,0,0))''
====energy_electric({{ArgTypeString}} labelDESCRIPTION: 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, {{ArgTypeAny}} x1otherwise, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====it is open.
''Example: energy_electric("FI_1",-10,-10,-10,10,10,10)''====polymesh====
DescriptionSYNTAX: Creates an electric energy integral observable in [[EM.Ferma]]. If the observable 'polymesh({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeString}} object, {{ArgTypeAny}} edge_length)
====energy_magneticEXAMPLE: ''polymesh({{ArgTypeString}} label"Poly_1", {{ArgTypeAny}} x1"Cric_1", {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z22)====''
''ExampleDESCRIPTION: energy_magnetic("FI_1",-10,-10,-10,10,10,10)''Discretizes the specified solid or surface object by the specified edge length. The results is a polymesh object.
Description: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====polystrip====
====ohmic_lossSYNTAX: polystrip({{ArgTypeString}} label, {{ArgTypeAnyArgType| 3x1 Python tuple}} x1p0, {{ArgTypeAnyArgType| 3x1 Python tuple}} y1p1, ... {{ArgTypeAnyArgType| 3x1 Python tuple}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2pn)====
EXAMPLE: ''Example: ohmic_losspolystrip("FI_1ps_1",-10(0,-100,-100),10(1,0,0),(1,100,100))''
DescriptionDESCRIPTION: Creates an ohmic loss integral observable or modifies a Polystrip object in [[EMthe project workspace.Ferma]]Each point is represented with a Python tuple type. If the observable The poly_strip function is 'labelself-closing' already exists, its properties are modified-- there is no need to supply the first point again at the end of the point list.
====solution_plane({{ArgTypeString}} label, {{ArgTypeAny}} field_sensor_label, {{ArgTypeAny}} is_quasi)port_definition_custom====
''ExampleSYNTAX: solution_planeport_definition_custom("FI_1"{{ArgTypeString}} label,"FS_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),1...)''
DescriptionEXAMPLE: Creates a 2D solution plane observable in [[EM.Ferma]]. If the observable 'label' already existsport_definition_custom("PD_1", its properties are modified.("LS_1","LS_2",50),,("LS_3","LS_4",50))''
== EMDESCRIPTION: Creates a custom port definition observable.CubeIf the observable 's Python Functions for Simulation-Related Functions & Operations ==label' already exists, its properties are modified.
====select_module({{ArgTypeString}} module_name)port_definition_default====
''ExampleSYNTAX: select_moduleport_definition_default("[[EM.Tempo]]"{{ArgTypeString}} label)''
DescriptionEXAMPLE: Selects and sets [[EM.Cube]]'s active module.'port_definition_default("PD_1")''
====set_units({{ArgTypeString}} units)====DESCRIPTION: Creates a default port definition observable. If the observable 'label' already exists, its properties are modified.
''Example: set_units("meter")''====probe_gap_src====
DescriptionSYNTAX: Sets probe_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} via_object, {{ArgTypeAny}} polarity[[EM.Cube], {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]'s project length units.)
====set_frequencyEXAMPLE: ''probe_gap_src({{ArgTypeAny}} value"Probe_1","Via_1",0)====''
''ExampleDESCRIPTION: set_frequency(2Creates a probe gap circuit source in [[EM.4e9)Picasso]]. If the probe gap source 'label'already exists, its properties are modified.
Description: Sets [[EM.Cube]]'s center frequency.====pyramid====
====set_bandwidthSYNTAX: pyramid({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} valueheight)====
EXAMPLE: ''Example: set_bandwidthpyramid(1e9"Pyramid_1",0,0,0,10,10,100)''
DescriptionDESCRIPTION: Sets [[EM.Cube]]Draws a pyramid object in the project workspace under the currently activated material group node, or modifies the pyramid named 's frequency bandwidthlabel' if it already exists.
====background_layer({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thickness)radial_strip====
''ExampleSYNTAX: background_layerradial_strip("Mid_Layer"{{ArgTypeString}} label,3.3{{ArgTypeAny}} x0,0.001{{ArgTypeAny}} y0,1{{ArgTypeAny}} z0,1.5{{ArgTypeAny}} radius, {{ArgTypeAny}} base_length, {{ArgTypeAny}} angle)''
DescriptionEXAMPLE: Adds a new substrate layer to [[EM.Picasso]]'s background layer stackup.'radial_strip("Radial_1",0,0,0,50,0,90)''
====delete_background_layer({{ArgTypeString}} 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.
''Example: delete_background_layer("Mid_Layer")''====rail_sweep====
DescriptionSYNTAX: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup.rail_sweep({{ArgTypeString}} rail_object, {{ArgTypeString}} sweep_object)
====set_stackup_orderEXAMPLE: ''rail_sweep("THSCurve_1", {{ArgTypeString}} label_1, {{ArgTypeString}} label_2, ..., {{ArgTypeString}} label_n, "BHSCurve_2")====''
''ExampleDESCRIPTION: background_layer("THS","Top_Layer","Mid_Layer","Bottom_Layer","BHS")''Rail-sweeps the specified sweep object along the specified curve object.
Description: 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. ====ramp====
====global_groundSYNTAX: ramp({{ArgTypeAnyArgTypeReal}} ground_on, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigmax)====
EXAMPLE: ''Example: global_groundramp(1,3.3,0.0015)''
DescriptionDESCRIPTION: Set the state of [[EM.Terrano]]'s global ground Computes and its material properties. A zero value for ground_on means to no global ground assumed at Z = returns the ramp function: x if x>0, 0 if x<0.
====delete({{ArgTypeString}} node_name)rand====
''ExampleSYNTAX: deleterand("Box_1"{{ArgTypeReal}} x, {{ArgTypeReal}} y)''
DescriptionEXAMPLE: Deletes a node name from the navigation tree. The node can be any geometric object''rand(0, source, observable or material group. 1)''
====rename({{ArgTypeString}} new_label, {{ArgTypeString}} old_label)====DESCRIPTION: Computes and returns a random number between x and y using an uniform distribution.
''Example: rename("Box_2","Box_1")''====random_group====
DescriptionSYNTAX: Deletes a node name from the navigation tree. The node can be any geometric objectrandom_group({{ArgTypeString}} label, source{{ArgTypeString}} key_object, observable or material group. {{ArgTypeString}} container_object, {{ArgTypeAny}} element_count)
====zoom_extentsEXAMPLE: ''random_group("Rand_1","Rect_1","Box_1",100)====''
DescriptionDESCRIPTION: Zooms to fit Creates a random group using the extents of specified key object and confines them in the physical structure into the screenspecified container object.
====get_domain_extent({{ArgTypeString}} coordinate)rcs_bistatic====
''ExampleSYNTAX: get_domain_extentrcs_bistatic("x"{{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])''
DescriptionEXAMPLE: Returns the size of the computational domain along the specified direction.''rcs_bistatic("RCS_1",1,1)''
====set_domain_offset({{ArgTypeAny}} dxn_offsetDESCRIPTION: Creates a bistatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the observable 'label' already exists, {{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset)====its properties are modified.
''Example: set_domain_offset(20,20,20,20,0,10)''====rcs_monostatic====
DescriptionSYNTAX: Sets the domain offset values along the ±Xrcs_monostatic({{ArgTypeString}} label, ±Y and ±Z directions in project units.{{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])
====set_domain_offset_lambdaEXAMPLE: ''rcs_monostatic({{ArgTypeAny}} dxn_offset"RCS_1", {{ArgTypeAny}} dxp_offset1, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset1)====''
DESCRIPTION: Creates a monostatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the observable 'label'Examplealready exists, its properties are modified. ====receiver_set==== SYNTAX: receiver_set({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z) EXAMPLE: ''receiver_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)'' DESCRIPTION: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label' already exists, its properties are modified. ====rect==== SYNTAX: rect({{ArgTypeReal}} x) EXAMPLE: ''rect(0.1)'' DESCRIPTION: Computes and returns the rectangular window function: 1 if x<0.5, 0 elsewhere. ====rect_gap_src==== SYNTAX: rect_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]) EXAMPLE: ''rect_gap_src("GAP_1","Rect_1",0,0)'' DESCRIPTION: Creates a strip gap circuit source in [[EM.Picasso]] or [[EM.Libera]]. If the strip gap source 'label' already exists, its properties are modified. ====rect_strip==== SYNTAX: rect_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side_x, {{ArgTypeAny}} side_y) EXAMPLE: ''rect_strip("my_rectangle",0,0,0,50,20)'' 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. ====rename==== SYNTAX: rename({{ArgTypeString}} new_label, {{ArgTypeString}} old_label) EXAMPLE: ''rename("Box_2","Box_1")'' DESCRIPTION: Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.  ====resistance==== SYNTAX: resistance({{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: ''resistance("FI_1",0,0,-10,0,0,10,-10,-10,0,10,10,0)'' DESCRIPTION: Creates a resistance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====resistor==== SYNTAX: resistor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} resistance) EXAMPLE: ''resistor("Res_1","Line_1",25,50)'' DESCRIPTION: Creates a resistor in [[EM.Tempo]]. If the resistor 'label' already exists, its properties are modified. ====revolve==== SYNTAX: revolve({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle) EXAMPLE: ''revolve("Rev1","Line_1",0,0,0,0,0,1,360)'' 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. ====rosen==== SYNTAX: rosen({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} a, {{ArgTypeReal}} b) EXAMPLE: ''rosen(0.5,0,1,2)'' DESCRIPTION: Computes and returns the Rosenbrock function: (a-x)**2 + b*(y-x**2)**2. ====rotate==== SYNTAX: rotate({{ArgTypeString}} object, {{ArgTypeAny}} rot_angle_degree, {{ArgTypeAny}} rot_axis_x, {{ArgTypeAny}} rot_axis_y, {{ArgTypeAny}} rot_axis_z) EXAMPLE: ''rotate("pyramid_1",45,1,1,0)'' 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. ====roughen==== SYNTAX: roughen({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length) EXAMPLE: ''roughen("Rect_1",1,5)'' DESCRIPTION: Roughens the surface of the specified object based on the specified RMS height and correlation length. ====run_analysis==== SYNTAX: run_analysis() DESCRIPTION: Runs a simulation in the current active [[EM.Cube]] computational module. ====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. ====sawtooth==== SYNTAX: sawtooth({{ArgTypeReal}} x) EXAMPLE: ''sawtooth(0.5)'' DESCRIPTION: Computes and returns the ascending periodic sawtooth function of period T = 2, oscillating between two values +1 and -1 and having a zero value of at x = 0. ====scale==== SYNTAX: scale({{ArgTypeString}} object, {{ArgTypeAny}} scale_factor) EXAMPLE: ''scale("pyramid_1",2)'' DESCRIPTION: Scales an object by the specified scale factor. ====select_module==== SYNTAX: select_module({{ArgTypeString}} module_name) EXAMPLE: ''select_module("[[EM.Tempo]]")'' DESCRIPTION: Selects and sets [[EM.Cube]]'s active module. ====set_bandwidth==== SYNTAX: set_bandwidth({{ArgTypeAny}} value) EXAMPLE: ''set_bandwidth(1e9)'' DESCRIPTION: Sets [[EM.Cube]]'s frequency bandwidth. ====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 ±X, ±Y and ±Z boundary walls. The options are "pec", "pmc" and "pml". ====set_domain_offset==== SYNTAX: set_domain_offset({{ArgTypeAny}} dxn_offset, {{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset) EXAMPLE: ''set_domain_offset(20,20,20,20,0,10)'' DESCRIPTION: Sets the domain offset values along the ±X, ±Y and ±Z directions in project units. ====set_domain_offset_lambda==== 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 ±X, ±Y and ±Z directions in free-space wavelengths. ====set_frequency==== SYNTAX: set_frequency({{ArgTypeAny}} value) EXAMPLE: ''set_frequency(2.4e9)'' DESCRIPTION: Sets [[EM.Cube]]'s center frequency. ====set_lcs_link==== SYNTAX: set_lcs_link({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off) EXAMPLE: ''set_lcs_link("pyramid_1","box_1",50,50,0)'' DESCRIPTION: Links the LCS of the first object to the LCS of the second object by the specified offset values along the three axes. ====set_periodic==== SYNTAX: set_periodic({{ArgTypeAny}} is_periodic, {{ArgTypeAny}} spacingX, {{ArgTypeAny}} spacingY)  EXAMPLE: ''set_periodic(1,50,50)'' DESCRIPTION: Designates the physical structure as periodic and sets the periods along the X and Y directions. ====set_rot==== SYNTAX: set_rot({{ArgTypeString}} object, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z) EXAMPLE: ''set_rot("pyramid_1",0,0,45)'' DESCRIPTION: Sets the three rotation angles of an object. ====set_rot_link==== SYNTAX: set_rot_link({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off_deg, {{ArgTypeAny}} y_off_deg, {{ArgTypeAny}} z_off_deg) EXAMPLE: ''set_rot_link("pyramid_1","box_1",0,0,45)'' 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. ====set_stackup_order==== SYNTAX: set_stackup_order("THS", {{ArgTypeString}} label_1, {{ArgTypeString}} label_2, ..., {{ArgTypeString}} label_n, "BHS") EXAMPLE: ''background_layer("THS","Top_Layer","Mid_Layer","Bottom_Layer","BHS")'' DESCRIPTION: 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.  ====set_units==== SYNTAX: set_units({{ArgTypeString}} units) EXAMPLE: ''set_units("meter")'' DESCRIPTION: Sets [[EM.Cube]]'s project length units. ====sgn==== SYNTAX: sgn({{ArgTypeReal}} x) EXAMPLE: ''sgn(-1.0)'' DESCRIPTION: Computes and returns the signum function: 1 if x>0, -1 if x<0. ====short_dipole==== SYNTAX: short_dipole({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase) EXAMPLE: ''short_dipole("SD_1",0,0,50,3,0,0,1,1,0)'' DESCRIPTION: Creates a Hertzian short dipole source. If the short dipole source 'label' already exists, its properties are modified. ====sigmoid==== SYNTAX: sigmoidnc({{ArgTypeReal}} x, {{ArgTypeReal}} a) EXAMPLE: ''sigmoid(0.5,1)'' DESCRIPTION: Computes and returns the sigmoid function of slope a: 2/(1 + exp(-a*x)) - 1. ====sinc==== SYNTAX: sinc({{ArgTypeReal}} x) EXAMPLE: ''sinc(0.5)'' DESCRIPTION: Computes and returns the sinc function: sin(pi*x)/(pi*x). ====slice==== SYNTAX: slice({{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ) EXAMPLE: ''slice("Rect_1",5)'' DESCRIPTION: Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates. ====slot_group==== SYNTAX: slot_group({{ArgTypeString}} label) EXAMPLE: ''slot_group("PMC_1")'' DESCRIPTION: Creates a slot trace group in the current module. If the slot trace group 'label' already exists, the group is activated. ====solution_plane==== SYNTAX: solution_plane({{ArgTypeString}} label, {{ArgTypeAny}} field_sensor_label, {{ArgTypeAny}} is_quasi) EXAMPLE: ''solution_plane("FI_1","FS_1",1)'' DESCRIPTION: Creates a 2D solution plane observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====sphere==== SYNTAX: sphere({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]) EXAMPLE: ''sphere("Sphere_1",0,0,0,10,0,180)'' 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. ====spiral_curve==== 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) EXAMPLE: ''spiral_curve("Spiral _1",0,0,0,10,50,5,0,0)'' 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.  ====spiral_strip==== 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) EXAMPLE: ''spiral_strip("Spiral _1",0,0,0,10,50,5,0,0)'' 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.  ====spline_fit==== SYNTAX: spline_fit({{ArgTypeString}} object) EXAMPLE: ''spline_fit("Poly_1")'' DESCRIPTION: Applies spline fit transformation on a specified polymesh, polyline or polystrip object. ====spline2==== SYNTAX: spline2({{ArgTypeReal}} x) EXAMPLE: ''spline2(1.0)'' DESCRIPTION: Computes and returns the quadratic B-spline function. ====spline3==== SYNTAX: spline3({{ArgTypeReal}} x) EXAMPLE: ''spline3(1.0)'' DESCRIPTION: Computes and returns the cubic B-spline function. ====sqr_wave==== SYNTAX: sqr_wave({{ArgTypeReal}} x) EXAMPLE: ''sqr_wave(0.5)'' DESCRIPTION: Computes and returns the periodic square wave function of period T = 2, oscillating between two values +1 and -1 and having a value of +1 at x = 0. ====sqr2==== SYNTAX: sqr2({{ArgTypeReal}} x, {{ArgTypeReal}} y) EXAMPLE: ''sqr2(0,1)'' DESCRIPTION: Computes and returns the sum of squares of x and y: x**2 + y**2. ====sqr3==== SYNTAX: sqr2({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} z) EXAMPLE: ''sqr2(0,1,2)'' DESCRIPTION: Computes and returns the sum of squares of x, y and z: x**2 + y**2 + z**2. ====sqrt2==== SYNTAX: sqrt2({{ArgTypeReal}} x, {{ArgTypeReal}} y) EXAMPLE: ''sqrt2(0,1)'' DESCRIPTION: Computes and returns the radius of the 2D point (x,y): sqrt(x**2 + y**2). ====sqrt3==== SYNTAX: sqrt3({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} z) EXAMPLE: ''sqrt3(0,1,2)'' DESCRIPTION: Computes and returns the radius of the 3D point (x,y,z): sqrt(x**2 + y**2 + z**2). ====step==== SYNTAX: step({{ArgTypeReal}} x) EXAMPLE: ''step(1.0)'' DESCRIPTION: Computes and returns the unit step function: 1 if x>0, 0 if x<0. ====strip_sweep==== SYNTAX: strip_sweep({{ArgTypeString}} object, {{ArgTypeAny}} width) EXAMPLE: ''strip_sweep("Curve_1",5)'' DESCRIPTION: Creates a strip version of a given curve object. ====subtract==== SYNTAX: subtract({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2) EXAMPLE: ''subtract("Subtract_Object","Rect_Strip1","Rect_Strip2")'' 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. ====superquad==== SYNTAX: superquad({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} order) EXAMPLE: ''superquad("SuperQuad_1",0,0,0,50,20,4)'' 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.  ====taper_strip==== SYNTAX: taper_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAny}} is_expo) EXAMPLE: ''taper_strip("ts_1",0,0,0,50,100,80,1)'' 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.  ====terrain_group==== SYNTAX: terrain_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma) EXAMPLE: ''terrain_group("Terrain_1",5.0,0.0001)'' DESCRIPTION: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label' already exists, the group is activated. ====thinwire_group==== SYNTAX: thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius) EXAMPLE: ''thinwire_group("Thinwire_1",4)'' DESCRIPTION: Creates a Thinwire material group in the current module. If the thin wire group 'label' already exists, the group is activated. ====torus==== SYNTAX: torus({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_major, {{ArgTypeAny}} radius_minor[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]) EXAMPLE: ''torus("Torus_1",0,0,0,50,20)'' 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.
Description: Sets the domain offset values along the ±X, ±Y and ±Z directions in free-space wavelengths.====translate_by====
====set_boundary_conditionsSYNTAX: translate_by({{ArgTypeString}} xn_typeobject, {{ArgTypeStringArgTypeReal}} xp_typex_dist, {{ArgTypeStringArgTypeReal}} yn_typey_dist, {{ArgTypeString}} yp_type, {{ArgTypeString}} zn_type, {{ArgTypeStringArgTypeReal}} zp_typez_dist)====
EXAMPLE: ''Example: set_domain_offset_lambdatranslate_by("pmlMyObj","pml"10,"pml"10,"pml","pec","pml"x)''
DescriptionDESCRIPTION: Sets [[EM.Tempo]]'s domain boundary conditions domain offset on Translates an object by the ±X, ±Y and ±Z boundary walls. The options are "pec", "pmc" and "pml"specified distances in each direction.
====add_variable({{ArgTypeString}} var_name, {{ArgTypeAny}} value)translate_to====
''ExampleSYNTAX: add_variabletranslate_to("MyVar"{{ArgTypeString}} object,1 {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest)''
DescriptionEXAMPLE: Adds a new variable to [[EM.Cube]]'s variable list.'translate_to("MyObj",20,20,x2)''
====run_analysis()====DESCRIPTION: Translates an object to the specified destination.
Description: Runs a simulation in the current active [[EM.Cube]] computational module.====transmitter_set====
====set_periodicSYNTAX: transmitter_set({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} is_periodicrot_x, {{ArgTypeAny}} spacingXrot_y, {{ArgTypeAny}} spacingYrot_z) ====
EXAMPLE: ''Example: set_periodictransmitter_set(1"TX_1","PT_1","DPL_STD.RAD",0,5090,500)''
DescriptionDESCRIPTION: Designates Creates a transmitter set in [[EM.Terrano]]. If the physical structure as periodic and sets the periods along the X and Y directionstransmitter set 'label' already exists, its properties are modified.
====get_standard_output({{ArgTypeString}} output_name) tri====
''ExampleSYNTAX: get_standard_outputtri("S11M"{{ArgTypeReal}} x)''
DescriptionEXAMPLE: Returns the computed value of the specified standard output parameter at the end of a simulation''tri(0.1)''
====save_data({{ArgTypeString}} directory_name) ====DESCRIPTION: Computes and returns the triangular window function: 1-|x| if x<1, 0 elsewhere.
''Example: save_data("Simulation_Data")''====tri_wave====
DescriptionSYNTAX: Saves [[EM.Cube]]'s output simulation data files under the specified directory.tri_wave({{ArgTypeReal}} x)
====plot_fileEXAMPLE: ''tri_wave({{ArgTypeString}} filename0.5) ====''
''ExampleDESCRIPTION: plot_file("D0Computes 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.DAT")''
Description: Plots the contents of a specified data file in EM.Grid.====triangle_strip====
====meshSYNTAX: triangle_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAny}} angle)====
DescriptionEXAMPLE: Generates and displays the mesh of the physical structure.''triangle_strip("ts_1",0,0,0,50,100,90)''
====emtempo_mesh_settings({{ArgTypeAny}} cells_per_lambdaDESCRIPTION: Draws a triangle strip object in the project workspace under the currently activated material group node, {{ArgTypeAny}} ratio_contour, {{ArgTypeAny}} ratio_thin, {{ArgTypeAny}} ratio_abs)====or modifies the triangle strip object named 'label' if it already exists.
''Example: emtempo_mesh_settings(30,0.1,0.1,0.02)''====union====
DescriptionSYNTAX: Sets the parameters of [[EM.Tempo]]'s adaptive mesh generator.union({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)
====emillumina_mesh_settingsEXAMPLE: ''union({{ArgTypeAny}} cells_per_lambda"Union_Object","Rect_Strip1","Rect_Strip2")====''
DESCRIPTION: Creates a Boolean object named 'label'Example: emillumina_mesh_settings(30)by unioning object_1 and object_2. An error will be thrown if a Boolean object named 'label'already exists.
Description: Sets the parameters of [[EM.Illumina]]'s mesh generator.====virtual_group====
====empicasso_mesh_settingsSYNTAX: virtual_group({{ArgTypeAnyArgTypeString}} cells_per_lambdalabel)====
EXAMPLE: ''Example: empicasso_mesh_settingsvirtual_group(30"VIR_1")''
DescriptionDESCRIPTION: Sets the parameters of Creates a virtual object group in [[EM.PicassoTerrano]]. If the virtual group 's planar hybrid mesh generatorlabel' already exists, the group is activated.
====emlibera_mesh_settings({{ArgTypeAny}} cells_per_lambda)voltage_integral====
''ExampleSYNTAX: emlibera_mesh_settingsvoltage_integral(30{{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)''
DescriptionEXAMPLE: Sets the parameters of [[EM.Libera]]'s mesh generator.'voltage_integral("FI_1",0,0,-10,0,0,10)''
====emferma_mesh_settings({{ArgTypeAny}} cell_size_xDESCRIPTION: Creates a voltage integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} cell_size_y, {{ArgTypeAny}} cell_size_z)====its properties are modified.
''Example: emferma_mesh_settings(0.5,0.5,0.5)''====volume_current_group====
DescriptionSYNTAX: Sets the parameters of [[EM.Ferma]]'s fixed-cell mesh generator.volume_current_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz)
====emterrano_mesh_settingsEXAMPLE: ''volume_current_group({{ArgTypeAny}} edge_length"Magnet_1", {{ArgTypeAny}} angle_tol0,0,1e6)====''
DESCRIPTION: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'label'Example: emterrano_mesh_settings(5already exists,10)''the group is activated.
Description: Sets the parameters of [[EM.Terrano]]'s facet mesh generator.====wave_port====
====cubecad_mesh_settingsSYNTAX: wave_port({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} edge_lengthphase, {{ArgTypeAny}} angle_tolresistance])====
EXAMPLE: ''Example: cubecad_mesh_settingswave_port(5"WP_1","Rect_1",0,100)''
DescriptionDESCRIPTION: Sets Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If the parameters of CubeCADwave port 's mesh generatorlabel' already exists, its properties are modified.
====emtempo_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} power_threshhold, {{ArgTypeAny}} max_timesteps)waveguide_design====
''ExampleSYNTAX: emtempo_engine_settingswaveguide_design("single-precision"{{ArgTypeReal}} er,-50,20000{{ArgTypeReal}} freq_hertz)''
DescriptionEXAMPLE: Sets the parameters of [[EM.Tempo]]'s FDTD simulation engine'waveguide_design(1.0,2e9)''
====emterrano_engine_settingsDESCRIPTION: Computes and returns the minimum larger dimension ({{ArgTypeAny}} bounce_count, {{ArgTypeAny}} do_edge_diffraction, {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshholdin 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: emterrano_engine_settings(5,1,1,-100)''====waveguide_src====
DescriptionSYNTAX: Sets the parameters of waveguide_src({{ArgTypeString}} label, {{ArgTypeAny}} box_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[[EM.Terrano], {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]'s SBR simulation engine.)
====empicasso_engine_settingsEXAMPLE: ''waveguide_src({{ArgTypeString}} matrix_solver"WG_1", {{ArgTypeAny}} error_tol"Box_1", {{ArgTypeAny}} max_iterations50,0)====''
DESCRIPTION: Creates a waveguide port source in [[EM.Tempo]]. If the waveguide port 'label'Example: empicasso_engine_settings("bicg"already exists,1e-3,1000)''its properties are modified.
Description: Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine.====wire_current_group====
====emillumina_engine_settingsSYNTAX: wire_current_group({{ArgTypeString}} enginelabel, {{ArgTypeAny}} is_fixed_iterationcurrent, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterationswire_radius)====
EXAMPLE: ''Example: emillumina_engine_settingswire_current_group("ipoMagnet_1",1,0,1e-2,20.5)''
DescriptionDESCRIPTION: Sets the parameters of Creates a wire current source group in [[EM.IlluminaFerma]]. If the wire current group 's Physical Optics simulation enginelabel' already exists, the group is activated.
====emferma_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)wire_gap_src====
''ExampleSYNTAX: emferma_engine_settingswire_gap_src("bicg-stab"{{ArgTypeString}} label,1e-3{{ArgTypeAny}} line_object,100{{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])''
DescriptionEXAMPLE: Sets the parameters of [[EM.Ferma]]'s electrostatic and magnetostatic simulation engines.'wire_gap_src("WIG_1","Line_1",50,0)''
====emlibera_engine_settings_wmom({{ArgTypeString}} matrix_solverDESCRIPTION: Creates a wire gap circuit source in [[EM.Libera]]. If the wire gap source 'label' already exists, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)====its properties are modified.
''Example: emlibera_engine_settings_wmom("bicg",1e-3,1000)''====zoom_extents====
DescriptionSYNTAX: Sets the parameters of [[EM.Libera]]'s wire MoM simulation engines.zoom_extents()
====emlibera_engine_settings_smom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations, {{ArgTypeAny}} ncpus, {{ArgTypeString}} formulation, {{ArgTypeAny}} alpha)====DESCRIPTION: Zooms to fit the extents of the physical structure into the screen.
''Example: emlibera_engine_settings_smom("bicg",1e-3,1000,4,"efie",0.4)''<br />
Description: Sets the parameters of [[EM.Libera]]'s surface MoM simulation engines.<hr>
<p> </p>[[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]]'''