Changes

Glossary of EM.Cube's Python Functions

2,625 bytes added, 17:53, 10 April 2017
DESCRIPTION: Activates a color, material or object group in the current active [[EM.Cube]] module.
 
====add_variable====
 
SYNTAX: add_variable({{ArgTypeString}} var_name, {{ArgTypeAny}} value)
 
EXAMPLE: ''add_variable("MyVar",1)''
 
DESCRIPTION: Adds a new variable to [[EM.Cube]]'s variable list.
====array====
DESCRIPTION: Creates or modifies an array object and sets its local coordinate system and rotation angles.
 
====background_layer====
 
SYNTAX: background_layer({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thickness)
 
EXAMPLE: ''background_layer("Mid_Layer",3.3,0.001,1,1.5)''
 
DESCRIPTION: Adds a new substrate layer to [[EM.Picasso]]'s background layer stackup.
====box====
DESCRIPTION: Draws a cylinder object in the project workspace under the currently activated material group node, or modifies the cylinder named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the cylinder's azimuth axis.
 
====delete====
 
SYNTAX: delete({{ArgTypeString}} node_name)
 
EXAMPLE: ''delete("Box_1")''
 
DESCRIPTION: Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.
 
====delete_background_layer====
 
SYNTAX: delete_background_layer({{ArgTypeString}} label)
 
EXAMPLE: ''delete_background_layer("Mid_Layer")''
 
DESCRIPTION: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup.
====ellipse_strip====
DESCRIPTION: Returns the specified coordinate of the unit vector along the specified local axis of an object.
 
====get_domain_extent====
 
SYNTAX: get_domain_extent({{ArgTypeString}} coordinate)
 
EXAMPLE: ''get_domain_extent("x")''
 
DESCRIPTION: Returns the size of the computational domain along the specified direction.
====get_extent====
DESCRIPTION: Returns the specified rotation angle of an object.
 
====get_standard_output====
 
SYNTAX: get_standard_output({{ArgTypeString}} output_name)
 
EXAMPLE: ''get_standard_output("S11M")''
 
DESCRIPTION: Returns the computed value of the specified standard output parameter at the end of a simulation.
====get_vertex====
DESCRIPTION: Returns the volume of a solid object.
 
====global_ground====
 
SYNTAX: global_ground({{ArgTypeAny}} ground_on, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)
 
EXAMPLE: ''global_ground(1,3.3,0.001)''
 
DESCRIPTION: Set the state of [[EM.Terrano]]'s global ground and its material properties. A zero value for ground_on means to no global ground assumed at Z = 0.
====group====
DESCRIPTION: Merges two specified curve objects into a single curve.
 
====mesh====
 
SYNTAX: mesh()
 
DESCRIPTION: Generates and displays the mesh of the physical structure.
====mirror====
DESCRIPTION: Creates a pipe version of a given curve object.
 
====plot_file====
 
SYNTAX: plot_file({{ArgTypeString}} filename)
 
EXAMPLE: ''plot_file("D0.DAT")''
 
DESCRIPTION: Plots the contents of a specified data file in EM.Grid.
====point====
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.
====revolve====
DESCRIPTION: Roughens the surface of the specified object based on the specified RMS height and correlation length.
 
====run_analysis====
 
SYNTAX: run_analysis()
 
DESCRIPTION: Runs a simulation in the current active [[EM.Cube]] computational module.
 
====save_data====
 
SYNTAX: save_data({{ArgTypeString}} directory_name)
 
EXAMPLE: ''save_data("Simulation_Data")''
 
DESCRIPTION: Saves [[EM.Cube]]'s output simulation data files under the specified directory.
====scale====
DESCRIPTION: Scales an object by the specified scale factor.
 
====select_module====
 
SYNTAX: select_module({{ArgTypeString}} module_name)
 
EXAMPLE: ''select_module("[[EM.Tempo]]")''
 
DESCRIPTION: Selects and sets [[EM.Cube]]'s active module.
 
====set_bandwidth====
 
SYNTAX: set_bandwidth({{ArgTypeAny}} value)
 
EXAMPLE: ''set_bandwidth(1e9)''
 
DESCRIPTION: Sets [[EM.Cube]]'s frequency bandwidth.
 
====set_boundary_conditions====
 
SYNTAX: set_boundary_conditions({{ArgTypeString}} xn_type, {{ArgTypeString}} xp_type, {{ArgTypeString}} yn_type, {{ArgTypeString}} yp_type, {{ArgTypeString}} zn_type, {{ArgTypeString}} zp_type)
 
EXAMPLE: ''set_domain_offset_lambda("pml","pml","pml","pml","pec","pml")''
 
DESCRIPTION: Sets [[EM.Tempo]]'s domain boundary conditions domain offset on the ±X, ±Y and ±Z boundary walls. The options are "pec", "pmc" and "pml".
 
====set_domain_offset====
 
SYNTAX: set_domain_offset({{ArgTypeAny}} dxn_offset, {{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset)
 
EXAMPLE: ''set_domain_offset(20,20,20,20,0,10)''
 
DESCRIPTION: Sets the domain offset values along the ±X, ±Y and ±Z directions in project units.
 
====set_domain_offset_lambda====
 
SYNTAX: set_domain_offset_lambda({{ArgTypeAny}} dxn_offset, {{ArgTypeAny}} dxp_offset, {{ArgTypeAny}} dyn_offset, {{ArgTypeAny}} dyp_offset, {{ArgTypeAny}} dzn_offset, {{ArgTypeAny}} dzp_offset)
 
EXAMPLE: ''set_domain_offset_lambda(0.1,0.1,0.1,0.1,0,0.25)''
 
DESCRIPTION: Sets the domain offset values along the ±X, ±Y and ±Z directions in free-space wavelengths.
 
====set_frequency====
 
SYNTAX: set_frequency({{ArgTypeAny}} value)
 
EXAMPLE: ''set_frequency(2.4e9)''
 
DESCRIPTION: Sets [[EM.Cube]]'s center frequency.
====set_lcs_link====
DESCRIPTION: Links the LCS of the first object to the LCS of the second object by the specified offset values along the three axes.
 
====set_periodic====
 
SYNTAX: set_periodic({{ArgTypeAny}} is_periodic, {{ArgTypeAny}} spacingX, {{ArgTypeAny}} spacingY)
 
EXAMPLE: ''set_periodic(1,50,50)''
 
DESCRIPTION: Designates the physical structure as periodic and sets the periods along the X and Y directions.
====set_rot====
DESCRIPTION: Links the rotation angles of the LCS of the first object to the rotation angles of the LCS of the second object by the specified angle offset values in degrees along the three axes.
 
====set_stackup_order====
 
SYNTAX: set_stackup_order("THS", {{ArgTypeString}} label_1, {{ArgTypeString}} label_2, ..., {{ArgTypeString}} label_n, "BHS")
 
EXAMPLE: ''background_layer("THS","Top_Layer","Mid_Layer","Bottom_Layer","BHS")''
 
DESCRIPTION: Sets the hierarchy of [[EM.Picasso]]'s background layer stackup from top to bottom. The sequence should always start with "THS" standing for the top half-space and must end in "BHS" standing for the bottom half-space. All the intermediate finite-thickness substrate layers must be included and listed in the right order.
 
====set_units====
 
SYNTAX: set_units({{ArgTypeString}} units)
 
EXAMPLE: ''set_units("meter")''
 
DESCRIPTION: Sets [[EM.Cube]]'s project length units.
====slice====
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.
 
====zoom_extents====
 
SYNTAX: zoom_extents()
 
DESCRIPTION: Zooms to fit the extents of the physical structure into the screen.
== EM.Cube's Python Functions for Material or Object Group Creation ==
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 ==
 
====background_layer====
 
SYNTAX: background_layer({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} thickness)
 
EXAMPLE: ''background_layer("Mid_Layer",3.3,0.001,1,1.5)''
 
DESCRIPTION: Adds a new substrate layer to [[EM.Picasso]]'s background layer stackup.
 
====delete_background_layer====
 
SYNTAX: delete_background_layer({{ArgTypeString}} label)
 
EXAMPLE: ''delete_background_layer("Mid_Layer")''
 
DESCRIPTION: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup.
 
====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.
 
====delete====
 
SYNTAX: delete({{ArgTypeString}} node_name)
 
EXAMPLE: ''delete("Box_1")''
 
DESCRIPTION: Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.
 
====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.
 
====zoom_extents====
 
SYNTAX: zoom_extents()
 
DESCRIPTION: Zooms to fit the extents of the physical structure into the screen.
 
====get_domain_extent====
 
SYNTAX: get_domain_extent({{ArgTypeString}} coordinate)
 
EXAMPLE: ''get_domain_extent("x")''
 
DESCRIPTION: Returns the size of the computational domain along the specified direction.
 
====add_variable====
 
SYNTAX: add_variable({{ArgTypeString}} var_name, {{ArgTypeAny}} value)
 
EXAMPLE: ''add_variable("MyVar",1)''
 
DESCRIPTION: Adds a new variable to [[EM.Cube]]'s variable list.
 
====run_analysis====
 
SYNTAX: run_analysis()
 
DESCRIPTION: Runs a simulation in the current active [[EM.Cube]] computational module.
 
====set_periodic====
 
SYNTAX: set_periodic({{ArgTypeAny}} is_periodic, {{ArgTypeAny}} spacingX, {{ArgTypeAny}} spacingY)
 
EXAMPLE: ''set_periodic(1,50,50)''
 
DESCRIPTION: Designates the physical structure as periodic and sets the periods along the X and Y directions.
 
====get_standard_output====
 
SYNTAX: get_standard_output({{ArgTypeString}} output_name)
 
EXAMPLE: ''get_standard_output("S11M")''
 
DESCRIPTION: Returns the computed value of the specified standard output parameter at the end of a simulation.
 
====plot_file====
 
SYNTAX: plot_file({{ArgTypeString}} filename)
 
EXAMPLE: ''plot_file("D0.DAT")''
 
DESCRIPTION: Plots the contents of a specified data file in EM.Grid.
 
====mesh====
 
SYNTAX: mesh()
 
DESCRIPTION: Generates and displays the mesh of the physical structure.
<br />
Kazem Sabet
28,333
edits