Add (Near Field Sphere)

Adds a near-field radiation boundary in the shape of a sphere.

Note: Only Name and Type are required parameters. If you set a custom Theta or Phi parameter, then you must set all Theta and Phi parameters. If you have a local coordinate system, then you must set the CS and UseLocalCS 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>Sphere.

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.
<StartTheta > String Optional. Starting point for theta in the spherical coordinate system for the sphere being defined. The default value is "0deg". Use the form "<num>deg".
<StartPhi> String Optional. Starting point for phi in the spherical coordinate system for the sphere being defined. The default value is "-180deg". Use the form "<num>deg".
<StopTheta> String Optional. Stopping point for theta in the spherical coordinate system for the sphere being defined. The default value is "180deg". Use the form "<num>deg".
<StopPhi> String Optional. Stopping point for phi in the spherical coordinate system for the sphere being defined. The default value is "1800deg". Use the form "<num>deg".
<StepTheta> String Optional. Step size between the start and the stop theta values at which the far field is calculated. The default value is "2deg". Use the form "<num>deg".
<StepPhi> String Optional. Step size between the start and the stop phi values at which the far field is calculated. The default value is "2deg". Use the form "<num>deg".
<CS> Integer Optional. The coordinate system to use. When coordinate system is local, set this number to the index of the local coordinate system. Set this value to -1 for a global coordinate system. The default value is -1.
<UseLocalCS> Boolean Optional. True to select a local coordinate system, and False to use the global coordinate system. The default value is False.
<NFRadius> String Optional. Radius of the sphere we want to calculate near fields on. The default value is "20mm".Use the form "<num><unit>".
Return Value None.

 

Python Syntax

oModule.Add(

[

"NAME:<Name>",

"Type:=" , "InfiniteSphereFarField",

"VersionID:=" , 0,

"ID:=" , <ID>,

"StartTheta:=" , "<StartTheta>deg",

"StartPhi:=" , "<StartPhi>deg",

"StopTheta:=" , "<StopTheta>deg",

"StopPhi:=" , "<StopPhi>deg",

"StepTheta:=" , "<StepTheta>deg",

"StepPhi:=" , "<StapPhi>deg",

"CS:=" , <CS>,

"UseLocalCS:=" , <UseLocalCS>,

"NFRadius:=", "<NFRadius>"

])

Python Example 
oDesign = oDesign.GetModule("RadiationSetupMgr")
oModule.Add(
[
   "NAME:Sphere 1",
   "Type:=", "NearFieldSphere",
   "VersionID:=", 0,
   "ID:=", 7,
   "StartTheta:=", "0deg",
   "StartPhi:=", "-180deg",
   "StopTheta:=", "180deg",
   "StopPhi:=", "180deg",
   "StepTheta:=", "2deg",
   "StepPhi:=", "2deg",
   "CS:=", -1,
   "UseLocalCS:=", False, 
   "NFRadius:=", "20mm"
])