WaveguideModeOptions

The waveguide mode properties.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Create a waveguide port

cuboid = project.Contents.Geometry:AddCuboid(cf.Point(-1,1,0), 1, 1, 1)
cuboid.Regions[1].Medium = project.Definitions.Media.FreeSpace

waveguidePort = project.Contents.Ports:AddWaveguidePort(cuboid.Faces[1])

    -- Add a waveguide source to the waveguide port

source = project.Contents.SolutionConfigurations.GlobalSources:AddWaveguideSource(waveguidePort)

    -- Specify the mode manually
    -- A properties table is used as the changes need to be
    -- made in one step

properties = source:GetProperties()
properties.SourceDefinitionType = cf.Enums.WaveguideSourceDefinitionTypeEnum.SpecifyModesManually
properties.ManuallySpecifiedModesProperties[1].WaveguideModeType =
    cf.Enums.SParameterWaveguideModeTypeEnum.TE
properties.ManuallySpecifiedModesProperties[1].IndexM = 1
properties.ManuallySpecifiedModesProperties[1].IndexN = 1
properties.ManuallySpecifiedModesProperties[1].Magnitude = 1
properties.ManuallySpecifiedModesProperties[1].Phase = 0
source:SetProperties(properties)

Inheritance

The WaveguideModeOptions object is derived from the CompositeValue object.

Usage locations

The WaveguideModeOptions object can be accessed from the following locations:

Property List

IndexM
The waveguide mode M index. (Read/Write ParametricExpression)
IndexN
The waveguide mode N index. (Read/Write ParametricExpression)
Magnitude
The waveguide mode magnitude (V). (Read/Write ParametricExpression)
Phase
The waveguide mode phase (degrees). (Read/Write ParametricExpression)
Rotation
The waveguide mode rotation (degrees). (Read/Write ParametricExpression)
WaveguideModeType
The waveguide mode type. (Read/Write SParameterWaveguideModeTypeEnum)

Property Details

IndexM
The waveguide mode M index.
Type
ParametricExpression
Access
Read/Write
IndexN
The waveguide mode N index.
Type
ParametricExpression
Access
Read/Write
Magnitude
The waveguide mode magnitude (V).
Type
ParametricExpression
Access
Read/Write
Phase
The waveguide mode phase (degrees).
Type
ParametricExpression
Access
Read/Write
Rotation
The waveguide mode rotation (degrees).
Type
ParametricExpression
Access
Read/Write
WaveguideModeType
The waveguide mode type.
Type
SParameterWaveguideModeTypeEnum
Access
Read/Write