vector_parameter_study
- pydantic model dakota.spec.method.vector_parameter_study.VectorParameterStudySelection
Generated model for VectorParameterStudySelection
Show JSON schema
{ "title": "VectorParameterStudySelection", "description": "Generated model for VectorParameterStudySelection", "type": "object", "properties": { "vector_parameter_study": { "$ref": "#/$defs/VectorParameterStudyConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "VECTOR_PARAMETER_STUDY" } ] } }, "$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" }, "FinalPoint": { "additionalProperties": false, "description": "Final variable values defining vector in vector parameter study", "properties": { "final_point": { "description": "Final variable values defining vector in vector parameter study", "items": { "type": "number" }, "title": "Final Point", "type": "array", "x-materialization": [ { "ir_key": "method.parameter_study.final_point", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "final_point" ], "title": "FinalPoint", "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" }, "StepVector": { "additionalProperties": false, "description": "Size of step for each variable", "properties": { "step_vector": { "description": "Size of step for each variable", "items": { "type": "number" }, "title": "Step Vector", "type": "array", "x-materialization": [ { "ir_key": "method.parameter_study.step_vector", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "step_vector" ], "title": "StepVector", "type": "object" }, "VectorParameterStudyConfig": { "additionalProperties": false, "description": "Samples variables along a user-defined vector", "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" } ] }, "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" } ] }, "step_control": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/FinalPoint" }, { "$ref": "#/$defs/StepVector" } ], "description": "Step Control", "title": "Step Control", "x-union-pattern": 4 }, "num_steps": { "description": "Number of sampling steps along the vector in a vector parameter study", "title": "Num Steps", "type": "integer", "x-materialization": [ { "ir_key": "method.parameter_study.num_steps", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "step_control", "num_steps" ], "title": "VectorParameterStudyConfig", "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": [ "vector_parameter_study" ] }
- Fields:
- field vector_parameter_study: VectorParameterStudyConfig [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.vector_parameter_study.VectorParameterStudyConfig
Samples variables along a user-defined vector
Show JSON schema
{ "title": "VectorParameterStudyConfig", "description": "Samples variables along a user-defined vector", "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" } ] }, "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" } ] }, "step_control": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/FinalPoint" }, { "$ref": "#/$defs/StepVector" } ], "description": "Step Control", "title": "Step Control", "x-union-pattern": 4 }, "num_steps": { "description": "Number of sampling steps along the vector in a vector parameter study", "title": "Num Steps", "type": "integer", "x-materialization": [ { "ir_key": "method.parameter_study.num_steps", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "$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" }, "FinalPoint": { "additionalProperties": false, "description": "Final variable values defining vector in vector parameter study", "properties": { "final_point": { "description": "Final variable values defining vector in vector parameter study", "items": { "type": "number" }, "title": "Final Point", "type": "array", "x-materialization": [ { "ir_key": "method.parameter_study.final_point", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "final_point" ], "title": "FinalPoint", "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" }, "StepVector": { "additionalProperties": false, "description": "Size of step for each variable", "properties": { "step_vector": { "description": "Size of step for each variable", "items": { "type": "number" }, "title": "Step Vector", "type": "array", "x-materialization": [ { "ir_key": "method.parameter_study.step_vector", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "step_vector" ], "title": "StepVector", "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": [ "step_control", "num_steps" ] }
- Fields:
- 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 model_pointer: str | None = None
Identifier for model block to be used by a method
- field num_steps: int [Required]
Number of sampling steps along the vector in a vector parameter study
- field output: Debug | Verbose | Normal | Quiet | Silent [Optional]
Control how much method information is written to the screen and output file
- field step_control: FinalPoint | StepVector [Required]
Step Control
Generated Pydantic models for method.vector_parameter_study
- pydantic model dakota.spec.method.vector_parameter_study.FinalPoint
Final variable values defining vector in vector parameter study
Show JSON schema
{ "title": "FinalPoint", "description": "Final variable values defining vector in vector parameter study", "type": "object", "properties": { "final_point": { "description": "Final variable values defining vector in vector parameter study", "items": { "type": "number" }, "title": "Final Point", "type": "array", "x-materialization": [ { "ir_key": "method.parameter_study.final_point", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "final_point" ] }
- Fields:
- field final_point: list[DakotaFloat] [Required]
Final variable values defining vector in vector parameter study
- pydantic model dakota.spec.method.vector_parameter_study.StepVector
Size of step for each variable
Show JSON schema
{ "title": "StepVector", "description": "Size of step for each variable", "type": "object", "properties": { "step_vector": { "description": "Size of step for each variable", "items": { "type": "number" }, "title": "Step Vector", "type": "array", "x-materialization": [ { "ir_key": "method.parameter_study.step_vector", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "step_vector" ] }
- Fields:
- field step_vector: list[DakotaFloat] [Required]
Size of step for each variable
