Changes

Glossary of EM.Cube's Python Functions

3,382 bytes added, 21:42, 1 September 2016
/* EM.Cube Python Functions for Material Group Creation */
== EM.Cube Python Functions for Material Group Creation ==
 
====color_group({{ArgTypeString}} label)====
 
''Example: color_group("Color_1")''
 
Description: Creates a Color group in CubeCAD module. If a Color group 'label' already exists, the group is activated.
====pec_group({{ArgTypeString}} label)====
''Example:pec_group("PEC_1")''
Description: Creates a PEC material group in the current module. If a PEC group 'label' already exists, the group is activated. ====pec_voltage_group({{ArgTypeString}} label, {{ArgTypeAny}} voltage)==== ''Example: pec_voltage_group("PEC_1",10)'' Description: Creates a fixed-potential PEC object group in the current module. If a PEC group 'label' already exists, the group is activated. ====pec_via_group({{ArgTypeString}} label, {{ArgTypeAny}} host_layer)==== ''Example: pec_via_group("PEC_1",10)'' Description: Creates an embedded PEC via set group in the current module. If a PEC via group 'label' already exists, the group is activated. ====thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)==== ''Example: thinwire_group("Thinwire_1",4)'' Description: Creates a Thinwire material group in the current module. If a Thinwire group 'label' already exists, the group is activated.
====pmc_group({{ArgTypeString}} label)====
''Example:pmc_group("PMC_1")''
Description: Creates a PMC material group in the current module. If a PMC group 'label' already exists, the group is activated. ====slot_group({{ArgTypeString}} label)==== ''Example: slot_group("PMC_1")'' Description: Creates a slot trace group in the current module. If a slot trace group 'label' already exists, the group is activated.
====dielectric_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)====
''Example:dielectric_group("Dielectric_1","my_eps",0,1,0)''
Description: Creates a Dielectric material group in the current module with the specified material properties. If a Dielectric group 'label' already exists, the group is activated.
====thinwire_groupimpenetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} radiuseps, {{ArgTypeAny}} sigma)====
''Example:thinwire_groupimpenetrable_surface_group("Thinwire_1Impenet_1",42.2,0.0001)''
Description: Creates a Thinwire material an impenetrable surface group in [[EM.Terrano]]. If the current moduleimpenetrable surface group 'label' already exists, the group is activated. ====penetrable_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)==== ''Example: penetrable_surface_group("Penet_1",2.2,0.0001, 1)'' Description: Creates a penetrable surface group in [[EM.Terrano]]. If the penetrable surface group 'label' already exists, the group is activated. ====penetrable_volume_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)==== ''Example: penetrable_volume_group("Vol_Penet_1",2.2,0.0001)'' Description: Creates a Thinwire penetrable volume group in [[EM.Terrano]]. If the penetrable volume group 'label' already exists, the group is activated. ====terrain_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)==== ''Example: terrain_group("Terrain_1",5.0,0.0001)'' Description: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label' already exists, the group is activated.
====base_point_group({{ArgTypeString}} label)====
''Example:base_point_set("BP_Set_1")''
Description: Creates a Base Point Set base point set in [[EM.Terrano]]. If a Base Point Set the base point set group 'label' already exists, the group is activated.
====color_groupvirtual_group({{ArgTypeString}} label)==== ''Example: virtual_group("VIR_1")'' Description: Creates a virtual object group in [[EM.Terrano]]. If the virtual group 'label' already exists, the group is activated. ====impedance_surface_group({{ArgTypeString}} label, {{ArgTypeAny}} z_real, {{ArgTypeAny}} z_imag)==== ''Example: impedance_surface_group("IMP_1",100,-100)'' Description: Creates a impedance_surface group in [[EM.Illumina]]. If the impedance surface group 'label' already exists, the group is activated. ====conductive_sheet_group({{ArgTypeString}} label, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)==== ''Example: conductive_sheet_group("Cond_1",100, 0.01)'' Description: Creates a conductive sheet group in [[EM.Picasso]]. If the conductive sheet group 'label' already exists, the group is activated. ====charge_group({{ArgTypeString}} label, {{ArgTypeAny}} density)==== ''Example: charge_group("Charge_1",-1e-5)'' Description: Creates a volume charge source group in [[EM.Ferma]]. If the charge group 'label' already exists, the group is activated.
''Example:color_group====magnet_group("Color_1"{{ArgTypeString}} label, {{ArgTypeAny}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mz)''====
Description: Creates a Color group in CubeCAD module. If a Color group 'label' already existsExample: magnet_group("Magnet_1", the group is activated.1,0,0,100)''
====penetrable_group({{ArgTypeString}} Description: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)====the group is activated.
''Example:penetrable_group====volume_current_group("Impenet_1"{{ArgTypeString}} label,2.2{{ArgTypeAny}} Jx,.0001{{ArgTypeAny}} Jy, 1{{ArgTypeAny}} Jz)''====
Description: Creates a Penetrable material group in [[EM.Terrano]]. If a Penetrable group 'label' already existsExample: volume_current_group("Magnet_1", the group is activated.0,0,1e6)''
====impenetrable_group({{ArgTypeString}} Description: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)====the group is activated.
''Example:impenetrable_group====wire_current_group("Impenet_1"{{ArgTypeString}} label,2.2{{ArgTypeAny}} current,.0001{{ArgTypeAny}} wire_radius)''====
Description: Creates a Impenetrable material group in [[EM.Terrano]]. If an Impenetrable group 'label' already existsExample: wire_current_group("Magnet_1", the group is activated1,0.5)''
Description: Creates a wire current source group in [[EM.Ferma]]. If the wire current group 'label' already exists, the group is activated.
<p>&nbsp;</p>
[[Image:Back_icon.png|40px]] '''[[EM.Cube | Back to EM.Cube Main Page]]'''
28,333
edits