OptimisationCombination

A combined set of goals where only the minimum, maximum or average value of all of the errors of all of the goals in the set is taken.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Optimisation.cfx]])
search = project.Optimisation.Searches["Search1"]

    -- Combine all the optimisation goals

goals = search.Goals:Items()
properties = cf.OptimisationCombination.GetDefaultProperties()
combinedGoal = search.Goals:AddCombinedGoal(properties, goals)

    -- Set the combination type to use only the maximum value of the combined goals
    
combinedGoal.CombineType = cf.Enums.OptimisationCombineTypeEnum.Maximum

Inheritance

The OptimisationCombination object is derived from the OptimisationOperator object.

Property List

CombineType
The combination type that specifies how the evaluated errors of the goals in the combination should be reduced to one error value. (Read/Write OptimisationCombineTypeEnum)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)
Weight
Weight associated with the combine. (Read/Write Expression)

Collection List

Goals
A collection of combined optimisation goals. (OptimisationCombinationCollection of OptimisationOperator.)

Method List

Delete ()
Deletes the combined goal.
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.

Static Function List

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

Property Details

CombineType
The combination type that specifies how the evaluated errors of the goals in the combination should be reduced to one error value.
Type
OptimisationCombineTypeEnum
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Weight
Weight associated with the combine.
Type
Expression
Access
Read/Write

Collection Details

Goals
A collection of combined optimisation goals.
Type
OptimisationCombinationCollection

Method Details

Delete ()
Deletes the combined goal.
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.

Static Function Details

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