.. _method-optpp_cg: """""""" optpp_cg """""""" A conjugate gradient optimization method **Topics** - :ref:`package_optpp ` - :ref:`local_optimization_methods ` .. toctree:: :hidden: :maxdepth: 1 method-optpp_cg-max_step method-optpp_cg-gradient_tolerance method-optpp_cg-max_iterations method-optpp_cg-convergence_tolerance method-optpp_cg-speculative method-optpp_cg-max_function_evaluations method-optpp_cg-scaling method-optpp_cg-model_pointer method-optpp_cg-id_method method-optpp_cg-output method-optpp_cg-final_solutions **Specification** - *Alias:* None - *Arguments:* None - *JSON argument key:* None **Child Keywords:** +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Required/Optional | Description of Group | JSON Group Key | Dakota Keyword | Dakota Keyword Description | +=========================+========================+====================+================================+============================================================+ | Optional | | | `max_step`__ | Max change in design point | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `gradient_tolerance`__ | Stopping critiera based on L2 norm of gradient | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `max_iterations`__ | Number of iterations allowed for optimizers and adaptive | | | | | | UQ methods | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `convergence_tolerance`__ | Stopping criterion based on objective function or | | | | | | statistics convergence | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `speculative`__ | Compute speculative gradients | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `max_function_evaluations`__ | Number of function evaluations allowed for optimizers | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `scaling`__ | Turn on scaling for variables, responses, and constraints | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `model_pointer`__ | Identifier for model block to be used by a method | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `id_method`__ | Name the method block; helpful when there are multiple | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `output`__ | Control how much method information is written to the | | | | | | screen and output file | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ | Optional | | | `final_solutions`__ | Number of designs returned as the best solutions | +-------------------------+------------------------+--------------------+--------------------------------+------------------------------------------------------------+ .. __: method-optpp_cg-max_step.html __ method-optpp_cg-gradient_tolerance.html __ method-optpp_cg-max_iterations.html __ method-optpp_cg-convergence_tolerance.html __ method-optpp_cg-speculative.html __ method-optpp_cg-max_function_evaluations.html __ method-optpp_cg-scaling.html __ method-optpp_cg-model_pointer.html __ method-optpp_cg-id_method.html __ method-optpp_cg-output.html __ method-optpp_cg-final_solutions.html **Description** The conjugate gradient method is an implementation of the Polak-Ribiere approach and handles only unconstrained problems. See :ref:`topic-package_optpp` for info related to all ``optpp`` methods. *Expected HDF5 Output* If Dakota was built with HDF5 support and run with the :dakkw:`environment-results_output-hdf5` keyword, this method writes the following results to HDF5: - :ref:`hdf5_results-best_params` - :ref:`hdf5_results-best_obj_fncs` (when :dakkw:`responses-objective_functions`) are specified) - :ref:`hdf5_results-calibration` (when :dakkw:`responses-calibration_terms` are specified)