Description: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label' already exists, its properties are modified.
====huygens_surface({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)====
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 ==
====select_module({{ArgTypeString}} module_name)====
''Example: select_module("[[EM.Tempo]]")''
Description: Selects and sets [[EM.Cube]]'s active module.
====set_units({{ArgTypeString}} units)====
''Example: set_units("meter")''
Description: Sets [[EM.Cube]]'s project length units.
====set_frequency({{ArgTypeString}} value)====
''Example: set_frequency(2.4e9)''
Description: Sets [[EM.Cube]]'s center frequency.
====set_bandwidth({{ArgTypeString}} value)====
''Example: set_bandwidth(1e9)''
Description: Sets [[EM.Cube]]'s frequency bandwidth.
====run_analysis()====
Description: Runs a simulation.
====set_periodic({{ArgTypeString}} is_periodic, {{ArgTypeString}} spacingX, {{ArgTypeString}} spacingY) ====
''Example: set_periodic(1,50,50)''
Description: Designates the physical structure as periodic and sets the periods along the X and Y directions.
====mesh()====
Description: Generates and displays the mesh of the physical structure.
====emtempo_mesh_settings({{ArgTypeString}} cells_per_lambda, {{ArgTypeString}} ratio_contour, {{ArgTypeString}} ratio_thin, {{ArgTypeString}} ratio_abs)====
''Example: emtempo_mesh_settings(30,0.1,0.1,0.02)''
Description: Sets the parameters of [[EM.Tempo]]'s adaptive mesh generator.
====emillumina_mesh_settings({{ArgTypeString}} cells_per_lambda)====
''Example: emillumina_mesh_settings(30)''
Description: Sets the parameters of [[EM.Illumina]]'s mesh generator.
====empicasso_mesh_settings({{ArgTypeString}} cells_per_lambda, {{ArgTypeString}} ratio_contour, {{ArgTypeString}} ratio_thin, {{ArgTypeString}} ratio_abs)====
''Example: empicasso_mesh_settings(30)''
Description: Sets the parameters of [[EM.Picasso]]'s planar hybrid mesh generator.
====emlibera_mesh_settings({{ArgTypeString}} cells_per_lambda)====
''Example: emlibera_mesh_settings(30)''
Description: Sets the parameters of [[EM.Libera]]'s mesh generator.
====emferma_mesh_settings({{ArgTypeString}} cell_size_x, {{ArgTypeString}} cell_size_y, {{ArgTypeString}} cell_size_z)====
''Example: emferma_mesh_settings(0.5,0.5,0.5)''
Description: Sets the parameters of [[EM.Ferma]]'s fixed-cell mesh generator.
====emterrano_mesh_settings({{ArgTypeString}} edge_length, {{ArgTypeString}} angle_tol)====
''Example: emterrano_mesh_settings(5,10)''
Description: Sets the parameters of [[EM.Terrano]]'s facet mesh generator.
====cubecad_mesh_settings({{ArgTypeString}} edge_length, {{ArgTypeString}} angle_tol)====
''Example: cubecad_mesh_settings(5,10)''
Description: Sets the parameters of CubeCAD's mesh generator.
====emtempo_engine_settings({{ArgTypeString}} engine, {{ArgTypeString}} power_threshhold, {{ArgTypeString}} max_timesteps)====
''Example: emtempo_engine_settings("single-precision",-50,20000)''
Description: Sets the parameters of [[EM.Tempo]]'s FDTD simulation engine.
====emterrano_engine_settings({{ArgTypeString}} bounce_count, {{ArgTypeString}} do_edge_diffraction, {{ArgTypeString}} angular_resolution, {{ArgTypeString}} ray_threshhold)====
''Example: emterrano_engine_settings(5,1,1,-100)''
Description: Sets the parameters of [[EM.Terrano]]'s SBR simulation engine.
====empicasso_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeString}} error_tol, {{ArgTypeString}} max_iterations)====
''Example: empicasso_engine_settings("bicg",1e-3,1000)''
Description: Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine.
====emillumina_engine_settings({{ArgTypeString}} engine, {{ArgTypeString}} is_fixed_iteration, {{ArgTypeString}} error_tol, {{ArgTypeString}} max_iterations)====
''Example: emillumina_engine_settings("ipo",0,1e-2,20)''
Description: Sets the parameters of [[EM.Illumina]]'s Physical Optics simulation engine.
====emferma_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeString}} error_tol, {{ArgTypeString}} max_iterations)====
''Example: emferma_engine_settings("bicg-stab",1e-3,100)''
Description: Sets the parameters of [[EM.Ferma]]'s electrostatic and magnetostatic simulation engines.
====emlibera_engine_settings_wmom({{ArgTypeString}} matrix_solver, {{ArgTypeString}} error_tol, {{ArgTypeString}} max_iterations)====
''Example: emlibera_engine_settings_wmom("bicg",1e-3,1000)''
Description: Sets the parameters of [[EM.Libera]]'s wire MoM simulation engines.
====emlibera_engine_settings_smom({{ArgTypeString}} matrix_solver, {{ArgTypeString}} error_tol, {{ArgTypeString}} max_iterations, {{ArgTypeString}} ncpus, {{ArgTypeString}} formulation, {{ArgTypeString}} alpha)====
''Example: emlibera_engine_settings_smom("bicg",1e-3,1000,4,"efie",0.4)''
Description: Sets the parameters of [[EM.Libera]]'s surface MoM simulation engines.
{"global_ground",emag_set_ground,METH_VARARGS,"global_ground(ground_on,eps,sigma) -- Set or unset global ground in [[EM.Terrano]]."},
{"get_domain_extent",emag_dom_getextents,METH_VARARGS,"get_domain_extent(coordinate) -- Get the specified extent of the domain box."},
{"set_domain_offset",emag_dom_offset,METH_VARARGS,"set_domain_offset(dxn_offset,dxp_offset,dyn_offset,dyp_offset,dzn_offset,dzp_offset) -- Set the offset values of the domain box in project units in all six directions."},
{"set_domain_offset_lambda",emag_dom_offset_lambda,METH_VARARGS,"set_domain_offset_lambda(dxn_offset,dxp_offset,dyn_offset,dyp_offset,dzn_offset,dzp_offset) -- Set the offset values of the domain box in wavelengths in all six directions."},
{"set_boundary_conditions",emag_set_bc,METH_VARARGS,"set_boundary_conditions(xn_type,xp_type,yn_type,yp_type,zn_type,zp_type) -- Set the boundary conditions on all the six walls of the domain box."},
{"set_periodic",emag_set_periodic,METH_VARARGS,"set_periodic(is_periodic,spacingX,spacingY) -- Set periodic boundary condition for [[EM.Tempo]] or [[EM.Picasso]]."},
<p> </p>
[[Image:Back_icon.png|40px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''