EditSources
Indicates which source excitations should be used for fields post-processing. For HFSS see For HFSS, the EditSources command details are as follows.
For HFSS, the EditSources command details are as follows.
Configures source excitation settings for post-processing. The argument syntax for this command involves an array containing an arbitrary number of nested arrays. The first of these nested arrays contains non-source specific settings relevant to the entire design while the subsequent arrays contain source specific settings relevant only to individual excitations.
Command: Right click on Field Overlays and select Edit Sources ….
Syntax: EditSources([
[<non-source specific settings>],
[<settings for source_1>],
[<settings for source_2>],
[<settings for source_3>],
…
])
Individual fields inside the nested arrays are specified in pairs, where the first array element in a pair is the name of the field to be specified and the second element is the corresponding value.
[
<Name of setting_1>, <Value of setting_1>,
<Name of setting_2>, <Value of setting_2>,
…
]
The following is a list of non-source specific and source specific settings. Note that for a given design or excitation, only a subset of these settings will be applicable.
Non-Source Specific Settings
| Name: | Type of Values: |
|---|---|
| “FieldType:=” | String. One of the following: “ScatteredFields” “TotalFields” “IncidentFields” “NoIncidentWave” “EigenPeakElectricField” “EigenStoredEnergy” |
| “ExciteModes:=” | Boolean. If true use modal excitations, otherwise use terminals. |
| “IncludePortPostProcessing:=” | Boolean |
| “UseIncidentVoltage:=” | Boolean. Otherwise use total voltage. |
| “UsePerElementArrayPower:=” | Boolean. Specify power for arrays on a per-element basis. |
| “SpecifySystemPower:=” | Boolean |
| “IncidentPower:=" | String. In units of power. |
Source Specific Settings
| Name: | Type of Values: |
|---|---|
| “Name:=” | String. Name of excitation. |
| “Magnitude:=” | String. Magnitude of excitation. Units depend on specific excitation. |
| “Phase:=” | String. Phase of excitation. Units can vary. |
| “Delay:=” | String. In units of time, applicable to transient designs. |
| “TransientMagnitude:=” | String. Magnitude of excitation. Units depend on specific excitation. |
| “Resistance:=” | String. In units of electrical resistance. |
| “Reactance:=” | String. In units of electrical resistance. |
| “Terminated:=” | Boolean ("true", "false"). If terminated, Magnitude and Phase are superseded with Resistance and Reactance. |
| “Renorm Impedance:=” | Boolean |
Return Value: None
Parameters:
Each inner block describes the values to be assigned to an individual excitation. The valid keywords are:
Name - Required. This identifies the excitation and uses the same syntax as the edit source dialog box. As opposed to the old command, names can be specified in any order. Unspecified excitations will not be affected, so users can edit one or more excitations without needing to edit them all.
Magnitude - a unit quantity ("1W", "2mV", …)
Phase - a unit quantity ("1W", "2mV", …)
For Driven Terminal designs, a terminal may be terminated
Terminated - boolean ("true", "false"). If terminated, Magnitude and Phase are superseded with:
Resistance - a unit quantity ("50ohm", …)
Reactance - a unit quantity ("50ohm", …)
For Transient problems, the spectral fields use Magnitude and Phase. The transient fields are controlled by:
Delay- a unit quantity ("3.5ps", …)
TransientMagnitude - a unit quantity ("1W", …)
For CMA problems, the special excitation "Modes" specifies the modal excitations. These are then set with the keywords:
Magnitudes - integer vector [ "0", "0", "1", "2.5" ]. The size of the vector will determine how many modes are visible in the dialog.
Phases - unit quantity vector [ "30deg", ... ]. The size of the vector must match the size of the magnitude vector.
For Eigen problems the special excitation "Modes" specifies the modal excitations. These are then set with the keywords:
Magnitudes - integer vector [ "0", "0", "1", "2.5" ]. The size of the vector must match the design,
Phases- unit quantity vector [ "30deg", ... ]. The size of the vector must match the design. :Phases is not needed for Stored Energy fields.
Optional settings that apply to all sources
Incident Power - unit quantity ("2.5W"). Use in system gain calculations
SpecifySystemPower - boolean. If set, the above power is used. Otherwise, the maximum power is calculated.
FieldType - string. One of
ScatteredFields
TotalFields
IncidentFields
NoIncidentWave
EigenPeakElecticField
EigenStoredEnergy
IncludePortPostProcessing - boolean
For Driven Terminal designs, a terminal may be terminated
UseIncidentVoltage - boolean - otherwise use total voltage
For CMA problems:
ExciteModes - boolean. If true use modal excitations, otherwise use terminals. Terminal excitations are specified by their name, magnitude, and phase
For Eigen problems:
The special excitation "Modes" specifies the modal excitations. These are then set with the keywords
For all unit quantities, expressions ( "3 * my_var", "pwl( freq, ds1 )") are permitted as well.
| Python Syntax | EditSources([
[<non-source specific settings>], [<settings for source_1>], ...]) |
| Python Example |
oModule.EditSources( [ [ "FieldType:=" , "IncidentFields", "UseIncidentVoltage:=" , True, "IncludePortPostProcessing:=", False, "SpecifySystemPower:=" , False ], [ "Name:=" , "1:1", "Magnitude:=" , "0W", "Phase:=" , "0deg" ], [ "Name:=" , "IncPWave1", "Magnitude:=" , "1V_per_meter", "Phase:=" , "0deg" ] ])
oModule.EditSources( [ [ "IncludePortPostProcessing:=", True, "SpecifySystemPower:=" , True, "Incident Power:=" , "1W" ], [ "Name:=" , "Port1:1", "Magnitude:=" , "1W", "Phase:=" , "0deg" ], [ "Name:=" , "Port2:1", "Magnitude:=" , "0W", "Phase:=" , "0deg" ], [ "Name:=" , "Port3:1", "Magnitude:=" , "0W", "Phase:=" , "0deg" ] ]) oModule.EditSources( [ [ "FieldType:=" , "EigenStoredEnergy" ], [ "Name:=" , "Modes", "Magnitudes:=" , ["0","2"] ]) oModule.EditSources( [ [ "FieldType:=" , "IncidentFields", "IncludePortPostProcessing:=", True, "SpecifySystemPower:=" , False, "UsePerElementArrayPower:=", True ], [ "Name:=" , "pAntArray1_1_p1", "Magnitude:=" , "1W", "Phase:=" , "0deg" ] ]) |