Changes

Glossary of EM.Cube's Python Functions

3,348 bytes added, 22:22, 11 June 2018
<table>
<tr>
<td>[[image:Cube-icon.png | link=Getting_Started_with_EM.Cube]] [[image:cad-ico.png | link=Building_Geometrical_Constructions_in_CubeCAD]] [[image:fdtd-ico.png | link=EM.Tempo]] [[image:prop-ico.png | link=EM.Terrano]] [[image:static-ico.png | link=EM.Ferma]] [[image:planar-ico.png | link=EM.Picasso]] [[image:metal-ico.png | link=EM.Libera]] [[image:po-ico.png | link=EM.Illumina]]</td>
<tr>
</table>
[[Image:Back_icon.png|30px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''
<br />
 
== Standard Python Operators ==
|}
== Standard Basic Mathematical Python Functions ==
{| class="wikitable"
| see [https://en.wikipedia.org/wiki/Mathieu_function Mathieu Functions on Wikipedia.]
|}
 
== EM.Cube's Miscellaneous Python Functions ==
 
{| class="wikitable"
!scope="col"| Syntax
!scope="col"| Type
!scope="col"| Description
!scope="col"| Notes
|-
| 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 Native Python Functions ==
DESCRIPTION: Creates a base point set in [[EM.Terrano]]. If the base point set group 'label' already exists, the group is activated.
 
====bh_step====
 
SYNTAX: bh_step({{ArgTypeReal}} x, {{ArgTypeReal}} T)
 
EXAMPLE: ''bh_step(0.5,1)''
 
DESCRIPTION: Computes and returns the Blackman-Harris step function.
 
====bh_window====
 
SYNTAX: bh_window({{ArgTypeReal}} x, {{ArgTypeReal}} T)
 
EXAMPLE: ''bh_window(0.5,1)''
 
DESCRIPTION: Computes and returns the Blackman-Harris window function.
====box====
DESCRIPTION: Sets the freeze state of an object (0/1).
 
====gauss====
 
SYNTAX: gauss({{ArgTypeReal}} x, ArgTypeReal}} mu, ArgTypeReal}} sigma)
 
EXAMPLE: ''gauss(0.5,0,1)''
 
DESCRIPTION: Computes and returns the Gaussian function of mean mu and standard deviation sigma: exp(-0.5*((x-mu)/sigma)**2)/sigma/sqrt(2*pi).
====gauss_beam====
DESCRIPTION: Creates a Gaussian beam source in [[EM.Tempo]]. If the Gaussian beam source 'label' already exists, its properties are modified.
 
====generate_input_files====
 
SYNTAX: generate_input_files()
 
EXAMPLE: ''generate_input_files()''
 
DESCRIPTION: Generates all the input files for the simulation engine of the current module without running a simulation.
 
====geo====
 
