`list_parameter_study`

pydantic model dakota.spec.method.list_parameter_study.ListParameterStudySelection

Generated model for ListParameterStudySelection

Show JSON schema

{
   "title": "ListParameterStudySelection",
   "description": "Generated model for ListParameterStudySelection",
   "type": "object",
   "properties": {
      "list_parameter_study": {
         "$ref": "#/$defs/ListParameterStudyConfig",
         "x-materialization": [
            {
               "ir_key": "method.algorithm",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "LIST_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"
      },
      "ImportPointsFileConfig": {
         "additionalProperties": false,
         "description": "File containing list of variable values to evaluate in a list parameter study",
         "properties": {
            "filename": {
               "description": "File containing list of variable values to evaluate in a list parameter study",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_file",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileAnnotated"
                  },
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "ListParameterStudyImportPointsFileAnnotated",
               "x-union-pattern": 1
            },
            "active_only": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Import only active variables from tabular data file",
               "title": "Active Only",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_active_only",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            }
         },
         "required": [
            "filename"
         ],
         "title": "ImportPointsFileConfig",
         "type": "object"
      },
      "ListOfPoints": {
         "additionalProperties": false,
         "description": "List of variable values to evaluate in a list parameter study",
         "properties": {
            "list_of_points": {
               "description": "List of variable values to evaluate in a list parameter study",
               "items": {
                  "type": "number"
               },
               "title": "List Of Points",
               "type": "array",
               "x-materialization": [
                  {
                     "ir_key": "method.parameter_study.list_of_points",
                     "ir_value_type": "RealVector",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "list_of_points"
         ],
         "title": "ListOfPoints",
         "type": "object"
      },
      "ListParameterStudyConfig": {
         "additionalProperties": false,
         "description": "Samples variables as a specified values",
         "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"
                  }
               ]
            },
            "source": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/ListOfPoints"
                  },
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFile"
                  }
               ],
               "description": "Points Source",
               "title": "Source",
               "x-union-pattern": 4
            }
         },
         "required": [
            "source"
         ],
         "title": "ListParameterStudyConfig",
         "type": "object"
      },
      "ListParameterStudyImportPointsFile": {
         "additionalProperties": false,
         "description": "File containing list of variable values to evaluate in a list parameter study",
         "properties": {
            "import_points_file": {
               "$ref": "#/$defs/ImportPointsFileConfig",
               "argument": "filename"
            }
         },
         "required": [
            "import_points_file"
         ],
         "title": "ListParameterStudyImportPointsFile",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "ListParameterStudyImportPointsFileCustomAnnotatedConfig"
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotatedConfig",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileFreeform",
         "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": [
      "list_parameter_study"
   ]
}

Fields:

list_parameter_study (dakota.spec.method.list_parameter_study.ListParameterStudyConfig)

