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

application = cf.Application.GetInstance()
project = application:NewProject()

dielectric = project.Definitions.Media.Dielectric:AddDielectric()

    -- Modify the ground plane

project.Contents.SolutionSettings.GroundPlane.DefinitionMethod = cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate
layer = project.Contents.SolutionSettings.GroundPlane.Layers:Append()
layer.Medium = dielectric
layer.GroundBottom = cf.Enums.GroundBottomTypeEnum.None
layer.Thickness = 0.1

Inheritance

The GroundPlane object is derived from the Object object.

Usage locations

The GroundPlane object can be accessed from the following locations:

Property List

DefinitionMethod
Infinite plane/ground definition method (environment type). (Read/Write GroundPlaneDefinitionMethodEnum)
Label
The object label. (Read/Write string)
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. (Read/Write PlanarSubstrateList)
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)
ZValue
Z value at the top of layer 1. This property is only valid when the DefinitionMethod is MultilayerSubstrate. (Read/Write ParametricExpression)

Method List

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
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 Object)
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.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

DefinitionMethod
Infinite plane/ground definition method (environment type).
Type
GroundPlaneDefinitionMethodEnum
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
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
PlanarSubstrateList
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
ZValue
Z value at the top of layer 1. This property is only valid when the DefinitionMethod is MultilayerSubstrate.
Type
ParametricExpression
Access
Read/Write

Method Details

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
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 table defining the properties.
SetProperties (properties Object)
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(Object)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.