Dakota Logo

Install

  • Download and Install Dakota

Getting Started with Dakota

  • What is Dakota?
  • Anatomy of a Dakota Study
  • Tutorial: Your First Dakota Study
  • Connecting Your Code: The Analysis Driver

Using Dakota

  • Using Dakota
  • Using Dakota GUI
  • Using External Tools
    • Preprocessing with dprepro and pyprepro
    • The Dakota Restart Utility
    • Pydantic Model Reference
      • Study
      • Methods
        • adaptive_sampling
        • approximate_control_variate
        • asynch_pattern_search
        • bayes_calibration
        • branch_and_bound
        • centered_parameter_study
        • coliny_beta
        • coliny_cobyla
        • coliny_direct
        • coliny_ea
        • coliny_pattern_search
        • coliny_solis_wets
        • conmin_frcg
        • conmin_mfd
        • dace
        • demo_tpl
        • dot_bfgs
        • dot_frcg
        • dot_mmfd
        • dot_slp
        • dot_sqp
        • efficient_global
        • external_python
        • fsu_cvt
        • fsu_quasi_mc
        • function_train
        • genie_direct
        • genie_opt_darts
        • global_evidence
        • global_interval_est
        • global_reliability
        • gpais
        • hybrid_sequential
        • import_points
        • importance_sampling
        • list_parameter_study
        • local_evidence
        • local_interval_est
        • local_reliability
        • mesh_adaptive_search
          • MeshAdaptiveSearchSelection
            • MeshAdaptiveSearchSelection.mesh_adaptive_search
          • MeshAdaptiveSearchConfig
            • MeshAdaptiveSearchConfig.display_all_evaluations
            • MeshAdaptiveSearchConfig.display_format
            • MeshAdaptiveSearchConfig.final_solutions
            • MeshAdaptiveSearchConfig.function_precision
            • MeshAdaptiveSearchConfig.history_file
            • MeshAdaptiveSearchConfig.id_method
            • MeshAdaptiveSearchConfig.initial_delta
            • MeshAdaptiveSearchConfig.max_function_evaluations
            • MeshAdaptiveSearchConfig.max_iterations
            • MeshAdaptiveSearchConfig.model_pointer
            • MeshAdaptiveSearchConfig.neighbor_order
            • MeshAdaptiveSearchConfig.output
            • MeshAdaptiveSearchConfig.scaling
            • MeshAdaptiveSearchConfig.seed
            • MeshAdaptiveSearchConfig.use_surrogate
            • MeshAdaptiveSearchConfig.variable_neighborhood_search
            • MeshAdaptiveSearchConfig.variable_tolerance
          • InformSearch
            • InformSearch.model_config
            • InformSearch.universal_validator()
          • Optimize
            • Optimize.model_config
            • Optimize.universal_validator()
        • moga
        • multi_start
        • multidim_parameter_study
        • multifidelity_function_train
        • multifidelity_polynomial_chaos
        • multifidelity_sampling
        • multifidelity_stoch_collocation
        • multilevel_blue
        • multilevel_function_train
        • multilevel_multifidelity_sampling
        • multilevel_polynomial_chaos
        • multilevel_sampling
        • ncsu_direct
        • nl2sol
        • nlpql_sqp
        • nlssol_sqp
        • nonlinear_cg
        • nowpac
        • npsol_sqp
        • optpp_cg
        • optpp_fd_newton
        • optpp_g_newton
        • optpp_newton
        • optpp_pds
        • optpp_q_newton
        • pareto_set
        • pof_darts
        • polynomial_chaos
        • psuade_moat
        • richardson_extrap
        • rkd_darts
        • rol
        • sampling
        • snowpac
        • soga
        • stoch_collocation
        • surrogate_based_global
        • surrogate_based_local
        • surrogate_based_uq
        • vector_parameter_study
      • Environment
      • Interface
      • Model
      • Responses
      • Variables
      • Shared
      • How to Work with the Pydantic Documentation
    • Working with Inputs

Building and Developing Dakota

  • Building Dakota
  • Developing Dakota

