nl2sol
- pydantic model dakota.spec.method.nl2sol.Nl2solSelection
Generated model for Nl2solSelection
Show JSON schema
{ "title": "Nl2solSelection", "description": "Generated model for Nl2solSelection", "type": "object", "properties": { "nl2sol": { "$ref": "#/$defs/Nl2solConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "NL2SOL" } ] } }, "$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" }, "Nl2solConfig": { "additionalProperties": false, "description": "Trust-region method for nonlinear least squares", "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" } ] }, "speculative": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Compute speculative gradients", "title": "Speculative", "x-materialization": [ { "ir_key": "method.speculative", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "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" } ] }, "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" } ] }, "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" } ] }, "absolute_conv_tol": { "default": -1.0, "description": "Absolute convergence tolerance", "title": "Absolute Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.absolute_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "x_conv_tol": { "default": -1.0, "description": "X-convergence tolerance", "title": "X Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.x_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "singular_conv_tol": { "default": -1.0, "description": "Singular convergence tolerance", "title": "Singular Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.singular_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "singular_radius": { "default": -1.0, "description": "Singular radius", "title": "Singular Radius", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.singular_radius", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "false_conv_tol": { "default": -1.0, "description": "False convergence tolerance", "title": "False Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.false_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "initial_trust_radius": { "default": -1.0, "description": "Initial trust region radius", "title": "Initial Trust Radius", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.initial_trust_radius", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "covariance": { "default": 0, "description": "Determine how the final covariance matrix is computed", "title": "Covariance", "type": "integer", "x-materialization": [ { "ir_key": "method.nl2sol.covariance", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "regression_diagnostics": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Turn on regression diagnostics", "title": "Regression Diagnostics", "x-materialization": [ { "ir_key": "method.nl2sol.regression_diagnostics", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "Nl2solConfig", "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": [ "nl2sol" ] }
- field nl2sol: Nl2solConfig [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.nl2sol.Nl2solConfig
Trust-region method for nonlinear least squares
Show JSON schema
{ "title": "Nl2solConfig", "description": "Trust-region method for nonlinear least squares", "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" } ] }, "speculative": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Compute speculative gradients", "title": "Speculative", "x-materialization": [ { "ir_key": "method.speculative", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "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" } ] }, "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" } ] }, "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" } ] }, "absolute_conv_tol": { "default": -1.0, "description": "Absolute convergence tolerance", "title": "Absolute Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.absolute_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "x_conv_tol": { "default": -1.0, "description": "X-convergence tolerance", "title": "X Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.x_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "singular_conv_tol": { "default": -1.0, "description": "Singular convergence tolerance", "title": "Singular Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.singular_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "singular_radius": { "default": -1.0, "description": "Singular radius", "title": "Singular Radius", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.singular_radius", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "false_conv_tol": { "default": -1.0, "description": "False convergence tolerance", "title": "False Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.false_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "initial_trust_radius": { "default": -1.0, "description": "Initial trust region radius", "title": "Initial Trust Radius", "type": "number", "x-materialization": [ { "ir_key": "method.nl2sol.initial_trust_radius", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "covariance": { "default": 0, "description": "Determine how the final covariance matrix is computed", "title": "Covariance", "type": "integer", "x-materialization": [ { "ir_key": "method.nl2sol.covariance", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "regression_diagnostics": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Turn on regression diagnostics", "title": "Regression Diagnostics", "x-materialization": [ { "ir_key": "method.nl2sol.regression_diagnostics", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$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" }, "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 absolute_conv_tol: DakotaFloat = -1.0
Absolute convergence tolerance
- 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 covariance: int = 0
Determine how the final covariance matrix is computed
- field false_conv_tol: DakotaFloat = -1.0
False convergence tolerance
- 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 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 id_method: str | None = None
Name the method block; helpful when there are multiple
- field initial_trust_radius: DakotaFloat = -1.0
Initial trust region radius
- 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 output: Debug | Verbose | Normal | Quiet | Silent [Optional]
Control how much method information is written to the screen and output file
- field regression_diagnostics: Literal[True] | None = None
Turn on regression diagnostics
- field scaling: Literal[True] | None = None
Turn on scaling for variables, responses, and constraints
- field singular_conv_tol: DakotaFloat = -1.0
Singular convergence tolerance
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field singular_radius: DakotaFloat = -1.0
Singular radius
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field speculative: Literal[True] | None = None
Compute speculative gradients
- field x_conv_tol: DakotaFloat = -1.0
X-convergence tolerance
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
Generated Pydantic models for method.nl2sol
