AssignIncidentWave

Creates an incident wave excitation.

UI Access N/A
Parameters
Name Type Description
<IncidentWaveArray> Array Structured array.

Array("NAME:<BoundName>",

"Faces:=", <array of face IDs>,

"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 AssignIncidentWave (<IncidentWaveArray>)
Python Example 
oModule.AssignIncidentWave(["NAME:IncWave1",
"Faces:=", [9],
"IsCartesian:=", True,
"EoX:=", "1", "EoY:=", "0", "EoZ:=", "0", 
"kX:=", "0", "kY:=", "0", "kZ:=", "1",
"IsPropagating:=", True,
"IsEvanescent:=", False,
"IsEllipticallyPolarized:=", False]
)
oModule.AssignIncidentWave(["NAME:IncWave2",
"Faces:=", [9],
"IsCartesian:=", False, 
"PhiStart:=","0deg", 
"PhiStop:=", "90deg", 
"PhiPoints:=", 2, 
"ThetaStart:=", "0deg", 
"ThetaStop:=", "180deg",
"ThetaPoints:=", 3,
"EoPhi:=", "1", "EoTheta:=", "0",
"IsPropagating:=", True,
"IsEvanescent:=", False,
"IsEllipticallyPolarized:=", False
])