OptimisationSearch

An optimisation search object.

Example

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

    -- Add an optimisation using the grid search algorithm

search = project.Optimisation.Searches:Add(cf.Enums.OptimisationMethodTypeEnum.GridSearch)

    -- Set the number of points used in the grid search to 20
    
search.NumberOfPoints = 20

Property List

Advanced
Advanced properties for the optimisation search. (Read only OptimisationSearchAdvancedSettings)
ConvergenceAccuracy
Set the convergence rate. Only applies if the MethodType is set to AutoMethod, ParticleSwarmOptimisation, GeneticAlgorithm, Simplex or AdaptiveResponseSurfaceMethod. (Read/Write OptimisationConvergenceAccuracyEnum)
Label
The object label. (Read/Write string)
MethodType
Set the search algorithm. (Read/Write OptimisationMethodTypeEnum)
NumberOfPoints
Specify the default number of points to be used in the grid search. Only applies if the MethodType is set to GridSearch. (Read/Write Expression)
Parameters
The parameters of the optimisation. (Read only OptimisationParameters)
SearchActive
Indicates if this is an active search. (Read only boolean)
Type
The object type string. (Read only string)

Collection List

Goals
A collection of optimisation goals. (OptimisationGoalCollection of OptimisationOperator.)

Method List

Delete ()
Deletes the search.
Duplicate ()
Duplicates the search. (Returns a OptimisationSearch 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.)
SetActive ()
Set the search to the currently active search.
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.

Static Function List

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

Property Details

Advanced
Advanced properties for the optimisation search.
Type
OptimisationSearchAdvancedSettings
Access
Read only
ConvergenceAccuracy
Set the convergence rate. Only applies if the MethodType is set to AutoMethod, ParticleSwarmOptimisation, GeneticAlgorithm, Simplex or AdaptiveResponseSurfaceMethod.
Type
OptimisationConvergenceAccuracyEnum
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
MethodType
Set the search algorithm.
Type
OptimisationMethodTypeEnum
Access
Read/Write
NumberOfPoints
Specify the default number of points to be used in the grid search. Only applies if the MethodType is set to GridSearch.
Type
Expression
Access
Read/Write
Parameters
The parameters of the optimisation.
Type
OptimisationParameters
Access
Read only
SearchActive
Indicates if this is an active search.
Type
boolean
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Collection Details

Goals
A collection of optimisation goals.
Type
OptimisationGoalCollection

Method Details

Delete ()
Deletes the search.
Duplicate ()
Duplicates the search.
Return
OptimisationSearch
A duplicate optimisation search.
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.
SetActive ()
Set the search to the currently active search.
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.

Static Function Details

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