mesh_adaptive_search
- pydantic model dakota.spec.method.mesh_adaptive_search.MeshAdaptiveSearchSelection
Generated model for MeshAdaptiveSearchSelection
Show JSON schema
{ "title": "MeshAdaptiveSearchSelection", "description": "Generated model for MeshAdaptiveSearchSelection", "type": "object", "properties": { "mesh_adaptive_search": { "$ref": "#/$defs/MeshAdaptiveSearchConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "MESH_ADAPTIVE_SEARCH" } ] } }, "$defs": { "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" }, "InformSearch": { "additionalProperties": false, "description": "Surrogate informs evaluation order in mesh adaptive search", "properties": { "inform_search": { "const": true, "default": true, "description": "Surrogate informs evaluation order in mesh adaptive search", "title": "Inform Search", "type": "boolean", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.use_surrogate", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "inform_search" } ] } }, "title": "InformSearch", "type": "object" }, "MeshAdaptiveSearchConfig": { "additionalProperties": false, "description": "Finds optimal variable values using adaptive mesh-based search", "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" } ] }, "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" } ] }, "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" } ] }, "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" } ] }, "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" } ] }, "initial_delta": { "default": 1.0, "description": "Initial step size for derivative-free optimizers", "title": "Initial Delta", "type": "number", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.initial_delta", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "variable_tolerance": { "default": 1e-06, "description": "Step length-based stopping criteria for derivative-free optimizers", "title": "Variable Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.variable_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "function_precision": { "default": 1e-10, "description": "Specify the maximum precision of the analysis code responses", "title": "Function Precision", "type": "number", "x-materialization": [ { "ir_key": "method.function_precision", "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" } ] }, "history_file": { "default": "mads_history", "description": "Name of file where mesh adaptive search records all evaluation points.", "title": "History File", "type": "string", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.history_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "display_format": { "default": "bbe obj", "description": "Information to be reported from mesh adaptive search's internal records.", "title": "Display Format", "type": "string", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.display_format", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "variable_neighborhood_search": { "default": 0.0, "description": "Percentage of evaluations to do to escape local minima.", "title": "Variable Neighborhood Search", "type": "number", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.variable_neighborhood_search", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "neighbor_order": { "default": 1, "description": "Number of dimensions in which to perturb categorical variables.", "exclusiveMinimum": 0, "title": "Neighbor Order", "type": "integer", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.neighbor_order", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "display_all_evaluations": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Shows mesh adaptive search's internally held list of all evaluations", "title": "Display All Evaluations", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.display_all_evaluations", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "use_surrogate": { "anyOf": [ { "$ref": "#/$defs/InformSearch" }, { "$ref": "#/$defs/Optimize" }, { "type": "null" } ], "default": null, "description": "Surrogate model usage mode for mesh adaptive search", "title": "Use Surrogate", "x-union-pattern": 2 } }, "title": "MeshAdaptiveSearchConfig", "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" }, "Optimize": { "additionalProperties": false, "description": "Surrogate is used in lieu of true model for mesh adaptive search", "properties": { "optimize": { "const": true, "default": true, "description": "Surrogate is used in lieu of true model for mesh adaptive search", "title": "Optimize", "type": "boolean", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.use_surrogate", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "optimize" } ] } }, "title": "Optimize", "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": [ "mesh_adaptive_search" ] }
- field mesh_adaptive_search: MeshAdaptiveSearchConfig [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.mesh_adaptive_search.MeshAdaptiveSearchConfig
Finds optimal variable values using adaptive mesh-based search
Show JSON schema
{ "title": "MeshAdaptiveSearchConfig", "description": "Finds optimal variable values using adaptive mesh-based search", "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" } ] }, "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" } ] }, "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" } ] }, "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" } ] }, "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" } ] }, "initial_delta": { "default": 1.0, "description": "Initial step size for derivative-free optimizers", "title": "Initial Delta", "type": "number", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.initial_delta", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "variable_tolerance": { "default": 1e-06, "description": "Step length-based stopping criteria for derivative-free optimizers", "title": "Variable Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.variable_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "function_precision": { "default": 1e-10, "description": "Specify the maximum precision of the analysis code responses", "title": "Function Precision", "type": "number", "x-materialization": [ { "ir_key": "method.function_precision", "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" } ] }, "history_file": { "default": "mads_history", "description": "Name of file where mesh adaptive search records all evaluation points.", "title": "History File", "type": "string", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.history_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "display_format": { "default": "bbe obj", "description": "Information to be reported from mesh adaptive search's internal records.", "title": "Display Format", "type": "string", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.display_format", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "variable_neighborhood_search": { "default": 0.0, "description": "Percentage of evaluations to do to escape local minima.", "title": "Variable Neighborhood Search", "type": "number", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.variable_neighborhood_search", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "neighbor_order": { "default": 1, "description": "Number of dimensions in which to perturb categorical variables.", "exclusiveMinimum": 0, "title": "Neighbor Order", "type": "integer", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.neighbor_order", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "display_all_evaluations": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Shows mesh adaptive search's internally held list of all evaluations", "title": "Display All Evaluations", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.display_all_evaluations", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "use_surrogate": { "anyOf": [ { "$ref": "#/$defs/InformSearch" }, { "$ref": "#/$defs/Optimize" }, { "type": "null" } ], "default": null, "description": "Surrogate model usage mode for mesh adaptive search", "title": "Use Surrogate", "x-union-pattern": 2 } }, "$defs": { "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" }, "InformSearch": { "additionalProperties": false, "description": "Surrogate informs evaluation order in mesh adaptive search", "properties": { "inform_search": { "const": true, "default": true, "description": "Surrogate informs evaluation order in mesh adaptive search", "title": "Inform Search", "type": "boolean", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.use_surrogate", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "inform_search" } ] } }, "title": "InformSearch", "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" }, "Optimize": { "additionalProperties": false, "description": "Surrogate is used in lieu of true model for mesh adaptive search", "properties": { "optimize": { "const": true, "default": true, "description": "Surrogate is used in lieu of true model for mesh adaptive search", "title": "Optimize", "type": "boolean", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.use_surrogate", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "optimize" } ] } }, "title": "Optimize", "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 display_all_evaluations: Literal[True] | None = None
Shows mesh adaptive search’s internally held list of all evaluations
- field display_format: str = 'bbe obj'
Information to be reported from mesh adaptive search’s internal records.
- field final_solutions: int = 0
Number of designs returned as the best solutions
- Constraints:
ge = 0
- field function_precision: DakotaFloat = 1e-10
Specify the maximum precision of the analysis code responses
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field history_file: str = 'mads_history'
Name of file where mesh adaptive search records all evaluation points.
- field id_method: str | None = None
Name the method block; helpful when there are multiple
- field initial_delta: DakotaFloat = 1.0
Initial step size for derivative-free optimizers
- 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 model_pointer: str | None = None
Identifier for model block to be used by a method
- field neighbor_order: int = 1
Number of dimensions in which to perturb categorical variables.
- Constraints:
gt = 0
- 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 use_surrogate: InformSearch | Optimize | None = None
Surrogate model usage mode for mesh adaptive search
- field variable_neighborhood_search: DakotaFloat = 0.0
Percentage of evaluations to do to escape local minima.
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field variable_tolerance: DakotaFloat = 1e-06
Step length-based stopping criteria for derivative-free optimizers
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
Generated Pydantic models for method.mesh_adaptive_search
- pydantic model dakota.spec.method.mesh_adaptive_search.InformSearch
Surrogate informs evaluation order in mesh adaptive search
Show JSON schema
{ "title": "InformSearch", "description": "Surrogate informs evaluation order in mesh adaptive search", "type": "object", "properties": { "inform_search": { "const": true, "default": true, "description": "Surrogate informs evaluation order in mesh adaptive search", "title": "Inform Search", "type": "boolean", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.use_surrogate", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "inform_search" } ] } }, "additionalProperties": false }
- Fields:
- field inform_search: Literal[True] = True
Surrogate informs evaluation order in mesh adaptive search
- pydantic model dakota.spec.method.mesh_adaptive_search.Optimize
Surrogate is used in lieu of true model for mesh adaptive search
Show JSON schema
{ "title": "Optimize", "description": "Surrogate is used in lieu of true model for mesh adaptive search", "type": "object", "properties": { "optimize": { "const": true, "default": true, "description": "Surrogate is used in lieu of true model for mesh adaptive search", "title": "Optimize", "type": "boolean", "x-materialization": [ { "ir_key": "method.mesh_adaptive_search.use_surrogate", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "optimize" } ] } }, "additionalProperties": false }
- Fields:
- field optimize: Literal[True] = True
Surrogate is used in lieu of true model for mesh adaptive search
