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
application = cf.Application.GetInstance() project = application:Load({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() properties.OperatorsToCombine = goals combinedGoal = search.Goals:AddCombinedGoal(properties) -- 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.
Usage locations
The OptimisationCombination object can be accessed from the following locations:
- Methods
- OptimisationGoalCollection collection has method AddCombinedGoal(table).
- OptimisationGoalCollection collection has method AddCombinedGoal(table, List of OptimisationOperator).
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 ParametricExpression)
Collection List
- Goals
- A collection of combined optimisation goals. (OptimisationGoalCollection of OptimisationOperator.)
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
- 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
- ParametricExpression
- Access
- Read/Write
Collection Details
- Goals
- A collection of combined optimisation goals.
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.