SYNTAX: geo({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''geo(1,2)''
 
DESCRIPTION: Computes and returns the geometric mean of x and y: sqrt(x*y).
====get_area====
DESCRIPTION: Groups a number of objects into a composite object with the given label.
 
====harm====
 
SYNTAX: harm({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''harm(1,2)''
 
DESCRIPTION: Computes and returns the harmonic mean of x and y: 2/(1/x+1/y).
====helix====
DESCRIPTION: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already exists, the group is activated.
 
====mcos====
 
SYNTAX: mcos({{ArgTypeReal}} x, {{ArgTypeReal}} r)
 
EXAMPLE: ''mcos(0.5,2)''
 
DESCRIPTION: Computes and returns the super-quadratic cosine function of order r.
 
====mean====
 
SYNTAX: mean({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''mean(1,2)''
 
DESCRIPTION: Computes and returns the arithmetic mean of x and y: 0.5*(x+y).
====merge_curve====
DESCRIPTION: Computes and returns the width-to-height ratio of a microstrip transmission line with characteristic impedance z0 in Ohms and substrate relative permittivity er.
 
====microstrip_z0====
 
SYNTAX: microstrip_z0({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
 
EXAMPLE: ''microstrip_z0(2,0.5,2.2)''
 
DESCRIPTION: Computes and returns the characteristic impedance (in Ohms) of a microstrip transmission line with width w, substrate height h and substrate relative permittivity er.
====microstrip_eps_eff====
EXAMPLE: ''microstrip_lambda_g(2,0.5,2.2,2e9)''
DESCRIPTION: Computes and returns the guide wavelength (in meters) of a microstrip transmission line with width w, substrate height h, and substrate relative permittivity er and at an operating frequency of freq_hertz.
====microstrip_src====
DESCRIPTION: Creates a microstrip port source in [[EM.Tempo]]. If the microstrip port 'label' already exists, its properties are modified.
 
====microstrip_z0====
 
SYNTAX: microstrip_z0({{ArgTypeReal}} w, {{ArgTypeReal}} h, {{ArgTypeReal}} er)
 
EXAMPLE: ''microstrip_z0(2,0.5,2.2)''
 
DESCRIPTION: Computes and returns the characteristic impedance (in Ohms) of a microstrip transmission line with width w, substrate height h and substrate relative permittivity er.
 
====microstrip_zoc====
 
SYNTAX: microstrip_zoc({{ArgTypeReal}} w, {{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
 
EXAMPLE: ''microstrip_zoc(2,25,0.5,2.2,2e9)''
 
DESCRIPTION: Computes and returns the input reactance (in Ohms) of an open-circuited microstrip transmission line with width w, length l, substrate height h and substrate relative permittivity er at an operating frequency of freq_hertz.
 
====microstrip_zsc====
 
SYNTAX: microstrip_zsc({{ArgTypeReal}} w, {{ArgTypeReal}} l, {{ArgTypeReal}} h, {{ArgTypeReal}} er, {{ArgTypeReal}} freq_hertz)
 
EXAMPLE: ''microstrip_zsc(2,25,0.5,2.2,2e9)''
 
DESCRIPTION: Computes and returns the input reactance (in 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.
====mirror====
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.
 
====msin====
 
SYNTAX: msin({{ArgTypeReal}} x, {{ArgTypeReal}} r)
 
EXAMPLE: ''msin(0.5,2)''
 
DESCRIPTION: Computes and returns the super-quadratic sine function of order r.
====nurbs_curve====
DESCRIPTION: Computes and returns the ramp function: x if x>0, 0 if x<0.
 
====rand====
 
SYNTAX: rand({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''rand(0,1)''
 
DESCRIPTION: Computes and returns a random number between x and y using an uniform distribution.
====random_group====
DESCRIPTION: Creates or modifies a revolution object from a specified object. If modifying an existing revolution object, the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. The revolution angle "rot_angle" is given in degrees.
 
====rosen====
 
SYNTAX: rosen({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} a, {{ArgTypeReal}} b)
 
EXAMPLE: ''rosen(0.5,0,1,2)''
 
DESCRIPTION: Computes and returns the Rosenbrock function: (a-x)**2 + b*(y-x**2)**2.
====rotate====
DESCRIPTION: Saves [[EM.Cube]]'s output simulation data files under the specified directory.
 
====sawtooth====
 
SYNTAX: sawtooth({{ArgTypeReal}} x)
 
EXAMPLE: ''sawtooth(0.5)''
 
DESCRIPTION: Computes and returns the ascending periodic sawtooth function of period T = 2, oscillating between two values +1 and -1 and having a zero value of at x = 0.
====scale====
DESCRIPTION: Creates a Hertzian short dipole source. If the short dipole source 'label' already exists, its properties are modified.
 
====sigmoid====
 
SYNTAX: sigmoidnc({{ArgTypeReal}} x, {{ArgTypeReal}} a)
 
EXAMPLE: ''sigmoid(0.5,1)''
 
DESCRIPTION: Computes and returns the sigmoid function of slope a: 2/(1 + exp(-a*x)) - 1.
 
====sinc====
 
SYNTAX: sinc({{ArgTypeReal}} x)
 
EXAMPLE: ''sinc(0.5)''
 
DESCRIPTION: Computes and returns the sinc function: sin(pi*x)/(pi*x).
====slice====
DESCRIPTION: Computes and returns the periodic square wave function of period T = 2, oscillating between two values +1 and -1 and having a value of +1 at x = 0.
 
====sqr2====
 
SYNTAX: sqr2({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''sqr2(0,1)''
 
DESCRIPTION: Computes and returns the sum of squares of x and y: x**2 + y**2.
 
====sqr3====
 
SYNTAX: sqr2({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} z)
 
EXAMPLE: ''sqr2(0,1,2)''
 
DESCRIPTION: Computes and returns the sum of squares of x, y and z: x**2 + y**2 + z**2.
 
====sqrt2====
 
SYNTAX: sqrt2({{ArgTypeReal}} x, {{ArgTypeReal}} y)
 
EXAMPLE: ''sqrt2(0,1)''
 
DESCRIPTION: Computes and returns the radius of the 2D point (x,y): sqrt(x**2 + y**2).
 
====sqrt3====
 
SYNTAX: sqrt3({{ArgTypeReal}} x, {{ArgTypeReal}} y, {{ArgTypeReal}} z)
 
EXAMPLE: ''sqrt3(0,1,2)''
 
DESCRIPTION: Computes and returns the radius of the 3D point (x,y,z): sqrt(x**2 + y**2 + z**2).
====step====
<hr>
[[Image:Top_icon.png|48px30px]] '''[[#Standard Python Functions Standard_Python_Operators | Back to the Top of the Page]]'''
[[Image:Back_icon.png|40px30px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''
Kazem Sabet
28,333
edits