field list_parameter_study: ListParameterStudyConfig [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.list_parameter_study.ListParameterStudyConfig

Samples variables as a specified values

Show JSON schema

{
   "title": "ListParameterStudyConfig",
   "description": "Samples variables as a specified values",
   "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"
            }
         ]
      },
      "source": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/ListOfPoints"
            },
            {
               "$ref": "#/$defs/ListParameterStudyImportPointsFile"
            }
         ],
         "description": "Points Source",
         "title": "Source",
         "x-union-pattern": 4
      }
   },
   "$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"
      },
      "ImportPointsFileConfig": {
         "additionalProperties": false,
         "description": "File containing list of variable values to evaluate in a list parameter study",
         "properties": {
            "filename": {
               "description": "File containing list of variable values to evaluate in a list parameter study",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_file",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileAnnotated"
                  },
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "ListParameterStudyImportPointsFileAnnotated",
               "x-union-pattern": 1
            },
            "active_only": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Import only active variables from tabular data file",
               "title": "Active Only",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_active_only",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            }
         },
         "required": [
            "filename"
         ],
         "title": "ImportPointsFileConfig",
         "type": "object"
      },
      "ListOfPoints": {
         "additionalProperties": false,
         "description": "List of variable values to evaluate in a list parameter study",
         "properties": {
            "list_of_points": {
               "description": "List of variable values to evaluate in a list parameter study",
               "items": {
                  "type": "number"
               },
               "title": "List Of Points",
               "type": "array",
               "x-materialization": [
                  {
                     "ir_key": "method.parameter_study.list_of_points",
                     "ir_value_type": "RealVector",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "list_of_points"
         ],
         "title": "ListOfPoints",
         "type": "object"
      },
      "ListParameterStudyImportPointsFile": {
         "additionalProperties": false,
         "description": "File containing list of variable values to evaluate in a list parameter study",
         "properties": {
            "import_points_file": {
               "$ref": "#/$defs/ImportPointsFileConfig",
               "argument": "filename"
            }
         },
         "required": [
            "import_points_file"
         ],
         "title": "ListParameterStudyImportPointsFile",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "ListParameterStudyImportPointsFileCustomAnnotatedConfig"
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotatedConfig",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileFreeform",
         "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": [
      "source"
   ]
}

Fields:

final_solutions (int)
id_method (str | None)
model_pointer (str | None)
output (dakota.spec.shared.misc.Debug | dakota.spec.shared.misc.Verbose | dakota.spec.shared.misc.Normal | dakota.spec.shared.misc.Quiet | dakota.spec.shared.misc.Silent)
source (dakota.spec.method.list_parameter_study.ListOfPoints | dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFile)

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 output: Debug | Verbose | Normal | Quiet | Silent [Optional]: Control how much method information is written to the screen and output file

field source: ListOfPoints | ListParameterStudyImportPointsFile [Required]: Points Source

Generated Pydantic models for method.list_parameter_study

pydantic model dakota.spec.method.list_parameter_study.ImportPointsFileConfig

File containing list of variable values to evaluate in a list parameter study

Show JSON schema

{
   "title": "ImportPointsFileConfig",
   "description": "File containing list of variable values to evaluate in a list parameter study",
   "type": "object",
   "properties": {
      "filename": {
         "description": "File containing list of variable values to evaluate in a list parameter study",
         "title": "Filename",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_file",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotated"
            },
            {
               "$ref": "#/$defs/ListParameterStudyImportPointsFileAnnotated"
            },
            {
               "$ref": "#/$defs/ListParameterStudyImportPointsFileFreeform"
            }
         ],
         "description": "Tabular Format",
         "title": "Format",
         "x-model-default": "ListParameterStudyImportPointsFileAnnotated",
         "x-union-pattern": 1
      },
      "active_only": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Import only active variables from tabular data file",
         "title": "Active Only",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_active_only",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      }
   },
   "$defs": {
      "ListParameterStudyImportPointsFileAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "ListParameterStudyImportPointsFileCustomAnnotatedConfig"
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotatedConfig",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "filename"
   ]
}

Fields:

active_only (Literal[True] | None)
filename (str)
format (dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileCustomAnnotated | dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileAnnotated | dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileFreeform)

field active_only: Literal[True] | None = None: Import only active variables from tabular data file

field filename: str [Required]: File containing list of variable values to evaluate in a list parameter study

field format: ListParameterStudyImportPointsFileCustomAnnotated | ListParameterStudyImportPointsFileAnnotated | ListParameterStudyImportPointsFileFreeform [Optional]: Tabular Format

pydantic model dakota.spec.method.list_parameter_study.ListOfPoints

List of variable values to evaluate in a list parameter study

Show JSON schema

{
   "title": "ListOfPoints",
   "description": "List of variable values to evaluate in a list parameter study",
   "type": "object",
   "properties": {
      "list_of_points": {
         "description": "List of variable values to evaluate in a list parameter study",
         "items": {
            "type": "number"
         },
         "title": "List Of Points",
         "type": "array",
         "x-materialization": [
            {
               "ir_key": "method.parameter_study.list_of_points",
               "ir_value_type": "RealVector",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "list_of_points"
   ]
}

Fields:

list_of_points (list[float])

field list_of_points: list[DakotaFloat] [Required]: List of variable values to evaluate in a list parameter study

pydantic model dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFile

File containing list of variable values to evaluate in a list parameter study

Show JSON schema

{
   "title": "ListParameterStudyImportPointsFile",
   "description": "File containing list of variable values to evaluate in a list parameter study",
   "type": "object",
   "properties": {
      "import_points_file": {
         "$ref": "#/$defs/ImportPointsFileConfig",
         "argument": "filename"
      }
   },
   "$defs": {
      "ImportPointsFileConfig": {
         "additionalProperties": false,
         "description": "File containing list of variable values to evaluate in a list parameter study",
         "properties": {
            "filename": {
               "description": "File containing list of variable values to evaluate in a list parameter study",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_file",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileAnnotated"
                  },
                  {
                     "$ref": "#/$defs/ListParameterStudyImportPointsFileFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "ListParameterStudyImportPointsFileAnnotated",
               "x-union-pattern": 1
            },
            "active_only": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Import only active variables from tabular data file",
               "title": "Active Only",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_active_only",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            }
         },
         "required": [
            "filename"
         ],
         "title": "ImportPointsFileConfig",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "ListParameterStudyImportPointsFileCustomAnnotatedConfig"
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotated",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotatedConfig",
         "type": "object"
      },
      "ListParameterStudyImportPointsFileFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "import_points_file"
   ]
}

Fields:

import_points_file (dakota.spec.method.list_parameter_study.ImportPointsFileConfig)

field import_points_file: ImportPointsFileConfig [Required]: File containing list of variable values to evaluate in a list parameter study

pydantic model dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileAnnotated

Selects annotated tabular file format

Show JSON schema

{
   "title": "ListParameterStudyImportPointsFileAnnotated",
   "description": "Selects annotated tabular file format",
   "type": "object",
   "properties": {
      "annotated": {
         "const": true,
         "default": true,
         "description": "Selects annotated tabular file format",
         "title": "Annotated",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_ANNOTATED"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

annotated (Literal[True])

field annotated: Literal[True] = True: Selects annotated tabular file format

pydantic model dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "ListParameterStudyImportPointsFileCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/ListParameterStudyImportPointsFileCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "ListParameterStudyImportPointsFileCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "ListParameterStudyImportPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.pstudy.import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "ListParameterStudyImportPointsFileCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

custom_annotated (dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileCustomAnnotatedConfig)

field custom_annotated: ListParameterStudyImportPointsFileCustomAnnotatedConfig [Optional]: Selects custom-annotated tabular file format

pydantic model dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "ListParameterStudyImportPointsFileCustomAnnotatedConfig",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "header": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable header row in custom-annotated tabular file",
         "title": "Header",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_HEADER"
            }
         ]
      },
      "eval_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable evaluation ID column in custom-annotated tabular file",
         "title": "Eval Id",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_EVAL_ID"
            }
         ]
      },
      "interface_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable interface ID column in custom-annotated tabular file",
         "title": "Interface Id",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_IFACE_ID"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

eval_id (Literal[True] | None)
header (Literal[True] | None)
interface_id (Literal[True] | None)

field eval_id: Literal[True] | None = None: Enable evaluation ID column in custom-annotated tabular file

field header: Literal[True] | None = None: Enable header row in custom-annotated tabular file

field interface_id: Literal[True] | None = None: Enable interface ID column in custom-annotated tabular file

pydantic model dakota.spec.method.list_parameter_study.ListParameterStudyImportPointsFileFreeform

Selects freeform file format

Show JSON schema

{
   "title": "ListParameterStudyImportPointsFileFreeform",
   "description": "Selects freeform file format",
   "type": "object",
   "properties": {
      "freeform": {
         "const": true,
         "default": true,
         "description": "Selects freeform file format",
         "title": "Freeform",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.pstudy.import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

freeform (Literal[True])

field freeform: Literal[True] = True: Selects freeform file format

list_parameter_study

Exceptional service in the national interest

`list_parameter_study`