GeneralOptimization

Reporter that provides TAO with the objective, gradient, and constraint data, which are supplied by the reporters and postprocessors from the forward and adjoint subapps.

Overview

GeneralOptimization is responsible for creating parameter vector(s) for optimization, setting the parameter initial condition for the optimization, and setting parameter bounds and constraints. Although the Optimize executioner holds a single vector for parameter values, this vector can be split into groups of parameters. This is done by specifying a name for each group with "parameter_names" and the number of parameters in each group with "num_values" or "num_values_name". The total number of parameters is ultimately defined by the sum of "num_values" or the values inside of the reporter defined by "num_values_name". The initial condition for the optimization can then be defined with "initial_condition", where a vector of data must defined for each group. This vector can be a single value in which case all parameters in that group are set to that value or a value can be set for every parameter in that group. The lower and upper bounds for the parameters can then specified by "lower_bounds" and "upper_bounds", respectively. The bounds follow the same input format rules as the initial_condition. If no initial conditions are provided, the parameters are initialized with 0. Default values for upper_bounds and lower_bounds are std::numeric<Real>::max() and std::numeric<Real>::lower(), respectively. These bounds are only applied if a bounded optimization algorithm is used. The reporter that holds the objective value is defined by "objective_name". Additionally, equality and inequality constraints can be defined by "equality_names" and "inequality_names", respectively.

Input Parameters

  • objective_namePreferred name of reporter value defining the objective.

    C++ Type:ReporterValueName

    Unit:(no unit assumed)

    Controllable:No

    Description:Preferred name of reporter value defining the objective.

  • parameter_namesList of parameter names, one for each group of parameters.

    C++ Type:std::vector<ReporterValueName>

    Unit:(no unit assumed)

    Controllable:No

    Description:List of parameter names, one for each group of parameters.

Required Parameters

  • equality_namesList of equality names.

    C++ Type:std::vector<ReporterValueName>

    Unit:(no unit assumed)

    Controllable:No

    Description:List of equality names.

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • inequality_namesList of inequality names.

    C++ Type:std::vector<ReporterValueName>

    Unit:(no unit assumed)

    Controllable:No

    Description:List of inequality names.

  • initial_conditionInitial conditions for each parameter. A vector is given for each parameter group. A single value can be given for each group and all parameters in that group will be set to that value. The default value is 0.

    C++ Type:std::vector<std::vector<double>>

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial conditions for each parameter. A vector is given for each parameter group. A single value can be given for each group and all parameters in that group will be set to that value. The default value is 0.

  • lower_boundsLower bound for each parameter. A vector is given for each parameter group. A single value can be given for each group and all parameters in that group will be set to that value

    C++ Type:std::vector<std::vector<double>>

    Unit:(no unit assumed)

    Controllable:No

    Description:Lower bound for each parameter. A vector is given for each parameter group. A single value can be given for each group and all parameters in that group will be set to that value

  • num_valuesNumber of parameter values associated with each parameter group in 'parameter_names'.

    C++ Type:std::vector<unsigned long>

    Unit:(no unit assumed)

    Controllable:No

    Description:Number of parameter values associated with each parameter group in 'parameter_names'.

  • num_values_nameReporter that holds the number of parameter values associated with each parameter group in 'parameter_names'.

    C++ Type:ReporterValueName

    Unit:(no unit assumed)

    Controllable:No

    Description:Reporter that holds the number of parameter values associated with each parameter group in 'parameter_names'.

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • tikhonov_coeff0Coefficient for Tikhonov Regularization.

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Coefficient for Tikhonov Regularization.

  • upper_boundsUpper bound for each parameter. A vector is given for each parameter group. A single value can be given for each group and all parameters in that group will be set to that value

    C++ Type:std::vector<std::vector<double>>

    Unit:(no unit assumed)

    Controllable:No

    Description:Upper bound for each parameter. A vector is given for each parameter group. A single value can be given for each group and all parameters in that group will be set to that value

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Files