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
          • ColinyPatternSearchSelection
            • ColinyPatternSearchSelection.coliny_pattern_search
          • ColinyPatternSearchConfig
            • ColinyPatternSearchConfig.constant_penalty
            • ColinyPatternSearchConfig.constraint_penalty
            • ColinyPatternSearchConfig.contraction_factor
            • ColinyPatternSearchConfig.convergence_tolerance
            • ColinyPatternSearchConfig.expand_after_success
            • ColinyPatternSearchConfig.exploratory_moves
            • ColinyPatternSearchConfig.final_solutions
            • ColinyPatternSearchConfig.id_method
            • ColinyPatternSearchConfig.initial_delta
            • ColinyPatternSearchConfig.max_function_evaluations
            • ColinyPatternSearchConfig.max_iterations
            • ColinyPatternSearchConfig.misc_options
            • ColinyPatternSearchConfig.model_pointer
            • ColinyPatternSearchConfig.no_expansion
            • ColinyPatternSearchConfig.output
            • ColinyPatternSearchConfig.pattern_basis
            • ColinyPatternSearchConfig.scaling
            • ColinyPatternSearchConfig.seed
            • ColinyPatternSearchConfig.show_misc_options
            • ColinyPatternSearchConfig.solution_target
            • ColinyPatternSearchConfig.stochastic
            • ColinyPatternSearchConfig.synchronization
            • ColinyPatternSearchConfig.total_pattern_size
            • ColinyPatternSearchConfig.variable_tolerance
          • Coordinate
            • Coordinate.model_config
            • Coordinate.universal_validator()
          • Simplex
            • Simplex.model_config
            • Simplex.universal_validator()
          • MultiStep
            • MultiStep.model_config
            • MultiStep.universal_validator()
          • AdaptivePattern
            • AdaptivePattern.model_config
            • AdaptivePattern.universal_validator()
          • BasicPattern
            • BasicPattern.model_config
            • BasicPattern.universal_validator()
        • 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
        • 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
  • coliny_pattern_search
  • View page source

coliny_pattern_search

pydantic model dakota.spec.method.coliny_pattern_search.ColinyPatternSearchSelection

Generated model for ColinyPatternSearchSelection

