Add (Near Field Plane)

Adds a near-field radiation boundary in the shape of a plane. This plane is calculated in reference to a rectangle defined by the X and Y parameters.

UI Access

In the Project Manager under the design name, right click Radiation and in the right-click menu, click Insert Near Field Setup>Plane.

Parameters

Name	Type	Description
<Name>	String	A user-defined name for the near field sphere.
<Type>	String	Type of radiation setup. It should be NearFieldSphere.
<VersionID>	Integer	Optional. Set to 0.
<ID>	Integer	Optional. Identifier that is created differently for every setup.
<MinX >	String	Optional. Starting X value for the plane that the near fields will be calculated for. The default value is "-41.5mm". Use the form "<num><unit>".
<MaxX>	String	Optional. Final X value for the plane that the near fields will be calculated for. The default value is "8.5mm". Use the form "<num><unit>".
<MinY>	String	Optional. Starting Y value for the plane that the near fields will be calculated for. The default value is "16mm". Use the form "<num><unit>".
<MaxY>	String	Optional. Final Y value for the plane that the near fields will be calculated for. The default value is "16mm". Use the form "<num><unit>".
<Height>	String	Optional. Height of the reference rectangle. The default value is "1.652145mm". Use the form "<num>".
<ExpFactor>	String	Optional. The X and Y dimensions are multipled by this exponential factor to determine new dimensions for the plane. For example, set to 1 to use the default calculated dimensions of the plane or set to 2 to double each dimension of the plane. The default value is "1". Use the form "<num>".
<UseExpFactor>	Boolean	Optional. Set to True to add the exponent factor to the plane dimensions or False to use the automatically calculated plane dimensions or user-defined plane dimensions. The default value is False.
<CSID>	Integer	Optional. An identifier for the coordinate system.

Return Value

None.

Python Syntax

oModule.Add(

[

"NAME:<Name>",

"Type:=" , "NearFieldPlane",

"VersionID:=" , 0,

"ID:=" , <ID>,

"MinX:=" , "<MinX>",

"MaxX:=" , "<MaxX>",

"MinY:=" , "<MinY>",

"MaxY:=" , "<MaxY>",

"Height:=" , "<Height>",

"ExpFactor:=" , "<ExpFactor>",

"UseExpFactor:=" , <UseExpFactor>,

"CSID:=" , <CSID>

])

Python Example

oDesign = oDesign.GetModule("RadiationSetupMgr")
oModule.Add(
[
   "NAME:Plane 1",
   "Type:=", "NearFieldPlane",
   "VersionID:=", 0,
   "ID:=", 7,
   "MinX:=", "-50mm",
   "MaxX:=", "25mm",
   "MinY:=", "-18.5mm",
   "MaxY:=", "31.5mm",
   "Height:=", "5.6mm",
   "ExpFactor:=", "1",
   "UseExpFactor:=", False,
   "CSID:=", -4
])