OptimizationReporter

Computes objective function, gradient and contains reporters for communicating between optimizeSolve and subapps

Overview

The OptimizationReporter sets up a reporter used for communicating data between the optimization executioner and the transfers to the sub-app forward and adjoint solves. Only one OptimizationReporter is allowed per main-app.

Example Input File Syntax

There two required parameters in the OptimizationReporter specified in Listing 1 used to define the design parameters. The first, "parameter_names", defines a vector of names for each group of design parameters. The second, "num_values", defines a vector containing the number of design parameters in each group named in parameter_names. Optional parameters bounds can be placed on each parameter group using "lower_bounds" and "upper_bounds".

The OptimizationReporter contains reporters holding measurement data. This measurement data can optionally be defined in the OptimizationReporter through the input file, as shown in Listing 1, or from a csv file. Alternatively, the measurement data can be transferred from a subapp reporter into the OptimizationReporter measurement reporters.

Listing 1: 

[OptimizationReporter]
  type = OptimizationReporter
  parameter_names = 'parameter_results'
  num_values = '3'
  measurement_points = '0.5 0.28 0
                        0.5 0.6 0
                        0.5 0.8 0
                        0.5 1.1 0'
  measurement_values = '293 304 315 320'
[]
(modules/optimization/test/tests/optimizationreporter/point_loads/main.i)

Input Parameters

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

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

    Controllable:No

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

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

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

    Controllable:No

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

Required Parameters

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

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

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.

  • 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>>

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

    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

  • 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

    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.

  • 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>>

    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

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

    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>

    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

    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

    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

    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

    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

    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>

    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

    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

  • file_timetimetime column name from csv file being read in.

    Default:time

    C++ Type:std::string

    Controllable:No

    Description:time column name from csv file being read in.

  • file_valuevaluemeasurement value column name from csv file being read in.

    Default:value

    C++ Type:std::string

    Controllable:No

    Description:measurement value column name from csv file being read in.

  • file_variable_weightsvariable weight column names from csv file being read in.

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

    Controllable:No

    Description:variable weight column names from csv file being read in.

  • file_xcoordxx coordinate column name from measurement_file csv being read in.

    Default:x

    C++ Type:std::string

    Controllable:No

    Description:x coordinate column name from measurement_file csv being read in.

  • file_ycoordyy coordinate column name from csv file being read in.

    Default:y

    C++ Type:std::string

    Controllable:No

    Description:y coordinate column name from csv file being read in.

  • file_zcoordzz coordinate column name from csv file being read in.

    Default:z

    C++ Type:std::string

    Controllable:No

    Description:z coordinate column name from csv file being read in.

  • measurement_fileCSV file with measurement value and coordinates (value, x, y, z).

    C++ Type:FileName

    Controllable:No

    Description:CSV file with measurement value and coordinates (value, x, y, z).

File Measurement Data Parameters

  • measurement_pointsPoint locations corresponding to each measurement value

    C++ Type:std::vector<libMesh::Point>

    Controllable:No

    Description:Point locations corresponding to each measurement value

  • measurement_timesTimes corresponding to each measurement value

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

    Controllable:No

    Description:Times corresponding to each measurement value

  • measurement_valuesMeasurement values collected from locations given by measurement_points

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

    Controllable:No

    Description:Measurement values collected from locations given by measurement_points

Input Measurement Data Parameters

Input Files

Available Objects

  • Optimization App
  • OptimizationReporterComputes objective function, gradient and contains reporters for communicating between optimizeSolve and subapps
  • ParameterMeshOptimizationComputes objective function, gradient and contains reporters for communicating between optimizeSolve and subapps using mesh-based parameter definition.

Available Actions