FDTDBoundaryConditions

An FDTDBoundaryConditions request.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]])

    -- Enable the FDTD solver
    
project.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true

    -- Access the 'FDTDBoundaryConditions' object and adjust the PositiveX boundary 

project.SolutionSettings.FDTDBoundary.PositiveX.BoundaryType = 
    cf.Enums.BoundaryFaceDefinitionEnum.PEC

Usage locations (object properties)

The following objects have properties using the FDTDBoundaryConditions object:

Property List

NegativeX
The -X boundary settings. (Read only FDTDBoundarySettings)
NegativeY
The -Y boundary settings. (Read only FDTDBoundarySettings)
NegativeZ
The bottom (-Z) boundary settings. (Read only FDTDBoundarySettings)
PositiveX
The +X boundary settings. (Read only FDTDBoundarySettings)
PositiveY
The +Y boundary settings. (Read only FDTDBoundarySettings)
PositiveZ
The top (+Z) boundary settings. (Read only FDTDBoundarySettings)
Type
The object type string. (Read only string)

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

NegativeX
The -X boundary settings.
Type
FDTDBoundarySettings
Access
Read only
NegativeY
The -Y boundary settings.
Type
FDTDBoundarySettings
Access
Read only
NegativeZ
The bottom (-Z) boundary settings.
Type
FDTDBoundarySettings
Access
Read only
PositiveX
The +X boundary settings.
Type
FDTDBoundarySettings
Access
Read only
PositiveY
The +Y boundary settings.
Type
FDTDBoundarySettings
Access
Read only
PositiveZ
The top (+Z) boundary settings.
Type
FDTDBoundarySettings
Access
Read only
Type
The object type string.
Type
string
Access
Read only

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.