Changes

Glossary of EM.Cube's Python Functions

539 bytes added, 01:37, 18 September 2016
/* EM.Cube's Python Functions for Material or Object Group Creation */
== EM.Cube's Python Functions for Material or Object Group Creation ==
====activate({{ArgTypeString}} group_node_label)====
''ExampleSYNTAX: activate("Color_1"{{ArgTypeString}} group_node_label)''
DescriptionEXAMPLE: Activates a color, material or object group in the current active [[EM.Cube]] module. ''activate("Color_1")''
====color_group({{ArgTypeString}} label)====DESCRIPTION: Activates a color, material or object group in the current active [[EM.Cube]] module.
''Example: ====color_group("Color_1")''====
DescriptionSYNTAX: Creates a color group in CubeCAD module. If the color group 'color_group({{ArgTypeString}} label' already exists, the group is activated.)
====pec_groupEXAMPLE: ''color_group({{ArgTypeString}} label"Color_1")====''
''ExampleDESCRIPTION: pec_group("PEC_1")Creates a color group in CubeCAD module. If the color group 'label'already exists, the group is activated.
Description: Creates a PEC material group in the current module. If the PEC group 'label' already exists, the group is activated.====pec_group====
====pec_voltage_groupSYNTAX: pec_group({{ArgTypeString}} label, {{ArgTypeAny}} voltage)====
EXAMPLE: ''Example: pec_voltage_grouppec_group("PEC_1",10)''
DescriptionDESCRIPTION: Creates a fixed-potential PEC object material group in the current module. If the PEC group 'label' already exists, the group is activated.
====pec_via_group({{ArgTypeString}} label, {{ArgTypeAny}} host_layer)pec_voltage_group====
''ExampleSYNTAX: pec_via_grouppec_voltage_group("PEC_1"{{ArgTypeString}} label,10{{ArgTypeAny}} voltage)''
DescriptionEXAMPLE: Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already existspec_voltage_group("PEC_1", the group is activated.10)''
====thinwire_group({{ArgTypeString}} DESCRIPTION: Creates a fixed-potential PEC object group in the current module. If the PEC group 'label' already exists, {{ArgTypeAny}} radius)====the group is activated.
''Example: thinwire_group("Thinwire_1",4)''====pec_via_group====
DescriptionSYNTAX: Creates a Thinwire material group in the current module. If the thin wire group 'pec_via_group({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} host_layer)
====pmc_groupEXAMPLE: ''pec_via_group({{ArgTypeString}} label"PEC_1",10)====''
''ExampleDESCRIPTION: pmc_group("PMC_1")Creates an embedded PEC via set group in the current module. If the PEC via group 'label'already exists, the group is activated.
Description: Creates a PMC material group in the current module. If the PMC group 'label' already exists, the group is activated.====thinwire_group====
====slot_groupSYNTAX: thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)====
EXAMPLE: ''Example: slot_groupthinwire_group("PMC_1Thinwire_1",4)''
DescriptionDESCRIPTION: Creates a slot trace Thinwire material group in the current module. If the slot trace thin wire group 'label' already exists, the group is activated.
====dielectric_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)pmc_group====
''ExampleSYNTAX: dielectric_grouppmc_group("Dielectric_1","my_eps",0,1,0{{ArgTypeString}} label)''
DescriptionEXAMPLE: Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'label' already exists, the group is activated.pmc_group("PMC_1")''
====impenetrable_surface_group({{ArgTypeString}} DESCRIPTION: Creates a PMC material group in the current module. If the PMC group 'label' already exists, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)====the group is activated.
''Example: impenetrable_surface_group("Impenet_1",2.2,0.0001)''====slot_group====
DescriptionSYNTAX: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'slot_group({{ArgTypeString}} label' already exists, the group is activated.)
====penetrable_surface_groupEXAMPLE: ''slot_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness"PMC_1")====''
DESCRIPTION: Creates a slot trace group in the current module. If the slot trace group 'label'Example: penetrable_surface_group("Penet_1"already exists,2the group is activated.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.====dielectric_group====
====penetrable_volume_groupSYNTAX: dielectric_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)====
EXAMPLE: ''Example: penetrable_volume_groupdielectric_group("Vol_Penet_1Dielectric_1",2.2"my_eps",0,1,0.0001)''
DescriptionDESCRIPTION: Creates a penetrable volume dielectric material group in [[EM.Terrano]]the current module with the specified material properties. If the penetrable volume dielectric group 'label' already exists, the group is activated.
====terrain_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)impenetrable_surface_group====
''ExampleSYNTAX: terrain_groupimpenetrable_surface_group("Terrain_1"{{ArgTypeString}} label,5.0{{ArgTypeAny}} eps,0.0001{{ArgTypeAny}} sigma)''
DescriptionEXAMPLE: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label' already existsimpenetrable_surface_group("Impenet_1", the group is activated2.2,0.0001)''
====base_point_group({{ArgTypeString}} DESCRIPTION: Creates an impenetrable surface group in [[EM.Terrano]]. If the impenetrable surface group 'label)====' already exists, the group is activated.
''Example: base_point_set("BP_Set_1")''====penetrable_surface_group====
DescriptionSYNTAX: Creates a base point set in [[EM.Terrano]]. If the base point set group 'penetrable_surface_group({{ArgTypeString}} label' already exists, the group is activated.{{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)
====virtual_groupEXAMPLE: ''penetrable_surface_group({{ArgTypeString}} label"Penet_1",2.2,0.0001, 1)====''
''ExampleDESCRIPTION: virtual_group("VIR_1")Creates a penetrable surface group in [[EM.Terrano]]. If the penetrable surface group 'label'already exists, the group is activated.
Description: Creates a virtual object group in [[EM.Terrano]]. If the virtual group 'label' already exists, the group is activated.====penetrable_volume_group====
====impedance_surface_groupSYNTAX: penetrable_volume_group({{ArgTypeString}} label, {{ArgTypeAny}} z_realeps, {{ArgTypeAny}} z_imagsigma)====
EXAMPLE: ''Example: impedance_surface_grouppenetrable_volume_group("IMP_1Vol_Penet_1",1002.2,-1000.0001)''
DescriptionDESCRIPTION: Creates a impedance_surface penetrable volume group in [[EM.IlluminaTerrano]]. If the impedance surface penetrable volume group 'label' already exists, the group is activated.
====conductive_sheet_group({{ArgTypeString}} label, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)terrain_group====
''ExampleSYNTAX: conductive_sheet_groupterrain_group("Cond_1"{{ArgTypeString}} label,100{{ArgTypeAny}} eps, 0.01{{ArgTypeAny}} sigma)''
DescriptionEXAMPLE: Creates a conductive sheet group in [[EM.Picasso]]. If the conductive sheet group 'label' already existsterrain_group("Terrain_1", the group is activated5.0,0.0001)''
====charge_group({{ArgTypeString}} DESCRIPTION: Creates an terrain surface group in [[EM.Terrano]]. If the terrain surface group 'label' already exists, {{ArgTypeAny}} density)====the group is activated.
''Example: charge_group("Charge_1",-1e-5)''====base_point_group====
DescriptionSYNTAX: Creates a volume charge source group in [[EM.Ferma]]. If the charge group 'base_point_group({{ArgTypeString}} label' already exists, the group is activated.)
====magnet_groupEXAMPLE: ''base_point_set({{ArgTypeString}} label, {{ArgTypeAny}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mz"BP_Set_1")====''
DESCRIPTION: Creates a base point set in [[EM.Terrano]]. If the base point set group 'label'Example: magnet_group("Magnet_1"already exists,1,0,0,100)''the group is activated.
Description: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already exists, the group is activated.====virtual_group====
====volume_current_groupSYNTAX: virtual_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz)====
EXAMPLE: ''Example: volume_current_groupvirtual_group("Magnet_1VIR_1",0,0,1e6)''
DescriptionDESCRIPTION: Creates a volume current source virtual object group in [[EM.FermaTerrano]]. If the volume current virtual group 'label' already exists, the group is activated.
====wire_current_group({{ArgTypeString}} label, {{ArgTypeAny}} current, {{ArgTypeAny}} wire_radius)impedance_surface_group====
''ExampleSYNTAX: wire_current_groupimpedance_surface_group("Magnet_1"{{ArgTypeString}} label,1{{ArgTypeAny}} z_real,0.5{{ArgTypeAny}} z_imag)''
DescriptionEXAMPLE: ''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==== SYNTAX: 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==== SYNTAX: 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. ====magnet_group==== SYNTAX: magnet_group({{ArgTypeString}} label, {{ArgTypeAny}} mu, {{ArgTypeAny}} Mx, {{ArgTypeAny}} My, {{ArgTypeAny}} Mz) EXAMPLE: ''magnet_group("Magnet_1",1,0,0,100)'' DESCRIPTION: Creates a permanent magnet source group in [[EM.Ferma]]. If the magnet group 'label' already exists, the group is activated. ====volume_current_group==== SYNTAX: volume_current_group({{ArgTypeString}} label, {{ArgTypeAny}} Jx, {{ArgTypeAny}} Jy, {{ArgTypeAny}} Jz) EXAMPLE: ''volume_current_group("Magnet_1",0,0,1e6)'' DESCRIPTION: Creates a volume current source group in [[EM.Ferma]]. If the volume current group 'label' already exists, the group is activated. ====wire_current_group==== SYNTAX: wire_current_group({{ArgTypeString}} label, {{ArgTypeAny}} current, {{ArgTypeAny}} wire_radius) EXAMPLE: ''wire_current_group("Magnet_1",1,0.5)'' DESCRIPTION: Creates a wire current source group in [[EM.Ferma]]. If the wire current group 'label' already exists, the group is activated.
== EM.Cube's Python Functions for Source & Lumped Device Definition ==
28,333
edits