GroundPlane

The model's infinite plane/ground. The following may be defined: PEC, PMC ground planes, homogeneous half space and planar multilayer substrate (finite and infinite).

Example

app = cf.GetApplication()
project = app:NewProject()

dielectric = project.Media:AddDielectric()

    -- Modify the ground plane
    
groundPlane = project.GroundPlane
groundPlane.Layers:Add(2,cf.Enums.GroundBottomTypeEnum.None,0.1,dielectric)
groundPlane.DefinitionMethod = cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate

Usage locations (object properties)

The following objects have properties using the GroundPlane object:

Property List

DefinitionMethod
Infinite plane/ground definition method (environment type). (Read/Write GroundPlaneDefinitionMethodEnum)
Medium
The ground medium for homogeneous half space in region Z < 0. This property is only valid when the DefinitionMethod is HalfspaceReflectionCoefficient or HalfspaceSommerfeld. (Read/Write Medium)
Type
The object type string. (Read only string)
Visible
Specifies whether the infinite plane/ground must be shown or hidden. (Read/Write boolean)
ZValue
Z value at the top of layer 1. This property is only valid when the DefinitionMethod is MultilayerSubstrate. (Read/Write Expression)

Collection List

Layers
The collection of planar layers for the multilayer substrate. Only applies when the DefinitionMethod is MultilayerSubstrate. By default three layers are created where the top and bottom layers are infinitely thick. (PlanarSubstrateCollection of PlanarSubstrate.)

Method List

GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Property Details

DefinitionMethod
Infinite plane/ground definition method (environment type).
Type
GroundPlaneDefinitionMethodEnum
Access
Read/Write
Medium
The ground medium for homogeneous half space in region Z < 0. This property is only valid when the DefinitionMethod is HalfspaceReflectionCoefficient or HalfspaceSommerfeld.
Type
Medium
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the infinite plane/ground must be shown or hidden.
Type
boolean
Access
Read/Write
ZValue
Z value at the top of layer 1. This property is only valid when the DefinitionMethod is MultilayerSubstrate.
Type
Expression
Access
Read/Write

Collection Details

Layers
The collection of planar layers for the multilayer substrate. Only applies when the DefinitionMethod is MultilayerSubstrate. By default three layers are created where the top and bottom layers are infinitely thick.
Type
PlanarSubstrateCollection

Method Details

GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.