Changes

Glossary of EM.Cube's Python Functions

2,705 bytes removed, 17:46, 10 April 2017
/* EM.Cube's Python Functions for Simulation-Related Functions & Operations */
== EM.Cube's Python Functions for Simulation-Related Functions & Operations ==
 
====select_module====
 
SYNTAX: select_module({{ArgTypeString}} module_name)
 
EXAMPLE: ''select_module("[[EM.Tempo]]")''
 
DESCRIPTION: Selects and sets [[EM.Cube]]'s active module.
 
====set_units====
 
SYNTAX: set_units({{ArgTypeString}} units)
 
EXAMPLE: ''set_units("meter")''
 
DESCRIPTION: Sets [[EM.Cube]]'s project length units.
 
====set_frequency====
 
SYNTAX: set_frequency({{ArgTypeAny}} value)
 
EXAMPLE: ''set_frequency(2.4e9)''
 
DESCRIPTION: Sets [[EM.Cube]]'s center frequency.
 
====set_bandwidth====
 
SYNTAX: set_bandwidth({{ArgTypeAny}} value)
 
EXAMPLE: ''set_bandwidth(1e9)''
 
DESCRIPTION: Sets [[EM.Cube]]'s frequency bandwidth.
====background_layer====
DESCRIPTION: Deletes a finite-thickness substrate layer from [[EM.Picasso]]'s background layer stackup.
 
====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.
====global_ground====
DESCRIPTION: Returns the size of the computational domain along the specified direction.
 
====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_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".
====add_variable====
DESCRIPTION: Returns the computed value of the specified standard output parameter at the end of a simulation.
 
====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.
====plot_file====
Kazem Sabet
28,333
edits