`FarFieldSphericalModeSettings`

Far field spherical mode settings.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create a far field request

farFieldRequest = project.SolutionConfigurations[1].FarFields:Add3DPattern()

    -- Calculate spherical expansion mode coefficients
    
farFieldRequest.Advanced.SphericalModes.CalculationEnabled = true

Usage locations (object properties)

The following objects have properties using the FarFieldSphericalModeSettings object:

FarFieldAdvancedSettings(.SphericalModes)

Property List

CalculationEnabled: Calculate spherical expansion mode coefficients. (Read/Write boolean)
ExportToASCIIEnabled: Export spherical expansion coefficients to ASCII file. This property is only valid if CalculationEnabled is true. (Read/Write boolean)
ModeMaximumIndex: Specify maximum mode index N. Changing this property will set ModeMaximumIndexEnabled to true. (Read/Write Expression)
ModeMaximumIndexEnabled: Specify number of spherical modes. This property is only valid if CalculationEnabled is true. (Read/Write boolean)

Property Details

CalculationEnabled

Calculate spherical expansion mode coefficients.

Type: boolean
Access: Read/Write

ExportToASCIIEnabled

Export spherical expansion coefficients to ASCII file. This property is only valid if CalculationEnabled is true.

Type: boolean
Access: Read/Write

ModeMaximumIndex

Specify maximum mode index N. Changing this property will set ModeMaximumIndexEnabled to true.

Type: Expression
Access: Read/Write

ModeMaximumIndexEnabled

Specify number of spherical modes. This property is only valid if CalculationEnabled is true.

Type: boolean
Access: Read/Write