config["Boundaries"]
"Boundaries":
{
"PEC":
{
...
},
"PMC":
{
...
},
"Impedance":
[
...
],
"Absorbing":
{
...
},
"Conductivity":
[
...
],
"LumpedPort":
[
...
],
"WavePort":
[
...
],
"WavePortPEC":
{
...
},
"SurfaceCurrent":
[
...
],
"Ground":
{
...
},
"ZeroCharge":
{
...
},
"Terminal":
[
...
],
"Periodic":
[
...
],
"Postprocessing":
{
"SurfaceFlux":
[
...
],
"Dielectric":
[
...
]
}
}
with
"PEC"
: Top-level object for configuring perfect electric conductor (PEC) boundary conditions (zero tangential electric field).
"PMC"
: Top-level object for configuring perfect magnetic conductor (PMC) boundary conditions (zero tangential magnetic field). Also imposes symmetry of the electric field across the boundary surface.
"Impedance"
: Array of objects for configuring surface impedance boundary conditions. A surface impedance boundary relates the tangential electric and magnetic fields on the boundary using a user specified surface impedance.
"Absorbing"
: Top-level object for configuring absorbing boundary conditions. These are artificial scattering boundary conditions at farfield boundaries.
"Conductivity"
: Array of objects for configuring finite conductivity surface impedance boundary conditions. Finite conductivity boundaries are only available for the frequency domain driven simulation type.
"LumpedPort"
: Array of objects for configuring lumped port boundary conditions. Lumped ports can be specified on boundaries which are internal to the computational domain.
"WavePort"
: Array of objects for configuring numeric wave port boundary conditions. Wave ports can only be specified on boundaries which are on the true boundary of the computational domain. Additionally, wave port boundaries are only available for the frequency domain driven simulation type.
"WavePortPEC"
: Top-level object for configuring PEC boundary conditions for boundary mode analysis performed on the wave port boundaries. Thus, this object is only relevant when wave port boundaries are specified under config["Boundaries"]["WavePort"]
.
"SurfaceCurrent"
: Array of objects for configuring surface current boundary conditions. This boundary prescribes a unit source surface current excitation on the given boundary in order to excite a frequency or time domain driven simulation or magnetostatic simulation. For the magnetostatic simulation type, entries of the inductance matrix are extracted corresponding to each surface current boundary.
"Ground"
: Top-level object for specifying ground, or zero voltage, boundary conditions for for electrostatic simulations.
"ZeroCharge"
: Top-level object for specifying zero charge boundary conditions for for electrostatic simulations. Also imposes symmetry of the electric field across the boundary surface.
"Terminal"
: Array of objects for configuring terminal boundary conditions for electrostatic simulations. Entries of the capacitance matrix are extracted corresponding to each terminal boundary.
"Periodic"
: Array of objects for configuring periodic boundary conditions for surfaces with meshes that are identical after a specified translation.
"Postprocessing"
: Top-level object for configuring boundary postprocessing.
"SurfaceFlux"
: Array of objects for postprocessing surface flux.
"Dielectric"
: Array of objects for postprocessing surface interface dielectric loss.
boundaries["PEC"]
"PEC":
{
"Attributes": [<int array>]
}
with
"Attributes" [None]
: Integer array of mesh boundary attributes at which to apply the PEC boundary condition.
boundaries["PMC"]
"PMC":
{
"Attributes": [<int array>]
}
with
"Attributes" [None]
: Integer array of mesh boundary attributes at which to apply the PMC boundary condition.
boundaries["Impedance"]
"Impedance":
[
{
"Attributes": [<int array>],
"Rs": <float>,
"Ls": <float>,
"Cs": <float>
},
...
]
with
"Attributes" [None]
: Integer array of mesh boundary attributes for this surface impedance boundary.
"Rs" [0.0]
: Surface resistance used for computing this surface impedance boundary's impedance per square, $\Omega$/sq.
"Ls" [0.0]
: Surface inductance used for computing this surface impedance boundary's impedance per square, H/sq.
"Cs" [0.0]
: Surface capacitance used computing this surface impedance boundary's impedance per square, F/sq.
boundaries["Absorbing"]
"Absorbing":
{
"Attributes": [<int array>],
"Order": <int>
}
with
"Attributes" [None]
: Integer array of mesh boundary attributes at which to apply farfield absorbing boundary conditions.
"Order" [1]
: Specify a first- or second-order approximation for the farfield absorbing boundary condition. Second-order absorbing boundary conditions are only available for the frequency domain driven simulation type.
boundaries["Conductivity"]
"Conductivity":
[
{
"Attributes": [<int array>],
"Conductivity": <float>,
"Permeability": <float>,
"Thickness": <float>
},
...
]
with
"Attributes" [None]
: Integer array of mesh boundary attributes for this finite conductivity boundary.
"Conductivity" [None]
: Electrical conductivity for this finite conductivity boundary, S/m.
"Permeability" [1.0]
: Relative permeability for this finite conductivity boundary.
"Thickness" [None]
: Optional conductor thickness for this finite conductivity boundary specified in mesh length units. Activates a finite conductivity boundary condition which accounts for nonzero metal thickness.
boundaries["LumpedPort"]
"LumpedPort":
[
{
"Index": <int>,
"Attributes": [<int array>],
"Direction": <string> or [<float array>],
"CoordinateSystem": <string>,
"Excitation": <bool>,
"Active": <bool>,
"R": <float>,
"L": <float>,
"C": <float>,
"Rs": <float>,
"Ls": <float>,
"Cs": <float>,
"Elements":
[
{
"Attributes": <string>,
"Direction": <string> or [<float array>],
"CoordinateSystem": <string>
},
...
]
},
...
]
with
"Index" [None]
: Index of this lumped port, used in postprocessing output files.
"Attributes" [None]
: Integer array of mesh boundary attributes for this lumped port boundary. If this port is to be a multielement lumped port with more than a single lumped element, use the "Elements"
array described below.
"Direction" [None]
: Direction to define the polarization direction of the port field mode on this lumped port boundary. Axis aligned lumped ports can be specified using keywords: "+X"
, "-X"
, "+Y"
, "-Y"
, "+Z"
, "-Z"
, while coaxial lumped ports can be specified using "+R"
, "-R"
. The direction can alternatively be specified as a normalized array of three values, for example [0.0, 1.0, 0.0]
. If a vector direction is specified, the "CoordinateSystem"
value specifies the coordinate system it is expressed in. If this port is to be a multielement lumped port with more than a single lumped element, use the "Elements"
array described below.
"CoordinateSystem" ["Cartesian"]
: Coordinate system used to express the "Direction"
vector, the options are "Cartesian"
and "Cylindrical"
. If a keyword argument is used for "Direction"
this value is ignored, and the appropriate coordinate system is used instead.
"Excitation" [false]
: Turns on or off port excitation for this lumped port boundary for driven or transient simulation types.
"Active" [true]
: Turns on or off damping boundary condition for this lumped port boundary for driven or transient simulation types.
"R" [0.0]
: Circuit resistance used for computing this lumped port boundary's impedance, $\Omega$. This option should only be used along with the corresponding "L"
and "C"
parameters, and not with any of the surface parameters "Rs"
, "Ls"
, or "Cs"
.
"L" [0.0]
: Circuit inductance used for computing this lumped port boundary's impedance, H. This option should only be used along with the corresponding "R"
and "C"
parameters, and not with any of the surface parameters "Rs"
, "Ls"
, or "Cs"
.
"C" [0.0]
: Circuit capacitance used for computing this lumped port boundary's impedance, F. This option should only be used along with the corresponding "R"
and "L"
parameters, and not with any of the surface parameters "Rs"
, "Ls"
, or "Cs"
.
"Rs" [0.0]
: Surface resistance used for computing this lumped port boundary's impedance, $\Omega$/sq. This option should only be used along with the corresponding "Ls"
and "Cs"
parameters, and not with any of the circuit parameters "R"
, "L"
, or "C"
.
"Ls" [0.0]
: Surface inductance used for computing this lumped port boundary's impedance, H/sq. This option should only be used along with the corresponding "Rs"
and "Cs"
parameters, and not with any of the circuit parameters "R"
, "L"
, or "C"
.
"Cs" [0.0]
: Surface capacitance used for computing this lumped port boundary's impedance, F/sq. This option should only be used along with the corresponding "Rs"
and "Ls"
parameters, and not with any of the circuit parameters "R"
, "L"
, or "C"
.
"Elements"[]["Attributes"] [None]
: This option is for multielement lumped ports and should not be combined with the "Attributes"
field described above. Each element of a multielement lumped port can be described by its own unique integer array of mesh boundary attributes, which are specified here. The elements of a multielement port add in parallel.
"Elements"[]["Direction"] [None]
: This option is for multielement lumped ports and should not be combined with the "Direction"
field described above. Each element of a multielement lumped port can be described by its own unique direction, which is specified here. The elements of a multielement port add in parallel.
"Elements"[]["CoordinateSystem"] ["Cartesian"]
: This option is for multielement lumped ports and should not be combined with the "CoordinateSystem"
field described above. Each element of a multielement lumped port can be described by its own unique direction, and corresponding coordinate system.
boundaries["WavePort"]
"WavePort":
[
{
"Index": <int>,
"Attributes": [<int array>],
"Excitation": <bool>,
"Active": <bool>,
"Mode": <int>,
"Offset": <float>,
"SolverType": <string>
},
...
]
with
"Index" [None]
: Index of this wave port boundary, used in postprocessing output files.
"Attributes" [None]
: Integer array of mesh boundary attributes for this wave port boundary.
"Excitation" [false]
: Turns on or off port excitation for this wave port boundary for driven simulation types.
"Active" [true]
: Turns on or off damping boundary condition for this wave port boundary for driven simulation types.
"Mode" [1]
: Mode index (1-based) for the characteristic port mode of this wave port boundary. Ranked in order of decreasing wave number.
"Offset" [0.0]
: Offset distance used for scattering parameter de-embedding for this wave port boundary, specified in mesh length units.
"SolverType" ["Default"]
: Specifies the eigenvalue solver to be used in computing the boundary mode for this wave port. See config["Solver"]["Eigenmode"]["Type"]
.
boundaries["WavePortPEC"]
"WavePortPEC":
{
"Attributes": [<int array>]
}
with
"Attributes" [None]
: Integer array of mesh boundary attributes to consider along with those specified under config["Boundaries"]["PEC"]["Attributes"]
as PEC when performing wave port boundary mode analysis.
boundaries["SurfaceCurrent"]
"SurfaceCurrent":
[
{
"Index": <int>,
"Attributes": [<int array>],
"Direction": <string> or [<float array>],
"CoordinateSystem": <string>,
"Elements":
[
{
"Attributes": [<int array>],
"Direction": <string> or [<float array>],
"CoordinateSystem": <string>,
},
...
]
},
...
]
with
"Index" [None]
: Index of this surface current boundary, used in postprocessing output files.
"Attributes" [None]
: Integer array of mesh boundary attributes for this surface current boundary. If this source is to be a multielement source which distributes the source across more than a single lumped element, use the "Elements"
array described below.
"Direction" [None]
: Defines the source current direction for this surface current boundary. The available options are the same as under config["Boundaries"]["LumpedPort"]["Direction"]
. If this source is to be a multielement source which distributes the source across more than a single lumped element, use the "Elements"
array described below.
"CoordinateSystem" ["Cartesian"]
: Defines the coordinate system for the source current direction for this surface current boundary. The available options are the same as under config["Boundaries"]["LumpedPort"]["CoordinateSystem"]
. If this source is to be a multielement source which distributes the source across more than a single lumped element, use the "Elements"
array described below.
"Elements"[]["Attributes"] [None]
: This option is for multielement surface current boundaries should not be combined with the "Attributes"
field described above. Each element of a multielement current source can be described by its own unique integer array of mesh boundary attributes, which are specified here. The elements of a multielement source add in parallel to give the same total current as a single-element source.
"Elements"[]["Direction"] [None]
: This option is for multielement surface current boundaries and should not be combined with the "Direction"
field described above. Each element of a multielement current source can be described by its own unique direction, which is specified here. The elements of a multielement source add in parallel to give the same total current as a single-element source.
"Elements"[]["CoordinateSystem"] ["Cartesian"]
: This option is for multielement surface current boundaries and should not be combined with the "CoordinateSystem"
field described above. Each element of a multielement current source can be described by its own unique direction, and corresponding coordinate system.
boundaries["Ground"]
"Ground":
{
"Attributes": [<int array>]
}
with
"Attributes" [None]
: Integer array of mesh boundary attributes at which to apply the ground boundary condition.
boundaries["ZeroCharge"]
"ZeroCharge":
{
"Attributes": [<int array>]
}
with
"Attributes" [None]
: Integer array of mesh boundary attributes at which to apply the zero-charge boundary condition.
boundaries["Terminal"]
"Terminal":
[
{
"Index": <int>,
"Attributes": [<int array>],
},
...
]
with
"Index" [None]
: Index of this terminal boundary, used in postprocessing output files and to index the computed capacitance matrix.
"Attributes" [None]
: Integer array of mesh boundary attributes for this terminal boundary.
boundaries["Periodic"]
"Periodic":
[
{
"DonorAttributes": [<int array>],
"ReceiverAttributes": [<int array>],
"Translation": [<float array>]
},
...
]
with
"DonorAttributes" [None]
: Integer array of the donor attributes of the mesh boundary attributes for this periodic boundary.
"ReceiverAttributes" [None]
: Integer array of the receiver attributes of the mesh boundary attributes for this periodic boundary.
"Translation" [None]
: Defines the distance between the donor and receiver attributes in mesh units.
boundaries["Postprocessing"]["SurfaceFlux"]
"Postprocessing":
{
"SurfaceFlux":
[
{
"Index": <int>,
"Attributes": [<int array>],
"Type": <string>,
"TwoSided": <bool>,
"Center": [<float array>]
},
...
]
}
with
"Index" [None]
: Index of this surface flux postprocessing boundary, used in postprocessing output files.
"Attributes" [None]
: Integer array of mesh boundary attributes for this surface flux postprocessing boundary.
"Type" [None]
: Specifies the type of surface flux to calculate for this postprocessing boundary. The available options are:
"Electric"
: Integrate the electric flux density over the boundary surface."Magnetic"
: Integrate the magnetic flux density over the boundary surface."Power"
: Integrate the energy flux density, given by the Poynting vector, over the boundary surface.
"TwoSided" [false]
: Specifies how to account for internal boundary surfaces with a possible discontinuous field on either side. When set to false
, the flux on either side of an internal boundary surface is averaged. When true
, it is summed with an opposite normal direction.
"Center" [None]
: Floating point array of length equal to the model spatial dimension specfiying the coordinates of a central point used to compute the outward flux. The true surface normal is used in the calculation, and this point is only used to ensure the correct orientation of the normal. Specified in mesh length units, and only relevant when "TwoSided"
is false
. If not specified, the point will be computed as the centroid of the axis-aligned bounding box for all elements making up the postprocessing boundary.
boundaries["Postprocessing"]["Dielectric"]
"Postprocessing":
{
"Dielectric":
[
{
"Index": <int>,
"Attributes": [<int array>],
"Type": <string>,
"Thickness": <float>,
"Permittivity": <float>,
"LossTan": <float>
},
...
]
}
with
"Index" [None]
: Index of this dielectric interface, used in postprocessing output files.
"Attributes" [None]
: Integer array of mesh boundary attributes for this dielectric interface.
"Type" [None]
: Specifies the type of dielectric interface for this postprocessing boundary. See also this page. Available options are:
"Default"
: Use the full electric field evaulated at the boundary to compute the energy participation ratio (EPR) of this dielectric interface and estimate loss."MA"
: Use the boundary conditions assuming a metal-air interface to compute the EPR of this dielectric interface."MS"
: Use the boundary conditions assuming a metal-substrate interface to compute the EPR of this dielectric interface."SA"
: Use the boundary conditions assuming a substrate-air interface to compute the EPR of this dielectric interface.
"Thickness" [None]
: Thickness of this dielectric interface, specified in mesh length units.
"Permittivity" [None]
: Relative permittivity for this dielectric interface. This should be the interface layer permittivity for the specific "Type"
of interface specified.
"LossTan" [0.0]
: Loss tangent for this lossy dielectric interface.