PlaneWave

A plane wave may be defined as a source in a model.

Example

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

    -- Create a plane wave source
    
configuration = project.SolutionConfigurations[1]
planeWave = configuration.Sources:AddPlaneWave(0,0)

Inheritance

The PlaneWave object is derived from the SolutionEntity object.

Property List

CalculateOrthogonalPolarisationsEnabled
Calculate orthogonal polarisations. (Read/Write boolean)
DefinitionMethod
The plane wave definition method. (Read/Write PlaneWaveDefinitionMethodEnum)
Ellipticity
Ellipticity (between 0 and 1). (Read/Write Expression)
EndPhi
The end phi angle (degrees). (Read/Write Expression)
EndTheta
The end theta angle (degrees). (Read/Write Expression)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
LocalWorkplane
The plane wave workplane. (Read only LocalWorkplane)
Magnitude
The source magnitude (V/m). (Read/Write Expression)
Phase
The source phase (degrees). (Read/Write Expression)
PhiIncrement
The phi angle increment (degrees). (Read/Write Expression)
PolarisationAngle
The polarisation angle (degrees). (Read/Write Expression)
PolarityType
The plane wave type specified by the PlaneWavePolarityTypeEnum, e.g. LeftHand, Linear, etc. (Read/Write PlaneWavePolarityTypeEnum)
StartPhi
The start phi angle (degrees). (Read/Write Expression)
StartTheta
The start theta angle (degrees). (Read/Write Expression)
ThetaIncrement
The theta angle increment (degrees). (Read/Write Expression)
Type
The object type string. (Read only string)
Visible
Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)

Method List

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity. (Returns a SolutionEntity object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

CalculateOrthogonalPolarisationsEnabled
Calculate orthogonal polarisations.
Type
boolean
Access
Read/Write
DefinitionMethod
The plane wave definition method.
Type
PlaneWaveDefinitionMethodEnum
Access
Read/Write
Ellipticity
Ellipticity (between 0 and 1).
Type
Expression
Access
Read/Write
EndPhi
The end phi angle (degrees).
Type
Expression
Access
Read/Write
EndTheta
The end theta angle (degrees).
Type
Expression
Access
Read/Write
Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The plane wave workplane.
Type
LocalWorkplane
Access
Read only
Magnitude
The source magnitude (V/m).
Type
Expression
Access
Read/Write
Phase
The source phase (degrees).
Type
Expression
Access
Read/Write
PhiIncrement
The phi angle increment (degrees).
Type
Expression
Access
Read/Write
PolarisationAngle
The polarisation angle (degrees).
Type
Expression
Access
Read/Write
PolarityType
The plane wave type specified by the PlaneWavePolarityTypeEnum, e.g. LeftHand, Linear, etc.
Type
PlaneWavePolarityTypeEnum
Access
Read/Write
StartPhi
The start phi angle (degrees).
Type
Expression
Access
Read/Write
StartTheta
The start theta angle (degrees).
Type
Expression
Access
Read/Write
ThetaIncrement
The theta angle increment (degrees).
Type
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the solution entity must be shown or hidden.
Type
boolean
Access
Read/Write

Method Details

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity.
Return
SolutionEntity
The duplicated entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
The default properties table.