coliny_direct
- pydantic model dakota.spec.method.coliny_direct.ColinyDirectSelection
Generated model for ColinyDirectSelection
Show JSON schema
{ "title": "ColinyDirectSelection", "description": "Generated model for ColinyDirectSelection", "type": "object", "properties": { "coliny_direct": { "$ref": "#/$defs/ColinyDirectConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "COLINY_DIRECT" } ] } }, "$defs": { "AllDims": { "additionalProperties": false, "description": "All dimensions are simultaneously subdivided", "properties": { "all_dimensions": { "const": true, "default": true, "description": "All dimensions are simultaneously subdivided", "title": "All Dimensions", "type": "boolean", "x-materialization": [ { "ir_key": "method.coliny.division", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "all_dimensions" } ] } }, "title": "AllDims", "type": "object" }, "ColinyDirectConfig": { "additionalProperties": false, "description": "DIviding RECTangles method", "properties": { "model_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "solution_target": { "default": -1.7976931348623157e+308, "description": "Stopping criteria based on objective function value", "title": "Solution Target", "type": "number", "x-aliases": [ "solution_accuracy" ], "x-materialization": [ { "ir_key": "method.asynch_pattern_search.solution_target", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" }, { "ir_key": "method.solution_target", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "seed": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Seed of the random number generator", "title": "Seed", "x-materialization": [ { "ir_key": "method.random_seed", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "show_misc_options": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Show algorithm parameters not exposed in Dakota input", "title": "Show Misc Options", "x-materialization": [ { "ir_key": "method.coliny.show_misc_options", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "misc_options": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Set method options not available through Dakota spec", "title": "Misc Options", "x-materialization": [ { "ir_key": "method.coliny.misc_options", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "max_iterations": { "default": 9223372036854775807, "description": "Number of iterations allowed for optimizers and adaptive UQ methods", "minimum": 0, "title": "Max Iterations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_iterations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "convergence_tolerance": { "default": -1.7976931348623157e+308, "description": "Stopping criterion based on objective function or statistics convergence", "title": "Convergence Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.convergence_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" }, { "ir_key": "method.jega.percent_change", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "max_function_evaluations": { "default": 9223372036854775807, "description": "Number of function evaluations allowed for optimizers", "minimum": 0, "title": "Max Function Evaluations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_function_evaluations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scaling": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Turn on scaling for variables, responses, and constraints", "title": "Scaling", "x-materialization": [ { "ir_key": "method.scaling", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "id_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the method block; helpful when there are multiple", "title": "Id Method", "x-materialization": [ { "ir_key": "method.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output": { "anyOf": [ { "$ref": "#/$defs/Debug" }, { "$ref": "#/$defs/Verbose" }, { "$ref": "#/$defs/Normal" }, { "$ref": "#/$defs/Quiet" }, { "$ref": "#/$defs/Silent" } ], "description": "Control how much method information is written to the screen and output file", "title": "Output", "x-model-default": "Normal", "x-union-pattern": 1 }, "final_solutions": { "default": 0, "description": "Number of designs returned as the best solutions", "minimum": 0, "title": "Final Solutions", "type": "integer", "x-materialization": [ { "ir_key": "method.final_solutions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "division": { "anyOf": [ { "$ref": "#/$defs/MajorDim" }, { "$ref": "#/$defs/AllDims" }, { "type": "null" } ], "default": null, "description": "Determine how rectangles are subdivided", "title": "Division", "x-union-pattern": 2 }, "global_balance_parameter": { "default": -1.0, "description": "Tolerance for whether a subregion is worth dividing", "title": "Global Balance Parameter", "type": "number", "x-materialization": [ { "ir_key": "method.coliny.global_balance_parameter", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "local_balance_parameter": { "default": -1.0, "description": "Tolerance for whether a subregion is worth dividing", "title": "Local Balance Parameter", "type": "number", "x-materialization": [ { "ir_key": "method.coliny.local_balance_parameter", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "max_boxsize_limit": { "default": -1.0, "description": "Stopping Criterion based on longest edge of hyperrectangle", "title": "Max Boxsize Limit", "type": "number", "x-materialization": [ { "ir_key": "method.coliny.max_boxsize_limit", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "min_boxsize_limit": { "default": -1.0, "description": "Stopping Criterion based on shortest edge of hyperrectangle", "title": "Min Boxsize Limit", "type": "number", "x-materialization": [ { "ir_key": "method.min_boxsize_limit", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "constraint_penalty": { "default": -1.0, "description": "Multiplier for the penalty function", "title": "Constraint Penalty", "type": "number", "x-materialization": [ { "ir_key": "method.constraint_penalty", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "title": "ColinyDirectConfig", "type": "object" }, "Debug": { "additionalProperties": false, "description": "Level 5 of 5 - maximum", "properties": { "debug": { "const": true, "default": true, "description": "Level 5 of 5 - maximum", "title": "Debug", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEBUG_OUTPUT" } ] } }, "title": "Debug", "type": "object" }, "MajorDim": { "additionalProperties": false, "description": "(default) Longest edge of subregion is subdivided", "properties": { "major_dimension": { "const": true, "default": true, "description": "(default) Longest edge of subregion is subdivided", "title": "Major Dimension", "type": "boolean", "x-materialization": [ { "ir_key": "method.coliny.division", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "major_dimension" } ] } }, "title": "MajorDim", "type": "object" }, "Normal": { "additionalProperties": false, "description": "Level 3 of 5 - default", "properties": { "normal": { "const": true, "default": true, "description": "Level 3 of 5 - default", "title": "Normal", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NORMAL_OUTPUT" } ] } }, "title": "Normal", "type": "object" }, "Quiet": { "additionalProperties": false, "description": "Level 2 of 5 - less than normal", "properties": { "quiet": { "const": true, "default": true, "description": "Level 2 of 5 - less than normal", "title": "Quiet", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "QUIET_OUTPUT" } ] } }, "title": "Quiet", "type": "object" }, "Silent": { "additionalProperties": false, "description": "Level 1 of 5 - minimum", "properties": { "silent": { "const": true, "default": true, "description": "Level 1 of 5 - minimum", "title": "Silent", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SILENT_OUTPUT" } ] } }, "title": "Silent", "type": "object" }, "Verbose": { "additionalProperties": false, "description": "Level 4 of 5 - more than normal", "properties": { "verbose": { "const": true, "default": true, "description": "Level 4 of 5 - more than normal", "title": "Verbose", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "VERBOSE_OUTPUT" } ] } }, "title": "Verbose", "type": "object" } }, "additionalProperties": false, "required": [ "coliny_direct" ] }
- field coliny_direct: ColinyDirectConfig [Required]
- classmethod get_registry() dict[str, type[MethodSelection]]
Get registry, performing deferred registration on first call
- classmethod get_union()
Generate Union from all registered selections
- pydantic model dakota.spec.method.coliny_direct.ColinyDirectConfig
DIviding RECTangles method
Show JSON schema
{ "title": "ColinyDirectConfig", "description": "DIviding RECTangles method", "type": "object", "properties": { "model_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "solution_target": { "default": -1.7976931348623157e+308, "description": "Stopping criteria based on objective function value", "title": "Solution Target", "type": "number", "x-aliases": [ "solution_accuracy" ], "x-materialization": [ { "ir_key": "method.asynch_pattern_search.solution_target", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" }, { "ir_key": "method.solution_target", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "seed": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Seed of the random number generator", "title": "Seed", "x-materialization": [ { "ir_key": "method.random_seed", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "show_misc_options": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Show algorithm parameters not exposed in Dakota input", "title": "Show Misc Options", "x-materialization": [ { "ir_key": "method.coliny.show_misc_options", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "misc_options": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Set method options not available through Dakota spec", "title": "Misc Options", "x-materialization": [ { "ir_key": "method.coliny.misc_options", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "max_iterations": { "default": 9223372036854775807, "description": "Number of iterations allowed for optimizers and adaptive UQ methods", "minimum": 0, "title": "Max Iterations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_iterations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "convergence_tolerance": { "default": -1.7976931348623157e+308, "description": "Stopping criterion based on objective function or statistics convergence", "title": "Convergence Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.convergence_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" }, { "ir_key": "method.jega.percent_change", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "max_function_evaluations": { "default": 9223372036854775807, "description": "Number of function evaluations allowed for optimizers", "minimum": 0, "title": "Max Function Evaluations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_function_evaluations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scaling": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Turn on scaling for variables, responses, and constraints", "title": "Scaling", "x-materialization": [ { "ir_key": "method.scaling", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "id_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the method block; helpful when there are multiple", "title": "Id Method", "x-materialization": [ { "ir_key": "method.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output": { "anyOf": [ { "$ref": "#/$defs/Debug" }, { "$ref": "#/$defs/Verbose" }, { "$ref": "#/$defs/Normal" }, { "$ref": "#/$defs/Quiet" }, { "$ref": "#/$defs/Silent" } ], "description": "Control how much method information is written to the screen and output file", "title": "Output", "x-model-default": "Normal", "x-union-pattern": 1 }, "final_solutions": { "default": 0, "description": "Number of designs returned as the best solutions", "minimum": 0, "title": "Final Solutions", "type": "integer", "x-materialization": [ { "ir_key": "method.final_solutions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "division": { "anyOf": [ { "$ref": "#/$defs/MajorDim" }, { "$ref": "#/$defs/AllDims" }, { "type": "null" } ], "default": null, "description": "Determine how rectangles are subdivided", "title": "Division", "x-union-pattern": 2 }, "global_balance_parameter": { "default": -1.0, "description": "Tolerance for whether a subregion is worth dividing", "title": "Global Balance Parameter", "type": "number", "x-materialization": [ { "ir_key": "method.coliny.global_balance_parameter", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "local_balance_parameter": { "default": -1.0, "description": "Tolerance for whether a subregion is worth dividing", "title": "Local Balance Parameter", "type": "number", "x-materialization": [ { "ir_key": "method.coliny.local_balance_parameter", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "max_boxsize_limit": { "default": -1.0, "description": "Stopping Criterion based on longest edge of hyperrectangle", "title": "Max Boxsize Limit", "type": "number", "x-materialization": [ { "ir_key": "method.coliny.max_boxsize_limit", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "min_boxsize_limit": { "default": -1.0, "description": "Stopping Criterion based on shortest edge of hyperrectangle", "title": "Min Boxsize Limit", "type": "number", "x-materialization": [ { "ir_key": "method.min_boxsize_limit", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "constraint_penalty": { "default": -1.0, "description": "Multiplier for the penalty function", "title": "Constraint Penalty", "type": "number", "x-materialization": [ { "ir_key": "method.constraint_penalty", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "AllDims": { "additionalProperties": false, "description": "All dimensions are simultaneously subdivided", "properties": { "all_dimensions": { "const": true, "default": true, "description": "All dimensions are simultaneously subdivided", "title": "All Dimensions", "type": "boolean", "x-materialization": [ { "ir_key": "method.coliny.division", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "all_dimensions" } ] } }, "title": "AllDims", "type": "object" }, "Debug": { "additionalProperties": false, "description": "Level 5 of 5 - maximum", "properties": { "debug": { "const": true, "default": true, "description": "Level 5 of 5 - maximum", "title": "Debug", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEBUG_OUTPUT" } ] } }, "title": "Debug", "type": "object" }, "MajorDim": { "additionalProperties": false, "description": "(default) Longest edge of subregion is subdivided", "properties": { "major_dimension": { "const": true, "default": true, "description": "(default) Longest edge of subregion is subdivided", "title": "Major Dimension", "type": "boolean", "x-materialization": [ { "ir_key": "method.coliny.division", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "major_dimension" } ] } }, "title": "MajorDim", "type": "object" }, "Normal": { "additionalProperties": false, "description": "Level 3 of 5 - default", "properties": { "normal": { "const": true, "default": true, "description": "Level 3 of 5 - default", "title": "Normal", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NORMAL_OUTPUT" } ] } }, "title": "Normal", "type": "object" }, "Quiet": { "additionalProperties": false, "description": "Level 2 of 5 - less than normal", "properties": { "quiet": { "const": true, "default": true, "description": "Level 2 of 5 - less than normal", "title": "Quiet", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "QUIET_OUTPUT" } ] } }, "title": "Quiet", "type": "object" }, "Silent": { "additionalProperties": false, "description": "Level 1 of 5 - minimum", "properties": { "silent": { "const": true, "default": true, "description": "Level 1 of 5 - minimum", "title": "Silent", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SILENT_OUTPUT" } ] } }, "title": "Silent", "type": "object" }, "Verbose": { "additionalProperties": false, "description": "Level 4 of 5 - more than normal", "properties": { "verbose": { "const": true, "default": true, "description": "Level 4 of 5 - more than normal", "title": "Verbose", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "VERBOSE_OUTPUT" } ] } }, "title": "Verbose", "type": "object" } }, "additionalProperties": false }
- Fields:
- field constraint_penalty: DakotaFloat = -1.0
Multiplier for the penalty function
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field convergence_tolerance: DakotaFloat = -1.7976931348623157e+308
Stopping criterion based on objective function or statistics convergence
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field final_solutions: int = 0
Number of designs returned as the best solutions
- Constraints:
ge = 0
- field global_balance_parameter: DakotaFloat = -1.0
Tolerance for whether a subregion is worth dividing
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field id_method: str | None = None
Name the method block; helpful when there are multiple
- field local_balance_parameter: DakotaFloat = -1.0
Tolerance for whether a subregion is worth dividing
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field max_boxsize_limit: DakotaFloat = -1.0
Stopping Criterion based on longest edge of hyperrectangle
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field max_function_evaluations: int = 9223372036854775807
Number of function evaluations allowed for optimizers
- Constraints:
ge = 0
- field max_iterations: int = 9223372036854775807
Number of iterations allowed for optimizers and adaptive UQ methods
- Constraints:
ge = 0
- field min_boxsize_limit: DakotaFloat = -1.0
Stopping Criterion based on shortest edge of hyperrectangle
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field misc_options: list[str] | None = None
Set method options not available through Dakota spec
- field model_pointer: str | None = None
Identifier for model block to be used by a method
- field output: Debug | Verbose | Normal | Quiet | Silent [Optional]
Control how much method information is written to the screen and output file
- field scaling: Literal[True] | None = None
Turn on scaling for variables, responses, and constraints
- field seed: int | None = None
Seed of the random number generator
- Constraints:
gt = 0
- field show_misc_options: Literal[True] | None = None
Show algorithm parameters not exposed in Dakota input
- field solution_target: DakotaFloat = -1.7976931348623157e+308
Stopping criteria based on objective function value
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
Generated Pydantic models for method.coliny_direct
- pydantic model dakota.spec.method.coliny_direct.AllDims
All dimensions are simultaneously subdivided
Show JSON schema
{ "title": "AllDims", "description": "All dimensions are simultaneously subdivided", "type": "object", "properties": { "all_dimensions": { "const": true, "default": true, "description": "All dimensions are simultaneously subdivided", "title": "All Dimensions", "type": "boolean", "x-materialization": [ { "ir_key": "method.coliny.division", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "all_dimensions" } ] } }, "additionalProperties": false }
- Fields:
- field all_dimensions: Literal[True] = True
All dimensions are simultaneously subdivided
- pydantic model dakota.spec.method.coliny_direct.MajorDim
(default) Longest edge of subregion is subdivided
Show JSON schema
{ "title": "MajorDim", "description": "(default) Longest edge of subregion is subdivided", "type": "object", "properties": { "major_dimension": { "const": true, "default": true, "description": "(default) Longest edge of subregion is subdivided", "title": "Major Dimension", "type": "boolean", "x-materialization": [ { "ir_key": "method.coliny.division", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "major_dimension" } ] } }, "additionalProperties": false }
- Fields:
- field major_dimension: Literal[True] = True
(default) Longest edge of subregion is subdivided
