<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="wikitable"!scope="col"| Syntax!scope="col"| Type!scope="col"| Description!scope="col"| Notes|-| style="widthEXAMPLE:100px;" | microstrip_design''activate(z0,er)| style="width:150px;Color_1" | EMAG Python function| style="width:250px;" | Returns the width-to-height ratio of a microstrip transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, er: substrate permittivity|-| style="width:100px;" | microstrip_z0(w,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the characteristic impedance of a microstrip transmission line in Ohms | style="width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity|-| style="width:100px;" | microstrip_eps_eff(w,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the effective permittivity of a microstrip transmission line | style="width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity|-| style="width:100px;" | microstrip_lambda_g(w,h,er,freq_hertz)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the guide wavelength of a microstrip transmission line in meters| style="width:250px;" | w: microstrip width, h: substrate height, er: substrate permittivity, freq_hertz: frequency in Hz|-| style="width:100px;" | cpw_design_w(z0,s,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the slot width of a coplanar waveguide (CPW) transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, s: center strip width (or slot spacing), h: substrate height, er: substrate permittivity|-| style="width:100px;" | cpw_design_s(z0,w,h,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the center strip width (or slot spacing) of a coplanar waveguide (CPW) transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, w: slot width, h: substrate height, er: substrate permittivity|-| style="width:100px;" | coaxial_design(z0,er)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the ratio of radius of the outer conductor to the radius of the inner condutcor of a coaxial transmission line | style="width:250px;" | z0: characteristic impedance in Ohms, er: core permittivity|-| style="width:100px;" | waveguide_design(er,freq_hertz)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the minimum larger dimension in meter of the cross section of a hollow rectangular waveguide above cutoff | style="width:250px;" | er: filling permittivity, freq_hertz: frequency in Hz|-| style="width:100px;" | horn_design_a(D0_dB,a_lambda,b_lambda)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the wavelength-normalized larger dimension of the aperture of an optimal pyramidal horn antenna | style="width:250px;" | D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide |-| style="width:100px;" | horn_design_b(D0_dB,a_lambda,b_lambda)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the wavelength-normalized smaller dimension of the aperture of an optimal pyramidal horn antenna | style="width:250px;" | D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide |-| style="width:100px;" | horn_design_l(D0_dB,a_lambda,b_lambda)| style="width:150px;" | EMAG Python function| style="width:250px;" | Returns the wavelength-normalized length of an optimal pyramidal horn antenna | style="width:250px;" | D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide |}''
== DESCRIPTION: Activates a color, material or object group in the current active [[EM.Cube's Python Functions ]] module for Geometric Object Creation ==insertion of new objects.
====boxadd_variable====
SYNTAX: boxadd_variable({{ArgTypeString}} labelvar_name, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} height[, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom]value)
EXAMPLE: ''boxadd_variable("Box_1MyVar",0,0,0,50,50,1001)''
DESCRIPTION: Draws Adds a box object in the project workspace under the currently activated material group node, or modifies the box named new variable to [[EM.Cube]]'label' if it already existss variable list.
====cylinderarray====
SYNTAX: cylinderarray({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAnyArgTypeString}} z0object, {{ArgTypeAny}} radiusx_count, {{ArgTypeAny}} height[y_count, {{ArgTypeAny}} start_anglez_count, {{ArgTypeAny}} end_anglex_spacing, {{ArgTypeAny}} cap_topy_spacing, {{ArgTypeAny}} cap_bottom]z_spacing)
EXAMPLE: ''cylinderarray("Cylinder_1Array_1",0"Rect_Strip_1",04,04,101,10050,50,0)''
DESCRIPTION: Draws a cylinder object in the project workspace under the currently activated material group node, Creates or modifies the cylinder named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the cylinder's azimuth axisan array object.
====conearray_custom====
SYNTAX: conearray_custom({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0x_count, {{ArgTypeAny}} y0y_count, {{ArgTypeAny}} z0z_count, {{ArgTypeAny}} base_radiusx_spacing, {{ArgTypeAny}} height[y_spacing, {{ArgTypeAny}} top_radiusz_spacing, {{ArgTypeAny}} start_anglex0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} end_anglerot_x, {{ArgTypeAny}} cap_toprot_y, {{ArgTypeAny}} cap_bottom]rot_z)
EXAMPLE: ''conearray_custom("Cone_1Array_1",0"Rect_Strip_1",04,4,1,50,50,0,30100,40100,20,0,1800,45)''
DESCRIPTION: Draws a cone object in the project workspace under the currently activated material group node, Creates or modifies the cone named 'label' if it already exists. The arguments start_angle an array object and end_angle are in degrees sets its local coordinate system and specify a sweep about the cone's azimuth axisrotation angles.
====pyramidbackground_layer====
SYNTAX: pyramidbackground_layer({{ArgTypeString}} label, {{ArgTypeAny}} x0eps, {{ArgTypeAny}} y0sigma, {{ArgTypeAny}} z0mu, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} heightthickness)
EXAMPLE: ''pyramidbackground_layer("Pyramid_1Mid_Layer",03.3,0.001,0,10,101,1001.5)''
DESCRIPTION: Draws Adds a pyramid object in the project workspace under the currently activated material group node, or modifies the pyramid named new substrate layer to [[EM.Picasso]]'label' if it already existss background layer stackup.
====spherebase_point_group====
SYNTAX: spherebase_point_group({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])
EXAMPLE: ''spherebase_point_set("Sphere_1BP_Set_1",0,0,0,10,0,180)''
DESCRIPTION: Draws Creates a sphere object base point set in [[EM.Terrano]]. If the project workspace under the currently activated Material Group node, or modifies the sphere named base point set group 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about , the sphere's azimuth axisgroup is activated.
====ellipsoidbh_step====
SYNTAX: ellipsoidbh_step({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y, {{ArgTypeAny}} radius_z[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]T)
EXAMPLE: ''ellipsoidbh_step("Ellipsoid_1",0,0,0,100,100,50,0.5,3601)''
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 Computes and specify a sweep about returns the ellipsoid's azimuth axisBlackman-Harris step function.
====torusbh_window====
SYNTAX: torusbh_window({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_major, {{ArgTypeAny}} radius_minor[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]T)
EXAMPLE: ''torusbh_window("Torus_1",0.5,0,0,50,201)''
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 Computes and specify a sweep about returns the torus's azimuth axisBlackman-Harris window function.
====rect_stripbox====
SYNTAX: rect_stripbox({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side_xbase_x, {{ArgTypeAny}} side_ybase_y, {{ArgTypeAny}} height[, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom])
EXAMPLE: ''rect_stripbox("my_rectangleBox_1",0,0,0,50,2050,100)''
DESCRIPTION: Draws a rectangle Strip box object in the project workspace under the currently activated material group node, or modifies the rectangle strip object box named 'label' if it already exists. ====capacitance==== SYNTAX: capacitance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4) EXAMPLE: ''capacitance("FI_1",-10,-10,5,10,10,10,0,0,-10,0,0,10)'' DESCRIPTION: Creates a capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====capacitor==== SYNTAX: capacitor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} capacitance_pF) EXAMPLE: ''capacitor("Cap_1","Line_1",25,10)'' DESCRIPTION: Creates a capacitor in [[EM.Tempo]]. If the capacitor 'label' already exists, its properties are modified. ====charge_group==== SYNTAX: charge_group({{ArgTypeString}} label, {{ArgTypeAny}} density) EXAMPLE: ''charge_group("Charge_1",-1e-5)'' DESCRIPTION: Creates a volume charge source group in [[EM.Ferma]]. If the charge group 'label' already exists, the group is activated.
====circ_strip====
DESCRIPTION: Draws a circle strip object in the project workspace under the currently activated material group node, 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.
====radial_stripcircle====
SYNTAX: radial_stripcircle({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} base_lengthstart_angle, {{ArgTypeAny}} angleend_angle)
EXAMPLE: ''radial_stripcircle("Radial_1pyramid_1",0,0,0,5010,010,90100)''
DESCRIPTION: Draws a radial strip circular curve object in the project workspace under the currently activated material group node, or modifies the radial strip object circle named 'label' if it already exists. The parameters start_angle and end_angle are in degrees.
====ellipse_stripclone====
SYNTAX: ellipse_stripclone({{ArgTypeString}} label, {{ArgTypeAnyArgTypeString}} x0object, {{ArgTypeAnyArgTypeReal}} y0x0, {{ArgTypeAnyArgTypeReal}} z0y0, {{ArgTypeAnyArgTypeReal}} radius_x, {{ArgTypeAny}} radius_y[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle]z0)
EXAMPLE: ''ellipse_stripclone("es_1NewObj",0,0"MyObj",010,5010,0)''
DESCRIPTION: Draws Creates a ellipse strip object in copy of the project workspace under the currently activated material group node, or modifies the ellipse strip specified object named 'label' if and repositions it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about at the ellipse strip's azimuth axisgiven coordinates.
====triangle_stripclose_curve====
SYNTAX: triangle_stripclose_curve({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAnyArgTypeString}} angleclose_state)
EXAMPLE: ''triangle_stripclose_curve("ts_1Curve_1",0,0,0,50,100,901)''
DESCRIPTION: Draws Sets the open/close state of a triangle strip object in the project workspace under the currently activated material group node, polyline or modifies the triangle strip object named 'label' if it already existsNURBS curve. Use 0 for open curve and 1 for close curve.
====taper_stripcoaxial_design====
SYNTAX: taper_stripcoaxial_design({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAnyArgTypeReal}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAnyArgTypeReal}} is_expoer)
EXAMPLE: ''taper_stripcoaxial_design("ts_1",0,0,0,50,100,80,12.2)''
DESCRIPTION: Draws a taper strip object in Computes and returns the project workspace under ratio of the currently activated material group node, or modifies radius of the taper strip object named 'label' if it already exists. If outer conductor to the Boolean parameters "is_expo" is 1, an exponential taper will be drawnradius of the inner conductor of a coaxial transmission line of characteristic impedance z0 (in Ohms) with core relative permittivity er.
====polygon_regcoaxial_src====
SYNTAX: polygon_regcoaxial_src({{ArgTypeString}} label, {{ArgTypeAny}} x0cylinder_object, {{ArgTypeAny}} y0outer_radius, {{ArgTypeAny}} z0edge[, {{ArgTypeAny}} radiusamplitude, {{ArgTypeAny}} n_sidesphase, {{ArgTypeAny}} resistance])
EXAMPLE: ''polygon_regcoaxial_src("ts_1COAX_1",0,0,0,50,100,80"Cyl_1",1.5,"+z")''
DESCRIPTION: Draws Creates a regular polygon object coaxial port source in [[EM.Tempo]]. If the project workspace under the currently activated material group node, or modifies the regular polygon object named coaxial port 'label' if it already exists, its properties are modified.
====spiral_stripcolor_group====
SYNTAX: spiral_stripcolor_group({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} width, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual)
EXAMPLE: ''spiral_stripcolor_group("Spiral _1Color_1",0,0,0,10,50,5,0,0)''
DESCRIPTION: Draws Creates a spiral strip object color group in CubeCAD module. If the project workspace under the currently activated material color 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" group is 1, a dual-arm spiral curve will be drawnactivated.
====polystripconduction_current_integral====
SYNTAX: polystripconduction_current_integral({{ArgTypeString}} label, {{ArgType| 3x1 Python tupleArgTypeAny}} p0x1, {{ArgType| 3x1 Python tupleArgTypeAny}} p1y1, ... {{ArgType| 3x1 Python tupleArgTypeAny}} pnz1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
EXAMPLE: ''polystripconduction_current_integral("ps_1FI_1",(0-10,0-10,0),(110,0,0),(1,010,0))''
DESCRIPTION: Creates or modifies a Polystrip object conduction current integral observable in the project workspace[[EM. Each point is represented with a Python tuple typeFerma]]. The poly_strip function is If the observable 'self-closinglabel' -- there is no need to supply the first point again at the end of the point listalready exists, its properties are modified.
====nurbs_stripconductive_sheet_group====
SYNTAX: nurbs_stripconductive_sheet_group({{ArgTypeString}} label, {{ArgType| 3x1 Python tupleArgTypeAny}} p0sigma, {{ArgType| 3x1 Python tupleArgTypeAny}} p1, ... {{ArgType| 3x1 Python tuple}} pnthickness)
EXAMPLE: ''nurbs_stripconductive_sheet_group("ns_1Cond_1",(0,0,0),(1,0,0),(1,0100,0).01)''
DESCRIPTION: Creates or modifies a NURBS Strip object conductive sheet group in the project workspace[[EM. Each point is represented with a Python tuple typePicasso]]. The nurbs_strip function is If the conductive sheet group 'self-closinglabel' -- there already exists, the group is no need to supply the first point again at the end of the point listactivated.
====linecone====
SYNTAX: linecone({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} lengthbase_radius, {{ArgTypeAny}} height[, {{ArgTypeAny}} dirtop_radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom])
EXAMPLE: ''linecone("my_lineCone_1",0,0,0,10030,"x"40,20,0,180)''
DESCRIPTION: Draws a Line cone object in the project workspace under the currently activated material group node, or modifies the line cone named 'label' if it already exists. Without the argument "dir", The arguments start_angle and end_angle are in degrees and specify a vertical line is drawn by defaultsweep about the cone's azimuth axis.
====circleconsolidate====
SYNTAX: circleconsolidate({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angleobject)
EXAMPLE: ''circleconsolidate("pyramid_1Poly_1",0,0,0,10,10,100)''
DESCRIPTION: Draws Consolidates a circular curve specified 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.
====superquadcpw_design_s====
SYNTAX: cpw_design_s({{ArgTypeReal}} z0, {{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: superquad''cpw_design_s({{ArgTypeString}} label50, {{ArgTypeAny}} x02, {{ArgTypeAny}} y00.5, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} order2.2)''
EXAMPLEDESCRIPTION: ''superquadComputes and returns the center strip width ("SuperQuad_1"in meters) of a CPW transmission line of characteristic impedance z0 with slot width w,0,0,0,50,20,4)''substrate height h and substrate relative permittivity er.
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 make the round edges sharper. An infinite order reduces the curve to a rectangle. ===cpw_design_w====
====parabola====SYNTAX: cpw_design_w({{ArgTypeReal}} z0, {{ArgTypeReal}} s, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: parabola''cpw_design_w({{ArgTypeString}} label50, {{ArgTypeAny}} x01, {{ArgTypeAny}} y00.5, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only2.2)''
EXAMPLEDESCRIPTION: ''parabolaComputes and returns the slot width ("Parabola _1"in meters) of a CPW transmission line of characteristic impedance z0 with center strip width s,0,0,0,50,20,0)''substrate height h and substrate relative permittivity er.
DESCRIPTION: Draws a parabola object in the project workspace under the currently activated material group node, or modifies the parabola named 'label' if it already exists. If the Boolean parameter "half_only" is 1, only half of the parabola will be drawn. ====cpw_src====
====hyperbola====SYNTAX: cpw_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} spacing, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
SYNTAXEXAMPLE: hyperbola''cpw_src({{ArgTypeString}} label"CPW_1", {{ArgTypeAny}} x0"Rect_1", {{ArgTypeAny}} y01.5, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only"+x")''
EXAMPLEDESCRIPTION: Creates a CPW port source in [[EM.Tempo]]. If the CPW port 'label'hyperbola("Hyperbola _1"already exists,0,0,0,50,40,20,0)''its properties are modified.
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. ====cubecad_mesh_settings====
====spiral_curve====SYNTAX: cubecad_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol)
EXAMPLE: ''cubecad_mesh_settings(5,10)''
SYNTAXDESCRIPTION: spiral_curve({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual)Sets the parameters of CubeCAD's mesh generator.
EXAMPLE: ''spiral_curve("Spiral _1",0,0,0,10,50,5,0,0)''====current_dist====
DESCRIPTIONSYNTAX: Draws a spiral curve object in the project workspace under the currently activated material group node, or modifies the spiral curve named 'current_dist({{ArgTypeString}} 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. )
====helix====EXAMPLE: ''current_dist("CD_1")''
SYNTAXDESCRIPTION: helix({{ArgTypeString}} Creates a current distribution observable. If the observable 'label' already exists, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} helix_dir)its properties are modified.
EXAMPLE: ''helix("Helix_1",0,0,0,15,15,10,0)''====current_integral====
DESCRIPTIONSYNTAX: Draws a helical curve in the project workspace under the currently activated material group node, or modifies the helix named 'current_integral({{ArgTypeString}} label' if it already exists. The parameter "radius_inner" specifies the helix's radius at the beginning of the helix, and radius_outer specifies the radius at the end of the helix. If the Boolean parameter "helixl_dir" is 1{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, the helical curve will be drawn counter-clockwise. {{ArgTypeAny}} z2)
====polyline====EXAMPLE: ''current_integral("FI_1",-10,-10,0,10,10,0)''
SYNTAXDESCRIPTION: polyline({{ArgTypeString}} Creates a current 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))''====cylinder====
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 pncylinder({{ArgTypeString}} label, otherwise{{ArgTypeAny}} x0, it is open.{{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} height[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle, {{ArgTypeAny}} cap_top, {{ArgTypeAny}} cap_bottom])
====nurbs_curve====EXAMPLE: ''cylinder("Cylinder_1",0,0,0,10,100)''
SYNTAXDESCRIPTION: nurbs_curve({{ArgTypeString}} Draws a cylinder object in the project workspace under the currently activated material group node, or modifies the cylinder named 'label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, .' if it already exists.The arguments start_angle and end_angle are in degrees and specify a sweep about the cylinder's azimuth axis. {{ArgType| 3x1 Python tuple}} pn)
EXAMPLE: ''nurbs_curve("nc_1",(0,0,0),(1,0,0),(1,0,0))''====delete====
DESCRIPTIONSYNTAX: 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.delete({{ArgTypeString}} node_name)
====point====EXAMPLE: ''delete("Box_1")''
SYNTAXDESCRIPTION: point({{ArgTypeString}} labelDeletes a node name from the navigation tree. The node can be any geometric object, {{ArgTypeAny}} x0source, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)observable or material group.
EXAMPLE: ''point("Point_1",0,0,10)''====delete_background_layer====
DESCRIPTIONSYNTAX: Draws a point in the project workspace under the currently activated material group node, or modifies the point named 'delete_background_layer({{ArgTypeString}} label' if it already exists.)
====fractal_tree====EXAMPLE: ''delete_background_layer("Mid_Layer")''
SYNTAXDESCRIPTION: 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}} Deletes a finite-thickness, {{ArgTypeAny}} thick_factor)substrate layer from [[EM.Picasso]]'s background layer stackup.
EXAMPLE: ''fractal_tree("Fractal_1",0,0,0,"line",10,3,30,3,0,0,0)''====dielectric_group====
DESCRIPTIONSYNTAX: Generates a fractal tree in the project workspace under the currently activated material group node, or modifies the fractal tree named 'dielectric_group({{ArgTypeString}} label' if it already exists., {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)
====param_curve====EXAMPLE: ''dielectric_group("Dielectric_1","my_eps",0,1,0)''
SYNTAXDESCRIPTION: param_curve({{ArgTypeString}} Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'label' already exists, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} model, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start, {{ArgTypeAny}} stop, {{ArgTypeAny}} step, {{ArgTypeAny}} function[, {{ArgTypeAny}} y(t), {{ArgTypeAny}} z(t)])the group is activated.
EXAMPLE: ''param_curve("Curve_1",0,0,0,"parametric","xy",0,10,0.1,"cos(t)","sin(t)","t")''====diode====
DESCRIPTIONSYNTAX: Generates a parametric curve in the project workspace under the currently activated material group node, or modifies the parametric curve named 'diode({{ArgTypeString}} label' if it already exists., {{ArgTypeAny}} line_object, {{ArgTypeAny}} polarity, {{ArgTypeAny}} is_fA, {{ArgTypeAny}} temperature_K, {{ArgTypeAny}} ideality_factor)
====param_surface====EXAMPLE: ''diode("Diode_1","Line_1",25,0,10,300,1)''
SYNTAXDESCRIPTION: param_surface({{ArgTypeString}} Creates a diode in [[EM.Tempo]]. If the diode 'label' already exists, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start1, {{ArgTypeAny}} stop1, {{ArgTypeAny}} step1, , {{ArgTypeAny}} start2, {{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} function)its properties are modified.
EXAMPLE: ''param_surface("Surf_1",0,0,0,"xy",0,10,0.1,0,10,0.1,"sin(x)*sin(y)")''====distributed_src====
DESCRIPTIONSYNTAX: Generates a parametric surface in the project workspace under the currently activated material group node, or modifies the parametric surface named 'distributed_src({{ArgTypeString}} label' if it already exists., {{ArgTypeAny}} rect_object, {{ArgTypeAny}} field_dir, {{ArgTypeAny}} profile[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
====import_stl====EXAMPLE: ''distributed_src("DS_1","Rect_1","+y","uniform")''
SYNTAXDESCRIPTION: import_stl({{ArgTypeString}} file_name)Creates a distributed source in [[EM.Tempo]]. If the distributed source 'label' already exists, its properties are modified.
EXAMPLE: ''import_stl("MySTLModel.STL")''====ellipse_strip====
DESCRIPTIONSYNTAX: Imports an external STL model file to the project workspace. If the file path is not specifiedellipse_strip({{ArgTypeString}} label, the current project folder is assumed as the path.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])
====import_dxf====EXAMPLE: ''ellipse_strip("es_1",0,0,0,50,0)''
SYNTAXDESCRIPTION: import_dxf({{ArgTypeString}} file_name)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 ellipse strip's azimuth axis.
EXAMPLE: ''import_dxf("MyDXFModel.DXF")''====ellipsoid====
DESCRIPTIONSYNTAX: Imports an external DXF model file to the project workspace. If the file path is not specifiedellipsoid({{ArgTypeString}} label, the current project folder is assumed as the path.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_x, {{ArgTypeAny}} radius_y, {{ArgTypeAny}} radius_z[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])
====import_stp====EXAMPLE: ''ellipsoid("Ellipsoid_1",0,0,0,100,100,50,0,360)''
SYNTAXDESCRIPTION: import_stp({{ArgTypeString}} file_name)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.
EXAMPLE: ''import_stp("MySTPModel.STP")''====emferma_engine_settings====
DESCRIPTIONSYNTAX: Imports an external STEP model file to the project workspace. If the file path is not specifiedemferma_engine_settings({{ArgTypeString}} matrix_solver, the current project folder is assumed as the path.{{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)
====import_igs====EXAMPLE: ''emferma_engine_settings("bicg-stab",1e-3,100)''
SYNTAXDESCRIPTION: import_igs({{ArgTypeString}} file_name)Sets the parameters of [[EM.Ferma]]'s electrostatic and magnetostatic simulation engines.
EXAMPLE: ''import_igs("MyIGSModel.IGS")''====emferma_mesh_settings====
DESCRIPTIONSYNTAX: Imports an external IGES model file to the project workspace. If the file path is not specifiedemferma_mesh_settings({{ArgTypeAny}} cell_size_x, the current project folder is assumed as the path.{{ArgTypeAny}} cell_size_y, {{ArgTypeAny}} cell_size_z)
====import_py====EXAMPLE: ''emferma_mesh_settings(0.5,0.5,0.5)''
SYNTAXDESCRIPTION: import_py({{ArgTypeString}} file_name)Sets the parameters of [[EM.Ferma]]'s fixed-cell mesh generator.
EXAMPLE: ''import_py("MyPYModel.PY")''====emillumina_engine_settings====
DESCRIPTIONSYNTAX: Imports a Python geometry file to the project workspace. The default path is the Python subfolder under "Documents → EMAG".emillumina_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} is_fixed_iteration, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)
====export_stl====EXAMPLE: ''emillumina_engine_settings("ipo",0,1e-2,20)''
SYNTAXDESCRIPTION: export_stl({{ArgTypeString}} file_name)Sets the parameters of [[EM.Illumina]]'s Physical Optics simulation engine.
EXAMPLE: ''export_stl("MySTLModel.STL")''====emillumina_mesh_settings====
SYNTAX: emillumina_mesh_settings({{ArgTypeAny}} cells_per_lambda) EXAMPLE: ''emillumina_mesh_settings(30)'' DESCRIPTION: Exports Sets the physical structure parameters of [[EM.Illumina]]'s mesh generator. ====emlibera_engine_settings_smom==== SYNTAX: emlibera_engine_settings_smom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations, {{ArgTypeAny}} ncpus, {{ArgTypeString}} formulation, {{ArgTypeAny}} alpha) EXAMPLE: ''emlibera_engine_settings_smom("bicg",1e-3,1000,4,"efie",0.4)'' DESCRIPTION: Sets the project workspacean to parameters of [[EM.Libera]]'s surface MoM simulation engines. ====emlibera_engine_settings_wmom==== SYNTAX: emlibera_engine_settings_wmom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations) EXAMPLE: ''emlibera_engine_settings_wmom("bicg",1e-3,1000)'' DESCRIPTION: Sets the parameters of [[EM.Libera]]'s wire MoM simulation engines. ====emlibera_mesh_settings==== SYNTAX: emlibera_mesh_settings({{ArgTypeAny}} cells_per_lambda) EXAMPLE: ''emlibera_mesh_settings(30)'' DESCRIPTION: Sets the parameters of [[EM.Libera]]'s mesh generator. ====empicasso_engine_settings==== SYNTAX: empicasso_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations) EXAMPLE: ''empicasso_engine_settings("bicg",1e-3,1000)'' DESCRIPTION: Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine. ====empicasso_mesh_settings==== SYNTAX: empicasso_mesh_settings({{ArgTypeAny}} cells_per_lambda) EXAMPLE: ''empicasso_mesh_settings(30)'' DESCRIPTION: Sets the parameters of [[EM.Picasso]]'s planar hybrid mesh generator. ====emtempo_engine_settings==== SYNTAX: emtempo_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} power_threshhold, {{ArgTypeAny}} max_timesteps) EXAMPLE: ''emtempo_engine_settings("single-precision",-50,20000)'' DESCRIPTION: Sets the parameters of [[EM.Tempo]]'s FDTD simulation engine. ====emtempo_mesh_settings==== SYNTAX: emtempo_mesh_settings({{ArgTypeAny}} cells_per_lambda, {{ArgTypeAny}} ratio_contour, {{ArgTypeAny}} ratio_thin, {{ArgTypeAny}} ratio_abs) EXAMPLE: ''emtempo_mesh_settings(30,0.1,0.1,0.02)'' DESCRIPTION: Sets the parameters of [[EM.Tempo]]'s adaptive mesh generator. ====emterrano_engine_settings==== SYNTAX: emterrano_engine_settings({{ArgTypeAny}} bounce_count, {{ArgTypeAny}} do_edge_diffraction, {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshhold) EXAMPLE: ''emterrano_engine_settings(5,1,1,-100)'' DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s SBR simulation engine. ====emterrano_mesh_settings==== SYNTAX: emterrano_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol) EXAMPLE: ''emterrano_mesh_settings(5,10)'' DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s facet mesh generator. ====energy_electric==== SYNTAX: energy_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''energy_electric("FI_1",-10,-10,-10,10,10,10)'' DESCRIPTION: Creates an STL model fileelectric energy integral observable in [[EM.Ferma]]. If the file path is not specifiedobservable 'label' already exists, its properties are modified. ====energy_magnetic==== SYNTAX: energy_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''energy_magnetic("FI_1",-10,-10,-10,10,10,10)'' DESCRIPTION: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the current project folder is assumed as the pathobservable 'label' already exists, its properties are modified. ====explode==== SYNTAX: explode({{ArgTypeString}} object) EXAMPLE: ''explode("MyArray")'' DESCRIPTION: Explodes an object into its basic primitives.
====export_dxf====
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".
== EM.Cube's Python Functions for Geometric Object Transformation ==export_stl====
====freeze====SYNTAX: export_stl({{ArgTypeString}} file_name)
SYNTAXEXAMPLE: freeze''export_stl({{ArgTypeString}} object, {{ArgTypeReal}} freeze_state"MySTLModel.STL")''
EXAMPLEDESCRIPTION: ''freeze("MyObj"Exports the physical structure of the project workspacean to an STL model file. If the file path is not specified,1)''the current project folder is assumed as the path.
DESCRIPTION: Sets the freeze state of an object (0/1). ====extrude====
====move_to====SYNTAX: extrude({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} extrude_height, {{ArgTypeAny}} cap_ends)
SYNTAXEXAMPLE: move_to''extrude({{ArgTypeString}} object"Extrude_1", {{ArgTypeString}} group_node_label["Rect_Strip1", {{ArgTypeString}} module_name]50)''
EXAMPLEDESCRIPTION: ''move_to("NewObj" Creates or modifies an extrusion object from a specified object by the specified height. If modifying an existing extrusion object,"MyObj",10,10,0)'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.
DESCRIPTION: Transfers an object from its current material/object group node in the navigation tree to another node or optionally to another [[EM.Cube]] module. ====farfield====
====clone====SYNTAX: farfield({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)
SYNTAXEXAMPLE: clone''farfield({{ArgTypeString}} label"FF_1", {{ArgTypeString}} object1, {{ArgTypeReal}} x0, {{ArgTypeReal}} y0, {{ArgTypeReal}} z01)''
EXAMPLEDESCRIPTION: Creates a far-field radiation pattern observable. If the observable 'label'clone("NewObj"already exists,"MyObj",10,10,0)''its properties are modified.
DESCRIPTION: Creates a copy of the specified object and repositions it at the given coordinates. ====field_probe====
====translate_by====SYNTAX: field_probe({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)
SYNTAXEXAMPLE: translate_by''field_probe({{ArgTypeString}} object"FS_1", {{ArgTypeReal}} x_dist0, {{ArgTypeReal}} y_dist0, {{ArgTypeReal}} z_dist50)''
EXAMPLEDESCRIPTION: Creates a temporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label'translate_by("MyObj"already exists,10,10,x)''its properties are modified.
DESCRIPTION: Translates an object by the specified distances in each direction.====field_sensor====
====translate_to====SYNTAX: field_sensor({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)
SYNTAXEXAMPLE: translate_to''field_sensor({{ArgTypeString}} object"FS_1", {{ArgTypeReal}} x_dest"z", {{ArgTypeReal}} y_dest0, {{ArgTypeReal}} z_dest0,0,100,100,0,25,25,0)''
EXAMPLEDESCRIPTION: Creates a near-field sensor observable. If the observable 'label'translate_to("MyObj"already exists,20,20,x2)''its properties are modified.
DESCRIPTION: Translates an object to the specified destination.====field_sensor_grid====
====rotate====SYNTAX: field_sensor_grid({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)
SYNTAXEXAMPLE: rotate''field_sensor_grid({{ArgTypeString}} object"FS_1", {{ArgTypeAny}} rot_angle_degree"z", {{ArgTypeAny}} rot_axis_x0, {{ArgTypeAny}} rot_axis_y0, {{ArgTypeAny}} rot_axis_z0)''
EXAMPLEDESCRIPTION: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label'rotate("pyramid_1"already exists,45,1,1,0)''its properties are modified.
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.====fill_curve====
====scale====SYNTAX: fill_curve({{ArgTypeString}} object)
SYNTAXEXAMPLE: scale''fill_curve({{ArgTypeString}} object, {{ArgTypeAny}} scale_factor"Curve_1")''
EXAMPLEDESCRIPTION: ''scale("pyramid_1",2)''Fill the interior of the specified closed curve object.
DESCRIPTION: Scales an object by the specified scale factor.====fillet====
====get_length====fillet({{ArgTypeString}} object, {{ArgTypeAny}} radius)
SYNTAXEXAMPLE: get_length''fillet({{ArgTypeString}} object"Rect_1",5)''
EXAMPLEDESCRIPTION: ''get_length("helix_1")''Fillets the corners of the specified surface or curve object by the specified radius.
DESCRIPTION: Returns the length of a curve object.====flux_electric====
====get_area====SYNTAX: flux_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
SYNTAXEXAMPLE: get_area''flux_electric({{ArgTypeString}} object"FI_1",-10,-10,5,10,10,10)''
EXAMPLEDESCRIPTION: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'label'get_area("ellipse_1")''already exists, its properties are modified.
DESCRIPTION: Returns the area of a surface object or the total surface area of a solid object.====flux_magnetic====
====get_volume====SYNTAX: flux_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
SYNTAXEXAMPLE: get_volume''flux_magnetic({{ArgTypeString}} object"FI_1",0,0,-10,10,0,10)''
EXAMPLEDESCRIPTION: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label'get_volume("pyramid_1")''already exists, its properties are modified.
DESCRIPTION: Returns the volume of a solid object.====fractal_tree====
====get_lcs====SYNTAX: 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)
SYNTAXEXAMPLE: get_lcs''fractal_tree({{ArgTypeString}} object"Fractal_1", {{ArgTypeString}} coordinate0,0,0,"line",10,3,30,3,0,0,0)''
EXAMPLEDESCRIPTION: ''get_lcs("pyramid_1"Generates a fractal tree in the project workspace under the currently activated material group node,"x")or modifies the fractal tree named 'label'if it already exists.
DESCRIPTION: Returns the specified coordinate of the LCS of an object.====freeze====
====get_rot====SYNTAX: freeze({{ArgTypeString}} object, {{ArgTypeReal}} freeze_state)
SYNTAXEXAMPLE: get_rot''freeze({{ArgTypeString}} object"MyObj", {{ArgTypeString}} coordinate1)''
EXAMPLEDESCRIPTION: ''get_rotSets the freeze state of an object ("pyramid_1","x"0/1)''.
====gauss==== SYNTAX: gauss({{ArgTypeReal}} x, ArgTypeReal}} mu, ArgTypeReal}} sigma) EXAMPLE: ''gauss(0.5,0,1)'' DESCRIPTION: Computes and returns the Gaussian function of mean mu and standard deviation sigma: exp(-0.5*((x-mu)/sigma)**2)/sigma/sqrt(2*pi). ====gauss_beam==== SYNTAX: gauss_beam({{ArgTypeString}} label, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization, {{ArgTypeAny}} focus_x, {{ArgTypeAny}} focus_y, {{ArgTypeAny}} focus_z, {{ArgTypeAny}} radius, {{ArgTypeAny}} p_mode, {{ArgTypeAny}} q_mode) EXAMPLE: ''gauss_beam("PW_1",180,0,"tm",0,0,0,20,0,0)'' DESCRIPTION: Creates a Gaussian beam source in [[EM.Tempo]]. If the Gaussian beam source 'label' already exists, its properties are modified. ====generate_input_files==== SYNTAX: generate_input_files() EXAMPLE: ''generate_input_files()'' DESCRIPTION: Generates all the input files for the simulation engine of the current module without running a simulation. ====geo==== SYNTAX: geo({{ArgTypeReal}} x, {{ArgTypeReal}} y) EXAMPLE: ''geo(1,2)'' DESCRIPTION: Computes and returns the geometric mean of x and y: sqrt(x*y). ====get_area==== SYNTAX: get_area({{ArgTypeString}} object) EXAMPLE: ''get_area("ellipse_1")'' DESCRIPTION: Returns the specified rotation angle area of a surface object or the total surface area of an a solid object.
====get_axis====
DESCRIPTION: Returns the specified coordinate of the unit vector along the specified local axis of an object.
====get_lcs_offsetget_domain_extent====
SYNTAX: get_lcs_offsetget_domain_extent({{ArgTypeString}} object, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off, {{ArgTypeString}} coordinate)
EXAMPLE: ''get_lcs_offsetget_domain_extent("box_1",50,50,0,"x")''
DESCRIPTION: Returns the specified coordinate size of the LCS of an object after being translated by computational domain along the specified offset values along the three principal axesdirection.
====get_extent====
DESCRIPTION: Returns the size of the bounding box of an object along the specified direction.
====get_vertexget_lcs====
SYNTAX: get_vertexget_lcs({{ArgTypeString}} object, {{ArgTypeAny}} node_index, {{ArgTypeString}} coordinate)
EXAMPLE: ''get_vertexget_lcs("pyramid_1",0,"x")''
DESCRIPTION: Returns the specified coordinate of the specified vertex of the bounding box LCS 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_rotget_lcs_offset====
SYNTAX: set_rotget_lcs_offset({{ArgTypeString}} object, {{ArgTypeAny}} rot_xx_off, {{ArgTypeAny}} rot_yy_off, {{ArgTypeAny}} rot_zz_off, {{ArgTypeString}} coordinate)
EXAMPLE: ''set_rotget_lcs_offset("pyramid_1box_1",050,50,0,45"x")''
DESCRIPTION: Sets Returns the three rotation angles specified coordinate of the LCS of an objectafter being translated by the specified offset values along the three principal axes.
====set_lcs_linkget_length====
SYNTAX: set_lcs_linkget_length({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off)
EXAMPLE: ''set_lcs_linkget_length("pyramid_1helix_1","box_1",50,50,0)''
DESCRIPTION: Links Returns the LCS length of the first a curve object to the LCS of the second object by the specified offset values along the three axes.
====set_rot_linkget_rot====
SYNTAX: set_rot_linkget_rot({{ArgTypeString}} object, {{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off_deg, {{ArgTypeAny}} y_off_deg, {{ArgTypeAny}} z_off_degcoordinate)
EXAMPLE: ''set_rot_linkget_rot("pyramid_1","box_1x",0,0,45)''
DESCRIPTION: Links Returns the specified rotation angles angle of the LCS of the first an object to the rotation angles of the LCS of the second object by the specified angle offset values in degrees along the three axes.
====mirrorget_standard_output====
SYNTAX: mirrorget_standard_output({{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZoutput_name)
EXAMPLE: ''mirrorget_standard_output("pyramid_1S11M",0,0,0,1,0,0)''
DESCRIPTION: Mirrors Returns the computed value of the specified standard output parameter at the end of a simulation. ====get_vertex==== SYNTAX: get_vertex({{ArgTypeString}} object, {{ArgTypeAny}} node_index, {{ArgTypeString}} coordinate) EXAMPLE: ''get_vertex("pyramid_1",0,"x")'' DESCRIPTION: Returns the specified coordinate of the specified vertex of the bounding box of an object in a plane defined . The vertices are specified by node indices. The lower front left corner has an index of 0, while the specified point coordinates upper back right corner has an index of 7. The indices are numbered counterclockwise, with the bottom face first and specified normal vector componentstop face next.  ====get_volume==== SYNTAX: get_volume({{ArgTypeString}} object) EXAMPLE: ''get_volume("pyramid_1")'' DESCRIPTION: Returns the volume of a solid object. ====global_ground==== SYNTAX: global_ground({{ArgTypeAny}} ground_on, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma) EXAMPLE: ''global_ground(1,3.3,0.001)'' DESCRIPTION: Set the state of [[EM.Terrano]]'s global ground and its material properties. A zero value for ground_on means to no global ground assumed at Z = 0.
====group====
DESCRIPTION: Groups a number of objects into a composite object with the given label.
====arrayharm====
SYNTAX: arrayharm({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeStringArgTypeReal}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacingy)
EXAMPLE: ''arrayharm("Array_1","Rect_Strip_1",4,4,1,50,50,02)''
DESCRIPTION: Creates or modifies an array objectComputes and returns the harmonic mean of x and y: 2/(1/x+1/y).
====array_customhelix====
SYNTAX: array_customhelix({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_countx0, {{ArgTypeAny}} y_county0, {{ArgTypeAny}} z_countz0, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0radius_inner, {{ArgTypeAny}} rot_xradius_outer, {{ArgTypeAny}} rot_ynturns, {{ArgTypeAny}} rot_zhelix_dir)
EXAMPLE: ''array_customhelix("Array_1Helix_1","Rect_Strip_1"0,4,4,1,50,500,0,10015,10015,2010,0,0,45)''
DESCRIPTION: Creates Draws a helical curve in the project workspace under the currently activated material group node, or modifies an array object the helix named 'label' if it already exists. The parameter "radius_inner" specifies the helix's radius at the beginning of the helix, and sets its local coordinate system and rotation anglesradius_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.
====explodehorn_design_a====
SYNTAX: explodehorn_design_a({{ArgTypeStringArgTypeReal}} objectD0_dB, {{ArgTypeReal}} a_lambda, {{ArgTypeReal}} b_lambda)
EXAMPLE: ''explodehorn_design_a("MyArray"15,0.4,0.3)''
DESCRIPTION: Explodes Computes and returns the wavelength-normalized larger dimension of the aperture of an object into its basic primitivesoptimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda.
====subtracthorn_design_b====
SYNTAX: subtracthorn_design_b({{ArgTypeStringArgTypeReal}} labelD0_dB, {{ArgTypeStringArgTypeReal}} object_1a_lambda, {{ArgTypeStringArgTypeReal}} object_2b_lambda)
EXAMPLE: ''subtracthorn_design_b("Subtract_Object"15,"Rect_Strip1"0.4,"Rect_Strip2"0.3)''
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 existsComputes 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.
====unionhorn_design_l====
SYNTAX: unionhorn_design_l({{ArgTypeStringArgTypeReal}} labelD0_dB, {{ArgTypeStringArgTypeReal}} object_1a_lambda, {{ArgTypeStringArgTypeReal}} object_2b_lambda)
EXAMPLE: ''unionhorn_design_l("Union_Object"15,"Rect_Strip1"0.4,"Rect_Strip2"0.3)''
DESCRIPTION: Computes and returns the wavelength-normalized length of an optimal pyramidal horn antenna with directivity D0_dB and wavelength-normalized feed waveguide dimensions a_lambda and b_lambda. ====huygens_src==== SYNTAX: huygens_src({{ArgTypeString}} label, {{ArgTypeAny}} filename[, {{ArgTypeAny}} set_lcs, {{ArgTypeAny}} polarization, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} x_rot, {{ArgTypeAny}} y_rot, {{ArgTypeAny}} z_rot]) EXAMPLE: ''huygens_src("HS_1","Huygens_1.HUY",1,100,100,0,0,0,0)'' DESCRIPTION: Creates a Boolean Huygens source. If the Huygens source 'label' already exists, its properties are modified. ====huygens_surface==== SYNTAX: huygens_surface({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples) EXAMPLE: ''huygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)'' DESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, its properties are modified. ====huygens_surface_grid==== SYNTAX: huygens_surface_grid({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''huygens_surface_grid("HS_1",-10,-10,-10,10,10,10)'' DESCRIPTION: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label' already exists, its properties are modified. ====hyperbola==== SYNTAX: hyperbola({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only) EXAMPLE: ''hyperbola("Hyperbola _1",0,0,0,50,40,20,0)'' DESCRIPTION: Draws a hyperbola object in the project workspace under the currently activated material group node, or modifies the hyperbola named 'label' by unioning object_1 and object_2if it already exists. An error If the Boolean parameter "half_only" is 1, only half of the hyperbola will be thrown if drawn.  ====impedance_surface_group==== SYNTAX: impedance_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag) EXAMPLE: ''impedance_surface_group("IMP_1",100,-100)'' DESCRIPTION: Creates a Boolean object named impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'label' already exists, the group is activated. ====impenetrable_surface_group==== SYNTAX: impenetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma) EXAMPLE: ''impenetrable_surface_group("Impenet_1",2.2,0.0001)'' DESCRIPTION: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'label' already exists, the group is activated. ====import_dxf==== SYNTAX: import_dxf({{ArgTypeString}} file_name) EXAMPLE: ''import_dxf("MyDXFModel.DXF")'' DESCRIPTION: 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. ====import_igs==== SYNTAX: import_igs({{ArgTypeString}} file_name) EXAMPLE: ''import_igs("MyIGSModel.IGS")'' 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. ====import_py==== SYNTAX: import_py({{ArgTypeString}} file_name) EXAMPLE: ''import_py("MyPYModel.PY")'' DESCRIPTION: Imports a Python geometry file to the project workspace. The default path is the Python subfolder under "Documents → EMAG". ====import_stl==== SYNTAX: import_stl({{ArgTypeString}} file_name) EXAMPLE: ''import_stl("MySTLModel.STL")'' DESCRIPTION: Imports 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_stp==== SYNTAX: import_stp({{ArgTypeString}} file_name) EXAMPLE: ''import_stp("MySTPModel.STP")'' DESCRIPTION: Imports an external STEP model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path. ====inductance==== SYNTAX: inductance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4) EXAMPLE: ''inductance("FI_1",0,0,-10,10,0,10,2.5,-2.5,0,7.5,2.5,0)'' DESCRIPTION: Creates a inductance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====inductor==== SYNTAX: inductor({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} inductance_nH) EXAMPLE: ''inductor("Cap_1","Line_1",25,10)'' DESCRIPTION: Creates a inductor in [[EM.Tempo]]. If the inductor 'label' already exists, its properties are modified.
====intersect====
DESCRIPTION: Creates a Boolean object named 'label' by intersecting object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.
====extrudeline====
SYNTAX: extrudeline({{ArgTypeString}} label, {{ArgTypeStringArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} objectz0, {{ArgTypeAny}} extrude_heightlength[, {{ArgTypeAny}} cap_endsdir])
EXAMPLE: ''extrudeline("Extrude_1my_line",0,0,0,100,"Rect_Strip1x",50)''
DESCRIPTION: Creates or modifies an extrusion object from Draws a specified Line object by in the specified height. If modifying an existing extrusion objectproject workspace under the currently activated material group node, or modifies the pre-existing primitive is usedline named 'label' if it already exists. This command can only extrude objects that have a single face and will extrude along Without the face's normalargument "dir", a vertical line is drawn by default.
====loft====
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.
====revolvelumped_src====
SYNTAX: revolvelumped_src({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0line_object, {{ArgTypeAny}} z0offset, {{ArgTypeAny}} uXpolarity[, {{ArgTypeAny}} uYamplitude, {{ArgTypeAny}} uZphase, {{ArgTypeAny}} rot_angleresistance])
EXAMPLE: ''revolvelumped_src("Rev1LS_1","Line_1",050,0,0,0,0,1,360)''
DESCRIPTION: Creates or modifies a revolution object from a specified objectlumped source in [[EM.Tempo]]. If modifying an existing revolution object, the pre-existing primitive object is used. (x0lumped source 'label' already exists,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. The revolution angle "rot_angle" is given in degreesits properties are modified.
====consolidatemagnet_group====
SYNTAX: consolidatemagnet_group({{ArgTypeString}} objectlabel, {{ArgTypeAny}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mz)
EXAMPLE: ''consolidatemagnet_group("Poly_1Magnet_1",1,0,0,100)''
DESCRIPTION: Consolidates Creates a specified objectpermanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already exists, the group is activated.
====spline_fitmcos====
SYNTAX: spline_fitmcos({{ArgTypeStringArgTypeReal}} objectx, {{ArgTypeReal}} r)
EXAMPLE: ''spline_fitmcos("Poly_1"0.5,2)''
DESCRIPTION: Applies spline fit transformation on a specified polymesh, polyline or polystrip objectComputes and returns the super-quadratic cosine function of order r.
====fill_curvemean====
SYNTAX: fill_curvemean({{ArgTypeStringArgTypeReal}} objectx, {{ArgTypeReal}} y)
EXAMPLE: ''fill_curvemean("Curve_1"1,2)''
DESCRIPTION: Fill Computes and returns the interior arithmetic mean of the specified closed curve objectx and y: 0.5*(x+y).
====merge_curve====
DESCRIPTION: Merges two specified curve objects into a single curve.
====close_curvemesh====
SYNTAX: close_curvemesh({{ArgTypeString}} label, {{ArgTypeString}} close_state)
EXAMPLEDESCRIPTION: ''close_curve("Curve_1",1)''Generates and displays the mesh of the physical structure.
DESCRIPTION: Sets the open/close state of a polyline or NURBS curve. Use 0 for open curve and 1 for close curve.====microstrip_design====
====polygonize====SYNTAX: microstrip_design({{ArgTypeReal}} z0, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: polygonize''microstrip_design({{ArgTypeString}} object50, {{ArgTypeAny}} side_length2.2)''
EXAMPLEDESCRIPTION: ''polygonize("Cric_1",2)''Computes and returns the width-to-height ratio of a microstrip transmission line with characteristic impedance z0 in Ohms and substrate relative permittivity er.
DESCRIPTION: Polygonizes the specified surface or curve object by the specified side length. The results is a polystrip or a polyline.====microstrip_eps_eff====
====polymesh====SYNTAX: microstrip_eps_eff({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: polymesh''microstrip_eps_eff({{ArgTypeString}} label2, {{ArgTypeString}} object0.5, {{ArgTypeAny}} edge_length2.2)''
EXAMPLEDESCRIPTION: ''polymesh("Poly_1"Computes and returns the effective permittivity of a microstrip transmission line with width w,"Cric_1",2)''substrate height h and substrate relative permittivity er.
DESCRIPTION: Discretizes the specified solid or surface object by the specified edge length. The results is a polymesh object.====microstrip_lambda_g====
====fillet====SYNTAX: microstrip_lambda_g({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
filletEXAMPLE: ''microstrip_lambda_g({{ArgTypeString}} object2, {{ArgTypeAny}} radius0.5,2.2,2e9)''
EXAMPLEDESCRIPTION: ''filletComputes and returns the guide wavelength ("Rect_1",5in meters)''of a microstrip transmission line with width w, substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
DESCRIPTION: Fillets the corners of the specified surface or curve object by the specified radius.====microstrip_src====
====slice====SYNTAX: microstrip_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} height, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
SYNTAXEXAMPLE: slice''microstrip_src({{ArgTypeString}} object"MS_1", {{ArgTypeAny}} x0"Rect_1", {{ArgTypeAny}} y01.5, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ"+x")''
EXAMPLEDESCRIPTION: Creates a microstrip port source in [[EM.Tempo]]. If the microstrip port 'label'slice("Rect_1"already exists,5)''its properties are modified.
DESCRIPTION: Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.====microstrip_z0====
====roughen====SYNTAX: microstrip_z0({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
SYNTAXEXAMPLE: roughen''microstrip_z0({{ArgTypeString}} label2, {{ArgTypeString}} object0.5, {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length2.2)''
EXAMPLEDESCRIPTION: ''roughenComputes and returns the characteristic impedance ("Rect_1"in Ohms) of a microstrip transmission line with width w,1,5)''substrate height h and substrate relative permittivity er.
DESCRIPTION: Roughens the surface of the specified object based on the specified RMS height and correlation length.====microstrip_zoc====
====random_group====SYNTAX: microstrip_zoc({{ArgTypeReal}} w, {{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
SYNTAXEXAMPLE: random_group''microstrip_zoc({{ArgTypeString}} label2, {{ArgTypeString}} key_object25, {{ArgTypeString}} container_object0.5, {{ArgTypeAny}} element_count2.2,2e9)''
EXAMPLEDESCRIPTION: ''random_groupComputes and returns the input reactance ("Rand_1"in Ohms) of an open-circuited microstrip transmission line with width w,"Rect_1"length l,"Box_1",100)''substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
DESCRIPTION: Creates a random group using the specified key object and confines them in the specified container object.====microstrip_zsc====
====strip_sweep====SYNTAX: microstrip_zsc({{ArgTypeReal}} w, {{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
SYNTAXEXAMPLE: strip_sweep''microstrip_zsc({{ArgTypeString}} object2, {{ArgTypeAny}} width25,0.5,2.2,2e9)''
EXAMPLEDESCRIPTION: ''strip_sweepComputes and returns the input reactance ("Curve_1",5in Ohms)''of a short-circuited microstrip transmission line with width w, length l, substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
DESCRIPTION: Creates a strip version of a given curve object.====mirror====
====pipe_sweep====SYNTAX: mirror({{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)
SYNTAXEXAMPLE: pipe_sweep''mirror({{ArgTypeString}} object"pyramid_1", {{ArgTypeAny}} radius0,0,0,1,0,0)''
EXAMPLEDESCRIPTION: ''pipe_sweep("Curve_1",5)''Mirrors an object in a plane defined by the specified point coordinates and specified normal vector components.
DESCRIPTION: Creates a pipe version of a given curve object.====move_to====
====rail_sweep====SYNTAX: move_to({{ArgTypeString}} object, {{ArgTypeString}} group_node_label[, {{ArgTypeString}} module_name])
SYNTAXEXAMPLE: rail_sweep''move_to({{ArgTypeString}} rail_object"NewObj", {{ArgTypeString}} sweep_object"MyObj",10,10,0)''
EXAMPLEDESCRIPTION: ''rail_sweep("Curve_1","Curve_2")''Transfers an object from its current material/object group node in the navigation tree to another node or optionally to another [[EM.Cube]] module.
DESCRIPTION: Rail-sweeps the specified sweep object along the specified curve object.====msin====
== EM.Cube's Python Functions for Material or Object Group Creation ==SYNTAX: msin({{ArgTypeReal}} x, {{ArgTypeReal}} r)
====activate====EXAMPLE: ''msin(0.5,2)''
SYNTAXDESCRIPTION: activate({{ArgTypeString}} group_node_label)Computes and returns the super-quadratic sine function of order r.
EXAMPLE: ''activate("Color_1")''====nurbs_curve====
DESCRIPTIONSYNTAX: Activates a colornurbs_curve({{ArgTypeString}} label, material or object group in the current active [[EM{{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ..Cube]] module. {{ArgType| 3x1 Python tuple}} pn)
====color_group====EXAMPLE: ''nurbs_curve("nc_1",(0,0,0),(1,0,0),(1,0,0))''
SYNTAXDESCRIPTION: color_group({{ArgTypeString}} label)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.
EXAMPLE: ''color_group("Color_1")''====nurbs_strip====
DESCRIPTIONSYNTAX: Creates a color group in CubeCAD module. If the color group 'nurbs_strip({{ArgTypeString}} label' already exists, the group is activated{{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ...{{ArgType| 3x1 Python tuple}} pn)
====pec_group====EXAMPLE: ''nurbs_strip("ns_1",(0,0,0),(1,0,0),(1,0,0))''
SYNTAXDESCRIPTION: pec_group({{ArgTypeString}} label)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.
EXAMPLE: ''pec_group("PEC_1")''====ohmic_loss====
DESCRIPTIONSYNTAX: Creates a PEC material group in the current module. If the PEC group 'ohmic_loss({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====pec_voltage_group====EXAMPLE: ''ohmic_loss("FI_1",-10,-10,-10,10,10,10)''
SYNTAXDESCRIPTION: pec_voltage_group({{ArgTypeString}} Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} voltage)its properties are modified.
EXAMPLE: ''pec_voltage_group("PEC_1",10)''====parabola====
DESCRIPTIONSYNTAX: Creates a fixed-potential PEC object group in the current module. If the PEC group 'parabola({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} focal_length, {{ArgTypeAny}} axial_length, {{ArgTypeAny}} half_only)
====pec_via_group====EXAMPLE: ''parabola("Parabola _1",0,0,0,50,20,0)''
SYNTAXDESCRIPTION: pec_via_group({{ArgTypeString}} Draws a parabola object in the project workspace under the currently activated material group node, or modifies the parabola named 'label' if it already exists. If the Boolean parameter "half_only" is 1, {{ArgTypeAny}} host_layer)only half of the parabola will be drawn.
EXAMPLE: ''pec_via_group("PEC_1",10)''====param_curve====
DESCRIPTIONSYNTAX: Creates an embedded PEC via set group in the current module. If the PEC via group 'param_curve({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} model, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start, {{ArgTypeAny}} stop, {{ArgTypeAny}} step, {{ArgTypeAny}} function[, {{ArgTypeAny}} y(t), {{ArgTypeAny}} z(t)])
====thinwire_group====EXAMPLE: ''param_curve("Curve_1",0,0,0,"parametric","xy",0,10,0.1,"cos(t)","sin(t)","t")''
SYNTAXDESCRIPTION: thinwire_group({{ArgTypeString}} labelGenerates a parametric curve in the project workspace under the currently activated material group node, {{ArgTypeAny}} radius)or modifies the parametric curve named 'label' if it already exists.
EXAMPLE: ''thinwire_group("Thinwire_1",4)''====param_surface====
DESCRIPTIONSYNTAX: Creates a Thinwire material group in the current module. If the thin wire group 'param_surface({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} orientation, {{ArgTypeAny}} start1, {{ArgTypeAny}} stop1, {{ArgTypeAny}} step1, , {{ArgTypeAny}} start2, {{ArgTypeAny}} stop2, {{ArgTypeAny}} step2, {{ArgTypeAny}} function)
====pmc_group====EXAMPLE: ''param_surface("Surf_1",0,0,0,"xy",0,10,0.1,0,10,0.1,"sin(x)*sin(y)")''
SYNTAXDESCRIPTION: pmc_group({{ArgTypeString}} 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.
EXAMPLE: ''pmc_group("PMC_1")''====pec_group====
DESCRIPTIONSYNTAX: Creates a PMC material group in the current module. If the PMC group 'pec_group({{ArgTypeString}} label' already exists, the group is activated.)
====slot_group====EXAMPLE: ''pec_group("PEC_1")''
SYNTAXDESCRIPTION: slot_group({{ArgTypeString}} Creates a PEC material group in the current module. If the PEC group 'label)' already exists, the group is activated.
EXAMPLE: ''slot_group("PMC_1")''====pec_via_group====
DESCRIPTIONSYNTAX: Creates a slot trace group in the current module. If the slot trace group 'pec_via_group({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} host_layer)
====dielectric_group====EXAMPLE: ''pec_via_group("PEC_1",10)''
SYNTAXDESCRIPTION: dielectric_group({{ArgTypeString}} Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)the group is activated.
EXAMPLE: ''dielectric_group("Dielectric_1","my_eps",0,1,0)''====pec_voltage_group====
DESCRIPTIONSYNTAX: Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'pec_voltage_group({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} voltage)
====impenetrable_surface_group====EXAMPLE: ''pec_voltage_group("PEC_1",10)''
SYNTAX: impenetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)Â EXAMPLE: ''impenetrable_surface_group("Impenet_1",2.2,0.0001)''Â DESCRIPTION: Creates an impenetrable surface a fixed-potential PEC object group in [[EM.Terrano]]the current module. If the impenetrable surface PEC group 'label' already exists, the group is activated.
====penetrable_surface_group====
DESCRIPTION: Creates a penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'label' already exists, the group is activated.
====terrain_grouppipe_sweep====
SYNTAX: terrain_grouppipe_sweep({{ArgTypeString}} labelobject, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigmaradius)
EXAMPLE: ''terrain_grouppipe_sweep("Terrain_1Curve_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 activateda pipe version of a given curve object.
====base_point_groupplanewave====
SYNTAX: base_point_groupplanewave({{ArgTypeString}} label, {{ArgTypeAny}} theta, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization)
'EXAMPLE: ''base_point_setplanewave("BP_Set_1PW_1",180,0,"tm")''
DESCRIPTION: Creates a base point set in [[EM.Terrano]]plane wave source. If the base point set group plane wave source 'label' already exists, the group is activatedits properties are modified.
====virtual_groupplot_file====
SYNTAX: virtual_groupplot_file({{ArgTypeString}} labelfilename)
EXAMPLE: ''virtual_groupplot_file("VIR_1D0.DAT")''
DESCRIPTION: Creates Plots the contents of a virtual object group specified data file in [[EM.Terrano]]. If the virtual group 'label' already exists, the group is activatedGrid.
====impedance_surface_grouppmc_group====
SYNTAX: impedance_surface_grouppmc_group({{ArgTypeString}} label, {{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag)
EXAMPLE: ''impedance_surface_grouppmc_group("IMP_1PMC_1",100,-100)''
DESCRIPTION: Creates a impedance_surface PMC material group in [[EM.Illumina]]the current module. If the impedance surface PMC group 'label' already exists, the group is activated.
====conductive_sheet_grouppoint====
SYNTAX: conductive_sheet_grouppoint({{ArgTypeString}} label, {{ArgTypeAny}} sigmax0, {{ArgTypeAny}} thicknessy0, {{ArgTypeAny}} z0)
EXAMPLE: ''conductive_sheet_grouppoint("Cond_1Point_1",1000, 0.01,10)''
DESCRIPTION: Creates Draws a conductive sheet group point in [[EM.Picasso]]. If the conductive sheet project workspace under the currently activated material group node, or modifies the point named 'label' if it already exists, the group is activated.
====charge_grouppolygon_reg====
SYNTAX: charge_grouppolygon_reg({{ArgTypeString}} label, {{ArgTypeAny}} densityx0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} n_sides)
EXAMPLE: ''charge_grouppolygon_reg("Charge_1ts_1",-1e-50,0,0,50,100,80,1)''
DESCRIPTION: Creates Draws a volume charge source group regular polygon object in [[EM.Ferma]]. If the charge project workspace under the currently activated material group node, or modifies the regular polygon object named 'label' if it already exists, the group is activated.
====magnet_grouppolygonize====
SYNTAX: magnet_grouppolygonize({{ArgTypeString}} labelobject, {{ArgTypeAny}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mzside_length)
EXAMPLE: ''magnet_grouppolygonize("Magnet_1Cric_1",1,0,0,1002)''
DESCRIPTION: Creates a permanent magnet source group in [[EM.Ferma]]. If Polygonizes the magnet group 'label' already exists, specified surface or curve object by the group specified side length. The results is activateda polystrip or a polyline.
====volume_current_grouppolyline====
SYNTAX: volume_current_grouppolyline({{ArgTypeString}} label, {{ArgTypeAnyArgType| 3x1 Python tuple}} Jxp0, {{ArgTypeAnyArgType| 3x1 Python tuple}} Jyp1, ... {{ArgTypeAnyArgType| 3x1 Python tuple}} Jzpn)
EXAMPLE: ''volume_current_grouppolyline("Magnet_1pl_1",(0,0,1e60),(1,0,0),(1,0,0))''
DESCRIPTION: Creates or modifies a volume current source group PolyLine object in [[EMthe project workspace.Ferma]]Each point is represented with a Python tuple type. If the volume current group 'label' already existsThe poly_line is closed if p0 is specified again as pn, the group otherwise, it is activatedopen.
====wire_current_grouppolymesh====
SYNTAX: wire_current_grouppolymesh({{ArgTypeString}} label, {{ArgTypeAnyArgTypeString}} currentobject, {{ArgTypeAny}} wire_radiusedge_length)
EXAMPLE: ''wire_current_grouppolymesh("Magnet_1Poly_1",1"Cric_1",0.52)''
DESCRIPTION: Creates a wire current source group in [[EM.Ferma]]. If Discretizes the wire current group 'label' already exists, specified solid or surface object by the group specified edge length. The results is activateda polymesh object.
== EM.Cube's Python Functions for Source & Lumped Device Definition ==polystrip====
====lumped_src====SYNTAX: polystrip({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)
SYNTAXEXAMPLE: lumped_src''polystrip({{ArgTypeString}} label"ps_1", {{ArgTypeAny}} line_object(0, {{ArgTypeAny}} offset0, {{ArgTypeAny}} polarity[0), {{ArgTypeAny}} amplitude(1, {{ArgTypeAny}} phase0, {{ArgTypeAny}} resistance]0),(1,0,0))''
EXAMPLEDESCRIPTION: Creates or modifies a Polystrip object in the project workspace. Each point is represented with a Python tuple type. The poly_strip function is 'self-closing'lumped_src("LS_1","Line_1",50,0)''-- there is no need to supply the first point again at the end of the point list.
DESCRIPTION: Creates a lumped source in [[EM.Tempo]]. If the lumped source 'label' already exists, its properties are modified.====port_definition_custom====
====distributed_src====SYNTAX: port_definition_custom({{ArgTypeString}} label, ({{ArgTypeString}} port_1_src_1, {{ArgTypeString}} port_1_src_2, ..., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance), ...)
SYNTAXEXAMPLE: distributed_src''port_definition_custom({{ArgTypeString}} label"PD_1", {{ArgTypeAny}} rect_object("LS_1", {{ArgTypeAny}} field_dir"LS_2", {{ArgTypeAny}} profile[50), {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase("LS_3", {{ArgTypeAny}} resistance]"LS_4",50))''
EXAMPLEDESCRIPTION: Creates a custom port definition observable. If the observable 'label'distributed_src("DS_1"already exists,"Rect_1","+y","uniform")''its properties are modified.
DESCRIPTION: Creates a distributed source in [[EM.Tempo]]. If the distributed source 'label' already exists, its properties are modified.====port_definition_default====
====microstrip_src====SYNTAX: port_definition_default({{ArgTypeString}} label)
SYNTAXEXAMPLE: microstrip_src''port_definition_default({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} height, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]"PD_1")''
EXAMPLEDESCRIPTION: Creates a default port definition observable. If the observable 'label'microstrip_src("MS_1"already exists,"Rect_1",1its properties are modified.5,"+x")''
DESCRIPTION: Creates a microstrip port source in [[EM.Tempo]]. If the microstrip port 'label' already exists, its properties are modified.====probe_gap_src====
====cpw_src====SYNTAX: probe_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} via_object, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
SYNTAXEXAMPLE: cpw_src''probe_gap_src({{ArgTypeString}} label"Probe_1", {{ArgTypeAny}} rect_object"Via_1", {{ArgTypeAny}} spacing, {{ArgTypeAny}} edge[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]0)''
EXAMPLEDESCRIPTION: Creates a probe gap circuit source in [[EM.Picasso]]. If the probe gap source 'label'cpw_src("CPW_1"already exists,"Rect_1",1its properties are modified.5,"+x")''
DESCRIPTION: Creates a CPW port source in [[EM.Tempo]]. If the CPW port 'label' already exists, its properties are modified.====pyramid====
====coaxial_src====SYNTAX: pyramid({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_x, {{ArgTypeAny}} base_y, {{ArgTypeAny}} height)
SYNTAXEXAMPLE: coaxial_src''pyramid({{ArgTypeString}} label"Pyramid_1", {{ArgTypeAny}} cylinder_object0, {{ArgTypeAny}} outer_radius0, {{ArgTypeAny}} edge[0, {{ArgTypeAny}} amplitude10, {{ArgTypeAny}} phase10, {{ArgTypeAny}} resistance]100)''
EXAMPLEDESCRIPTION: Draws a pyramid object in the project workspace under the currently activated material group node, or modifies the pyramid named 'label'coaxial_src("COAX_1","Cyl_1",1if it already exists.5,"+z")''
DESCRIPTION: Creates a coaxial port source in [[EM.Tempo]]. If the coaxial port 'label' already exists, its properties are modified.====radial_strip====
====waveguide_src====SYNTAX: radial_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} base_length, {{ArgTypeAny}} angle)
SYNTAXEXAMPLE: waveguide_src''radial_strip({{ArgTypeString}} label"Radial_1", {{ArgTypeAny}} box_object0, {{ArgTypeAny}} offset0, {{ArgTypeAny}} is_negative[0, {{ArgTypeAny}} amplitude50, {{ArgTypeAny}} phase0, {{ArgTypeAny}} resistance]90)''
EXAMPLEDESCRIPTION: ''waveguide_src("WG_1","Box_1",50Draws a radial strip object in the project workspace under the currently activated material group node,0)or modifies the radial strip object named 'label'if it already exists.
DESCRIPTION: Creates a waveguide port source in [[EM.Tempo]]. If the waveguide port 'label' already exists, its properties are modified.====rail_sweep====
====wire_gap_src====SYNTAX: rail_sweep({{ArgTypeString}} rail_object, {{ArgTypeString}} sweep_object)
SYNTAXEXAMPLE: wire_gap_src''rail_sweep({{ArgTypeString}} label"Curve_1", {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]"Curve_2")''
EXAMPLEDESCRIPTION: ''wire_gap_src("WIG_1","Line_1",50,0)''Rail-sweeps the specified sweep object along the specified curve object.
DESCRIPTION: Creates a wire gap circuit source in [[EM.Libera]]. If the wire gap source 'label' already exists, its properties are modified.====ramp====
====rect_gap_src====SYNTAX: ramp({{ArgTypeReal}} x)
SYNTAXEXAMPLE: rect_gap_src''ramp({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]0.5)''
EXAMPLEDESCRIPTION: ''rect_gap_src("GAP_1","Rect_1",Computes and returns the ramp function: x if x>0,0)''if x<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.====rand====
====probe_gap_src====SYNTAX: rand({{ArgTypeReal}} x, {{ArgTypeReal}} y)
SYNTAXEXAMPLE: probe_gap_src''rand({{ArgTypeString}} label0, {{ArgTypeAny}} via_object, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]1)''
EXAMPLEDESCRIPTION: ''probe_gap_src("Probe_1","Via_1",0)''Computes and returns a random number between x and y using an uniform distribution.
DESCRIPTION: Creates a probe gap circuit source in [[EM.Picasso]]. If the probe gap source 'label' already exists, its properties are modified.====random_group====
====wave_port====SYNTAX: random_group({{ArgTypeString}} label, {{ArgTypeString}} key_object, {{ArgTypeString}} container_object, {{ArgTypeAny}} element_count)
SYNTAXEXAMPLE: wave_port''random_group({{ArgTypeString}} label"Rand_1", {{ArgTypeAny}} rect_object"Rect_1", {{ArgTypeAny}} offset"Box_1", {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]100)''
EXAMPLEDESCRIPTION: ''wave_port("WP_1","Rect_1",0,0)''Creates a random group using the specified key object and confines them in the specified container object.
DESCRIPTION: Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If the wave port 'label' already exists, its properties are modified.====rcs_bistatic====
====short_dipole====SYNTAX: rcs_bistatic({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])
SYNTAXEXAMPLE: short_dipole''rcs_bistatic({{ArgTypeString}} label"RCS_1", {{ArgTypeAny}} x01, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase1)''
EXAMPLEDESCRIPTION: Creates a bistatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the observable 'label'short_dipole("SD_1"already exists,0,0,50,3,0,0,1,1,0)''its properties are modified.
DESCRIPTION: Creates a Hertzian short dipole source. If the short dipole source 'label' already exists, its properties are modified.====rcs_monostatic====
====planewave====SYNTAX: rcs_monostatic({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr[, {{ArgTypeAny}} frequency])
SYNTAXEXAMPLE: planewave''rcs_monostatic({{ArgTypeString}} label"RCS_1", {{ArgTypeAny}} theta1, {{ArgTypeAny}} phi, {{ArgTypeAny}} polarization1)''
'EXAMPLEDESCRIPTION: Creates a monostatic RCS observable. The frequency can also be optionally specified for [[EM.Tempo]]. If the observable 'label'planewave("PW_1"already exists,180,0,"tm")''its properties are modified.
DESCRIPTION: Creates a plane wave source. If the plane wave source 'label' already exists, its properties are modified.====receiver_set====
====gauss_beam====SYNTAX: receiver_set({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)
SYNTAXEXAMPLE: gauss_beam''receiver_set({{ArgTypeString}} label"TX_1", {{ArgTypeAny}} theta"PT_1", {{ArgTypeAny}} phi"DPL_STD.RAD", {{ArgTypeAny}} polarization0, {{ArgTypeAny}} focus_x90, {{ArgTypeAny}} focus_y, {{ArgTypeAny}} focus_z, {{ArgTypeAny}} radius, {{ArgTypeAny}} p_mode, {{ArgTypeAny}} q_mode0)''
EXAMPLEDESCRIPTION: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label'gauss_beam("PW_1"already exists,180,0,"tm",0,0,0,20,0,0)''its properties are modified.
DESCRIPTION: Creates a Gaussian beam source in [[EM.Tempo]]. If the Gaussian beam source 'label' already exists, its properties are modified.====rect====
====huygens_src====SYNTAX: rect({{ArgTypeReal}} x)
SYNTAXEXAMPLE: huygens_src''rect({{ArgTypeString}} label, {{ArgTypeAny}} filename[, {{ArgTypeAny}} set_lcs, {{ArgTypeAny}} polarization, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} x_rot, {{ArgTypeAny}} y_rot, {{ArgTypeAny}} z_rot]0.1)''
EXAMPLEDESCRIPTION: Computes and returns the rectangular window function: ''huygens_src("HS_1","Huygens_1.HUY",1,100,100,if x<0.5,0,0,0)''elsewhere.
DESCRIPTION: Creates a Huygens source. If the Huygens source 'label' already exists, its properties are modified.====rect_gap_src====
====transmitter_set====SYNTAX: rect_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance])
SYNTAXEXAMPLE: transmitter_set''rect_gap_src({{ArgTypeString}} label"GAP_1", {{ArgTypeAny}} base_point_set["Rect_1", {{ArgTypeAny}} pattern_file0, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z0)''
EXAMPLEDESCRIPTION: Creates a strip gap circuit source in [[EM.Picasso]] or [[EM.Libera]]. If the strip gap source 'label'transmitter_set("TX_1"already exists,"PT_1","DPL_STDits properties are modified.RAD",0,90,0)''
====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 transmitter set resistance integral observable in [[EM.TerranoFerma]]. If the transmitter set observable 'label' already exists, its properties are modified.
====resistor====
DESCRIPTION: Creates a resistor in [[EM.Tempo]]. If the resistor 'label' already exists, its properties are modified.
====capacitorrevolve====
SYNTAX: capacitorrevolve({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} line_objectuY, {{ArgTypeAny}} offsetuZ, {{ArgTypeAny}} capacitance_pFrot_angle)
EXAMPLE: ''capacitorrevolve("Cap_1Rev1","Line_1",250,100,0,0,0,1,360)''
DESCRIPTION: Creates or modifies a capacitor in [[EM.Tempo]]revolution object from a specified object. If modifying an existing revolution object, the capacitor 'label' already existspre-existing primitive object is used. (x0, its properties are modifiedy0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. The revolution angle "rot_angle" is given in degrees.
====inductorrosen====
SYNTAX: inductorrosen({{ArgTypeStringArgTypeReal}} labelx, {{ArgTypeAnyArgTypeReal}} line_objecty, {{ArgTypeAnyArgTypeReal}} offseta, {{ArgTypeAnyArgTypeReal}} inductance_nHb)
EXAMPLE: ''inductorrosen("Cap_1"0.5,"Line_1"0,251,102)''
DESCRIPTION: Creates a inductor in [[EM.Tempo]]. If Computes and returns the inductor 'label' already exists, its properties are modifiedRosenbrock function: (a-x)**2 + b*(y-x**2)**2.
====dioderotate====
SYNTAX: dioderotate({{ArgTypeString}} labelobject, {{ArgTypeAny}} line_objectrot_angle_degree, {{ArgTypeAny}} polarityrot_axis_x, {{ArgTypeAny}} is_fArot_axis_y, {{ArgTypeAny}} temperature_K, {{ArgTypeAny}} ideality_factorrot_axis_z)
EXAMPLE: ''dioderotate("Diode_1pyramid_1","Line_1"45,251,1,0,10,300,1)''
DESCRIPTION: Creates Rotates an object about a diode in [[EM.Tempo]]. If the diode 'label' already exists, line passing through its properties are modifiedLCS center and aligned along the specified direction vector (rot_axis) by the specified angle.
== EM.Cube's Python Functions for Observable Definition ==roughen====
====port_definition_default====SYNTAX: roughen({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} rms_height, {{ArgTypeAny}} correl_length)
SYNTAXEXAMPLE: port_definition_default''roughen({{ArgTypeString}} label"Rect_1",1,5)''
EXAMPLEDESCRIPTION: ''port_definition_default("PD_1")''Roughens the surface of the specified object based on the specified RMS height and correlation length.
DESCRIPTION: Creates a default port definition observable. If the observable 'label' already exists, its properties are modified.====run_analysis====
====port_definition_custom====SYNTAX: run_analysis()
SYNTAXDESCRIPTION: port_definition_custom({{ArgTypeString}} label, ({{ArgTypeString}} port_1_src_1, {{ArgTypeString}} port_1_src_2, Runs a simulation in the current active [[EM.Cube]] computational module.., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance), ...)
EXAMPLE: ''port_definition_custom("PD_1",("LS_1","LS_2",50),,("LS_3","LS_4",50))''====save_data====
DESCRIPTIONSYNTAX: Creates a custom port definition observable. If the observable 'label' already exists, its properties are modified.save_data({{ArgTypeString}} directory_name)
====farfield====EXAMPLE: ''save_data("Simulation_Data")''
SYNTAXDESCRIPTION: farfield({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)Saves [[EM.Cube]]'s output simulation data files under the specified directory.
EXAMPLE: ''farfield("FF_1",1,1)''====sawtooth====
DESCRIPTIONSYNTAX: Creates a far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.sawtooth({{ArgTypeReal}} x)
====rcs_bistatic====EXAMPLE: ''sawtooth(0.5)''
SYNTAXDESCRIPTION: rcs_bistatic({{ArgTypeString}} labelComputes and returns the ascending periodic sawtooth function of period T = 2, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)oscillating between two values +1 and -1 and having a zero value of at x = 0.
EXAMPLE: ''rcs_bistatic("RCS_1",1,1)''====scale====
DESCRIPTIONSYNTAX: Creates a bistatic RCS observable. If the observable 'label' already existsscale({{ArgTypeString}} object, its properties are modified.{{ArgTypeAny}} scale_factor)
====current_dist====EXAMPLE: ''scale("pyramid_1",2)''
SYNTAXDESCRIPTION: current_dist({{ArgTypeString}} label)Scales an object by the specified scale factor.
EXAMPLE: ''current_dist("CD_1")''====select_module====
DESCRIPTIONSYNTAX: Creates a current distribution observable. If the observable 'label' already exists, its properties are modified.select_module({{ArgTypeString}} module_name)
====field_sensor====EXAMPLE: ''select_module("[[EM.Tempo]]")''
SYNTAXDESCRIPTION: field_sensor({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)Selects and sets [[EM.Cube]]'s active module.
EXAMPLE: ''field_sensor("FS_1","z",0,0,0,100,100,0,25,25,0)''====set_bandwidth====
DESCRIPTIONSYNTAX: Creates a near-field sensor observable. If the observable 'label' already exists, its properties are modified.set_bandwidth({{ArgTypeAny}} value)
====field_sensor_grid====EXAMPLE: ''set_bandwidth(1e9)''
SYNTAXDESCRIPTION: field_sensor_grid({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)Sets [[EM.Cube]]'s frequency bandwidth.
EXAMPLE: ''field_sensor_grid("FS_1","z",0,0,0)''====set_boundary_conditions====
DESCRIPTIONSYNTAX: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already existsset_boundary_conditions({{ArgTypeString}} xn_type, its properties are modified.{{ArgTypeString}} xp_type, {{ArgTypeString}} yn_type, {{ArgTypeString}} yp_type, {{ArgTypeString}} zn_type, {{ArgTypeString}} zp_type)
====field_probe====EXAMPLE: ''set_domain_offset_lambda("pml","pml","pml","pml","pec","pml")''
SYNTAXDESCRIPTION: field_probe({{ArgTypeString}} labelSets [[EM.Tempo]]'s domain boundary conditions domain offset on the ±X, {{ArgTypeAny}} x0±Y and ±Z boundary walls. The options are "pec", {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)"pmc" and "pml".
EXAMPLE: ''field_probe("FS_1",0,0,50)''====set_domain_offset====
DESCRIPTIONSYNTAX: Creates a temporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already existsset_domain_offset({{ArgTypeAny}} dxn_offset, its properties are modified.{{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset)
====receiver_set====EXAMPLE: ''set_domain_offset(20,20,20,20,0,10)''
SYNTAXDESCRIPTION: receiver_set({{ArgTypeString}} labelSets the domain offset values along the ±X, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)±Y and ±Z directions in project units.
EXAMPLE: ''receiver_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)''====set_domain_offset_lambda====
DESCRIPTIONSYNTAX: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label' already existsset_domain_offset_lambda({{ArgTypeAny}} dxn_offset, its properties are modified.{{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset)
====huygens_surface====EXAMPLE: ''set_domain_offset_lambda(0.1,0.1,0.1,0.1,0,0.25)''
SYNTAXDESCRIPTION: huygens_surface({{ArgTypeString}} labelSets the domain offset values along the ±X, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)±Y and ±Z directions in free-space wavelengths.
EXAMPLE: ''huygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)''====set_frequency====
DESCRIPTIONSYNTAX: Creates a Huygens surface observable. If the observable 'label' already exists, its properties are modified.set_frequency({{ArgTypeAny}} value)
====huygens_surface_grid====EXAMPLE: ''set_frequency(2.4e9)''
SYNTAXDESCRIPTION: huygens_surface_grid({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)Sets [[EM.Cube]]'s center frequency.
EXAMPLE: ''huygens_surface_grid("HS_1",-10,-10,-10,10,10,10)''====set_lcs_link====
DESCRIPTIONSYNTAX: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label' already existsset_lcs_link({{ArgTypeString}} object, its properties are modified.{{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off, {{ArgTypeAny}} y_off, {{ArgTypeAny}} z_off)
====voltage_integral====EXAMPLE: ''set_lcs_link("pyramid_1","box_1",50,50,0)''
SYNTAXDESCRIPTION: voltage_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)Links the LCS of the first object to the LCS of the second object by the specified offset values along the three axes.
EXAMPLE: ''voltage_integral("FI_1",0,0,-10,0,0,10)''====set_periodic====
DESCRIPTIONSYNTAX: Creates a voltage integral observable in [[EM.Ferma]]. If the observable 'label' already existsset_periodic({{ArgTypeAny}} is_periodic, its properties are modified.{{ArgTypeAny}} spacingX, {{ArgTypeAny}} spacingY)
====current_integral====EXAMPLE: ''set_periodic(1,50,50)''
SYNTAXDESCRIPTION: current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)Designates the physical structure as periodic and sets the periods along the X and Y directions.
EXAMPLE: ''current_integral("FI_1",-10,-10,0,10,10,0)''====set_rot====
DESCRIPTIONSYNTAX: Creates a current integral observable in [[EM.Ferma]]. If the observable 'label' already existsset_rot({{ArgTypeString}} object, its properties are modified.{{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)
====conduction_current_integral====EXAMPLE: ''set_rot("pyramid_1",0,0,45)''
SYNTAXDESCRIPTION: conduction_current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)Sets the three rotation angles of an object.
EXAMPLE: ''conduction_current_integral("FI_1",-10,-10,0,10,10,0)''====set_rot_link====
DESCRIPTIONSYNTAX: Creates a conduction current integral observable in [[EM.Ferma]]. If the observable 'label' already existsset_rot_link({{ArgTypeString}} object, its properties are modified.{{ArgTypeString}} lcs_obj, {{ArgTypeAny}} x_off_deg, {{ArgTypeAny}} y_off_deg, {{ArgTypeAny}} z_off_deg)
====capacitance====EXAMPLE: ''set_rot_link("pyramid_1","box_1",0,0,45)''
SYNTAXDESCRIPTION: 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)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.
EXAMPLE: ''capacitance("FI_1",-10,-10,5,10,10,10,0,0,-10,0,0,10)''====set_stackup_order====
DESCRIPTIONSYNTAX: Creates a capacitance integral observable in [[EMset_stackup_order("THS", {{ArgTypeString}} label_1, {{ArgTypeString}} label_2, .Ferma]]. If the observable 'label' already exists, its properties are modified., {{ArgTypeString}} label_n, "BHS")
====inductance====EXAMPLE: ''background_layer("THS","Top_Layer","Mid_Layer","Bottom_Layer","BHS")''
SYNTAXDESCRIPTION: inductance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)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.
EXAMPLE: ''inductance("FI_1",0,0,-10,10,0,10,2.5,-2.5,0,7.5,2.5,0)''====set_units====
DESCRIPTIONSYNTAX: Creates a inductance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.set_units({{ArgTypeString}} units)
====resistance====EXAMPLE: ''set_units("meter")''
SYNTAXDESCRIPTION: 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)Sets [[EM.Cube]]'s project length units.
EXAMPLE: ''resistance("FI_1",0,0,-10,0,0,10,-10,-10,0,10,10,0)''====sgn====
DESCRIPTIONSYNTAX: Creates a resistance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.sgn({{ArgTypeReal}} x)
====flux_electric====EXAMPLE: ''sgn(-1.0)''
SYNTAXDESCRIPTION: flux_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2Computes and returns the signum function: 1 if x>0, {{ArgTypeAny}} z2)-1 if x<0.
EXAMPLE: ''flux_electric("FI_1",-10,-10,5,10,10,10)''====short_dipole====
DESCRIPTIONSYNTAX: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'short_dipole({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} length, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase)
====flux_magnetic====EXAMPLE: ''short_dipole("SD_1",0,0,50,3,0,0,1,1,0)''
SYNTAXDESCRIPTION: flux_magnetic({{ArgTypeString}} Creates a Hertzian short dipole source. If the short dipole source 'label' already exists, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)its properties are modified.
EXAMPLE: ''flux_magnetic("FI_1",0,0,-10,10,0,10)''====sigmoid====
DESCRIPTIONSYNTAX: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label' already existssigmoidnc({{ArgTypeReal}} x, its properties are modified.{{ArgTypeReal}} a)
====energy_electric====EXAMPLE: ''sigmoid(0.5,1)''
SYNTAXDESCRIPTION: energy_electricComputes and returns the sigmoid function of slope a: 2/({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z21 + exp(-a*x))- 1.
EXAMPLE: ''energy_electric("FI_1",-10,-10,-10,10,10,10)''====sinc====
DESCRIPTIONSYNTAX: Creates an electric energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.sinc({{ArgTypeReal}} x)
====energy_magnetic====EXAMPLE: ''sinc(0.5)''
SYNTAXDESCRIPTION: energy_magneticComputes and returns the sinc function: sin(pi*x)/({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2pi*x).
EXAMPLE: ''energy_magnetic("FI_1",-10,-10,-10,10,10,10)''====slice====
DESCRIPTIONSYNTAX: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label' already existsslice({{ArgTypeString}} object, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ)
====ohmic_loss====EXAMPLE: ''slice("Rect_1",5)''
SYNTAXDESCRIPTION: ohmic_loss({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.
EXAMPLE: ''ohmic_loss("FI_1",-10,-10,-10,10,10,10)''====slot_group====
SYNTAX: slot_group({{ArgTypeString}} label)Â EXAMPLE: ''slot_group("PMC_1")''Â DESCRIPTION: Creates an ohmic loss integral observable a slot trace group in [[EM.Ferma]]the current module. If the observable slot trace group 'label' already exists, its properties are modifiedthe group is activated.
====solution_plane====
DESCRIPTION: Creates a 2D solution plane observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
== EM.Cube's Python Functions for Simulation-Related Functions & Operations ==sphere====
====select_moduleSYNTAX: sphere({{ArgTypeString}} module_namelabel, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle])====
EXAMPLE: ''Example: select_modulesphere("[[EM.Tempo]]Sphere_1",0,0,0,10,0,180)''
DescriptionDESCRIPTION: Selects and sets [[EMDraws a sphere object in the project workspace under the currently activated Material Group node, or modifies the sphere named 'label' if it already exists.Cube]]The arguments start_angle and end_angle are in degrees and specify a sweep about the sphere's active moduleazimuth axis.
====set_units({{ArgTypeString}} units)spiral_curve====
''ExampleSYNTAX: set_unitsspiral_curve("meter"{{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer, {{ArgTypeAny}} nturns, {{ArgTypeAny}} spiral_dir, {{ArgTypeAny}} is_dual)''
DescriptionEXAMPLE: Sets [[EM.Cube]]'s project length units.'spiral_curve("Spiral _1",0,0,0,10,50,5,0,0)''
====set_frequency({{ArgTypeAny}} value)====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.
''Example: set_frequency(2.4e9)''====spiral_strip====
DescriptionSYNTAX: Sets [[EM.Cube]]'s center frequency.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)
====set_bandwidthEXAMPLE: ''spiral_strip({{ArgTypeAny}} value"Spiral _1",0,0,0,10,50,5,0,0)====''
''ExampleDESCRIPTION: set_bandwidth(1e9)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.
Description: Sets [[EM.Cube]]'s frequency bandwidth.====spline_fit====
====background_layerSYNTAX: spline_fit({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thicknessobject)====
EXAMPLE: ''Example: background_layerspline_fit("Mid_LayerPoly_1",3.3,0.001,1,1.5)''
DescriptionDESCRIPTION: Adds Applies spline fit transformation on a new substrate layer to [[EM.Picasso]]'s background layer stackupspecified polymesh, polyline or polystrip object.
====delete_background_layer({{ArgTypeString}} label)spline2====
''ExampleSYNTAX: delete_background_layerspline2("Mid_Layer"{{ArgTypeReal}} x)''
DescriptionEXAMPLE: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup'spline2(1.0)''
====set_stackup_order("THS", {{ArgTypeString}} label_1, {{ArgTypeString}} label_2, DESCRIPTION: Computes and returns the quadratic B-spline function..., {{ArgTypeString}} label_n, "BHS")====
''Example: background_layer("THS","Top_Layer","Mid_Layer","Bottom_Layer","BHS")''====spline3====
DescriptionSYNTAX: Sets the hierarchy of [[EM.Picasso]]'s background layer stackup from top to bottom. The sequence should always start with "THS" standing for the top half-space and must end in "BHS" standing for the bottom half-space. All the intermediate finite-thickness substrate layers must be included and listed in the right order. spline3({{ArgTypeReal}} x)
====global_groundEXAMPLE: ''spline3({{ArgTypeAny}} ground_on, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma1.0)====''
''ExampleDESCRIPTION: global_ground(1,3Computes and returns the cubic B-spline function.3,0.001)''
Description: Set the state of [[EM.Terrano]]'s global ground and its material properties. A zero value for ground_on means to no global ground assumed at Z = 0. ===sqr_wave====
====deleteSYNTAX: sqr_wave({{ArgTypeStringArgTypeReal}} node_namex)====
EXAMPLE: ''Example: deletesqr_wave("Box_1"0.5)''
DescriptionDESCRIPTION: Deletes a node name from Computes and returns the navigation tree. The node can be any geometric objectperiodic square wave function of period T = 2, source, observable or material grouposcillating between two values +1 and -1 and having a value of +1 at x = 0.
====rename({{ArgTypeString}} new_label, {{ArgTypeString}} old_label)sqr2====
''ExampleSYNTAX: renamesqr2("Box_2"{{ArgTypeReal}} x,"Box_1"{{ArgTypeReal}} y)''
DescriptionEXAMPLE: Deletes a node name from the navigation tree. The node can be any geometric object''sqr2(0, source, observable or material group. 1)''
====zoom_extents()====DESCRIPTION: Computes and returns the sum of squares of x and y: x**2 + y**2.
Description: Zooms to fit the extents of the physical structure into the screen.====sqr3====
====get_domain_extentSYNTAX: sqr2({{ArgTypeStringArgTypeReal}} coordinatex, {{ArgTypeReal}} y, {{ArgTypeReal}} z)====
EXAMPLE: ''Example: get_domain_extentsqr2("x"0,1,2)''
DescriptionDESCRIPTION: Returns Computes and returns the size sum of the computational domain along the specified directionsquares of x, y and z: x**2 + y**2 + z**2.
====set_domain_offset({{ArgTypeAny}} dxn_offset, {{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset)sqrt2====
''ExampleSYNTAX: set_domain_offsetsqrt2(20{{ArgTypeReal}} x,20,20,20,0,10{{ArgTypeReal}} y)''
DescriptionEXAMPLE: Sets the domain offset values along the ±X''sqrt2(0, ±Y and ±Z directions in project units.1)''
====set_domain_offset_lambdaDESCRIPTION: Computes and returns the radius of the 2D point ({{ArgTypeAny}} dxn_offsetx, {{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offsety): sqrt(x**2 + y**2)====.
''Example: set_domain_offset_lambda(0.1,0.1,0.1,0.1,0,0.25)''====sqrt3====
DescriptionSYNTAX: Sets the domain offset values along the ±Xsqrt3({{ArgTypeReal}} x, ±Y and ±Z directions in free-space wavelengths.{{ArgTypeReal}} y, {{ArgTypeReal}} z)
====set_boundary_conditionsEXAMPLE: ''sqrt3({{ArgTypeString}} xn_type0, {{ArgTypeString}} xp_type1, {{ArgTypeString}} yn_type, {{ArgTypeString}} yp_type, {{ArgTypeString}} zn_type, {{ArgTypeString}} zp_type2)====''
''ExampleDESCRIPTION: set_domain_offset_lambdaComputes and returns the radius of the 3D point ("pml"x,"pml"y,"pml","pml","pec","pml"z): sqrt(x**2 + y**2 + z**2)''.
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".====step====
====add_variableSYNTAX: step({{ArgTypeStringArgTypeReal}} var_name, {{ArgTypeAny}} valuex)====
EXAMPLE: ''Example: add_variablestep("MyVar",1.0)''
DescriptionDESCRIPTION: Adds a new variable to [[EM.Cube]]'s variable listComputes and returns the unit step function: 1 if x>0, 0 if x<0.
====run_analysis()strip_sweep====
DescriptionSYNTAX: Runs a simulation in the current active [[EM.Cube]] computational module.strip_sweep({{ArgTypeString}} object, {{ArgTypeAny}} width)
====set_periodicEXAMPLE: ''strip_sweep({{ArgTypeAny}} is_periodic"Curve_1", {{ArgTypeAny}} spacingX, {{ArgTypeAny}} spacingY5) ====''
''ExampleDESCRIPTION: set_periodic(1,50,50)''Creates a strip version of a given curve object.
Description: Designates the physical structure as periodic and sets the periods along the X and Y directions.====subtract====
====get_standard_outputSYNTAX: subtract({{ArgTypeString}} output_namelabel, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2) ====
EXAMPLE: ''Example: get_standard_outputsubtract("S11MSubtract_Object","Rect_Strip1","Rect_Strip2")''
DescriptionDESCRIPTION: Returns the computed value of the specified standard output parameter at the end of Creates a simulationBoolean object named 'label' by subtracting object_2 from object_1. An error will be thrown if a Boolean object named 'label' already exists.
====save_data({{ArgTypeString}} directory_name) superquad====
''ExampleSYNTAX: save_datasuperquad("Simulation_Data"{{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} diam_x, {{ArgTypeAny}} diam_y, {{ArgTypeAny}} order)''
DescriptionEXAMPLE: Saves [[EM.Cube]]'s output simulation data files under the specified directory.'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 ====plot_file({{ArgTypeString}} filename) ====2, the curve reduces to an ellipse. Higher order makes the round edges sharper. An infinite order reduces the curve to a rectangle.
''Example: plot_file("D0.DAT")''====taper_strip====
DescriptionSYNTAX: Plots the contents of a specified data file in EM.Grid.taper_strip({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} base_width, {{ArgTypeAny}} top_width, {{ArgTypeAny}} length, {{ArgTypeAny}} is_expo)
====meshEXAMPLE: ''taper_strip("ts_1",0,0,0,50,100,80,1)====''
DescriptionDESCRIPTION: Generates and displays Draws a taper strip object in the mesh of project workspace under the physical structurecurrently 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.
====emtempo_mesh_settings({{ArgTypeAny}} cells_per_lambda, {{ArgTypeAny}} ratio_contour, {{ArgTypeAny}} ratio_thin, {{ArgTypeAny}} ratio_abs)terrain_group====
''ExampleSYNTAX: emtempo_mesh_settingsterrain_group(30{{ArgTypeString}} label,0.1{{ArgTypeAny}} eps,0.1,0.02{{ArgTypeAny}} sigma)''
DescriptionEXAMPLE: Sets the parameters of [[EM.Tempo]]'s adaptive mesh generator'terrain_group("Terrain_1",5.0,0.0001)''
====emillumina_mesh_settings({{ArgTypeAny}} cells_per_lambda)====DESCRIPTION: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label' already exists, the group is activated.
''Example: emillumina_mesh_settings(30)''====thinwire_group====
DescriptionSYNTAX: Sets the parameters of [[EM.Illumina]]'s mesh generator.thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)
====empicasso_mesh_settingsEXAMPLE: ''thinwire_group({{ArgTypeAny}} cells_per_lambda"Thinwire_1",4)====''
''ExampleDESCRIPTION: empicasso_mesh_settings(30)Creates a Thinwire material group in the current module. If the thin wire group 'label'already exists, the group is activated.
Description: Sets the parameters of [[EM.Picasso]]'s planar hybrid mesh generator.====torus====
====emlibera_mesh_settingsSYNTAX: torus({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius_major, {{ArgTypeAny}} radius_minor[, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} cells_per_lambdaend_angle])====
EXAMPLE: ''Example: emlibera_mesh_settingstorus(30"Torus_1",0,0,0,50,20)''
DescriptionDESCRIPTION: Sets Draws an torus object in the parameters of [[EMproject workspace under the currently activated material group node, or modifies the torus named 'label' if it already exists.Libera]]The arguments start_angle and end_angle are in degrees and specify a sweep about the torus's mesh generatorazimuth axis.
====emferma_mesh_settings({{ArgTypeAny}} cell_size_x, {{ArgTypeAny}} cell_size_y, {{ArgTypeAny}} cell_size_z)translate_by====
''ExampleSYNTAX: emferma_mesh_settingstranslate_by(0.5{{ArgTypeString}} object,0.5 {{ArgTypeReal}} x_dist,0.5{{ArgTypeReal}} y_dist, {{ArgTypeReal}} z_dist)''
DescriptionEXAMPLE: Sets the parameters of [[EM.Ferma]]'s fixed-cell mesh generator.'translate_by("MyObj",10,10,x)''
====emterrano_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol)====DESCRIPTION: Translates an object by the specified distances in each direction.
''Example: emterrano_mesh_settings(5,10)''====translate_to====
DescriptionSYNTAX: Sets the parameters of [[EM.Terrano]]'s facet mesh generator.translate_to({{ArgTypeString}} object, {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest)
====cubecad_mesh_settingsEXAMPLE: ''translate_to({{ArgTypeAny}} edge_length"MyObj", {{ArgTypeAny}} angle_tol20,20,x2)====''
''ExampleDESCRIPTION: cubecad_mesh_settings(5,10)''Translates an object to the specified destination.
Description: Sets the parameters of CubeCAD's mesh generator.====transmitter_set====
====emtempo_engine_settingsSYNTAX: transmitter_set({{ArgTypeString}} enginelabel, {{ArgTypeAny}} power_threshholdbase_point_set[, {{ArgTypeAny}} max_timestepspattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)====
EXAMPLE: ''Example: emtempo_engine_settingstransmitter_set("single-precisionTX_1",-50"PT_1","DPL_STD.RAD",0,90,200000)''
DescriptionDESCRIPTION: Sets the parameters of Creates a transmitter set in [[EM.TempoTerrano]]. If the transmitter set 'label's FDTD simulation enginealready exists, its properties are modified.
====emterrano_engine_settings({{ArgTypeAny}} bounce_count, {{ArgTypeAny}} do_edge_diffraction, {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshhold)tri====
''ExampleSYNTAX: emterrano_engine_settingstri(5,1,1,-100{{ArgTypeReal}} x)''
DescriptionEXAMPLE: Sets the parameters of [[EM.Terrano]]'s SBR simulation engine'tri(0.1)''
====empicasso_engine_settings({{ArgTypeString}} matrix_solverDESCRIPTION: Computes and returns the triangular window function: 1-|x| if x<1, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)====0 elsewhere.
''Example: empicasso_engine_settings("bicg",1e-3,1000)''====tri_wave====
DescriptionSYNTAX: Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine.tri_wave({{ArgTypeReal}} x)
====emillumina_engine_settingsEXAMPLE: ''tri_wave({{ArgTypeString}} engine, {{ArgTypeAny}} is_fixed_iteration, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations0.5)====''
''ExampleDESCRIPTION: emillumina_engine_settings("ipo"Computes and returns the periodic triangular wave function of period T = 2,oscillating between two values +1 and -1 and having a value of +1 at x = 0,1e-2,20)''.
Description: Sets the parameters of [[EM.Illumina]]'s Physical Optics simulation engine.====triangle_strip====
====emferma_engine_settingsSYNTAX: triangle_strip({{ArgTypeString}} matrix_solverlabel, {{ArgTypeAny}} error_tolx0, {{ArgTypeAny}} max_iterationsy0, {{ArgTypeAny}} z0, {{ArgTypeAny}} side1, {{ArgTypeAny}} side2, {{ArgTypeAny}} angle)====
EXAMPLE: ''Example: emferma_engine_settingstriangle_strip("bicg-stabts_1",1e-30,0,0,50,100,90)''
DescriptionDESCRIPTION: Sets Draws a triangle strip object in the parameters of [[EM.Ferma]]project workspace under the currently activated material group node, or modifies the triangle strip object named 'label's electrostatic and magnetostatic simulation enginesif it already exists.
====emlibera_engine_settings_wmomunion==== SYNTAX: union({{ArgTypeString}} matrix_solverlabel, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2) EXAMPLE: ''union("Union_Object","Rect_Strip1","Rect_Strip2")'' DESCRIPTION: Creates a Boolean object named 'label' by unioning object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists. ====virtual_group==== SYNTAX: virtual_group({{ArgTypeString}} label) EXAMPLE: ''virtual_group("VIR_1")'' DESCRIPTION: Creates a virtual object group in [[EM.Terrano]]. If the virtual group 'label' already exists, the group is activated. ====voltage_integral==== SYNTAX: voltage_integral({{ArgTypeString}} label, {{ArgTypeAny}} error_tolx1, {{ArgTypeAny}} max_iterationsy1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''voltage_integral("FI_1",0,0,-10,0,0,10)'' DESCRIPTION: Creates a voltage integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====volume_current_group==== SYNTAX: volume_current_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz) EXAMPLE: ''volume_current_group("Magnet_1",0,0,1e6)'' DESCRIPTION: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'label' already exists, the group is activated. ====wave_port==== SYNTAX: wave_port({{ArgTypeString}} label, {{ArgTypeAny}} rect_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]) EXAMPLE: ''wave_port("WP_1","Rect_1",0,0)'' DESCRIPTION: Creates a scattering wave port source in [[EM.Picasso]] or [[EM.Libera]]. If the wave port 'label' already exists, its properties are modified. ====waveguide_design==== SYNTAX: waveguide_design({{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz) EXAMPLE: ''waveguide_design(1.0,2e9)'' DESCRIPTION: Computes and returns the minimum larger dimension (in 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. ====waveguide_src==== SYNTAX: waveguide_src({{ArgTypeString}} label, {{ArgTypeAny}} box_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} is_negative[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]) EXAMPLE: ''waveguide_src("WG_1","Box_1",50,0)'' DESCRIPTION: Creates a waveguide port source in [[EM.Tempo]]. If the waveguide port 'label' already exists, its properties are modified. ====wire_current_group==== SYNTAX: wire_current_group({{ArgTypeString}} label, {{ArgTypeAny}} current, {{ArgTypeAny}} wire_radius) EXAMPLE: ''wire_current_group("Magnet_1",1,0.5)'' DESCRIPTION: Creates a wire current source group in [[EM.Ferma]]. If the wire current group 'label' already exists, the group is activated. ====wire_gap_src==== SYNTAX: wire_gap_src({{ArgTypeString}} label, {{ArgTypeAny}} line_object, {{ArgTypeAny}} offset, {{ArgTypeAny}} polarity[, {{ArgTypeAny}} amplitude, {{ArgTypeAny}} phase, {{ArgTypeAny}} resistance]) EXAMPLE: ''wire_gap_src("WIG_1","Line_1",50,0)'' DESCRIPTION: Creates a wire gap circuit source in [[EM.Libera]]. If the wire gap source 'label' already exists, 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]]'''