branch_and_bound

pydantic model dakota.spec.method.branch_and_bound.BranchAndBoundSelection

Generated model for BranchAndBoundSelection

Show JSON schema

{
   "title": "BranchAndBoundSelection",
   "description": "Generated model for BranchAndBoundSelection",
   "type": "object",
   "properties": {
      "branch_and_bound": {
         "$ref": "#/$defs/BranchAndBoundConfig",
         "x-materialization": [
            {
               "ir_key": "method.algorithm",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "BRANCH_AND_BOUND"
            }
         ]
      }
   },
   "$defs": {
      "BranchAndBoundConfig": {
         "additionalProperties": false,
         "description": "(Experimental Capability) Solves a mixed integer nonlinear optimization problem",
         "properties": {
            "scaling": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Turn on scaling for variables, responses, and constraints",
               "title": "Scaling",
               "x-materialization": [
                  {
                     "ir_key": "method.scaling",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            },
            "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"
                  }
               ]
            },
            "sub_method": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/BranchAndBoundMethodPointer"
                  },
                  {
                     "$ref": "#/$defs/BranchAndBoundMethodName"
                  }
               ],
               "description": "Local Optimizer Selection",
               "title": "Sub Method",
               "x-union-pattern": 4
            }
         },
         "required": [
            "sub_method"
         ],
         "title": "BranchAndBoundConfig",
         "type": "object"
      },
      "BranchAndBoundMethodName": {
         "additionalProperties": false,
         "description": "Specify sub-method by name",
         "properties": {
            "method_name": {
               "$ref": "#/$defs/BranchAndBoundMethodNameConfig",
               "argument": "name"
            }
         },
         "required": [
            "method_name"
         ],
         "title": "BranchAndBoundMethodName",
         "type": "object"
      },
      "BranchAndBoundMethodNameConfig": {
         "additionalProperties": false,
         "description": "Specify sub-method by name",
         "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"
                  }
               ]
            },
            "name": {
               "description": "Specify sub-method by name",
               "title": "Name",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.sub_method_name",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "name"
         ],
         "title": "BranchAndBoundMethodNameConfig",
         "type": "object"
      },
      "BranchAndBoundMethodPointer": {
         "additionalProperties": false,
         "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem",
         "properties": {
            "method_pointer": {
               "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem",
               "title": "Method Pointer",
               "type": "string",
               "x-block-pointer": "method",
               "x-materialization": [
                  {
                     "ir_key": "method.sub_method_pointer",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "method_pointer"
         ],
         "title": "BranchAndBoundMethodPointer",
         "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"
      },
      "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": [
      "branch_and_bound"
   ]
}

Fields:

• branch_and_bound (dakota.spec.method.branch_and_bound.BranchAndBoundConfig)

field branch_and_bound: BranchAndBoundConfig [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.branch_and_bound.BranchAndBoundConfig

(Experimental Capability) Solves a mixed integer nonlinear optimization problem

Show JSON schema

{
   "title": "BranchAndBoundConfig",
   "description": "(Experimental Capability) Solves a mixed integer nonlinear optimization problem",
   "type": "object",
   "properties": {
      "scaling": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Turn on scaling for variables, responses, and constraints",
         "title": "Scaling",
         "x-materialization": [
            {
               "ir_key": "method.scaling",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "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"
            }
         ]
      },
      "sub_method": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/BranchAndBoundMethodPointer"
            },
            {
               "$ref": "#/$defs/BranchAndBoundMethodName"
            }
         ],
         "description": "Local Optimizer Selection",
         "title": "Sub Method",
         "x-union-pattern": 4
      }
   },
   "$defs": {
      "BranchAndBoundMethodName": {
         "additionalProperties": false,
         "description": "Specify sub-method by name",
         "properties": {
            "method_name": {
               "$ref": "#/$defs/BranchAndBoundMethodNameConfig",
               "argument": "name"
            }
         },
         "required": [
            "method_name"
         ],
         "title": "BranchAndBoundMethodName",
         "type": "object"
      },
      "BranchAndBoundMethodNameConfig": {
         "additionalProperties": false,
         "description": "Specify sub-method by name",
         "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"
                  }
               ]
            },
            "name": {
               "description": "Specify sub-method by name",
               "title": "Name",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.sub_method_name",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "name"
         ],
         "title": "BranchAndBoundMethodNameConfig",
         "type": "object"
      },
      "BranchAndBoundMethodPointer": {
         "additionalProperties": false,
         "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem",
         "properties": {
            "method_pointer": {
               "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem",
               "title": "Method Pointer",
               "type": "string",
               "x-block-pointer": "method",
               "x-materialization": [
                  {
                     "ir_key": "method.sub_method_pointer",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "method_pointer"
         ],
         "title": "BranchAndBoundMethodPointer",
         "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"
      },
      "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": [
      "sub_method"
   ]
}

Fields:

• final_solutions (int)

• id_method (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)

• scaling (Literal[True] | None)

• sub_method (dakota.spec.method.branch_and_bound.BranchAndBoundMethodPointer | dakota.spec.method.branch_and_bound.BranchAndBoundMethodName)

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 output: Debug | Verbose | Normal | Quiet | Silent [Optional]

Control how much method information is written to the screen and output file

field scaling: Literal[True] | None = None

Turn on scaling for variables, responses, and constraints

field sub_method: BranchAndBoundMethodPointer | BranchAndBoundMethodName [Required]

Local Optimizer Selection

Generated Pydantic models for method.branch_and_bound

pydantic model dakota.spec.method.branch_and_bound.BranchAndBoundMethodName

Specify sub-method by name

Show JSON schema

{
   "title": "BranchAndBoundMethodName",
   "description": "Specify sub-method by name",
   "type": "object",
   "properties": {
      "method_name": {
         "$ref": "#/$defs/BranchAndBoundMethodNameConfig",
         "argument": "name"
      }
   },
   "$defs": {
      "BranchAndBoundMethodNameConfig": {
         "additionalProperties": false,
         "description": "Specify sub-method by name",
         "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"
                  }
               ]
            },
            "name": {
               "description": "Specify sub-method by name",
               "title": "Name",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.sub_method_name",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "name"
         ],
         "title": "BranchAndBoundMethodNameConfig",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "method_name"
   ]
}

Fields:

• method_name (dakota.spec.method.branch_and_bound.BranchAndBoundMethodNameConfig)

field method_name: BranchAndBoundMethodNameConfig [Required]

Specify sub-method by name

pydantic model dakota.spec.method.branch_and_bound.BranchAndBoundMethodNameConfig

Specify sub-method by name

Show JSON schema

{
   "title": "BranchAndBoundMethodNameConfig",
   "description": "Specify sub-method by name",
   "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"
            }
         ]
      },
      "name": {
         "description": "Specify sub-method by name",
         "title": "Name",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "method.sub_method_name",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "name"
   ]
}

Fields:

• model_pointer (str | None)

• name (str)

field model_pointer: str | None = None

Identifier for model block to be used by a method

field name: str [Required]

Specify sub-method by name

pydantic model dakota.spec.method.branch_and_bound.BranchAndBoundMethodPointer

Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem

Show JSON schema

{
   "title": "BranchAndBoundMethodPointer",
   "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem",
   "type": "object",
   "properties": {
      "method_pointer": {
         "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem",
         "title": "Method Pointer",
         "type": "string",
         "x-block-pointer": "method",
         "x-materialization": [
            {
               "ir_key": "method.sub_method_pointer",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "method_pointer"
   ]
}

Fields:

• method_pointer (str)

field method_pointer: str [Required]

Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem