Changes

Jump to: navigation, search

Glossary of EM.Cube's Python Functions

70 bytes removed, 17:43, 10 April 2017
DESCRIPTION: Consolidates a specified object.
 
====cubecad_mesh_settings====
 
SYNTAX: cubecad_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol)
 
EXAMPLE: ''cubecad_mesh_settings(5,10)''
 
DESCRIPTION: Sets the parameters of CubeCAD's mesh generator.
====cylinder====
DESCRIPTION: Draws an ellipsoid object in the project workspace under the currently activated material group node, or modifies the ellipsoid named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the ellipsoid's azimuth axis.
 
====emferma_engine_settings====
 
SYNTAX: emferma_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)
 
EXAMPLE: ''emferma_engine_settings("bicg-stab",1e-3,100)''
 
DESCRIPTION: Sets the parameters of [[EM.Ferma]]'s electrostatic and magnetostatic simulation engines.
 
====emferma_mesh_settings====
 
SYNTAX: emferma_mesh_settings({{ArgTypeAny}} cell_size_x, {{ArgTypeAny}} cell_size_y, {{ArgTypeAny}} 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.
 
====emillumina_engine_settings====
 
SYNTAX: emillumina_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} is_fixed_iteration, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)
 
EXAMPLE: ''emillumina_engine_settings("ipo",0,1e-2,20)''
 
DESCRIPTION: Sets the parameters of [[EM.Illumina]]'s Physical Optics simulation engine.
 
====emillumina_mesh_settings====
 
SYNTAX: emillumina_mesh_settings({{ArgTypeAny}} cells_per_lambda)
 
EXAMPLE: ''emillumina_mesh_settings(30)''
 
DESCRIPTION: Sets the parameters of [[EM.Illumina]]'s mesh generator.
 
====emlibera_engine_settings_smom====
 
SYNTAX: emlibera_engine_settings_smom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations, {{ArgTypeAny}} ncpus, {{ArgTypeString}} formulation, {{ArgTypeAny}} 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.
 
====emlibera_engine_settings_wmom====
 
SYNTAX: emlibera_engine_settings_wmom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)
 
EXAMPLE: ''emlibera_engine_settings_wmom("bicg",1e-3,1000)''
 
DESCRIPTION: Sets the parameters of [[EM.Libera]]'s wire MoM simulation engines.
 
====emlibera_mesh_settings====
 
SYNTAX: emlibera_mesh_settings({{ArgTypeAny}} cells_per_lambda)
 
EXAMPLE: ''emlibera_mesh_settings(30)''
 
DESCRIPTION: Sets the parameters of [[EM.Libera]]'s mesh generator.
 
====empicasso_engine_settings====
 
SYNTAX: empicasso_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations)
 
EXAMPLE: ''empicasso_engine_settings("bicg",1e-3,1000)''
 
DESCRIPTION: Sets the parameters of [[EM.Picasso]]'s planar MoM simulation engine.
 
====empicasso_mesh_settings====
 
SYNTAX: empicasso_mesh_settings({{ArgTypeAny}} cells_per_lambda)
 
EXAMPLE: ''empicasso_mesh_settings(30)''
 
DESCRIPTION: Sets the parameters of [[EM.Picasso]]'s planar hybrid mesh generator.
 
====emtempo_engine_settings====
 
SYNTAX: emtempo_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} power_threshhold, {{ArgTypeAny}} max_timesteps)
 
EXAMPLE: ''emtempo_engine_settings("single-precision",-50,20000)''
 
DESCRIPTION: Sets the parameters of [[EM.Tempo]]'s FDTD simulation engine.
 
====emtempo_mesh_settings====
 
SYNTAX: emtempo_mesh_settings({{ArgTypeAny}} cells_per_lambda, {{ArgTypeAny}} ratio_contour, {{ArgTypeAny}} ratio_thin, {{ArgTypeAny}} ratio_abs)
 
EXAMPLE: ''emtempo_mesh_settings(30,0.1,0.1,0.02)''
 
DESCRIPTION: Sets the parameters of [[EM.Tempo]]'s adaptive mesh generator.
 
====emterrano_engine_settings====
 
