richardson_extrap
- pydantic model dakota.spec.method.richardson_extrap.RichardsonExtrapSelection
Generated model for RichardsonExtrapSelection
Show JSON schema
{ "title": "RichardsonExtrapSelection", "description": "Generated model for RichardsonExtrapSelection", "type": "object", "properties": { "richardson_extrap": { "$ref": "#/$defs/RichardsonExtrapConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RICHARDSON_EXTRAP" } ] } }, "$defs": { "ConvergeOrder": { "additionalProperties": false, "description": "Refine until the estimated covergence order converges", "properties": { "converge_order": { "const": true, "default": true, "description": "Refine until the estimated covergence order converges", "title": "Converge Order", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_CONVERGE_ORDER" } ] } }, "title": "ConvergeOrder", "type": "object" }, "ConvergeQoi": { "additionalProperties": false, "description": "Refine until the response converges", "properties": { "converge_qoi": { "const": true, "default": true, "description": "Refine until the response converges", "title": "Converge Qoi", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_CONVERGE_QOI" } ] } }, "title": "ConvergeQoi", "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" }, "EstimateOrder": { "additionalProperties": false, "description": "Compute the best estimate of the convergence order from three points", "properties": { "estimate_order": { "const": true, "default": true, "description": "Compute the best estimate of the convergence order from three points", "title": "Estimate Order", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_ESTIMATE_ORDER" } ] } }, "title": "EstimateOrder", "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" }, "RichardsonExtrapConfig": { "additionalProperties": false, "description": "Estimate order of convergence of a response as model fidelity increases", "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" } ] }, "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" } ] }, "mode": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/EstimateOrder" }, { "$ref": "#/$defs/ConvergeOrder" }, { "$ref": "#/$defs/ConvergeQoi" } ], "description": "Verification Mode", "title": "Mode", "x-union-pattern": 4 }, "refinement_rate": { "default": 2.0, "description": "Rate at which the state variables are refined", "title": "Refinement Rate", "type": "number", "x-materialization": [ { "ir_key": "method.verification.refinement_rate", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "mode" ], "title": "RichardsonExtrapConfig", "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": [ "richardson_extrap" ] }
- field richardson_extrap: RichardsonExtrapConfig [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.richardson_extrap.RichardsonExtrapConfig
Estimate order of convergence of a response as model fidelity increases
Show JSON schema
{ "title": "RichardsonExtrapConfig", "description": "Estimate order of convergence of a response as model fidelity increases", "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" } ] }, "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" } ] }, "mode": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/EstimateOrder" }, { "$ref": "#/$defs/ConvergeOrder" }, { "$ref": "#/$defs/ConvergeQoi" } ], "description": "Verification Mode", "title": "Mode", "x-union-pattern": 4 }, "refinement_rate": { "default": 2.0, "description": "Rate at which the state variables are refined", "title": "Refinement Rate", "type": "number", "x-materialization": [ { "ir_key": "method.verification.refinement_rate", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "ConvergeOrder": { "additionalProperties": false, "description": "Refine until the estimated covergence order converges", "properties": { "converge_order": { "const": true, "default": true, "description": "Refine until the estimated covergence order converges", "title": "Converge Order", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_CONVERGE_ORDER" } ] } }, "title": "ConvergeOrder", "type": "object" }, "ConvergeQoi": { "additionalProperties": false, "description": "Refine until the response converges", "properties": { "converge_qoi": { "const": true, "default": true, "description": "Refine until the response converges", "title": "Converge Qoi", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_CONVERGE_QOI" } ] } }, "title": "ConvergeQoi", "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" }, "EstimateOrder": { "additionalProperties": false, "description": "Compute the best estimate of the convergence order from three points", "properties": { "estimate_order": { "const": true, "default": true, "description": "Compute the best estimate of the convergence order from three points", "title": "Estimate Order", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_ESTIMATE_ORDER" } ] } }, "title": "EstimateOrder", "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": [ "mode" ] }
- Fields:
- 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 id_method: str | None = None
Name the method block; helpful when there are multiple
- field max_iterations: int = 9223372036854775807
Number of iterations allowed for optimizers and adaptive UQ methods
- Constraints:
ge = 0
- field mode: EstimateOrder | ConvergeOrder | ConvergeQoi [Required]
Verification Mode
- 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 refinement_rate: DakotaFloat = 2.0
Rate at which the state variables are refined
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
Generated Pydantic models for method.richardson_extrap
- pydantic model dakota.spec.method.richardson_extrap.ConvergeOrder
Refine until the estimated covergence order converges
Show JSON schema
{ "title": "ConvergeOrder", "description": "Refine until the estimated covergence order converges", "type": "object", "properties": { "converge_order": { "const": true, "default": true, "description": "Refine until the estimated covergence order converges", "title": "Converge Order", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_CONVERGE_ORDER" } ] } }, "additionalProperties": false }
- Fields:
- field converge_order: Literal[True] = True
Refine until the estimated covergence order converges
- pydantic model dakota.spec.method.richardson_extrap.ConvergeQoi
Refine until the response converges
Show JSON schema
{ "title": "ConvergeQoi", "description": "Refine until the response converges", "type": "object", "properties": { "converge_qoi": { "const": true, "default": true, "description": "Refine until the response converges", "title": "Converge Qoi", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_CONVERGE_QOI" } ] } }, "additionalProperties": false }
- Fields:
- field converge_qoi: Literal[True] = True
Refine until the response converges
- pydantic model dakota.spec.method.richardson_extrap.EstimateOrder
Compute the best estimate of the convergence order from three points
Show JSON schema
{ "title": "EstimateOrder", "description": "Compute the best estimate of the convergence order from three points", "type": "object", "properties": { "estimate_order": { "const": true, "default": true, "description": "Compute the best estimate of the convergence order from three points", "title": "Estimate Order", "type": "boolean", "x-materialization": [ { "ir_key": "method.sub_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SUBMETHOD_ESTIMATE_ORDER" } ] } }, "additionalProperties": false }
- Fields:
- field estimate_order: Literal[True] = True
Compute the best estimate of the convergence order from three points
