Add (Layout Editor)

AddSetup

Adds a new setup.

Note: The following tables display example parameters applicable to a Near Field solution setup. Selecting a different setup will also add, remove, or change the applicable parameters.

UI Access

From HFSS, choose Solution Setup and then select from the available solution setups.

Parameters

Name	Type	Description
<SetupArray>	Array	An array that contains these parameters in order: <NAME:SetupName> <NameArray> <CustomSetup> <Position> <SimSetupType> <SimSettingsArray> <SolveSetupType> This array's placeholder does not appear in the syntax or examples below but instead has its contents listed.
<NAME:SetupName>	String	User-entered name of the new setup.
<NameArray>	Array	An array that contains these parameters in order: <NAME:Properties> <Enable>
<NAME:Properties>	String	Identifies the contents of the array (i.e., Properties).
<Enable>	Boolean	True – setup is active False – setup is inactive
<SimSetupType>	String	Identifies the type of setup (e.g., kSIwaveNearField).
<SimSettingArray>	Array	Optional. An array that contains these parameters in order: <NAME:SimulationSettings> <Enabled> <UseSISettings> <UseCustomSettings> <SISliderPros> <PISliderPros> <SIWAdvancedArray> <SIWDCArray> <SIWDCAdvancedArray> <SIWSParamArray> <NearFieldSettingArray> <NAME:SweepDataList> This array's placeholder does not appear in the syntax or examples below but instead has its contents listed.
<NAME:SimulationSettings>	String	Identifies the contents of the array (i.e., SimulationSettings).
<Enabled>	Boolean	True – array settings are active False – array settings are inactive
<UseSISettings>	Boolean	True – uses SI Simulation settings False – uses PI Simulation settings
<UseCustomSettings>	Boolean	True – overrides <UseSISettings> and activates <SIWAdvancedArray> parameters False groups by range
<SISliderPros>	Integer	0 – optimizes simulation for speed 1 – optimizes simulation to balance speed and accuracy 2 – optimizes simulation for accuracy
<PISliderPros>	Integer	0 – optimizes simulation for speed 1 – optimizes simulation to balance speed and accuracy 2 – optimizes simulation for accuracy
<SIWAdvancedArray>	Array	Optional. An array that contains these parameters in order: <NAME:SIWAdvancedSettings> <IncludeCoPlaneCoupling> <IncludeInterPlaneCoupling> <IncludeSplitPlaneCoupling> <IncludeFringeCoupling> <IncludeTraceCoupling> <XtalkThreshold> <MaxCoupledLines> <MinVoidArea> <MinPadAreaToMesh> SnapLengthThreshold> <MeshAutoMatic> <MeshFrequency> <ReturnCurrentDistribution> <INcludeVISources> <IncludeInfGnd> <InfGndLocation> <PerformERC> <IgnoreNonFunctionalPads> This array's placeholder does not appear in the syntax or examples below but instead has its contents listed.
<NAME:SIWAdvancedSettings>	String	Identifies the contents of the array (i.e., SIWAdvancedSettings).
<IncludeCoPlaneCoupling>	Boolean	True – coplane coupling active False – coplane coupling inactive
<IncludeInterPlaneCoupling>	Boolean	True – intra-plane coupling active False – intra-plane coupling inactive
<IncludeSplitPlaneCoupling>	Boolean	True – split-plane coupling active False – split-plane coupling inactive
<IncludeFringeCoupling>	Boolean	True – cavity field coupling active False – cavity field coupling inactive
<IncludeTraceCoupling>	Boolean	True – trace coupling active False – trace coupling inactive
<XtalkThreshold>	Integer	Maximum cross-talk threshold, in decibels.
<MaxCoupledLines>	Integer	The number of allowed coupled lines.
<MinVoidArea>	Integer	Minimum size of voids; voids larger than the minimum are meshed.
<MinPadAreaToMesh>	Integer	Minimum size of pads; pads larger than the minimum are meshed.
SnapLengthThreshold>	Integer	Minimum distance of vertices; vertices less than the minimum are snapped.
<MeshAutoMatic>	Boolean	True – mesh are automatically refined False – mesh are not automatically refined
<MeshFrequency>	Integer	Specific frequency at which mesh are refined.
<ReturnCurrentDistribution>	Boolean	True – returns current distribution is traced False – returns current distribution is not traced
<IncludeVISources>	Boolean	True – parasitic elements from voltage/current sources are included False – parasitic elements are not included
<IncludeInfGnd>	Boolean	True – infinite ground plane is included False – infinite ground plane is not included
<InfGndLocation>	Integer	Distance below bottom layer in stackup to place infinite ground plane.
<PerformERC>	Boolean	True – performs ERC during simulation False – does not perform ERC during simulation
<IgnoreNonFunctionalPads>	Boolean	True – excludes non-functional pads from resonant mode, frequency sweep, and SYZ simulations False – does not exclude non-functional pads from resonant mode, frequency sweep, and SYZ simulations.
<SIWSParamSettings>	Array	Optional. An array that contains these parameters in order: <UseStateSpace> <Interpolation> <Extrapolation> <DCBehavior> This array's placeholder does not appear in the syntax or examples below but instead has its contents listed.
<UseStateSpace>	Boolean	True – uses the State Space Model False – uses a Custom Model
<Interpolation>	Integer	0 – sets Interpolation to Point 1 – sets Interpolation to Point 2 – sets Interpolation to Point
<Extrapolation>	Integer	0 – sets Extrapolation to Zero padding 1 – sets Extrapolation to Same as last point 2 – sets Extrapolation to Linear extrapolation from last 2 points 3 – sets Extrapolation to Constant magnitude linear phase extrapolation
<DCBehavior>	Integer	0 – sets DC Behavior to Zero padding 1 – sets DC Behavior to Same as last point 2 – sets DC Behavior to Linear extrapolation from last 2 points 3 – sets DC Behavior to Constant magnitude linear phase extrapolation 4 – sets DC Behavior to Series Capacitor 5 – sets DC Behavior to Leave all signal lines open circuited
<SIWSNearFieldArray>	Array	An array that contains these parameters in order: <NAME:SIWNearFieldSettings> <UseExternalSources> <ExternalSourceFilePath> <InterpolateSpectrum> <IncludeInfGnd> <PosXoffset> <NegXoffset> <PosYoffset> <NegYoffset> <PosZoffset> <NegZoffset> <MinAdaptPasses> <MaxAdaptPasses> <NewTrianglesPerPass> <GlobalErrorTol> <UseUserEdgeLength> <MeshEdgeLength> <ExportData> <ExportDataPath> This array's placeholder does not appear in the syntax or examples below but instead has its contents listed.
<NAME:SIWNearFieldSettings>	String	Identifies the contents of the array (i.e., SIWNearFieldSettings).
<UseExternalSources>	Boolean	True – uses external Excitations definitions False – uses Excitations definitions defined in project
<ExternalSourceFilePath>	String	Directory path to external Excitations definitions file.
<InterpolateSpectrum>	Boolean	True – interpolates spectrum at missing frequency points (external Excitations definitions file only) False – does not interpolate spectrum at missing frequency points
<IncludeInfGnd>	Boolean	True – infinite ground plane is included False – infinite ground plane is not included
<PosXoffset>	Integer	Value determines the +X offset of a cube that encloses the design; the Near Field is evaluated on the surface of this cuboid.
<NegXoffset>	Integer	Value determines the -X offset of a cube that encloses the design; the Near Field is evaluated on the surface of this cuboid.
<PosYoffset>	Integer	Value determines the +Y offset of a cube that encloses the design; the Near Field is evaluated on the surface of this cuboid.
<NegYoffset>	Integer	Value determines the -Y offset of a cube that encloses the design; the Near Field is evaluated on the surface of this cuboid.
<PosZoffset>	Integer	Value determines the +Z offset of a cube that encloses the design; the Near Field is evaluated on the surface of this cuboid.
<NegZoffset>	Integer	Value determines the -Z offset of a cube that encloses the design; the Near Field is evaluated on the surface of this cuboid.
<MinAdaptPasses>	Integer	Minimum number of passes the adaptive analysis will make, even if convergence criteria are met.
<MaxAdaptPasses>	Integer	Maximum number of passes the adaptive analysis will make, unless convergence criteria are met.
<NewTrianglesPerPass>	Integer	Percentage of triangles to add per pass.
<GlobalErrorTol>	Integer	Maximum relative number of errors to allow between two successive adaptive passes.
<UseUserEdgeLength>	Boolean	True – uses custom maximum edge length False – automatically determines maximum edge length
<MeshEdgeLength>	Integer	Maximum edge length.
<ExportData>	Boolean	True – exports Near Field data False – does not export Near Field data
<ExportDataPath>	String	Path to directory in which to save Near Field data.
<NAME:SweepDataList>	String	Identifies the determining factors of the Near Field simulation (i.e., sweeps) (i.e., SweepDataList).
<SolveSetupType>	String	Identifies the type of setup (i.e., SIwaveNearField).

