Boundary Object
Represents the boundary condition of the calculation domain for each boundary plane. You may either have a magnetic, electric or an open boundary condition.
Xmin ( enum boundaryType )
Xmax ( enum boundaryType )
Ymin ( enum boundaryType )
Ymax ( enum boundaryType )
Zmin ( enum boundaryType )
Zmax ( enum boundaryType )
GetXmin enum boundaryType
GetXmax enum boundaryType
GetYmin enum boundaryType
GetYmax enum boundaryType
GetZmin enum boundaryType
GetZmax enum boundaryType
Xmin, Xmax, Ymin, Ymax, Zmin and Zmax specifiy the boundary conditions for the lower or upper x, y or z calculation domain boundary respectively.
GetXmin, GetXmax, GetYmin, GetYmax, GetZmin, GetZmax return the boundary conditions at the lower or upper x, y or z calculation domain boundary respectively.
boundaryType can have one of the following values:
|
”electric” |
Electric boundary condition (Etan = 0) |
|
”magnetic” |
Magnetic boundary condition (Htan = 0) |
|
"tangential" |
All tangential field components for all sorts of fields are zero. |
|
"normal" |
All normal field components for all sorts of fields are zero. |
|
”open” |
Simulates the open space. |
Xsymmetry ( enum symmetryType )
Ysymmetry ( enum symmetryType )
Zsymmetry ( enum symmetryType )
GetXSymmetry enum symmetryType
GetYSymmetry enum symmetryType
GetZSymmetry enum symmetryType
Xsymmetry, Ysymmetry and Zsymmetry define if the structure is electrically or magnetically symmetric regarding the origin of the x, y or z-axis respectively.
GetXSymmetry, GetYSymmetry and GetZSymmetry return the currently set symmetry type for the x, y or z-symmetry plane respectively.
symmetryType can have one of the following values:
|
”electric” |
All tangential E-fields are considered zero at the symmetry plane. |
|
”magnetic” |
All tangential H-fields are considered zero at the symmetry plane. |
|
”none” |
No symmetry. |
ApplyInAllDirections ( bool switch )
Is used by the background dialog to identify if the Xmin value should be applied in all the other directions.
XminPotentialType ( enum type )
XmaxPotentialType ( enum type )
YminPotentialType ( enum type )
YmaxPotentialType ( enum type )
ZminPotentialType ( enum type )
ZmaxPotentialType ( enum type )
Specifies the potential type of the lower and upper boundaries. The setting of a potential value is only enabled if the type of the boundary is set to "normal" or "electric". The potential type can have one of the following values:
|
”none” |
No potential is considered on the corresponding boundary. |
|
”fixed” |
On the boundaries a fixed potential can be defined by use of the corresponding Potential methods (see below). |
|
”floating” |
The potential is defined as floating on the corresponding boundary. |
XminPotential ( double potvalue )
YminPotential ( double potvalue )
ZminPotential ( double potvalue )
XmaxPotential ( double potvalue )
YmaxPotential ( double potvalue )
ZmaxPotential ( double potvalue )
Specifies the potential values of the lower and upper boundaries. The setting of a potential value has only an effect if the type of the boundary is set to "normal" or "electric" and the corresponding PotentialType is set to "fixed".
GetCalculationBox ( double_ref xmin, double_ref xmax, double_ref ymin, double_ref ymax, double_ref zmin, double_ref zmax )
Returns the bounding box the calculation domain. The minimum and maximum values of the bounding box of the calculation domain regarding the x, y and z direction are stored in the parameters xmin, xmax, ymin, ymax, zmin, zmax respectively.
SetPeriodicBoundaryAnglesDirection ( enum direction )
direction defines whether the scan angle defined with SetPeriodicBoundaryAngles refers to an inward or outward (with respect to the radial unit vector in the spherical coordinate system) propagating plane wave, and can have one of the following values:
|
”outward” |
The phase is set for an outward traveling plane wave. Floquet modes should be excited at Zmin. |
|
”inward” |
The phase is set for an inward traveling plane wave. Floquet modes should be excited at Zmax. |
GetUnitCellScanAngle ( double_ref theta, double_ref phi, long_ref direction ) valid
The scan angle defined with SetPeriodicBoundaryAngles and its orientation as defined by calling SetPeriodicBoundaryAnglesDirection can be accessed using this function. All arguments of this function are output values, which are set by the function. Its return value is True if the unit cell is active and the expressions for the scan angle are valid. If direction is +1, then it refers to the ”outward” direction, and to the ”inward” direction if direction is -1.
Xmin ("electric")
Xmax ("electric")
Ymin ("electric")
Ymax ("electric")
Zmin ("electric")
Zmax ("electric")
Xsymmetry ("none")
Ysymmetry ("none")
Zsymmetry ("none")
ApplyInAllDirections (False)
XminPotentialType ("none")
XmaxPotentialType ("none")
YminPotentialType ("none")
YmaxPotentialType ("none")
ZminPotentialType ("none")
ZmaxPotentialType ("none")
With Boundary
.Xmin ("electric")
.Xmax ("electric")
.Ymin ("electric")
.Ymax ("electric")
.Zmin ("electric")
.Zmax ("electric")
.Xsymmetry ("none")
.Ysymmetry ("none")
.Zsymmetry ("none")
.ApplyInAllDirections (False)
.XminPotential ""
.XmaxPotential ""
.YminPotential ""
.YmaxPotential ""
.ZmaxPotential ""
End With