More

  • Miscellaneous
Dakota

Sandia National Laboratories

  • Search Sandia.gov
  • All Sandia Websites
  • Using External Tools
  • Pydantic Model Reference
  • Methods
  • mesh_adaptive_search
  • View page source

mesh_adaptive_search

pydantic model dakota.spec.method.mesh_adaptive_search.MeshAdaptiveSearchSelection

Generated model for MeshAdaptiveSearchSelection

Show JSON schema
{
   "title": "MeshAdaptiveSearchSelection",
   "description": "Generated model for MeshAdaptiveSearchSelection",
   "type": "object",
   "properties": {
      "mesh_adaptive_search": {
         "$ref": "#/$defs/MeshAdaptiveSearchConfig",
         "x-materialization": [
            {
               "ir_key": "method.algorithm",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "MESH_ADAPTIVE_SEARCH"
            }
         ]
      }
   },
   "$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"
      },
      "InformSearch": {
         "additionalProperties": false,
         "description": "Surrogate informs evaluation order in mesh adaptive search",
         "properties": {
            "inform_search": {
               "const": true,
               "default": true,
               "description": "Surrogate informs evaluation order in mesh adaptive search",
               "title": "Inform Search",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.use_surrogate",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "inform_search"
                  }
               ]
            }
         },
         "title": "InformSearch",
         "type": "object"
      },
      "MeshAdaptiveSearchConfig": {
         "additionalProperties": false,
         "description": "Finds optimal variable values using adaptive mesh-based search",
         "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"
                  }
               ]
            },
            "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"
                  }
               ]
            },
            "max_function_evaluations": {
               "default": 9223372036854775807,
               "description": "Number of function evaluations allowed for optimizers",
               "minimum": 0,
               "title": "Max Function Evaluations",
               "type": "integer",
               "x-materialization": [
                  {
                     "ir_key": "method.max_function_evaluations",
                     "ir_value_type": "size_t",
                     "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"
                  }
               ]
            },
            "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"
                  }
               ],
               "x-taglist": "method"
            },
            "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"
                  }
               ]
            },
            "initial_delta": {
               "default": 1.0,
               "description": "Initial step size for derivative-free optimizers",
               "title": "Initial Delta",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.initial_delta",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "variable_tolerance": {
               "default": 1e-06,
               "description": "Step length-based stopping criteria for derivative-free optimizers",
               "title": "Variable Tolerance",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.variable_tolerance",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "function_precision": {
               "default": 1e-10,
               "description": "Specify the maximum precision of the analysis code responses",
               "title": "Function Precision",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.function_precision",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "seed": {
               "anyOf": [
                  {
                     "exclusiveMinimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Seed of the random number generator",
               "title": "Seed",
               "x-materialization": [
                  {
                     "ir_key": "method.random_seed",
                     "ir_value_type": "int",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "history_file": {
               "default": "mads_history",
               "description": "Name of file where mesh adaptive search records all evaluation points.",
               "title": "History File",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.history_file",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "display_format": {
               "default": "bbe obj",
               "description": "Information to be reported from mesh adaptive search's internal records.",
               "title": "Display Format",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.display_format",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "variable_neighborhood_search": {
               "default": 0.0,
               "description": "Percentage of evaluations to do to escape local minima.",
               "title": "Variable Neighborhood Search",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.variable_neighborhood_search",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "neighbor_order": {
               "default": 1,
               "description": "Number of dimensions in which to perturb categorical variables.",
               "exclusiveMinimum": 0,
               "title": "Neighbor Order",
               "type": "integer",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.neighbor_order",
                     "ir_value_type": "int",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "display_all_evaluations": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Shows mesh adaptive search's internally held list of all evaluations",
               "title": "Display All Evaluations",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.display_all_evaluations",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            },
            "use_surrogate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/InformSearch"
                  },
                  {
                     "$ref": "#/$defs/Optimize"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Surrogate model usage mode for mesh adaptive search",
               "title": "Use Surrogate",
               "x-union-pattern": 2
            }
         },
         "title": "MeshAdaptiveSearchConfig",
         "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"
      },
      "Optimize": {
         "additionalProperties": false,
         "description": "Surrogate is used in lieu of true model for mesh adaptive search",
         "properties": {
            "optimize": {
               "const": true,
               "default": true,
               "description": "Surrogate is used in lieu of true model for mesh adaptive search",
               "title": "Optimize",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.use_surrogate",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "optimize"
                  }
               ]
            }
         },
         "title": "Optimize",
         "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": [
      "mesh_adaptive_search"
   ]
}

Fields:
  • mesh_adaptive_search (MeshAdaptiveSearchConfig)

field mesh_adaptive_search: MeshAdaptiveSearchConfig [Required]
pydantic model dakota.spec.method.mesh_adaptive_search.MeshAdaptiveSearchConfig

Finds optimal variable values using adaptive mesh-based search

Show JSON schema
{
   "title": "MeshAdaptiveSearchConfig",
   "description": "Finds optimal variable values using adaptive mesh-based search",
   "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"
            }
         ]
      },
      "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"
            }
         ]
      },
      "max_function_evaluations": {
         "default": 9223372036854775807,
         "description": "Number of function evaluations allowed for optimizers",
         "minimum": 0,
         "title": "Max Function Evaluations",
         "type": "integer",
         "x-materialization": [
            {
               "ir_key": "method.max_function_evaluations",
               "ir_value_type": "size_t",
               "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"
            }
         ]
      },
      "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"
            }
         ],
         "x-taglist": "method"
      },
      "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"
            }
         ]
      },
      "initial_delta": {
         "default": 1.0,
         "description": "Initial step size for derivative-free optimizers",
         "title": "Initial Delta",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.mesh_adaptive_search.initial_delta",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "variable_tolerance": {
         "default": 1e-06,
         "description": "Step length-based stopping criteria for derivative-free optimizers",
         "title": "Variable Tolerance",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.mesh_adaptive_search.variable_tolerance",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "function_precision": {
         "default": 1e-10,
         "description": "Specify the maximum precision of the analysis code responses",
         "title": "Function Precision",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.function_precision",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "seed": {
         "anyOf": [
            {
               "exclusiveMinimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Seed of the random number generator",
         "title": "Seed",
         "x-materialization": [
            {
               "ir_key": "method.random_seed",
               "ir_value_type": "int",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "history_file": {
         "default": "mads_history",
         "description": "Name of file where mesh adaptive search records all evaluation points.",
         "title": "History File",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "method.mesh_adaptive_search.history_file",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "display_format": {
         "default": "bbe obj",
         "description": "Information to be reported from mesh adaptive search's internal records.",
         "title": "Display Format",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "method.mesh_adaptive_search.display_format",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "variable_neighborhood_search": {
         "default": 0.0,
         "description": "Percentage of evaluations to do to escape local minima.",
         "title": "Variable Neighborhood Search",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.mesh_adaptive_search.variable_neighborhood_search",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "neighbor_order": {
         "default": 1,
         "description": "Number of dimensions in which to perturb categorical variables.",
         "exclusiveMinimum": 0,
         "title": "Neighbor Order",
         "type": "integer",
         "x-materialization": [
            {
               "ir_key": "method.mesh_adaptive_search.neighbor_order",
               "ir_value_type": "int",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "display_all_evaluations": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Shows mesh adaptive search's internally held list of all evaluations",
         "title": "Display All Evaluations",
         "x-materialization": [
            {
               "ir_key": "method.mesh_adaptive_search.display_all_evaluations",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "use_surrogate": {
         "anyOf": [
            {
               "$ref": "#/$defs/InformSearch"
            },
            {
               "$ref": "#/$defs/Optimize"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Surrogate model usage mode for mesh adaptive search",
         "title": "Use Surrogate",
         "x-union-pattern": 2
      }
   },
   "$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"
      },
      "InformSearch": {
         "additionalProperties": false,
         "description": "Surrogate informs evaluation order in mesh adaptive search",
         "properties": {
            "inform_search": {
               "const": true,
               "default": true,
               "description": "Surrogate informs evaluation order in mesh adaptive search",
               "title": "Inform Search",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.use_surrogate",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "inform_search"
                  }
               ]
            }
         },
         "title": "InformSearch",
         "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"
      },
      "Optimize": {
         "additionalProperties": false,
         "description": "Surrogate is used in lieu of true model for mesh adaptive search",
         "properties": {
            "optimize": {
               "const": true,
               "default": true,
               "description": "Surrogate is used in lieu of true model for mesh adaptive search",
               "title": "Optimize",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.mesh_adaptive_search.use_surrogate",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "optimize"
                  }
               ]
            }
         },
         "title": "Optimize",
         "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
}

Fields:
  • display_all_evaluations (Literal[True] | None)

  • display_format (str)

  • final_solutions ()

  • function_precision (DakotaFloat)

  • history_file (str)

  • id_method ()

  • initial_delta (DakotaFloat)

  • max_function_evaluations ()

  • max_iterations ()

  • model_pointer ()

  • neighbor_order (int)

  • output ()

  • scaling ()

  • seed (int | None)

  • use_surrogate (Union[InformSearch, Optimize] | None)

  • variable_neighborhood_search (DakotaFloat)

  • variable_tolerance (DakotaFloat)

field display_all_evaluations: Literal[True] | None = None

Shows mesh adaptive search’s internally held list of all evaluations

field display_format: str = 'bbe obj'

Information to be reported from mesh adaptive search’s internal records.

field final_solutions: int = 0

Number of designs returned as the best solutions

Constraints:
  • ge = 0

field function_precision: DakotaFloat = 1e-10

Specify the maximum precision of the analysis code responses

Constraints:
  • func = <function _serialize_dakota_float at 0x7f5db8efeca0>

  • return_type = float | str

  • when_used = json

field history_file: str = 'mads_history'

Name of file where mesh adaptive search records all evaluation points.

field id_method: str | None = None

Name the method block; helpful when there are multiple

field initial_delta: DakotaFloat = 1.0

Initial step size for derivative-free optimizers

Constraints:
  • func = <function _serialize_dakota_float at 0x7f5db8efeca0>

  • return_type = float | str

  • when_used = json

field max_function_evaluations: int = 9223372036854775807

Number of function evaluations allowed for optimizers

Constraints:
  • ge = 0

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 neighbor_order: int = 1

Number of dimensions in which to perturb categorical variables.

Constraints:
  • gt = 0

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 seed: int | None = None

Seed of the random number generator

Constraints:
  • gt = 0

field use_surrogate: InformSearch | Optimize | None = None

Surrogate model usage mode for mesh adaptive search

field variable_neighborhood_search: DakotaFloat = 0.0

Percentage of evaluations to do to escape local minima.

Constraints:
  • func = <function _serialize_dakota_float at 0x7f5db8efeca0>

  • return_type = float | str

  • when_used = json

field variable_tolerance: DakotaFloat = 1e-06

Step length-based stopping criteria for derivative-free optimizers

Constraints:
  • func = <function _serialize_dakota_float at 0x7f5db8efeca0>

  • return_type = float | str

  • when_used = json

Generated Pydantic models for method.mesh_adaptive_search

class dakota.spec.method.mesh_adaptive_search.InformSearch(*, inform_search: Literal[True] = True)

Surrogate informs evaluation order in mesh adaptive search

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.method.mesh_adaptive_search.Optimize(*, optimize: Literal[True] = True)

Surrogate is used in lieu of true model for mesh adaptive search

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

Previous Next

Exceptional service in the national interest

© 2023 National Technology and Engineering Solutions of Sandia, LLC. | Questions & Comments | Privacy & Security

U.S. Department of Energy National Nuclear Security Administration

Sandia National Laboratories is a multimission laboratory managed and operated by National Technology and Engineering Solutions of Sandia, LLC., a wholly owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy’s National Nuclear Security Administration under contract DE-NA-0003525.