Return Value

None

Python Syntax

oModule.Add([<NAME:SIwaveNearField1>, [<NAME:Properties>, <Enable>], <SimSetupType>, [<NAME:SimulationSettings>, <Enabled>, <UseSISettings>, <UseCustomSettings>, <SISliderPos>, <PISliderPos>], [<NAME:SIWAdvancedSettings>, <IncludeCoPlaneCoupling>, <IncludeInterPlaneCoupling>, <IncludeSplitPlaneCoupling>, <IncludeFringeCoupling>, <IncludeTraceCoupling>, <XtalkThreshold>, <MaxCoupledLines>, <MinVoidArea>, <MinPadAreaToMesh>, <SnapLengthThreshold>, <MeshAutoMatic>, <MeshFrequency>, <ReturnCurrentDistribution>, <IncludeVISources>, <IncludeInfGnd>, <InfGndLocation>, <PerformERC>, <IgnoreNonFunctionalPads>], [<NAME:SIWSParamSettings>, <UseStateSpace>, <Interpolation>, <Extrapolation>, <DCBehavior>], [<NAME:SIWNearFieldSettings>, <UseExternalSources>, <ExternalSourceFilePath>, <InterpolateSpectrum>, <IncludeInfGnd>, <PosXoffset>, <NegXoffset>, <PosYoffset>, <NegYoffset>, <PosZoffset>, <NegZoffset>, <MinAdaptPasses>, <MaxAdaptPasses>, <NewTrianglesPerPass>, <GlobalErrorTol>, <UseUserEdgeLength>, <MeshEdgeLength>, <ExportData>, <ExportDataPath>]], [<NAME:SweepDataList>], <SolveSetupType>])

