Glossary of EM.Cube's Python Functions
Contents
- 1 Standard Python Functions
- 2 Advanced Mathematical Python Functions
- 3 EM.Cube's Miscellaneous Python Functions
- 4 EM.Cube's Design Python Functions
- 5 EM.Cube's Python Functions for Geometric Object Creation
- 5.1 box(string label, any x0, any y0, any z0, any length, any width, any height)
- 5.2 cylinder(string label, any x0, any y0, any z0, any radius, any height)
- 5.3 pyramid(string label, any x0, any y0, any z0, any base_x, any base_y, any height)
- 5.4 sphere(string label, any x0, any y0, any z0, any radius, any start_angle, any end_angle)
- 5.5 rect_strip(string label, any x0, any y0, any z0, any length, any width)
- 5.6 circ_strip(string label, any x0, any y0, any z0, any inner_radius, any outer_radius)
- 5.7 poly_strip(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
- 5.8 nurbs_strip(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
- 5.9 line(string label, any x0, any y0, any z0, any length)
- 5.10 circle(string label, any x0, any y0, any z0, any radius, any start_angle, any end_angle)
- 5.11 helix(string label, any x0, any y0, any z0, any nturns, any radius_inner, any radius_outer)
- 5.12 poly_line(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
- 5.13 nurbs_curve(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
- 6 EM.Cube's Python Functions for Geometric Object Transformation
- 6.1 subtract(string label, string object_1, string object_2)
- 6.2 union(string label, string object_1, string object_2)
- 6.3 intersect(string label, string object_1, string object_2)
- 6.4 array(string label, string object, any x_count, any y_count, any z_count, any x_spacing, any y_spacing, any z_spacing)
- 6.5 translate_by(string label, real x_dist, real y_dist, real z_dist)
- 6.6 translate_to(string label, real x_dest, real y_dest, real z_dest)
- 6.7 rotate(string label, any x0, any y0, any z0, any radius, any start_angle, any end_angle)
- 6.8 extrude(string label, string object, any height)
- 6.9 explode(string object)
- 6.10 revolve(string label, string object, any x0, any y0, any z0, any uX, any uY, any uZ, any rot_angle)
- 7 EM.Cube's Python Functions for Material or Object Group Creation
- 7.1 color_group(string label)
- 7.2 pec_group(string label)
- 7.3 pec_voltage_group(string label, any voltage)
- 7.4 pec_via_group(string label, any host_layer)
- 7.5 thinwire_group(string label, any radius)
- 7.6 pmc_group(string label)
- 7.7 slot_group(string label)
- 7.8 dielectric_group(string label, any eps, any sigma, any mu, any rho)
- 7.9 impenetrable_surface_group(string label, any eps, any sigma)
- 7.10 penetrable_surface_group(string label, any eps, any sigma, any thickness)
- 7.11 penetrable_volume_group(string label, any eps, any sigma)
- 7.12 terrain_group(string label, any eps, any sigma)
- 7.13 base_point_group(string label)
- 7.14 virtual_group(string label)
- 7.15 impedance_surface_group(string label, any z_real, any z_imag)
- 7.16 conductive_sheet_group(string label, any sigma, any thickness)
- 7.17 charge_group(string label, any density)
- 7.18 magnet_group(string label, any mu, any Mx, any My, any Mz)
- 7.19 volume_current_group(string label, any Jx, any Jy, any Jz)
- 7.20 wire_current_group(string label, any current, any wire_radius)
- 8 EM.Cube's Python Functions for Source & Lumped Device Definition
- 8.1 lumped_src(string label, any line_object, any offset, any polarity[, any amplitude, any phase, any resistance])
- 8.2 distributed_src(string label, any rect_object, any field_dir, any profile[, any amplitude, any phase, any resistance])
- 8.3 microstrip_src(string label, any rect_object, any height, any edge[, any amplitude, any phase, any resistance])
- 8.4 cpw_src(string label, any rect_object, any spacing, any edge[, any amplitude, any phase, any resistance])
- 8.5 coaxial_src(string label, any cylinder_object, any outer_radius, any edge[, any amplitude, any phase, any resistance])
- 8.6 waveguide_src(string label, any box_object, any offset, any is_negative[, any amplitude, any phase, any resistance])
- 8.7 wire_gap_src(string label, any line_object, any offset, any polarity[, any amplitude, any phase, any resistance])
- 8.8 rect_gap_src(string label, any rect_object, any offset, any polarity[, any amplitude, any phase, any resistance])
- 8.9 probe_gap_src(string label, any via_object, any polarity[, any amplitude, any phase, any resistance])
- 8.10 wave_port(string label, any rect_object, any offset, any is_negative[, any amplitude, any phase, any resistance])
- 8.11 short_dipole(string label, any x0, any y0, any z0, any length, any uX, any uY, any uZ, any amplitude, any phase)
- 8.12 planewave(string label, any theta, any phi, any polarization)
- 8.13 gauss_beam(string label, any theta, any phi, any polarization, any focus_x, any focus_y, any focus_z, any radius, any p_mode, any q_mode)
- 8.14 huygens_src(string label, any filename[, any set_lcs, any polarization, any x0, any y0, any z0, any x_rot, any y_rot, any z_rot])
- 8.15 transmitter_set(string label, any base_point_set[, any pattern_file, any rot_x, any rot_y, any rot_z)
- 8.16 resistor(string label, any line_object, any offset, any resistance)
- 8.17 capacitor(string label, any line_object, any offset, any capacitance_pF)
- 8.18 inductor(string label, any line_object, any offset, any inductance_nH)
- 8.19 diode(string label, any line_object, any polarity, any is_fA, any temperature_K, any ideality_factor)
- 9 EM.Cube's Python Functions for Observable Definition
- 9.1 port_definition_default(string label)
- 9.2 port_definition_custom(string label, (string port_1_src_1, string port_1_src_2, ..., string port_1_impedance), (string port_2_src_1, string port_2_src_2, ..., string port_2_impedance), ...)
- 9.3 farfield(string label, any theta_incr, any phi_incr)
- 9.4 rcs_bistatic(string label, any theta_incr, any phi_incr)
- 9.5 current_dist(string label)
- 9.6 field_sensor(string label, any dir_coordinate, any x0, any y0, any z0, any xSize, any ySize, any zSize, any xSamples, any ySamples, any zSamples)
- 9.7 field_sensor_grid(string label, any dir_coordinate, any x0, any y0, any z0)
- 9.8 field_probe(string label, any x0, any y0, any z0)
- 9.9 receiver_set(string label, any base_point_set[, any pattern_file, any rot_x, any rot_y, any rot_z)
- 9.10 huygens_surface(string label, any x1, any y1, any z1, any x2, any y2, any z2, any xSamples, any ySamples, any zSamples)
- 9.11 huygens_surface_grid(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.12 voltage_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.13 current_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.14 conduction_current_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.15 capacitance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any z4)
- 9.16 inductance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any z4)
- 9.17 resistance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any z4)
- 9.18 flux_electric(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.19 flux_magnetic(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.20 energy_electric(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.21 energy_magnetic(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.22 ohmic_loss(string label, any x1, any y1, any z1, any x2, any y2, any z2)
- 9.23 solution_plane(string label, any field_sensor_label, any is_quasi)
Standard Python Functions
| Syntax | Type | Description | Notes |
|---|---|---|---|
| abs(x) | Std. Python function | Absolute value function | 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 | Power function | x**y |
| sqrt(x) | Std. Python function | Square root function | pow(x,0.5) |
| exp(x) | Std. Python function | Exponential function | pow(e,x) |
| log(x) | Std. Python function | Natural logarithm function | - |
| log10(x) | Std. Python function | Base 10 logarithm function | ln(x)/ln(10) |
| factorial(x) | Std. Python function | Factorial | For integer values of x: n! = n(n-1)(n-2)...3.2.1 |
| max(x,y) | Std. Python function | Maximum of x and y | - |
| min(x,y) | Std. Python function | Minimum of x and y | - |
| sin(x) | Std. Python function | Sine function | - |
| cos(x) | Std. Python function | Cosine function | - |
| tan(x) | Std. Python function | Tangent function | - |
| asin(x) | Std. Python function | Inverse sine function | - |
| acos(x) | Std. Python function | Inverse cosine function | - |
| atan(x) | Std. Python function | Inverse tangent function | - |
| atan2(x,y) | Std. Python function | Inverse tangent function | - |
| sinh(x) | Std. Python function | Hyperbolic sine function | - |
| cosh(x) | Std. Python function | Hyperbolic cosine function | - |
| tanh(x) | Std. Python function | Hyperbolic tangent function | - |
| asinh(x) | Std. Python function | Inverse hyperbolic sine function | - |
| acosh(x) | Std. Python function | Inverse hyperbolic cosine function | - |
| atanh(x) | Std. Python function | Inverse hyperbolic tangent function | - |
Advanced Mathematical Python Functions
| Syntax | Type | Description | Notes |
|---|---|---|---|
| sp.sici(x) | Std. Python function | Sine and cosine integral functions | See Trigonometric Integrals on Wikipedia. |
| sp.fresnel(x) | Std. Python function | Sine and cosine Fresnel integral functions | See Fresnel Integrals on Wikipedia. |
| sp.ellipe(x) | Std. Python function | Elliptic function of the first kind | See Elliptic Integrals on Wikipedia. |
| sp.ellipk(x) | Std. Python function | Elliptic function of the second kind | See Elliptic Integrals on Wikipedia. |
| sp.expi(x) | Std. Python function | Exponential integral function | See Exponential Integrals on Wikipedia. |
| sp.expn(n,x) | Std. Python function | Generalized exponential integral function of order n | See Exponential Integrals on Wikipedia. |
| sp.erf(x) | Std. Python function | Error function | See Error Function on Wikipedia. |
| sp.erfc(x) | Std. Python function | Complementary error function | See Error Function on Wikipedia. |
| sp.gamma(x) | Std. Python function | Gamma function | See Gamma Function on Wikipedia. |
| sp.airy(x) | Std. Python function | Airy function of the first (Ai) and second (Bi) kind and their derivatives | See Airy Functions on Wikipedia. |
| sp.j0(x) | Std. Python function | Bessel function of the first kind and order 0 | See Bessel Functions on Wikipedia. |
| sp.j1(x) | Std. Python function | Bessel function of the first kind and order 1 | See Bessel Functions on Wikipedia. |
| sp.jv(n,x) | Std. Python function | Bessel function of the first kind and order n | See Bessel Functions on Wikipedia. |
| sp.y0(x) | Std. Python function | Bessel function of the second kind and order 0 | See Bessel Functions on Wikipedia. |
| sp.y1(x) | Std. Python function | Bessel function of the second kind and order 1 | See Bessel Functions on Wikipedia. |
| sp.yv(n,x) | Std. Python function | Bessel function of the second kind and order n | See Bessel Functions on Wikipedia. |
| sp.i0(x) | Std. Python function | Modified Bessel function of the first kind and order 0 | See Bessel Functions on Wikipedia. |
| sp.i1(x) | Std. Python function | Modified Bessel function of the first kind and order 1 | See Bessel Functions on Wikipedia. |
| sp.iv(n,x) | Std. Python function | Modified Bessel function of the first kind and order n | See Bessel Functions on Wikipedia. |
| sp.k0(x) | Std. Python function | Modified Bessel function of the second kind and order 0 | See Bessel Functions on Wikipedia. |
| sp.k1(x) | Std. Python function | Modified Bessel function of the second kind and order 1 | See Bessel Functions on Wikipedia. |
| sp.kv(n,x) | Std. Python function | Modified Bessel function of the second kind and order n | See Bessel Functions on Wikipedia. |
| sp.sph_jn(n,x) | Std. Python function | Spherical Bessel function of the first kind and order n | See Bessel Functions on Wikipedia. |
| sp.sph_yn(n,x) | Std. Python function | Spherical Bessel function of the second kind and order n | See Bessel Functions on Wikipedia. |
| sp.sph_in(n,x) | Std. Python function | Modified spherical Bessel function of the first kind and order n | See Bessel Functions on Wikipedia. |
| sp.sph_kn(n,x) | Std. Python function | Modified spherical Bessel function of the second kind and order n | See Bessel Functions on Wikipedia. |
| sp.lpn(n,x) | Std. Python function | Legendre function of the first kind and order n | See Legendre Polynomials on Wikipedia. |
| sp.lqn(n,x) | Std. Python function | Legendre function of the second kind and order n | See Legendre Polynomials on Wikipedia. |
| sp.lpmn(m,n,x) | Std. Python function | Associated Legendre function of the first kind and order n | See Legendre Polynomials on Wikipedia. |
| sp.lqmn(m,n,x) | Std. Python function | Associated Legendre function of the second kind and order n | See Legendre Polynomials on Wikipedia. |
| sp.eval_chebyt(n,x) | Std. Python function | Chebyshev polynomial of the first kind and order n | See Chebyshev Polynomials on Wikipedia. |
| sp.eval_chebyu(n,x) | Std. Python function | Chebyshev polynomial of the second kind and order n | See Chebyshev Polynomials on Wikipedia. |
| sp.eval_legendre(n,x) | Std. Python function | Legendre polynomial of order n | See Legendre Polynomials on Wikipedia. |
| sp.eval_laguerre(n,x) | Std. Python function | Laguerre polynomial of order n | See Laguerre Polynomials on Wikipedia. |
| sp.eval_hermite(n,x) | Std. Python function | Hermite polynomial of order n | See Hermite Polynomials on Wikipedia. |
| Math_ce(n,r,x) | Std. Python function | Even periodic (cosine) Mathieu function of order n | See Mathieu Functions on Wikipedia. |
| Math_se(n,r,x) | Std. Python function | Odd periodic (sine) Mathieu function of order n | See Mathieu Functions on Wikipedia. |
EM.Cube's Miscellaneous Python Functions
| Syntax | Type | Description | Notes |
|---|---|---|---|
| rect(x) | EMAG Python function | Rectangle function | 1 if |x|≤0.5, 0 elsewhere |
| tri(x) | EMAG Python function | Triangle function | 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 | - |
| 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) | Std. Python function | Gaussian function | - |
| rand(x,y) | EMAG Python function | Random function | - |
EM.Cube's Design Python Functions
| Syntax | Type | Description | Notes |
|---|---|---|---|
| Z0_MS(e,x) | EMAG Python function | Characteristic impedance of a microstrip transmission line | x: width-to-height ratio, e: substrate permittivity |
| w_MS(z,e,t) | EMAG Python function | Width of a microstrip transmission line | z: characteristic impedance, e: substrate permittivity, t: substrate thickness |
| eeff_MS(e,x) | EMAG Python function | Effective permittivity of a microstrip transmission line | x: width-to-height ratio, e: substrate permittivity |
| woh_MS(e,z) | EMAG Python function | Width-to-height ratio of a microstrip transmission line | z: characteristic impedance z, e: substrate permittivity |
| Z0_CPW(e,x,y) | EMAG Python function | Characteristic impedance of a coplanar waveguide transmission line | x: slot width-to-height ratio, y: center strip width-to-height ratio, e: substrate permittivity |
| eeff_CPW(e,x,y) | EMAG Python function | Effective permittivity of a coplanar waveguide transmission line | x: slot width-to-height ratio, y: center strip width-to-height ratio, e: substrate permittivity |
| horn_a(d,x,y) | EMAG Python function | Wavelength-normalized a-dimension of an optimal pyramidal horn antenna | d: directivity d, x and y: wavelength-normalized waveguide dimensions |
| horn_b(d,x,y) | EMAG Python function | Wavelength-normalized b-dimension of an optimal pyramidal horn antenna | d: directivity d, x and y: wavelength-normalized waveguide dimensions |
| horn_l(d,x,y) | EMAG Python function | Wavelength-normalized length of an optimal pyramidal horn antenna | d: directivity d, x and y: wavelength-normalized waveguide dimensions |
EM.Cube's Python Functions for Geometric Object Creation
box(string label, any x0, any y0, any z0, any length, any width, any height)
Example:box("my_box",0,0,0,"x",y,100)
Description: Draws a Box object in the scene under the currently activated Material Group node, or modifies a Box if Box 'label' already exists.
cylinder(string label, any x0, any y0, any z0, any radius, any height)
Example:cylinder("cylinder_1",0,0,0,10,100)
Description: Draws a Cylinder object in the scene under the currently activated Material Group node, or modifies a Cylinder if Cylinder 'label' already exists.
pyramid(string label, any x0, any y0, any z0, any base_x, any base_y, any height)
Example:pyramid("pyramid_1",0,0,0,10,10,100)
Description: Draws a Pyramid object in the scene under the currently activated Material Group node, or modifies a Pyramid if Pyramid 'label' already exists.
sphere(string label, any x0, any y0, any z0, any radius, any start_angle, any end_angle)
Example:sphere("sphere",0,0,0,10,0,180)
Description: Draws a Sphere object in the scene under the currently activated Material Group node, or modifies a Sphere if Sphere 'label' already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the sphere's theta axis.
rect_strip(string label, any x0, any y0, any z0, any length, any width)
Example:rect_strip("my_rectangle",0,0,0,"x",y)
Description: Draws a Rect Strip object in the scene under the currently activated Material Group node, or modifies a Rect Strip if Rect Strip 'label' already exists.
circ_strip(string label, any x0, any y0, any z0, any inner_radius, any outer_radius)
Example:circ_strip("cs_1",0,0,0,0,100)
Description: Draws a Circular Strip object in the scene under the currently activated Material Group node, or modifies a Circular Strip if Circular Strip 'label' already exists.
poly_strip(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
Example:poly_strip("ps_1",(0,0,0),(1,0,0),(1,0,0))
Description: Creates or modifies a PolyStrip object in the scene. Each point is represented with a Python tuple type. The poly_strip function is 'self-closing' -- there is no need to supply the first point again at the end of the point list.
nurbs_strip(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
Example:nurbs_strip("ns_1",(0,0,0),(1,0,0),(1,0,0))
Description: Creates or modifies a NURBS Strip object in the scene. 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.
line(string label, any x0, any y0, any z0, any length)
Example:line("my_line",0,0,0,100)
Description: Draws a Line object in the scene under the currently activated Material Group node, or modifies a Line if Line 'label' already exists.
circle(string label, any x0, any y0, any z0, any radius, any start_angle, any end_angle)
Example:circle("pyramid_1",0,0,0,10,10,100)
Description: Draws a circular curve object in the scene under the currently activated Material Group node, or modifies a Circle object if Circle 'label' already exists. The parameters start_angle and end_angle are in degrees.
helix(string label, any x0, any y0, any z0, any nturns, any radius_inner, any radius_outer)
Example:helix("Helix_1",0,0,0,5,15,50)
Description: Draws a helical curve in the scene under the currently activated Material Group node, or modifies a Helix if Helix 'label' already exists. 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.
poly_line(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
Example:poly_line("pl_1",(0,0,0),(1,0,0),(1,0,0))
Description: Creates or modifies a PolyLine object in the scene. Each point is represented with a Python tuple type. The poly_line is closed if p0 is specified again as pn, otherwise, it is open.
nurbs_curve(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)
Example:nurbs_curve("nc_1",(0,0,0),(1,0,0),(1,0,0))
Description: Creates or modifies a NURBS Curve object in the scene. Each point is represented with a Python tuple type. The curve is closed if p0 is specified again as pn, otherwise, it is open.
EM.Cube's Python Functions for Geometric Object Transformation
subtract(string label, string object_1, string object_2)
Example:subtract("Subtract_Object","Rect_Strip1","Rect_Strip2")
Description: Creates a Boolean object named 'label' by subtracting object_2 from object_1. An error will be thrown if a Boolean object named 'label' already exists.
union(string label, string object_1, string 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.
intersect(string label, string object_1, string object_2)
Example:intersect("Intersection_Object","Rect_Strip1","Rect_Strip2")
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.
array(string label, string object, any x_count, any y_count, any z_count, any x_spacing, any y_spacing, any z_spacing)
Example:array("Array_1","Rect_Strip_1",4,4,1,"spacing","spacing",0)
Description: Create or modify an Array object.
translate_by(string label, real x_dist, real y_dist, real z_dist)
Example:translate_by("MyObj",10,10,x)
Description: Translates an object by the specified distances in each direction.
translate_to(string label, real x_dest, real y_dest, real z_dest)
Example:translate_to("MyObj",20,20,x2)
Description: Translates an object to the specified destination.
rotate(string label, any x0, any y0, any z0, any radius, any start_angle, any end_angle)
Example:rotate("pyramid_1",0,0,0,10,10,100)
Description: Draws a circular curve object in the scene under the currently activated Material Group node, or modifies a Circle object if Circle 'label' already exists. The parameters start_angle and end_angle are in degrees.
extrude(string label, string object, any height)
Example:extrude("Extrude_Object","Rect_Strip1",50)
Description: Creates or modifies an Extrusion object from CAD object 'object'. If modifying an existing extrusion, 'object' is ignored, and the pre-existing primitive is used. extrude(...) can only extrude objects that have a single face, and will extrude in the direction of the face's normal.
explode(string object)
Example:explode("MyArray")
Description: Performs an explode operation on a CAD object named 'object'.
revolve(string label, string object, any x0, any y0, any z0, any uX, any uY, any uZ, any rot_angle)
Example:revolve("Rev1","Line_1",0,0,0,0,0,1)
Description: Creates or modifies a Revolution object called 'label', with a primitive object named 'object'. If modifying an existing Revolution object, 'object' is ignored, and the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. rot_angle is in degrees.
EM.Cube's Python Functions for Material or Object Group Creation
color_group(string label)
Example: color_group("Color_1")
Description: Creates a color group in CubeCAD module. If the color group 'label' already exists, the group is activated.
pec_group(string label)
Example: pec_group("PEC_1")
Description: Creates a PEC material group in the current module. If the PEC group 'label' already exists, the group is activated.
pec_voltage_group(string label, any voltage)
Example: pec_voltage_group("PEC_1",10)
Description: Creates a fixed-potential PEC object group in the current module. If the PEC group 'label' already exists, the group is activated.
pec_via_group(string label, any host_layer)
Example: pec_via_group("PEC_1",10)
Description: Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already exists, the group is activated.
thinwire_group(string label, any radius)
Example: thinwire_group("Thinwire_1",4)
Description: Creates a Thinwire material group in the current module. If the thin wire group 'label' already exists, the group is activated.
pmc_group(string label)
Example: pmc_group("PMC_1")
Description: Creates a PMC material group in the current module. If the PMC group 'label' already exists, the group is activated.
slot_group(string label)
Example: slot_group("PMC_1")
Description: Creates a slot trace group in the current module. If the slot trace group 'label' already exists, the group is activated.
dielectric_group(string label, any eps, any sigma, any mu, any rho)
Example: dielectric_group("Dielectric_1","my_eps",0,1,0)
Description: Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'label' already exists, the group is activated.
impenetrable_surface_group(string label, any eps, any 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.
penetrable_surface_group(string label, any eps, any sigma, any thickness)
Example: penetrable_surface_group("Penet_1",2.2,0.0001, 1)
Description: Creates a penetrable surface group in EM.Terrano. If the penetrable surface group 'label' already exists, the group is activated.
penetrable_volume_group(string label, any eps, any sigma)
Example: penetrable_volume_group("Vol_Penet_1",2.2,0.0001)
Description: Creates a penetrable volume group in EM.Terrano. If the penetrable volume group 'label' already exists, the group is activated.
terrain_group(string label, any eps, any sigma)
Example: terrain_group("Terrain_1",5.0,0.0001)
Description: Creates an terrain surface group in EM.Terrano. If the terrain surface group 'label' already exists, the group is activated.
base_point_group(string label)
Example: base_point_set("BP_Set_1")
Description: Creates a base point set in EM.Terrano. If the base point set group 'label' already exists, the group is activated.
virtual_group(string 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.
impedance_surface_group(string label, any z_real, any z_imag)
Example: impedance_surface_group("IMP_1",100,-100)
Description: Creates a impedance_surface group in EM.Illumina. If the impedance surface group 'label' already exists, the group is activated.
conductive_sheet_group(string label, any sigma, any thickness)
Example: conductive_sheet_group("Cond_1",100, 0.01)
Description: Creates a conductive sheet group in EM.Picasso. If the conductive sheet group 'label' already exists, the group is activated.
charge_group(string label, any 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.
magnet_group(string label, any mu, any Mx, any My, any Mz)
Example: magnet_group("Magnet_1",1,0,0,100)
Description: Creates a permanent magnet source group in EM.Ferma. If the magnet group 'label' already exists, the group is activated.
volume_current_group(string label, any Jx, any Jy, any 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.
wire_current_group(string label, any current, any 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.
EM.Cube's Python Functions for Source & Lumped Device Definition
lumped_src(string label, any line_object, any offset, any polarity[, any amplitude, any phase, any resistance])
Example: lumped_src("LS_1","Line_1",50,0)
Description: Creates a lumped source in EM.Tempo. If the lumped source 'label' already exists, its properties are modified.
distributed_src(string label, any rect_object, any field_dir, any profile[, any amplitude, any phase, any resistance])
Example: distributed_src("DS_1","Rect_1","+y","uniform")
Description: Creates a distributed source in EM.Tempo. If the distributed source 'label' already exists, its properties are modified.
microstrip_src(string label, any rect_object, any height, any edge[, any amplitude, any phase, any resistance])
Example: microstrip_src("MS_1","Rect_1",1.5,"+x")
Description: Creates a microstrip port source in EM.Tempo. If the microstrip port 'label' already exists, its properties are modified.
cpw_src(string label, any rect_object, any spacing, any edge[, any amplitude, any phase, any resistance])
Example: cpw_src("CPW_1","Rect_1",1.5,"+x")
Description: Creates a CPW port source in EM.Tempo. If the CPW port 'label' already exists, its properties are modified.
coaxial_src(string label, any cylinder_object, any outer_radius, any edge[, any amplitude, any phase, any resistance])
Example: coaxial_src("COAX_1","Cyl_1",1.5,"+z")
Description: Creates a coaxial port source in EM.Tempo. If the coaxial port 'label' already exists, its properties are modified.
waveguide_src(string label, any box_object, any offset, any is_negative[, any amplitude, any phase, any 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_gap_src(string label, any line_object, any offset, any polarity[, any amplitude, any phase, any 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.
rect_gap_src(string label, any rect_object, any offset, any polarity[, any amplitude, any phase, any resistance])
Example: rect_gap_src("GAP_1","Rect_1",0,0)
Description: Creates a strip gap circuit source in EM.Picasso or EM.Libera. If the strip gap source 'label' already exists, its properties are modified.
probe_gap_src(string label, any via_object, any polarity[, any amplitude, any phase, any resistance])
Example: probe_gap_src("Probe_1","Via_1",0)
Description: Creates a probe gap circuit source in EM.Picasso. If the probe gap source 'label' already exists, its properties are modified.
wave_port(string label, any rect_object, any offset, any is_negative[, any amplitude, any phase, any 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.
short_dipole(string label, any x0, any y0, any z0, any length, any uX, any uY, any uZ, any amplitude, any phase)
Example: wave_port("SD_1",0,0,50,3,0,0,1,1,0)
Description: Creates a Hertzian short dipole source. If the short dipole source 'label' already exists, its properties are modified.
planewave(string label, any theta, any phi, any polarization)
Example: planewave("PW_1",180,0,"tm")
Description: Creates a plane wave source. If the plane wave source 'label' already exists, its properties are modified.
gauss_beam(string label, any theta, any phi, any polarization, any focus_x, any focus_y, any focus_z, any radius, any p_mode, any 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.
huygens_src(string label, any filename[, any set_lcs, any polarization, any x0, any y0, any z0, any x_rot, any y_rot, any z_rot])
Example: huygens_src("HS_1","Huygens_1.HUY",1,100,100,0,0,0,0)
Description: Creates a Huygens source. If the Huygens source 'label' already exists, its properties are modified.
transmitter_set(string label, any base_point_set[, any pattern_file, any rot_x, any rot_y, any rot_z)
Example: transmitter_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)
Description: Creates a transmitter set in EM.Terrano. If the transmitter set 'label' already exists, its properties are modified.
resistor(string label, any line_object, any offset, any resistance)
Example: resistor("Res_1","Line_1",25,50)
Description: Creates a resistor in EM.Tempo. If the resistor 'label' already exists, its properties are modified.
capacitor(string label, any line_object, any offset, any 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.
inductor(string label, any line_object, any offset, any 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.
diode(string label, any line_object, any polarity, any is_fA, any temperature_K, any ideality_factor)
Example: diode("Diode_1","Line_1",25,0,10,300,1)
Description: Creates a diode in EM.Tempo. If the diode 'label' already exists, its properties are modified.
EM.Cube's Python Functions for Observable Definition
port_definition_default(string label)
Example: port_definition_default("PD_1")
Description: Creates a default port definition observable. If the observable 'label' already exists, its properties are modified.
port_definition_custom(string label, (string port_1_src_1, string port_1_src_2, ..., string port_1_impedance), (string port_2_src_1, string port_2_src_2, ..., string port_2_impedance), ...)
Example: port_definition_custom("PD_1",("LS_1","LS_2",50),,("LS_3","LS_4",50))
Description: Creates a custom port definition observable. If the observable 'label' already exists, its properties are modified.
farfield(string label, any theta_incr, any phi_incr)
Example: farfield("FF_1",1,1)
Description: Creates a far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.
rcs_bistatic(string label, any theta_incr, any phi_incr)
Example: rcs_bistatic("RCS_1",1,1)
Description: Creates a bistatic RCS observable. If the observable 'label' already exists, its properties are modified.
current_dist(string label)
Example: current_dist("CD_1")
Description: Creates a current distribution observable. If the observable 'label' already exists, its properties are modified.
field_sensor(string label, any dir_coordinate, any x0, any y0, any z0, any xSize, any ySize, any zSize, any xSamples, any ySamples, any zSamples)
Example: field_sensor("FS_1","z",0,0,0,100,100,0,25,25,0)
Description: Creates a near-field sensor observable. If the observable 'label' already exists, its properties are modified.
field_sensor_grid(string label, any dir_coordinate, any x0, any y0, any z0)
Example: field_sensor_grid("FS_1","z",0,0,0)
Description: Creates a near-field sensor observable in EM.Tempo or EM.Ferma. If the observable 'label' already exists, its properties are modified.
field_probe(string label, any x0, any y0, any z0)
Example: field_probe("FS_1",0,0,50)
Description: Creates a temporal field probe observable in EM.Tempo or EM.Ferma. If the observable 'label' already exists, its properties are modified.
receiver_set(string label, any base_point_set[, any pattern_file, any rot_x, any rot_y, any rot_z)
Example: receiver_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)
Description: Creates a receiver set in EM.Terrano. If the receiver set 'label' already exists, its properties are modified.
huygens_surface(string label, any x1, any y1, any z1, any x2, any y2, any z2, any xSamples, any ySamples, any 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(string label, any x1, any y1, any z1, any x2, any y2, any 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.
voltage_integral(string label, any x1, any y1, any z1, any x2, any y2, any 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.
current_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)
Example: current_integral("FI_1",-10,-10,0,10,10,0)
Description: Creates a current integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
conduction_current_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)
Example: conduction_current_integral("FI_1",-10,-10,0,10,10,0)
Description: Creates a conduction current integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
capacitance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any 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.
inductance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any 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.
resistance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any z4)
Example: resistance("FI_1",0,0,-10,0,0,10,-10,-10,0,10,10,0)
Description: Creates a resistance integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
flux_electric(string label, any x1, any y1, any z1, any x2, any y2, any z2)
Example: flux_electric("FI_1",-10,-10,5,10,10,10)
Description: Creates an electric flux integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
flux_magnetic(string label, any x1, any y1, any z1, any x2, any y2, any z2)
Example: flux_magnetic("FI_1",0,0,-10,10,0,10)
Description: Creates a magnetic flux integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
energy_electric(string label, any x1, any y1, any z1, any x2, any y2, any z2)
Example: energy_electric("FI_1",-10,-10,-10,10,10,10)
Description: Creates an electric energy integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
energy_magnetic(string label, any x1, any y1, any z1, any x2, any y2, any z2)
Example: energy_magnetic("FI_1",-10,-10,-10,10,10,10)
Description: Creates a magnetic energy integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
ohmic_loss(string label, any x1, any y1, any z1, any x2, any y2, any z2)
Example: ohmic_loss("FI_1",-10,-10,-10,10,10,10)
Description: Creates an ohmic loss integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
solution_plane(string label, any field_sensor_label, any is_quasi)
Example: solution_plane("FI_1","FS_1",1)
Description: Creates a 2D solution plane observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.
