The $optimize block

The $optimize block sets up the composite properties that enter in the calculation of the score function, as well as their weights and uncertainty tolerances. This block can appear only once in the input file.

The input parameters that are set in this block are listed below.

Block parameters

Parameter

Value Type

Description

Remarks

type

string

(Mergeable) (Optional) The type of the score function (for the default type, see Score).

properties

List[object reference]

The names of the composite properties that enter in the score.

Depends on the properties to which it refers.

references

List[numerical]

(Mergeable) The reference/target values of the properties in the score.

The value for each property should be compatible with the order in which it is listed in the properties option.

weights

List[numerical]

(Mergeable) The weights of the properties in the score.

The value for each property should be compatible with the order in which it is listed in the properties option.

tolerances

List[numerical]

(Mergeable) The uncertainty tolerances of the properties.

The value for each property should be compatible with the order in which it is listed in the properties option.

Note

Parameters that are not listed above can also be supplied. They are not recognized by the program in any special way, but are parsed and made available in the Customization API, together with all the other block parameters, as an InputParameters object.

Example

See Tutorial for a commented example.