SolutionSettings

The model solution settings.

Example

application = cf.Application.GetInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]]})

    -- Access the 'SolutionSettings' object and set the X plane symmetry to geometric

project.Contents.SolutionSettings.ModelSymmetry.PlaneX = cf.Enums.ModelSymmetryTypeEnum.Geometric

Inheritance

The SolutionSettings object is derived from the Object object.

Usage locations

The SolutionSettings object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
FDTDBoundary
The finite difference time domain boundary settings. (Read only FDTDBoundaryConditions)
GroundPlane
Planar Green's functions and ground planes in the model. (Read only GroundPlane)
Label
The object label. (Read/Write string)
ModelSymmetry
The model symmetry planes. (Read only ModelSymmetry)
NumericalGreensFunction
The numerical Green's function (NGF) settings. (Read only NumericalGreensFunction)
PeriodicBoundary
The periodic boundary condition (PBC) for the model. (Read only PeriodicBoundary)
SolverSettings
The solver solution settings of the model. (Read only SolverSettings)
Type
The object type string. (Read only string)

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

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
FDTDBoundary
The finite difference time domain boundary settings.
Type
FDTDBoundaryConditions
Access
Read only
GroundPlane
Planar Green's functions and ground planes in the model.
Type
GroundPlane
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
ModelSymmetry
The model symmetry planes.
Type
ModelSymmetry
Access
Read only
NumericalGreensFunction
The numerical Green's function (NGF) settings.
Type
NumericalGreensFunction
Access
Read only
PeriodicBoundary
The periodic boundary condition (PBC) for the model.
Type
PeriodicBoundary
Access
Read only
SolverSettings
The solver solution settings of the model.
Type
SolverSettings
Access
Read only
Type
The object type string.
Type
string
Access
Read only

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.