Show JSON schema
{
   "title": "ColinyPatternSearchSelection",
   "description": "Generated model for ColinyPatternSearchSelection",
   "type": "object",
   "properties": {
      "coliny_pattern_search": {
         "$ref": "#/$defs/ColinyPatternSearchConfig",
         "x-group": "Optimization: Local, Derivative-free",
         "x-materialization": [
            {
               "ir_key": "method.algorithm",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "COLINY_PATTERN_SEARCH"
            }
         ]
      }
   },
   "$defs": {
      "AdaptivePattern": {
         "additionalProperties": false,
         "description": "Adaptively rescale search directions",
         "properties": {
            "adaptive_pattern": {
               "const": true,
               "default": true,
               "description": "Adaptively rescale search directions",
               "title": "Adaptive Pattern",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.exploratory_moves",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "adaptive"
                  }
               ]
            }
         },
         "title": "AdaptivePattern",
         "type": "object"
      },
      "BasicPattern": {
         "additionalProperties": false,
         "description": "Use the same search pattern every iteration",
         "properties": {
            "basic_pattern": {
               "const": true,
               "default": true,
               "description": "Use the same search pattern every iteration",
               "title": "Basic Pattern",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.exploratory_moves",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "simple"
                  }
               ]
            }
         },
         "title": "BasicPattern",
         "type": "object"
      },
      "Blocking": {
         "additionalProperties": false,
         "description": "Complete concurrent evaluation of all evaluations within a batch",
         "properties": {
            "blocking": {
               "const": true,
               "default": true,
               "description": "Complete concurrent evaluation of all evaluations within a batch",
               "title": "Blocking",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.synchronization",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "BLOCKING_SYNCHRONIZATION"
                  }
               ]
            }
         },
         "title": "Blocking",
         "type": "object"
      },
      "ColinyPatternSearchConfig": {
         "additionalProperties": false,
         "description": "Pattern search, derivative free optimization method",
         "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"
                  }
               ]
            },
            "solution_target": {
               "default": -1.7976931348623157e+308,
               "description": "Stopping criteria based on objective function value",
               "title": "Solution Target",
               "type": "number",
               "x-aliases": [
                  "solution_accuracy"
               ],
               "x-materialization": [
                  {
                     "ir_key": "method.asynch_pattern_search.solution_target",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  },
                  {
                     "ir_key": "method.solution_target",
                     "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"
                  }
               ]
            },
            "show_misc_options": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Show algorithm parameters not exposed in Dakota input",
               "title": "Show Misc Options",
               "x-complexity": 1,
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.show_misc_options",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            },
            "misc_options": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Set method options not available through Dakota spec",
               "title": "Misc Options",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.misc_options",
                     "ir_value_type": "StringArray",
                     "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"
                  }
               ]
            },
            "convergence_tolerance": {
               "default": -1.7976931348623157e+308,
               "description": "Stopping criterion based on objective function or statistics convergence",
               "title": "Convergence Tolerance",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.convergence_tolerance",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  },
                  {
                     "ir_key": "method.jega.percent_change",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "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"
                  }
               ]
            },
            "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"
                  }
               ]
            },
            "synchronization": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blocking"
                  },
                  {
                     "$ref": "#/$defs/Nonblocking"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Select how Dakota schedules a batch of concurrent function evaluations in a parallel algorithm",
               "title": "Synchronization",
               "x-union-pattern": 2
            },
            "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"
                  }
               ]
            },
            "constant_penalty": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Use a simple weighted penalty to manage feasibility",
               "title": "Constant Penalty",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.constant_penalty",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            },
            "no_expansion": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Don't allow expansion of the search pattern",
               "title": "No Expansion",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.expansion",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_FALSE"
                  }
               ]
            },
            "expand_after_success": {
               "default": 0,
               "description": "Set the factor by which a search pattern can be expanded",
               "title": "Expand After Success",
               "type": "integer",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.expand_after_success",
                     "ir_value_type": "int",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "pattern_basis": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Coordinate"
                  },
                  {
                     "$ref": "#/$defs/Simplex"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Pattern basis selection",
               "title": "Pattern Basis",
               "x-union-pattern": 2
            },
            "stochastic": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Generate trial points in random order",
               "title": "Stochastic",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.randomize",
                     "ir_value_type": "bool",
                     "storage_type": "PRESENCE_TRUE"
                  }
               ]
            },
            "total_pattern_size": {
               "default": 0,
               "description": "Total number of points in search pattern",
               "title": "Total Pattern Size",
               "type": "integer",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.total_pattern_size",
                     "ir_value_type": "int",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "exploratory_moves": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MultiStep"
                  },
                  {
                     "$ref": "#/$defs/AdaptivePattern"
                  },
                  {
                     "$ref": "#/$defs/BasicPattern"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Exploratory moves selection",
               "title": "Exploratory Moves",
               "x-union-pattern": 2
            },
            "contraction_factor": {
               "default": 0.5,
               "description": "Amount by which step length is rescaled",
               "title": "Contraction Factor",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.contraction_factor",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "constraint_penalty": {
               "default": -1.0,
               "description": "Multiplier for the penalty function",
               "title": "Constraint Penalty",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.constraint_penalty",
                     "ir_value_type": "Real",
                     "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.coliny.initial_delta",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "variable_tolerance": {
               "default": -1.0,
               "description": "Step length-based stopping criteria for derivative-free optimizers",
               "title": "Variable Tolerance",
               "type": "number",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.variable_tolerance",
                     "ir_value_type": "Real",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "title": "ColinyPatternSearchConfig",
         "type": "object"
      },
      "Coordinate": {
         "additionalProperties": false,
         "description": "Use coordinate directions as search pattern",
         "properties": {
            "coordinate": {
               "const": true,
               "default": true,
               "description": "Use coordinate directions as search pattern",
               "title": "Coordinate",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.pattern_basis",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "coordinate"
                  }
               ]
            }
         },
         "title": "Coordinate",
         "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"
      },
      "MultiStep": {
         "additionalProperties": false,
         "description": "Examine trial step around successful new point",
         "properties": {
            "multi_step": {
               "const": true,
               "default": true,
               "description": "Examine trial step around successful new point",
               "title": "Multi Step",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.exploratory_moves",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "multi_step"
                  }
               ]
            }
         },
         "title": "MultiStep",
         "type": "object"
      },
      "Nonblocking": {
         "additionalProperties": false,
         "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm",
         "properties": {
            "nonblocking": {
               "const": true,
               "default": true,
               "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm",
               "title": "Nonblocking",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.synchronization",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "NONBLOCKING_SYNCHRONIZATION"
                  }
               ]
            }
         },
         "title": "Nonblocking",
         "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"
      },
      "Simplex": {
         "additionalProperties": false,
         "description": "Use a minimal simplex for the search pattern",
         "properties": {
            "simplex": {
               "const": true,
               "default": true,
               "description": "Use a minimal simplex for the search pattern",
               "title": "Simplex",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.pattern_basis",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "simplex"
                  }
               ]
            }
         },
         "title": "Simplex",
         "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": [
      "coliny_pattern_search"
   ]
}

