CreateFieldPlot

Note:

Use in conjunction with GetGeometryIdsForNetLayerCombinations and GetGeometryIdsForAllNetLayerCombinations.

  • GetGeometryIdsForNetLayerCombinations returns ID numbers of all faces and edges of the active design related to the current target combination of nets and layers.
  • GetGeometryIdsForAllNetLayerCombinations returns ID numbers for all possible combinations of nets and layers it is possible to choose.

HFSS Multipaction SEY Plot

# ------------------------------------------

# Script Recorded by Ansys Electronics Desktop Version 2025.2.0

# 15:36:54 Jan 15, 2025

# ------------------------------------------

import ScriptEnv

ScriptEnv.Initialize("Ansoft.ElectronicsDesktop")

oDesktop.RestoreWindow()

oProject = oDesktop.SetActiveProject("JPL_coax_r251")

oDesign = oProject.SetActiveDesign("Coaxial_7-8")

oModule = oDesign.GetModule("FieldsReporter")

oModule.CreateFieldPlot(

[

"NAME:SEY_Plot1",

"SolutionName:=" , "300MHz_low : Power",

"UserSpecifyName:=" , 0,

"UserSpecifyFolder:=" , 0,

"QuantityName:=" , "Unknown",

"PlotFolder:=" , "SEY_Plot",

"StreamlinePlot:=" , False,

"AdjacentSidePlot:=" , False,

"FullModelPlot:=" , False,

"IntrinsicVar:=" , "PowerMultiplier=\'250\' Time=\'0s\'",

"PlotGeomInfo:=" , [1,"Surface","FacesList",4,"16","17","18","24"],

"FilterBoxes:=" , [0],

[

"NAME:PlotOnSurfaceSettings",

"Filled:=" , False,

"IsoValType:=" , "Tone",

"AddGrid:=" , False,

"MapTransparency:=" , True,

"Refinement:=" , 0,

"Transparency:=" , 0,

"SmoothingLevel:=" , 0,

"ShadingType:=" , 0,

[

"NAME:Arrow3DSpacingSettings",

"ArrowUniform:=" , True,

"ArrowSpacing:=" , 0,

"MinArrowSpacing:=" , 0,

"MaxArrowSpacing:=" , 0

],

"GridColor:=" , [255,255,255]

],

"EnableGaussianSmoothing:=", False,

"SurfaceOnly:=" , False,

"QuantityName:=" , "QuantityName_SecondaryEmission",

"PlotFolder:=" , "SEY_Plot",

"IntrinsicVar:=" , "PowerMultiplier=\'250\' Time=\'0s\'"

], "SecondaryEmission")

Use: Creates a field/mesh plot.

Command:Q3D Extractor or 2D Extractor > Fields

Syntax: CreateFieldPlot <PlotParameterArray>

Return Value: None

Parameters: <PlotParameterArray>

   Array("NAME:<PlotName>",
      "SolutionName:="       , <string>, _
      "QuantityName:="       , <string>, _
      "PlotFolder:="         , <string>, _
      "UserSpecifyName:="    , <int>, _
      "UserSpecifyFolder:="  , <int>, _
      "IntrinsicVar:="       , <string>, _
      "PlotGeomInfo:="       , <PlotGeomArray>, _
      "FilterBoxes:="        , <FilterBoxArray>, _
      <PlotOnPointSettings>  , <PlotOnLineSettings>, _
      <PlotOnSurfaceSettings>, <PlotOnVolumeSettings>)

SolutionName

Name of the solution setup and solution formatted as

"<SolveSetupName> : <WhichSolution>",

where <WhichSolution> can be "Adaptive_<n>", "LastAdaptive", or "PortOnly".

For example: "Setup1 : Adaptive_2"

HFSS requires a space on both sides of the ‘:’ character. Otherwise, the plot is not be created.

QuantityName

Type of plot to create. Possible values are:

Mesh plots: "Mesh"

Q3D Field Plots:


2D Extractor Field Plots:


PlotFolder

Name of the folder to which the plot should be added. Possible values are:

"Q", "ABS_Q", "JDC Vol", "Phi", "JDC Surf", and "JAC".

UserSpecifyName

0 if default name for plot is used, 1 otherwise.

This parameter is not essential. <PlotName> is respected regardless of whether this flag is set.

UserSpecifyFolder

0 if the default folder for plot is used, 1 otherwise.

This parameter is not essential. The specified PlotFolder is respected regardless of whether this flag is set.

IntrinsicVar

Formatted string that specifies the frequency and phase at which to create the plot.

For example: "Freq='1GHz' Phase='30deg'"

<PlotGeomArray>

Array(<NumGeomTypes>, <GeomTypeData>, <GeomTypeData>, …)

For example:

     Array(4, "Volume", "ObjList", 1, "Box1", _
        "Surface", "FacesList", 1, "12", "Line", 1, _
        "Polyline1", "Point", 2, "Point1", "Point2")

<NumGeomTypes>

Type: <int>

Number of different geometry types (volume, surface, line, point) plotted at the same time.

<GeomTypeData>

<GeomType>, <ListType>, <NumIDs>, <ID>, <ID>, …)

<GeomType>

Type: <string>

Possible values are:

"Volume", "Surface", "Line", "Point"

<ListType>

Type: <string>

Possible values are:

"ObjList", "FacesList".

These are used for GeomType values "Line" or "Point".

<NumIDs>

Type: <int>

Number of IDs or object names that will follow.

<ID>

Type: <int> or <string>

ID of a face or name of an object, line, or point on which to plot.

<FilterBoxArray>

Array of object names used to restrict the plot range.

Array(<NumFilters>, <ObjName>, <ObjName>, ...)

Examples:

Array(1, "Box1")
Array(0) no filtering

<PlotOnPointSettings>

   Array("NAME:PlotOnPointSettings", _
      "PlotMarker:=", <bool>, _
      "PlotArrow:=" , <bool>)

<PlotOnLineSettings>

   Array("NAME:PlotOnLineSettings",
      Array("NAME:LineSettingsID", _
         "Width:="       , <int>, _
         "Style:="       , <string>), _
      "IsoValType:="  , <string>, _
      "ArrowUniform:=", <bool>, _
      "NumofArrow:="  , <int>)

Style

Possible values are

"Cylinder", "Solid", "Dashdash", "Dotdot", "Dotdash".

IsoValType

Possible values are

"Tone", "Fringe", "Gourard"

<PlotOnSurfaceSettings>

   Array("NAME:PlotOnSurfaceSettings", _
      "Filled:="         , <bool>, _
      "IsoValType:="     , <string>, _
      "SmoothShade:="    , <bool>, _
      "AddGrid:="        , <bool>, _
      "MapTransparency:=", <bool>, _
      "Transparency:="   , <double>, _
      "ArrowUniform:="   , <bool> _
      "ArrowSpacing:="   , <double> _
      "GridColor:="      , Array(<int>, <int>, <int>)

IsoValType

Possible values are

"Tone", "Line", "Fringe", "Gourard"

GridColor

Array containing the R, G, B components of the color. Components should be in the range 0 to 255.

<PlotOnVolumeSettings>

   Array("NAME:PlotOnVolumeSettings", _
      "PlotIsoSurface:=", <bool>, _
      "CloudDensity:="  , <double>, _
      "PointSize:="     , <int>, _
      "ArrowUniform:="  , <bool>, _
      "ArrowSpacing:="  , <double>)