HFSS 3D Layout and arguments#

This section lists all setup templates with their default values and keys available in HFSS 3D Layout.

You can edit a setup after it is created. Here is an example:

Launch AEDT 2023 R1 in non-graphical mode

from ansys.aedt.core import Hfss

hfss = Hfss()
# Any property of this setup can be found on this page.
setup = hfss.create_setup()
setup.props["AdaptMultipleFreqs"] = True
setup.update()
HFSS3DLayout
{ 'AdaptiveSettings': { 'AdaptType': 'kSingle',
                        'Basic': True,
                        'BroadbandFrequencyDataList': { 'AdaptiveFrequencyData': [ { 'AdaptiveFrequency': '5GHz',
                                                                                     'Expressions': [ ],
                                                                                     'MaxDelta': '0.02',
                                                                                     'MaxPasses': 10},
                                                                                   { 'AdaptiveFrequency': '10GHz',
                                                                                     'Expressions': [ ],
                                                                                     'MaxDelta': '0.02',
                                                                                     'MaxPasses': 10}]},
                        'DoAdaptive': True,
                        'MaxRefinePerPass': 30,
                        'MinConvergedPasses': 1,
                        'MinPasses': 1,
                        'MultiFrequencyDataList': { 'AdaptiveFrequencyData': [ { 'AdaptiveFrequency': '2.5GHz',
                                                                                 'Expressions': [ ],
                                                                                 'MaxDelta': '0.02',
                                                                                 'MaxPasses': 10},
                                                                               { 'AdaptiveFrequency': '5GHz',
                                                                                 'Expressions': [ ],
                                                                                 'MaxDelta': '0.02',
                                                                                 'MaxPasses': 10},
                                                                               { 'AdaptiveFrequency': '10GHz',
                                                                                 'Expressions': [ ],
                                                                                 'MaxDelta': '0.02',
                                                                                 'MaxPasses': 10}]},
                        'SaveFields': False,
                        'SaveRadFieldsOnly': False,
                        'SingleFrequencyDataList': { 'AdaptiveFrequencyData': { 'AdaptiveFrequency': '5GHz',
                                                                                'Expressions': [ ],
                                                                                'MaxDelta': '0.02',
                                                                                'MaxPasses': 10}}},
  'AdvancedSettings': { 'AccuracyLevel': 2,
                        'BroadbandFreqOption': 'AutoMaxFreq',
                        'BroadbandMaxNumFreq': 5,
                        'CausalMaterials': True,
                        'CircuitIntegrationType': 'FFT',
                        'CircuitSparamDefinition': False,
                        'ComputeBothEvenAndOddCPWModes': False,
                        'DRCOn': False,
                        'DesignType': 'generic',
                        'EnableDesignIntersectionCheck': True,
                        'EnhancedLowFreqAccuracy': False,
                        'ExportAfterSolve': False,
                        'ExportDir': '',
                        'FastSolverOn': False,
                        'GapPortCalibration': True,
                        'LoopTreeOn': True,
                        'MaxDeltaZo': 2,
                        'MaxTrianglesForWavePort': 500,
                        'MeshingMethod': 'Phi',
                        'MinTrianglesForWavePort': 100,
                        'ModeOption': 'General mode',
                        'NumProcessors': 1,
                        'OrderBasis': -1,
                        'PhiMesherDeltaZRatio': 100000,
                        'ReferenceLengthRatio': 0.25,
                        'RefineAreaRatio': 4,
                        'RelativeResidual': 1e-06,
                        'SVDHighCompression': False,
                        'SaveADP': True,
                        'SetTrianglesForWavePort': False,
                        'SingularElementsOn': False,
                        'SolverType': 'Direct Solver',
                        'StartFastSolverAt': 3000,
                        'ThinDielectric': 0,
                        'UseAdvancedDCExtrap': False,
                        'UseAlternativeMeshMethodsAsFallBack': True,
                        'UseHfssIterativeSolver': False,
                        'UseHfssMUMPSSolver': True,
                        'UseRadBoundaryOnPorts': False,
                        'UseShellElements': False,
                        'UseStaticPortSolver': False,
                        'UseThinMetalPortSolver': False,
                        'ZeroMetalLayerThickness': 0,
                        'enabledsoforopti': True,
                        'numprocessorsdistrib': 1,
                        'usehfsssolvelicense': False},
  'AuxBlock': {},
  'Color': ['R', 0, 'G', 0, 'B', 0],
  'CurveApproximation': { 'ArcAngle': '30deg',
                          'Error': '0meter',
                          'MaxPoints': 8,
                          'Replace3DTriangles': True,
                          'StartAzimuth': '0deg',
                          'UnionPolys': True,
                          'UseError': False},
  'CustomSetup': False,
  'DefeatureAbsLength': '0mm',
  'DefeatureRatio': 1e-06,
  'DoAdaptive': True,
  'EdgeMeshAbsLength': '1000mm',
  'EdgeMeshRatio': 0.1,
  'Frequency': '10GHz',
  'HealingOption': 1,
  'HfssMesh': True,
  'InclBBoxOption': 1,
  'InfArrayDimX': 0,
  'InfArrayDimY': 0,
  'InfArrayOrigX': 0,
  'InfArrayOrigY': 0,
  'InfArraySkew': 0,
  'LambdaRefine': True,
  'LayerProjectThickness': '0meter',
  'LayerSnapTol': '1e-05',
  'MaxRatio': 2,
  'MaxRefinement': 1000000,
  'MeshSizeFactor': 1.5,
  'MinAngle': '15deg',
  'MinNumberOfConvergedPasses': 1,
  'MinNumberOfPasses': 1,
  'NumberOfProcessors': 0,
  'PercentRefinementPerPass': 30,
  'ProdMajVerID': -1,
  'ProdMinVerID': -1,
  'ProjDesignSetup': '',
  'Properties': {'Enable': 'true'},
  'Q3D_DCSettings': { 'Cond': { 'MaxPass': 10,
                                'MinConvPass': 1,
                                'MinPass': 1,
                                'PerError': 1,
                                'PerRefine': 30},
                      'Mult': { 'MaxPass': 1,
                                'MinConvPass': 1,
                                'MinPass': 1,
                                'PerError': 1,
                                'PerRefine': 30},
                      'Solution Order': 'Normal',
                      'SolveResOnly': True},
  'Q3dPostProc': False,
  'QualityRefine': True,
  'Refine': False,
  'Replace3DTriangles': True,
  'SaveAdaptiveCurrents': False,
  'SaveLastAdaptiveRadFields': False,
  'SmallVoidArea': -2e-09,
  'Smooth': False,
  'SmoothingPasses': 5,
  'SolveSetupType': 'HFSS',
  'Style25DVia': 'Mesh',
  'UniformityRefine': False,
  'UnitFactor': 1000,
  'UseDefaultLambda': True,
  'UseDefeature': True,
  'UseDefeatureAbsLength': False,
  'UseEdgeMesh': False,
  'UseEdgeMeshAbsLength': False,
  'UseMaxRefinement': False,
  'Verbose': False,
  'ViaDensity': 0,
  'ViaMaterial': 'copper',
  'ViaNumSides': 6}