Python Example

oModule.Add(
[
"NAME:SIwaveNearField1",
[
"NAME:Properties",
"Enable:="		, "true"
],
"SimSetupType:="	, "kSIwaveNearField",
[
"NAME:SimulationSettings",
"Enabled:="		, True,
"UseSISettings:="	, False,
"UseCustomSettings:="	, False,
"SISliderPos:="		, 2,
"PISliderPos:="		, 0,
[
"NAME:SIWAdvancedSettings",
"IncludeCoPlaneCoupling:=", False,
"IncludeInterPlaneCoupling:=", False,
"IncludeSplitPlaneCoupling:=", False,
"IncludeFringeCoupling:=", False,
"IncludeTraceCoupling:=", False,
"XtalkThreshold:="	, "-34",
"MaxCoupledLines:="	, 12,
"MinVoidArea:="		, "2mm2",
"MinPadAreaToMesh:="	, "1mm2",
"MinPlaneAreaToMesh:="	, "6.25e-6mm2",
"SnapLengthThreshold:="	, "2.5um",
"MeshAutoMatic:="	, True,
"MeshFrequency:="	, "4GHz",
"ReturnCurrentDistribution:=", False,
"IncludeVISources:="	, False,
"IncludeInfGnd:="	, False,
"InfGndLocation:="	, "0mm",
"PerformERC:="		, False,
"IgnoreNonFunctionalPads:=", True
],
[
"NAME:SIWSParamSettings",
"UseStateSpace:="	, True,
"Interpolation:="	, 1,
"Extrapolation:="	, 3,
"DCBehavior:="		, 3
],
[
"NAME:SIWNearFieldSettings",
"UseExternalSources:="	, False,
"ExternalSourceFilePath:=", "",
"InterpolateSpectrum:="	, True,
"IncludeInfGnd:="	, False,
"PosXoffset:="		, "1mm",
"NegXoffset:="		, "1mm",
"PosYoffset:="		, "1mm",
"NegYoffset:="		, "1mm",
"PosZoffset:="		, "1mm",
"NegZoffset:="		, "1mm",
"MinAdaptPasses:="	, 1,
"MaxAdaptPasses:="	, 10,
"NewTrianglesPerPass:="	, 20,
"GlobalErrorTol:="	, 3,
"UseUserEdgeLength:="	, False,
"MeshEdgeLength:="	, "1mm",
"ExportData:="		, False,
"ExportDataPath:="	, ""
]
],
[
"NAME:SweepDataList"
],
"SolveSetupType:="	, "SIwaveNearField"
])