pyaedt.modules.Boundary.FarFieldSetup

class pyaedt.modules.Boundary.FarFieldSetup(app, component_name, props, component_type, units='deg')[source]

Manages Far Field Component data and execution.

Examples

in this example the sphere1 returned object is a pyaedt.modules.Boundary.FarFieldSetup >>> from pyaedt import Hfss >>> hfss = Hfss() >>> sphere1 = hfss.insert_infinite_sphere() >>> sphere1.props[“ThetaStart”] = 45 >>> sphere1.delete()

Methods

FarFieldSetup.create()

Create a Field Setup Component in HFSS.

FarFieldSetup.delete()

Delete the Field Setup in AEDT.

FarFieldSetup.update()

Update the Field Setup in AEDT.

Attributes

FarFieldSetup.azimuth_start

Set/Get the Far Field Azimuth Start Angle if Definition is Set to Az Over El or El Over Az.

FarFieldSetup.azimuth_step

Set/Get the Far Field Azimuth Step Angle if Definition is Set to Az Over El or El Over Az.

FarFieldSetup.azimuth_stop

Set/Get the Far Field Azimuth Stop Angle if Definition is Set to Az Over El or El Over Az.

FarFieldSetup.custom_radiation_surface

Set/Get the Far Field Radiation Surface FaceList.

FarFieldSetup.definition

Set/Get the Far Field Angle Definition.

FarFieldSetup.elevation_start

Set/Get the Far Field Elevation Start Angle if Definition is Set to Az Over El or El Over Az.

FarFieldSetup.elevation_step

Set/Get the Far Field Elevation Step Angle if Definition is Set to Az Over El or El Over Az.

FarFieldSetup.elevation_stop

Set/Get the Far Field Elevation Stop Angle if Definition is Set to Az Over El or El Over Az.

FarFieldSetup.local_coordinate_system

Set/Get the custom Coordinate System name.

FarFieldSetup.phi_start

Set/Get the Far Field Phi Start Angle if Definition is Set to Theta-Phi.

FarFieldSetup.phi_step

Set/Get the Far Field Phi Step Angle if Definition is Set to Theta-Phi.

FarFieldSetup.phi_stop

Set/Get the Far Field Phi Stop Angle if Definition is Set to Theta-Phi.

FarFieldSetup.polarization

Set/Get the Far Field Polarization.

FarFieldSetup.slant_angle

Set/Get the Far Field Slant Angle if Polarization is Set to Slant.

FarFieldSetup.theta_start

Set/Get the Far Field Theta Start Angle if Definition is Set to Theta-Phi.

FarFieldSetup.theta_step

Set/Get the Far Field Theta Step Angle if Definition is Set to Theta-Phi.

FarFieldSetup.theta_stop

Set/Get the Far Field Theta Stop Angle if Definition is Set to Theta-Phi.

FarFieldSetup.use_custom_radiation_surface

Set/Get the Far Field Radiation Surface Enable.

FarFieldSetup.use_local_coordinate_system

Set/Get the usage of a custom Coordinate System.