SolverSettings

The solution solver settings.

Example

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

    -- Activate the finite difference time domain solver

project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true

Inheritance

The SolverSettings object is derived from the Object object.

Usage locations

The SolverSettings object can be accessed from the following locations:

Property List

AdvancedSettings
Advanced solver settings. (Read/Write AdvancedSolverSettings)
DomainDecompositionSettings
Domain decomposition solver settings. (Read/Write DomainDecompositionSettings)
FDTDSettings
Settings for the finite difference time domain solver. (Read/Write FDTDSettings)
FEMSettings
FEM settings. (Read/Write FEMSettings)
GeneralSettings
General solution solver settings. (Read/Write GeneralSolverSettings)
HighFrequencySettings
High frequency solver settings. (Read/Write HighFrequencySettings)
IntegralEquation
Integral equation solver settings. (Read/Write IntegralEquation)
Label
The object label. (Read/Write string)
MLFMMACASettings
MLFMM / ACA settings. (Read/Write MLFMMACASettings)
PreconditionerSettings
Preconditioner solver settings. (Read/Write PreconditionerSettings)
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

AdvancedSettings
Advanced solver settings.
Type
AdvancedSolverSettings
Access
Read/Write
DomainDecompositionSettings
Domain decomposition solver settings.
Type
DomainDecompositionSettings
Access
Read/Write
FDTDSettings
Settings for the finite difference time domain solver.
Type
FDTDSettings
Access
Read/Write
FEMSettings
FEM settings.
Type
FEMSettings
Access
Read/Write
GeneralSettings
General solution solver settings.
Type
GeneralSolverSettings
Access
Read/Write
HighFrequencySettings
High frequency solver settings.
Type
HighFrequencySettings
Access
Read/Write
IntegralEquation
Integral equation solver settings.
Type
IntegralEquation
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
MLFMMACASettings
MLFMM / ACA settings.
Type
MLFMMACASettings
Access
Read/Write
PreconditionerSettings
Preconditioner solver settings.
Type
PreconditionerSettings
Access
Read/Write
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.