Fields:
  • coliny_pattern_search (ColinyPatternSearchConfig)

field coliny_pattern_search: ColinyPatternSearchConfig [Required]
pydantic model dakota.spec.method.coliny_pattern_search.ColinyPatternSearchConfig

Pattern search, derivative free optimization method

Show JSON schema
{
   "title": "ColinyPatternSearchConfig",
   "description": "Pattern search, derivative free optimization method",
   "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"
            }
         ]
      },
      "solution_target": {
         "default": -1.7976931348623157e+308,
         "description": "Stopping criteria based on objective function value",
         "title": "Solution Target",
         "type": "number",
         "x-aliases": [
            "solution_accuracy"
         ],
         "x-materialization": [
            {
               "ir_key": "method.asynch_pattern_search.solution_target",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            },
            {
               "ir_key": "method.solution_target",
               "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"
            }
         ]
      },
      "show_misc_options": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Show algorithm parameters not exposed in Dakota input",
         "title": "Show Misc Options",
         "x-complexity": 1,
         "x-materialization": [
            {
               "ir_key": "method.coliny.show_misc_options",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "misc_options": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Set method options not available through Dakota spec",
         "title": "Misc Options",
         "x-materialization": [
            {
               "ir_key": "method.coliny.misc_options",
               "ir_value_type": "StringArray",
               "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"
            }
         ]
      },
      "convergence_tolerance": {
         "default": -1.7976931348623157e+308,
         "description": "Stopping criterion based on objective function or statistics convergence",
         "title": "Convergence Tolerance",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.convergence_tolerance",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            },
            {
               "ir_key": "method.jega.percent_change",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "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"
            }
         ]
      },
      "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"
            }
         ]
      },
      "synchronization": {
         "anyOf": [
            {
               "$ref": "#/$defs/Blocking"
            },
            {
               "$ref": "#/$defs/Nonblocking"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Select how Dakota schedules a batch of concurrent function evaluations in a parallel algorithm",
         "title": "Synchronization",
         "x-union-pattern": 2
      },
      "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"
            }
         ]
      },
      "constant_penalty": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Use a simple weighted penalty to manage feasibility",
         "title": "Constant Penalty",
         "x-materialization": [
            {
               "ir_key": "method.coliny.constant_penalty",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "no_expansion": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Don't allow expansion of the search pattern",
         "title": "No Expansion",
         "x-materialization": [
            {
               "ir_key": "method.coliny.expansion",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_FALSE"
            }
         ]
      },
      "expand_after_success": {
         "default": 0,
         "description": "Set the factor by which a search pattern can be expanded",
         "title": "Expand After Success",
         "type": "integer",
         "x-materialization": [
            {
               "ir_key": "method.coliny.expand_after_success",
               "ir_value_type": "int",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "pattern_basis": {
         "anyOf": [
            {
               "$ref": "#/$defs/Coordinate"
            },
            {
               "$ref": "#/$defs/Simplex"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Pattern basis selection",
         "title": "Pattern Basis",
         "x-union-pattern": 2
      },
      "stochastic": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Generate trial points in random order",
         "title": "Stochastic",
         "x-materialization": [
            {
               "ir_key": "method.coliny.randomize",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "total_pattern_size": {
         "default": 0,
         "description": "Total number of points in search pattern",
         "title": "Total Pattern Size",
         "type": "integer",
         "x-materialization": [
            {
               "ir_key": "method.coliny.total_pattern_size",
               "ir_value_type": "int",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "exploratory_moves": {
         "anyOf": [
            {
               "$ref": "#/$defs/MultiStep"
            },
            {
               "$ref": "#/$defs/AdaptivePattern"
            },
            {
               "$ref": "#/$defs/BasicPattern"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Exploratory moves selection",
         "title": "Exploratory Moves",
         "x-union-pattern": 2
      },
      "contraction_factor": {
         "default": 0.5,
         "description": "Amount by which step length is rescaled",
         "title": "Contraction Factor",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.coliny.contraction_factor",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "constraint_penalty": {
         "default": -1.0,
         "description": "Multiplier for the penalty function",
         "title": "Constraint Penalty",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.constraint_penalty",
               "ir_value_type": "Real",
               "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.coliny.initial_delta",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "variable_tolerance": {
         "default": -1.0,
         "description": "Step length-based stopping criteria for derivative-free optimizers",
         "title": "Variable Tolerance",
         "type": "number",
         "x-materialization": [
            {
               "ir_key": "method.coliny.variable_tolerance",
               "ir_value_type": "Real",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "$defs": {
      "AdaptivePattern": {
         "additionalProperties": false,
         "description": "Adaptively rescale search directions",
         "properties": {
            "adaptive_pattern": {
               "const": true,
               "default": true,
               "description": "Adaptively rescale search directions",
               "title": "Adaptive Pattern",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.exploratory_moves",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "adaptive"
                  }
               ]
            }
         },
         "title": "AdaptivePattern",
         "type": "object"
      },
      "BasicPattern": {
         "additionalProperties": false,
         "description": "Use the same search pattern every iteration",
         "properties": {
            "basic_pattern": {
               "const": true,
               "default": true,
               "description": "Use the same search pattern every iteration",
               "title": "Basic Pattern",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.exploratory_moves",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "simple"
                  }
               ]
            }
         },
         "title": "BasicPattern",
         "type": "object"
      },
      "Blocking": {
         "additionalProperties": false,
         "description": "Complete concurrent evaluation of all evaluations within a batch",
         "properties": {
            "blocking": {
               "const": true,
               "default": true,
               "description": "Complete concurrent evaluation of all evaluations within a batch",
               "title": "Blocking",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.synchronization",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "BLOCKING_SYNCHRONIZATION"
                  }
               ]
            }
         },
         "title": "Blocking",
         "type": "object"
      },
      "Coordinate": {
         "additionalProperties": false,
         "description": "Use coordinate directions as search pattern",
         "properties": {
            "coordinate": {
               "const": true,
               "default": true,
               "description": "Use coordinate directions as search pattern",
               "title": "Coordinate",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.pattern_basis",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "coordinate"
                  }
               ]
            }
         },
         "title": "Coordinate",
         "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"
      },
      "MultiStep": {
         "additionalProperties": false,
         "description": "Examine trial step around successful new point",
         "properties": {
            "multi_step": {
               "const": true,
               "default": true,
               "description": "Examine trial step around successful new point",
               "title": "Multi Step",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.exploratory_moves",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "multi_step"
                  }
               ]
            }
         },
         "title": "MultiStep",
         "type": "object"
      },
      "Nonblocking": {
         "additionalProperties": false,
         "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm",
         "properties": {
            "nonblocking": {
               "const": true,
               "default": true,
               "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm",
               "title": "Nonblocking",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.synchronization",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "NONBLOCKING_SYNCHRONIZATION"
                  }
               ]
            }
         },
         "title": "Nonblocking",
         "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"
      },
      "Simplex": {
         "additionalProperties": false,
         "description": "Use a minimal simplex for the search pattern",
         "properties": {
            "simplex": {
               "const": true,
               "default": true,
               "description": "Use a minimal simplex for the search pattern",
               "title": "Simplex",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.coliny.pattern_basis",
                     "ir_value_type": "String",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": "simplex"
                  }
               ]
            }
         },
         "title": "Simplex",
         "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:
  • constant_penalty (Literal[True] | None)

  • constraint_penalty (DakotaFloat)

  • contraction_factor (DakotaFloat)

  • convergence_tolerance ()

  • expand_after_success (int)

  • exploratory_moves (Union[MultiStep, AdaptivePattern, BasicPattern] | None)

  • final_solutions ()

  • id_method ()

  • initial_delta (DakotaFloat)

  • max_function_evaluations ()

  • max_iterations ()

  • misc_options ()

  • model_pointer ()

  • no_expansion (Literal[True] | None)

  • output ()

  • pattern_basis (Union[Coordinate, Simplex] | None)

  • scaling ()

  • seed ()

  • show_misc_options ()

  • solution_target ()

  • stochastic (Literal[True] | None)

  • synchronization ()

  • total_pattern_size (int)

  • variable_tolerance (DakotaFloat)

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

Use a simple weighted penalty to manage feasibility

field constraint_penalty: DakotaFloat = -1.0

Multiplier for the penalty function

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

  • return_type = float | str

  • when_used = json

field contraction_factor: DakotaFloat = 0.5

Amount by which step length is rescaled

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

  • return_type = float | str

  • when_used = json

field convergence_tolerance: DakotaFloat = -1.7976931348623157e+308

Stopping criterion based on objective function or statistics convergence

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

  • return_type = float | str

  • when_used = json

field expand_after_success: int = 0

Set the factor by which a search pattern can be expanded

field exploratory_moves: MultiStep | AdaptivePattern | BasicPattern | None = None

Exploratory moves selection

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 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 misc_options: list[str] | None = None

Set method options not available through Dakota spec

field model_pointer: str | None = None

Identifier for model block to be used by a method

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

Don’t allow expansion of the search pattern

field output: Debug | Verbose | Normal | Quiet | Silent [Optional]

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

field pattern_basis: Coordinate | Simplex | None = None

Pattern basis selection

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 show_misc_options: Literal[True] | None = None

Show algorithm parameters not exposed in Dakota input

field solution_target: DakotaFloat = -1.7976931348623157e+308

Stopping criteria based on objective function value

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

  • return_type = float | str

  • when_used = json

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

Generate trial points in random order

field synchronization: Blocking | Nonblocking | None = None

Select how Dakota schedules a batch of concurrent function evaluations in a parallel algorithm

field total_pattern_size: int = 0

Total number of points in search pattern

field variable_tolerance: DakotaFloat = -1.0

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.coliny_pattern_search

class dakota.spec.method.coliny_pattern_search.Coordinate(*, coordinate: Literal[True] = True)

Use coordinate directions as search pattern

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.coliny_pattern_search.Simplex(*, simplex: Literal[True] = True)

Use a minimal simplex for the search pattern

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.coliny_pattern_search.MultiStep(*, multi_step: Literal[True] = True)

Examine trial step around successful new point

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.coliny_pattern_search.AdaptivePattern(*, adaptive_pattern: Literal[True] = True)

Adaptively rescale search directions

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.coliny_pattern_search.BasicPattern(*, basic_pattern: Literal[True] = True)

Use the same search pattern every iteration

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.