AssignPlaneWave

Creates an incident plane wave excitation.

UI Access HFSS > Excitations > Assign > Incident Wave > Plane Wave...
Parameters
Name Type Description
<PlaneWaveArray> Array Structured array.

Array("NAME:<Name of incident wave>",

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

"IsCartesian:=", <boolean>,

"EoX:=", "<numeric value>",

"EoY:=", "<numeric value>",

"EoZ:=", "<numeric value>",

"kX:=", "<numeric value>",

"kY:=", "<numeric value>",

"kZ:=", "<numeric value>",

"PhiStart:=",<value>,

"PhiStop:=", <value>,

"PhiPoints:=", <int>,

"ThetaStart:=", <value>,

"ThetaStop:=", <value>,

"ThetaPoints:=", <integer>,

"EoPhi:=", <value>,

"EoTheta:=", <value>,

"OriginX:=", "<numUnit>",

"OriginY:=", "<numUnit>",

"OriginZ:=", "<numUnit>",

"IsPropagating:=", <boolean>,

"IsEvanescent:=", <boolean>,

"IsEllipticallyPolarized:=", <boolean>,

"RealPropConst:=", "<value>",

"ImagPropConst:=", "<value>",

"PolarizationAngle:=", "<value>deg",

"PolarizationRatio:=" , "<value>")

IsCartesian:

  • True - provide the EoX, EoY, EoZ, kX, kY, kZ parameters.
  • False - provide the PhiStart, PhiStop, PhiPoints, ThetaStart, ThetStop, ThetaPoints, EoPhi, EoTheta parameters.

IsEvanescent:

  • True - provide the RealPropConst, ImagPropConst.

IsEllipticallyPolarized:

  • True - provide the PolarizationAngle, PolarizationRatio.
Return Value None.

 

Python Syntax AssignPlaneWave(<PlaneWaveArray>)
Python Example 
oModule.AssignPlaneWave(
["NAME:IncPWave1",
"Faces:="		, [9],
"IsCartesian:="		, True,
"EoX:="			, "1",
"EoY:="			, "0",
"EoZ:="			, "0",
"kX:="			, "0",
"kY:="			, "0",
"kZ:="			, "1",
"OriginX:="		, "0mm",
"OriginY:="		, "0mm",
"OriginZ:="		, "0mm",
"IsPropagating:="	, True,
"IsEvanescent:="	, False,
"IsEllipticallyPolarized:=", False
])
oModule.AssignPlaneWave(
["NAME:IncPWave2",
"Faces:="		, [8],
"IsCartesian:="		, False,
"PhiStart:="		, "0deg",
"PhiStop:="		, "0deg",
"PhiPoints:="		, 1,
"ThetaStart:="		, "0deg",
"ThetaStop:="		, "0deg",
"ThetaPoints:="		, 1,
"EoPhi:="		, "1",
"EoTheta:="		, "0",
"OriginX:="		, "0mm",
"OriginY:="		, "0mm",
"OriginZ:="		, "0mm",
"IsPropagating:="	, False,
"IsEvanescent:="	, True,
"IsEllipticallyPolarized:=", False,
"RealPropConst:="	, "0",
"ImagPropConst:="	, "1"
])

 

VB Syntax AssignPlaneWave <PlaneWaveArray>
VB Example 
oModule.AssignPlaneWave Array("NAME:IncPWave3", _
"Faces:=", Array(8), _
"IsCartesian:=",  true, _
"EoX:=", "1", "EoY:=", "0", "EoZ:=", "0", _
"kX:=", "0", "kY:=", "0", "kZ:=",  "1", _
"OriginX:=", "0mm", "OriginY:=", "0mm", "OriginZ:=", "0mm", _
"IsPropagating:=",  false, _
"IsEvanescent:=", false, _
"IsEllipticallyPolarized:=", true, _
"PolarizationAngle:=",  "0deg", "PolarizationRatio:=", "1")