EditIncidentWave

Modifies an incident wave excitation.

UI Access

Double-click the excitation in the project tree to modify its settings.

Parameters

Name

Type

Description

<BoundaryName>

String

Name of the incident wave excitation to be edited.

<IncidentWaveArray>

Array

Structured array.

Array("NAME:<BoundName>",

"IsCartesian:=",<boolean>,

"EoX:=", <value>,

"EoY:=", <value>,

"EoZ:=", <value>,

"kX:=", <value>,

"kY:=", <value>,

"kZ:=", <value>

"PhiStart:=",<value>,

"PhiStop:=", <value>,

"PhiPoints:=", <int>,

"ThetaStart:=", <value>,

"ThetaStop:=", <value>,

"ThetaPoints:=", <int>,

"EoPhi:=", <value>,

"EoTheta:=", <value>,

"IsPropagating:=", <boolean>,

"IsEvanescent:=", <boolean>,

"IsEllipticallyPolarized:=", <boolean>)

IsCartesian

If true, provide the EoX, EoY, EoZ, kX, kY, kZ parameters.

If false, provide the PhiStart, PhiStop, PhiPoints, ThetaStart, ThetStop, ThetaPoints, EoPhi, EoTheta parameters.

Return Value

None.

Python Syntax

EditIncidentWave(<BoundaryName>, <IncidentWaveArray>)

Python Example

oModule.EditIncidentWave("IncWave1", 
["NAME:IncWave1After",
"IsCartesian:=", True,
"EoX:=", "1", "EoY:=", "0", "EoZ:=", "0", 
"kX:=", "0", "kY:=", "0", "kZ:=", "1",
"IsPropagating:=", True,
"IsEvanescent:=", False,
"IsEllipticallyPolarized:=", False])