SphericalModeOptions
For manual specification, each mode must be defined separately per specification entry.
Example
application = cf.Application.GetInstance() project = application:NewProject() properties = cf.SphericalModeDataManuallySpecified.GetDefaultProperties() properties.ModeIndices[1].SphericalMJ = "1" properties.ModeIndices[1].SphericalMagnitude = "3" properties.ModeIndices[1].SphericalN = "2" properties.ModeIndices[1].SphericalPhase = "4" fieldData = project.Definitions.FieldDataList:AddSphericalModeDataManuallySpecified(properties) -- Modify the first spherical mode sphericalModeIndexProp = fieldData:GetProperties() sphericalModeIndexProp.ModeIndices[1].TeTmType = cf.Enums.SphericalModeDataTeTmTypeMethodEnum.Empty sphericalModeIndexProp.ModeIndices[1].IndexSchemeType = cf.Enums.SphericalModeDataIndexSchemeMethodEnum.Compressed fieldData:SetProperties(sphericalModeIndexProp)
Inheritance
The SphericalModeOptions object is derived from the CompositeValue object.
Usage locations
The SphericalModeOptions object can be accessed from the following locations:
- Methods
- SphericalModeOptionsList object has method Append().
- SphericalModeOptionsList object has method Get(number).
Property List
- IndexSchemeType
- Index scheme for this specific spherical mode. (Read/Write SphericalModeDataIndexSchemeMethodEnum)
- SphericalMJ
- The M mode index which is in the azimuth direction for this specific spherical mode. (Read/Write ParametricExpression)
- SphericalMagnitude
- Absolute value of the complex amplitude of this specific spherical mode. (Read/Write ParametricExpression)
- SphericalN
- The N mode index which is in radial direction for this specific spherical mode. (Read/Write ParametricExpression)
- SphericalPhase
- The phase of the complex amplitude of this spherical mode in degrees. (Read/Write ParametricExpression)
- TeTmType
- Select either the TE or TM mode for this specific spherical mode. (Read/Write SphericalModeDataTeTmTypeMethodEnum)
Property Details
- IndexSchemeType
- Index scheme for this specific spherical mode.
- Type
- SphericalModeDataIndexSchemeMethodEnum
- Access
- Read/Write
- SphericalMJ
- The M mode index which is in the azimuth direction for this specific spherical mode.
- Type
- ParametricExpression
- Access
- Read/Write
- SphericalMagnitude
- Absolute value of the complex amplitude of this specific spherical mode.
- Type
- ParametricExpression
- Access
- Read/Write
- SphericalN
- The N mode index which is in radial direction for this specific spherical mode.
- Type
- ParametricExpression
- Access
- Read/Write
- SphericalPhase
- The phase of the complex amplitude of this spherical mode in degrees.
- Type
- ParametricExpression
- Access
- Read/Write
- TeTmType
- Select either the TE or TM mode for this specific spherical mode.
- Type
- SphericalModeDataTeTmTypeMethodEnum
- Access
- Read/Write