SYNTAX: emterrano_engine_settings({{ArgTypeAny}} bounce_count, {{ArgTypeAny}} do_edge_diffraction, {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshhold)
 
EXAMPLE: ''emterrano_engine_settings(5,1,1,-100)''
 
DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s SBR simulation engine.
 
====emterrano_mesh_settings====
 
SYNTAX: emterrano_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol)
 
EXAMPLE: ''emterrano_mesh_settings(5,10)''
 
DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s facet mesh generator.
====explode====
DESCRIPTION: Draws a triangle strip object in the project workspace under the currently activated material group node, or modifies the triangle strip object named 'label' if it already exists.
 
== EM.Cube's Python Functions for Geometric Object Transformation ==
====union====
DESCRIPTION: Generates and displays the mesh of the physical structure.
 
====emtempo_mesh_settings====
 
SYNTAX: emtempo_mesh_settings({{ArgTypeAny}} cells_per_lambda, {{ArgTypeAny}} ratio_contour, {{ArgTypeAny}} ratio_thin, {{ArgTypeAny}} 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====
 
SYNTAX: emillumina_mesh_settings({{ArgTypeAny}} cells_per_lambda)
 
EXAMPLE: ''emillumina_mesh_settings(30)''
 
DESCRIPTION: Sets the parameters of [[EM.Illumina]]'s mesh generator.
 
====empicasso_mesh_settings====
 
SYNTAX: empicasso_mesh_settings({{ArgTypeAny}} cells_per_lambda)
 
EXAMPLE: ''empicasso_mesh_settings(30)''
 
DESCRIPTION: Sets the parameters of [[EM.Picasso]]'s planar hybrid mesh generator.
 
====emlibera_mesh_settings====
 
SYNTAX: emlibera_mesh_settings({{ArgTypeAny}} cells_per_lambda)
 
EXAMPLE: ''emlibera_mesh_settings(30)''
 
DESCRIPTION: Sets the parameters of [[EM.Libera]]'s mesh generator.
 
====emferma_mesh_settings====
 
SYNTAX: emferma_mesh_settings({{ArgTypeAny}} cell_size_x, {{ArgTypeAny}} cell_size_y, {{ArgTypeAny}} 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====
 
SYNTAX: emterrano_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol)
 
EXAMPLE: ''emterrano_mesh_settings(5,10)''
 
DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s facet mesh generator.
 
====cubecad_mesh_settings====
 
SYNTAX: cubecad_mesh_settings({{ArgTypeAny}} edge_length, {{ArgTypeAny}} angle_tol)
 
EXAMPLE: ''cubecad_mesh_settings(5,10)''
 
DESCRIPTION: Sets the parameters of CubeCAD's mesh generator.
 
====emtempo_engine_settings====
 
SYNTAX: emtempo_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} power_threshhold, {{ArgTypeAny}} max_timesteps)
 
EXAMPLE: ''emtempo_engine_settings("single-precision",-50,20000)''
 
DESCRIPTION: Sets the parameters of [[EM.Tempo]]'s FDTD simulation engine.
 
====emterrano_engine_settings====
 
SYNTAX: emterrano_engine_settings({{ArgTypeAny}} bounce_count, {{ArgTypeAny}} do_edge_diffraction, {{ArgTypeAny}} angular_resolution, {{ArgTypeAny}} ray_threshhold)
 
EXAMPLE: ''emterrano_engine_settings(5,1,1,-100)''
 
DESCRIPTION: Sets the parameters of [[EM.Terrano]]'s SBR simulation engine.
 
====empicasso_engine_settings====
 
SYNTAX: empicasso_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} 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====
 
SYNTAX: emillumina_engine_settings({{ArgTypeString}} engine, {{ArgTypeAny}} is_fixed_iteration, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} 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====
 
SYNTAX: emferma_engine_settings({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} 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====
 
SYNTAX: emlibera_engine_settings_wmom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} 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====
 
SYNTAX: emlibera_engine_settings_smom({{ArgTypeString}} matrix_solver, {{ArgTypeAny}} error_tol, {{ArgTypeAny}} max_iterations, {{ArgTypeAny}} ncpus, {{ArgTypeString}} formulation, {{ArgTypeAny}} 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.
<br />
28,333
edits