Changes

Glossary of EM.Cube's Python Functions

564 bytes added, 01:52, 18 September 2016
/* EM.Cube's Python Functions for Observable Definition */
== EM.Cube's Python Functions for Observable Definition ==
====port_definition_default({{ArgTypeString}} label)====
''ExampleSYNTAX: port_definition_default("PD_1"{{ArgTypeString}} label)''
DescriptionEXAMPLE: Creates a default port definition observable. If the observable 'label' already exists, its properties are modified.port_definition_default("PD_1")''
====port_definition_custom({{ArgTypeString}} DESCRIPTION: Creates a default port definition observable. If the observable 'label' already exists, ({{ArgTypeString}} port_1_src_1, {{ArgTypeString}} port_1_src_2, ..., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance), ..its properties are modified.)====
''Example: ====port_definition_custom("PD_1",("LS_1","LS_2",50),,("LS_3","LS_4",50))''====
DescriptionSYNTAX: Creates a custom port definition observable. If the observable 'port_definition_custom({{ArgTypeString}} label' already exists, its properties are modified({{ArgTypeString}} port_1_src_1, {{ArgTypeString}} port_1_src_2, ..., {{ArgTypeString}} port_1_impedance), ({{ArgTypeString}} port_2_src_1, {{ArgTypeString}} port_2_src_2, ..., {{ArgTypeString}} port_2_impedance), ...)
====farfieldEXAMPLE: ''port_definition_custom({{ArgTypeString}} label"PD_1", {{ArgTypeAny}} theta_incr("LS_1", {{ArgTypeAny}} phi_incr"LS_2",50),,("LS_3","LS_4",50))====''
DESCRIPTION: Creates a custom port definition observable. If the observable 'label'Example: farfield("FF_1"already exists,1,1)''its properties are modified.
Description: Creates a far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.====farfield====
====rcs_bistaticSYNTAX: farfield({{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)====
EXAMPLE: ''Example: rcs_bistaticfarfield("RCS_1FF_1",1,1)''
DescriptionDESCRIPTION: Creates a bistatic RCS far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.
====current_dist({{ArgTypeString}} label)rcs_bistatic====
''ExampleSYNTAX: current_distrcs_bistatic("CD_1"{{ArgTypeString}} label, {{ArgTypeAny}} theta_incr, {{ArgTypeAny}} phi_incr)''
DescriptionEXAMPLE: Creates a current distribution observable. If the observable 'label' already existsrcs_bistatic("RCS_1", its properties are modified.1,1)''
====field_sensor({{ArgTypeString}} DESCRIPTION: Creates a bistatic RCS observable. If the observable 'label' already exists, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)====its properties are modified.
''Example: field_sensor("FS_1","z",0,0,0,100,100,0,25,25,0)''====current_dist====
DescriptionSYNTAX: Creates a near-field sensor observable. If the observable 'current_dist({{ArgTypeString}} label' already exists, its properties are modified.)
====field_sensor_gridEXAMPLE: ''current_dist({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0"CD_1")====''
DESCRIPTION: Creates a current distribution observable. If the observable 'label'Example: field_sensor_grid("FS_1"already exists,"z",0,0,0)''its properties are modified.
Description: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====field_sensor====
====field_probeSYNTAX: field_sensor({{ArgTypeString}} label, {{ArgTypeAny}} dir_coordinate, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} xSize, {{ArgTypeAny}} ySize, {{ArgTypeAny}} zSize, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)====
EXAMPLE: ''Example: field_probefield_sensor("FS_1","z",0,0,500,100,100,0,25,25,0)''
DescriptionDESCRIPTION: Creates a temporal near-field probe sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
====receiver_set({{ArgTypeString}} label, {{ArgTypeAny}} base_point_set[, {{ArgTypeAny}} pattern_file, {{ArgTypeAny}} rot_x, {{ArgTypeAny}} rot_y, {{ArgTypeAny}} rot_z)field_sensor_grid====
''ExampleSYNTAX: receiver_setfield_sensor_grid("TX_1"{{ArgTypeString}} label,"PT_1"{{ArgTypeAny}} dir_coordinate,"DPL_STD.RAD"{{ArgTypeAny}} x0,0{{ArgTypeAny}} y0,90,0{{ArgTypeAny}} z0)''
DescriptionEXAMPLE: Creates a receiver set in [[EM.Terrano]]. If the receiver set 'label' already existsfield_sensor_grid("FS_1", its properties are modified."z",0,0,0)''
====huygens_surface({{ArgTypeString}} DESCRIPTION: Creates a near-field sensor observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)====its properties are modified.
''Example: huygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)''====field_probe====
DescriptionSYNTAX: Creates a Huygens surface observable. If the observable 'field_probe({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0)
====huygens_surface_gridEXAMPLE: ''field_probe({{ArgTypeString}} label"FS_1", {{ArgTypeAny}} x10, {{ArgTypeAny}} y10, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z250)====''
DESCRIPTION: Creates a temporal field probe observable in [[EM.Tempo]] or [[EM.Ferma]]. If the observable 'label'Example: huygens_surface_grid("HS_1"already exists,-10,-10,-10,10,10,10)''its properties are modified.
Description: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label' already exists, its properties are modified.====receiver_set====
====voltage_integralSYNTAX: receiver_set({{ArgTypeString}} label, {{ArgTypeAny}} x1base_point_set[, {{ArgTypeAny}} y1pattern_file, {{ArgTypeAny}} z1rot_x, {{ArgTypeAny}} x2rot_y, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2rot_z)====
EXAMPLE: ''Example: voltage_integralreceiver_set("FI_1TX_1",0"PT_1",0,-10"DPL_STD.RAD",0,090,100)''
DescriptionDESCRIPTION: Creates a voltage integral observable receiver set in [[EM.FermaTerrano]]. If the observable receiver set 'label' already exists, its properties are modified.
====current_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)huygens_surface====
''ExampleSYNTAX: current_integralhuygens_surface("FI_1"{{ArgTypeString}} label,-10{{ArgTypeAny}} x1,-10{{ArgTypeAny}} y1,0{{ArgTypeAny}} z1,10{{ArgTypeAny}} x2,10{{ArgTypeAny}} y2,0{{ArgTypeAny}} z2, {{ArgTypeAny}} xSamples, {{ArgTypeAny}} ySamples, {{ArgTypeAny}} zSamples)''
DescriptionEXAMPLE: Creates a current integral observable in [[EM.Ferma]]. If the observable 'label' already existshuygens_surface("HS_1", its properties are modified.-10,-10,-10,10,10,10,40,40,40)''
====conduction_current_integral({{ArgTypeString}} DESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====its properties are modified.
''Example: conduction_current_integral("FI_1",-10,-10,0,10,10,0)''====huygens_surface_grid====
DescriptionSYNTAX: Creates a conduction current integral observable in [[EM.Ferma]]. If the observable 'huygens_surface_grid({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====capacitanceEXAMPLE: ''huygens_surface_grid({{ArgTypeString}} label"HS_1", {{ArgTypeAny}} x1-10, {{ArgTypeAny}} y1-10, {{ArgTypeAny}} z1-10, {{ArgTypeAny}} x210, {{ArgTypeAny}} y210, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z410)====''
DESCRIPTION: Creates a Huygens surface observable in [[EM.Tempo]]. If the observable 'label'Example: capacitance("FI_1"already exists,-10,-10,5,10,10,10,0,0,-10,0,0,10)''its properties are modified.
Description: Creates a capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====voltage_integral====
====inductanceSYNTAX: voltage_integral({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)====
EXAMPLE: ''Example: inductancevoltage_integral("FI_1",0,0,-10,100,0,10,2.5,-2.5,0,7.5,2.5,0)''
DescriptionDESCRIPTION: Creates a inductance voltage integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
====resistance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)current_integral====
''ExampleSYNTAX: resistancecurrent_integral("FI_1"{{ArgTypeString}} label,0{{ArgTypeAny}} x1,0{{ArgTypeAny}} y1,-10{{ArgTypeAny}} z1,0{{ArgTypeAny}} x2,0{{ArgTypeAny}} y2,10,-10,-10,0,10,10,0{{ArgTypeAny}} z2)''
DescriptionEXAMPLE: Creates a resistance integral observable in [[EM.Ferma]]. If the observable 'label' already existscurrent_integral("FI_1", its properties are modified.-10,-10,0,10,10,0)''
====flux_electric({{ArgTypeString}} DESCRIPTION: Creates a current integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====its properties are modified.
''Example: flux_electric("FI_1",-10,-10,5,10,10,10)''====conduction_current_integral====
DescriptionSYNTAX: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'conduction_current_integral({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)
====flux_magneticEXAMPLE: ''conduction_current_integral({{ArgTypeString}} label"FI_1", {{ArgTypeAny}} x1-10, {{ArgTypeAny}} y1-10, {{ArgTypeAny}} z10, {{ArgTypeAny}} x210, {{ArgTypeAny}} y210, {{ArgTypeAny}} z20)====''
DESCRIPTION: Creates a conduction current integral observable in [[EM.Ferma]]. If the observable 'label'Example: flux_magnetic("FI_1"already exists,0,0,-10,10,0,10)''its properties are modified.
Description: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.====capacitance====
====energy_electricSYNTAX: capacitance({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)====
EXAMPLE: ''Example: energy_electriccapacitance("FI_1",-10,-10,-5,10,10,10,0,0,-10,0,0,10)''
DescriptionDESCRIPTION: Creates an electric energy a capacitance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified.
====energy_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)inductance====
''ExampleSYNTAX: energy_magneticinductance("FI_1"{{ArgTypeString}} label,-10{{ArgTypeAny}} x1,-10{{ArgTypeAny}} y1,-10{{ArgTypeAny}} z1,10{{ArgTypeAny}} x2,10{{ArgTypeAny}} y2,10{{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)''
DescriptionEXAMPLE: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label' already existsinductance("FI_1", its properties are modified0,0,-10,10,0,10,2.5,-2.5,0,7.5,2.5,0)''
====ohmic_loss({{ArgTypeString}} DESCRIPTION: Creates a inductance integral observable in [[EM.Ferma]]. If the observable 'label' already exists, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2)====its properties are modified.
''Example: ohmic_loss("FI_1",-10,-10,-10,10,10,10)''====resistance====
DescriptionSYNTAX: Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'resistance({{ArgTypeString}} label' already exists, its properties are modified.{{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2, {{ArgTypeAny}} x3, {{ArgTypeAny}} y3, {{ArgTypeAny}} z3, {{ArgTypeAny}} x4, {{ArgTypeAny}} y4, {{ArgTypeAny}} z4)
====solution_planeEXAMPLE: ''resistance({{ArgTypeString}} label"FI_1", {{ArgTypeAny}} field_sensor_label0, {{ArgTypeAny}} is_quasi0,-10,0,0,10,-10,-10,0,10,10,0)====''
DESCRIPTION: Creates a resistance integral observable in [[EM.Ferma]]. If the observable 'label'Example: solution_plane("FI_1"already exists,"FS_1",1)''its properties are modified.
Description====flux_electric==== SYNTAX: flux_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''flux_electric("FI_1",-10,-10,5,10,10,10)'' DESCRIPTION: Creates an electric flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====flux_magnetic==== SYNTAX: flux_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''flux_magnetic("FI_1",0,0,-10,10,0,10)'' DESCRIPTION: Creates a magnetic flux integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====energy_electric==== SYNTAX: energy_electric({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''energy_electric("FI_1",-10,-10,-10,10,10,10)'' DESCRIPTION: Creates an electric energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====energy_magnetic==== SYNTAX: energy_magnetic({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''energy_magnetic("FI_1",-10,-10,-10,10,10,10)'' DESCRIPTION: Creates a magnetic energy integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====ohmic_loss==== SYNTAX: ohmic_loss({{ArgTypeString}} label, {{ArgTypeAny}} x1, {{ArgTypeAny}} y1, {{ArgTypeAny}} z1, {{ArgTypeAny}} x2, {{ArgTypeAny}} y2, {{ArgTypeAny}} z2) EXAMPLE: ''ohmic_loss("FI_1",-10,-10,-10,10,10,10)'' DESCRIPTION: Creates an ohmic loss integral observable in [[EM.Ferma]]. If the observable 'label' already exists, its properties are modified. ====solution_plane==== SYNTAX: solution_plane({{ArgTypeString}} label, {{ArgTypeAny}} field_sensor_label, {{ArgTypeAny}} is_quasi) EXAMPLE: ''solution_plane("FI_1","FS_1",1)'' 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 ==
28,333
edits