fsu_quasi_mc
- pydantic model dakota.spec.method.fsu_quasi_mc.FsuQuasiMcSelection
Generated model for FsuQuasiMcSelection
Show JSON schema
{ "title": "FsuQuasiMcSelection", "description": "Generated model for FsuQuasiMcSelection", "type": "object", "properties": { "fsu_quasi_mc": { "$ref": "#/$defs/FsuQuasiMcConfig" } }, "$defs": { "Binned": { "additionalProperties": false, "description": "Computes Sobol' main effects using a binned approach", "properties": { "binned": { "$ref": "#/$defs/BinnedConfig", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "VBD_BINNED" } ] } }, "required": [ "binned" ], "title": "Binned", "type": "object" }, "BinnedConfig": { "additionalProperties": false, "description": "Computes Sobol' main effects using a binned approach", "properties": { "num_bins": { "default": -1, "description": "Number of bins used to compute the variance-based decomposition", "title": "Num Bins", "type": "integer", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_num_bins", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "BinnedConfig", "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" }, "FsuQuasiMcConfig": { "additionalProperties": false, "description": "Design of Computer Experiments - Quasi-Monte Carlo sampling", "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" } ] }, "variance_based_decomp": { "anyOf": [ { "$ref": "#/$defs/VbdSamplingVarianceBasedDecomp" }, { "type": "null" } ], "default": null, "description": "Activates global sensitivity analysis based on decomposition of response variance into contributions from variables", "x-materialization": [ { "ir_key": "method.variance_based_decomp", "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" } ] }, "sequence": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/FsuQuasiMcHalton" }, { "$ref": "#/$defs/Hammersley" } ], "description": "Sequence Type", "title": "Sequence", "x-union-pattern": 4 }, "latinize": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Adjust samples to improve the discrepancy of the marginal distributions", "title": "Latinize", "x-materialization": [ { "ir_key": "method.latinize", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "quality_metrics": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Calculate metrics to assess the quality of quasi-Monte Carlo samples", "title": "Quality Metrics", "x-materialization": [ { "ir_key": "method.quality_metrics", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "samples": { "default": 0, "description": "Number of samples for sampling-based methods", "title": "Samples", "type": "integer", "x-materialization": [ { "ir_key": "method.samples", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "fixed_sequence": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Reuse the same sequence and samples for multiple sampling sets", "title": "Fixed Sequence", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.fixed_sequence", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "sequence_start": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Choose where to start sampling the sequence", "title": "Sequence Start", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.sequenceStart", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "sequence_leap": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify how often the sequence is sampled", "title": "Sequence Leap", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.sequenceLeap", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "prime_base": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The prime numbers used to generate the sequence", "title": "Prime Base", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.primeBase", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "sequence" ], "title": "FsuQuasiMcConfig", "type": "object" }, "FsuQuasiMcHalton": { "additionalProperties": false, "description": "Generate samples from a Halton sequence", "properties": { "halton": { "const": true, "default": true, "description": "Generate samples from a Halton sequence", "title": "Halton", "type": "boolean", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FSU_HALTON" } ] } }, "title": "FsuQuasiMcHalton", "type": "object" }, "Hammersley": { "additionalProperties": false, "description": "Use Hammersley sequences", "properties": { "hammersley": { "const": true, "default": true, "description": "Use Hammersley sequences", "title": "Hammersley", "type": "boolean", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FSU_HAMMERSLEY" } ] } }, "title": "Hammersley", "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" }, "PickAndFreeze": { "additionalProperties": false, "description": "Use the pick-and-freeze variance-based decomposition method", "properties": { "pick_and_freeze": { "const": true, "default": true, "description": "Use the pick-and-freeze variance-based decomposition method", "title": "Pick And Freeze", "type": "boolean", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "VBD_PICK_AND_FREEZE" } ] } }, "title": "PickAndFreeze", "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" }, "VbdSamplingVarianceBasedDecomp": { "additionalProperties": false, "description": "Activates global sensitivity analysis based on decomposition of response variance into contributions from variables", "properties": { "drop_tolerance": { "default": -1.0, "description": "Suppresses output of sensitivity indices with values lower than this tolerance", "title": "Drop Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.vbd_drop_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "vbd_sampling_method": { "anyOf": [ { "$ref": "#/$defs/Binned" }, { "$ref": "#/$defs/PickAndFreeze" }, { "type": "null" } ], "default": null, "description": "The method to use for variance-based decomposition", "title": "Vbd Sampling Method", "x-union-pattern": 2 } }, "title": "VbdSamplingVarianceBasedDecomp", "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": [ "fsu_quasi_mc" ] }
- field fsu_quasi_mc: FsuQuasiMcConfig [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.fsu_quasi_mc.FsuQuasiMcConfig
Design of Computer Experiments - Quasi-Monte Carlo sampling
Show JSON schema
{ "title": "FsuQuasiMcConfig", "description": "Design of Computer Experiments - Quasi-Monte Carlo sampling", "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" } ] }, "variance_based_decomp": { "anyOf": [ { "$ref": "#/$defs/VbdSamplingVarianceBasedDecomp" }, { "type": "null" } ], "default": null, "description": "Activates global sensitivity analysis based on decomposition of response variance into contributions from variables", "x-materialization": [ { "ir_key": "method.variance_based_decomp", "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" } ] }, "sequence": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/FsuQuasiMcHalton" }, { "$ref": "#/$defs/Hammersley" } ], "description": "Sequence Type", "title": "Sequence", "x-union-pattern": 4 }, "latinize": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Adjust samples to improve the discrepancy of the marginal distributions", "title": "Latinize", "x-materialization": [ { "ir_key": "method.latinize", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "quality_metrics": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Calculate metrics to assess the quality of quasi-Monte Carlo samples", "title": "Quality Metrics", "x-materialization": [ { "ir_key": "method.quality_metrics", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "samples": { "default": 0, "description": "Number of samples for sampling-based methods", "title": "Samples", "type": "integer", "x-materialization": [ { "ir_key": "method.samples", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "fixed_sequence": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Reuse the same sequence and samples for multiple sampling sets", "title": "Fixed Sequence", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.fixed_sequence", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "sequence_start": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Choose where to start sampling the sequence", "title": "Sequence Start", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.sequenceStart", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "sequence_leap": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify how often the sequence is sampled", "title": "Sequence Leap", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.sequenceLeap", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "prime_base": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The prime numbers used to generate the sequence", "title": "Prime Base", "x-materialization": [ { "ir_key": "method.fsu_quasi_mc.primeBase", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "Binned": { "additionalProperties": false, "description": "Computes Sobol' main effects using a binned approach", "properties": { "binned": { "$ref": "#/$defs/BinnedConfig", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "VBD_BINNED" } ] } }, "required": [ "binned" ], "title": "Binned", "type": "object" }, "BinnedConfig": { "additionalProperties": false, "description": "Computes Sobol' main effects using a binned approach", "properties": { "num_bins": { "default": -1, "description": "Number of bins used to compute the variance-based decomposition", "title": "Num Bins", "type": "integer", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_num_bins", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "BinnedConfig", "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" }, "FsuQuasiMcHalton": { "additionalProperties": false, "description": "Generate samples from a Halton sequence", "properties": { "halton": { "const": true, "default": true, "description": "Generate samples from a Halton sequence", "title": "Halton", "type": "boolean", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FSU_HALTON" } ] } }, "title": "FsuQuasiMcHalton", "type": "object" }, "Hammersley": { "additionalProperties": false, "description": "Use Hammersley sequences", "properties": { "hammersley": { "const": true, "default": true, "description": "Use Hammersley sequences", "title": "Hammersley", "type": "boolean", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FSU_HAMMERSLEY" } ] } }, "title": "Hammersley", "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" }, "PickAndFreeze": { "additionalProperties": false, "description": "Use the pick-and-freeze variance-based decomposition method", "properties": { "pick_and_freeze": { "const": true, "default": true, "description": "Use the pick-and-freeze variance-based decomposition method", "title": "Pick And Freeze", "type": "boolean", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_method", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "VBD_PICK_AND_FREEZE" } ] } }, "title": "PickAndFreeze", "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" }, "VbdSamplingVarianceBasedDecomp": { "additionalProperties": false, "description": "Activates global sensitivity analysis based on decomposition of response variance into contributions from variables", "properties": { "drop_tolerance": { "default": -1.0, "description": "Suppresses output of sensitivity indices with values lower than this tolerance", "title": "Drop Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.vbd_drop_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "vbd_sampling_method": { "anyOf": [ { "$ref": "#/$defs/Binned" }, { "$ref": "#/$defs/PickAndFreeze" }, { "type": "null" } ], "default": null, "description": "The method to use for variance-based decomposition", "title": "Vbd Sampling Method", "x-union-pattern": 2 } }, "title": "VbdSamplingVarianceBasedDecomp", "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": [ "sequence" ] }
- field final_solutions: int = 0
Number of designs returned as the best solutions
- Constraints:
ge = 0
- field fixed_sequence: Literal[True] | None = None
Reuse the same sequence and samples for multiple sampling sets
- field id_method: str | None = None
Name the method block; helpful when there are multiple
- field latinize: Literal[True] | None = None
Adjust samples to improve the discrepancy of the marginal distributions
- 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 prime_base: list[int] | None = None
The prime numbers used to generate the sequence
- field quality_metrics: Literal[True] | None = None
Calculate metrics to assess the quality of quasi-Monte Carlo samples
- field samples: int = 0
Number of samples for sampling-based methods
- field sequence: FsuQuasiMcHalton | Hammersley [Required]
Sequence Type
- field sequence_leap: list[int] | None = None
Specify how often the sequence is sampled
- field sequence_start: list[int] | None = None
Choose where to start sampling the sequence
- field variance_based_decomp: VbdSamplingVarianceBasedDecomp | None = None
Activates global sensitivity analysis based on decomposition of response variance into contributions from variables
Generated Pydantic models for method.fsu_quasi_mc
- pydantic model dakota.spec.method.fsu_quasi_mc.FsuQuasiMcHalton
Generate samples from a Halton sequence
Show JSON schema
{ "title": "FsuQuasiMcHalton", "description": "Generate samples from a Halton sequence", "type": "object", "properties": { "halton": { "const": true, "default": true, "description": "Generate samples from a Halton sequence", "title": "Halton", "type": "boolean", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FSU_HALTON" } ] } }, "additionalProperties": false }
- Fields:
- field halton: Literal[True] = True
Generate samples from a Halton sequence
- pydantic model dakota.spec.method.fsu_quasi_mc.Hammersley
Use Hammersley sequences
Show JSON schema
{ "title": "Hammersley", "description": "Use Hammersley sequences", "type": "object", "properties": { "hammersley": { "const": true, "default": true, "description": "Use Hammersley sequences", "title": "Hammersley", "type": "boolean", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FSU_HAMMERSLEY" } ] } }, "additionalProperties": false }
- Fields:
- field hammersley: Literal[True] = True
Use Hammersley sequences
