PlaneWave

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

Example

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

    -- Create a plane wave source

planeWave = project.Contents.SolutionConfigurations.GlobalSources:AddPlaneWave(0,0)

Inheritance

The PlaneWave object is derived from the Source object.

Usage locations

The PlaneWave object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
CalculateOrthogonalPolarisationsEnabled
Calculate orthogonal polarisations. (Read/Write boolean)
DefinitionMethod
The plane wave definition method. (Read/Write PlaneWaveDefinitionMethodEnum)
Ellipticity
Ellipticity (between 0 and 1). (Read/Write ParametricExpression)
Label
The object label. (Read/Write string)
LocalWorkplane
The source workplane. (Read/Write LocalWorkplane)
Magnitude
The source magnitude (V/m). (Read/Write ParametricExpression)
Phase
The source phase (degrees). (Read/Write ParametricExpression)
Phi
The phi range of points. (Read/Write PointAngleRange)
PolarisationAngle
The polarisation angle (degrees). (Read/Write ParametricExpression)
PolarityType
The plane wave type specified by the PlaneWavePolarityTypeEnum, e.g. LeftHand, Linear, etc. (Read/Write PlaneWavePolarityTypeEnum)
Theta
The theta range of points. (Read/Write PointAngleRange)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Collection List

Transforms
The collection of transforms on the operator. (TransformCollection of Transform.)

Method List

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry. (Returns a List of Object object.)
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object 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 Object)
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

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
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
ParametricExpression
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Read/Write
Magnitude
The source magnitude (V/m).
Type
ParametricExpression
Access
Read/Write
Phase
The source phase (degrees).
Type
ParametricExpression
Access
Read/Write
Phi
The phi range of points.
Type
PointAngleRange
Access
Read/Write
PolarisationAngle
The polarisation angle (degrees).
Type
ParametricExpression
Access
Read/Write
PolarityType
The plane wave type specified by the PlaneWavePolarityTypeEnum, e.g. LeftHand, Linear, etc.
Type
PlaneWavePolarityTypeEnum
Access
Read/Write
Theta
The theta range of points.
Type
PointAngleRange
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the geometry must be shown or hidden.
Type
boolean
Access
Read/Write

Collection Details

Transforms
The collection of transforms on the operator.
Type
TransformCollection

Method Details

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
List of Object
The mirrored geometry.
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of rotated geometry.
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry.
Input Parameters
origin(Point)
The coordinates of the origin of the rotation.
rotationaxis(Vector)
The axis of rotation.
angle(number)
The angle of rotation (degrees).
count(number)
The number of copies.
Return
List of Object
The list of rotated geometry.
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of translated geometry.
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry.
Input Parameters
from(Point)
Translate from coordinate.
to(Point)
Translate to coordinate.
count(number)
The number of copies.
Return
List of Object
The list of translated geometry.
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (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 table defining the properties.
SetProperties (properties Object)
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(Object)
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
A table containing the default properties.