Optimization Failure Analysis Report

Introduction

The FAR for Optimization describes the system functional and non-functional requirements that describe the expected interactions that the software shall provide.

Dependencies

The Optimization application is developed using MOOSE and is based on various modules, as such the FAR for Optimization is dependent upon the following documents.

Framework Failure Analysis Report

Failure Analysis Requirements

The following is a complete list for all the requirements related to failure analysis for Optimization.

optimization: Functions
11.3.2
The system shall report an error if
1. the size of value vector is wrong;
2. x-coordinate data is wrong size;
3. y-coordinate data is wrong size;
4. z-coordinate data is wrong size;
5. time data is wrong size;
Specification(s): error/v, error/x, error/y, error/z, error/t
Design: NearestReporterCoordinatesFunction
Issue(s): #22215
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
27 27 27 27 27
11.3.4
The system shall prevent
1. using second order element meshes
2. with closest point projection;
Specification(s): check_dbgs/create_second, check_dbgs/evaluate_second
Design: ParameterMeshFunction
Issue(s): #30796
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): CheckFilesRunException
27 27
11.3.6
The system shall support parsed function expressions with parameter values by
1. computing parameter gradient;
2. erroring if vector is incorrect size;
Specification(s): parsed_function/compute_gradient, parsed_function/wrong_vector_size
Design: ParsedOptimizationFunction
Issue(s): #21885
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): CSVDiffRunException
27 30

optimization: Misc
11.4.2
The system shall throw out an error when
1. scalings are manually assigned to adjoint variables to remind users that no scaling will be performed for adjoint system.
Specification(s): optimization_scaling_errors/scaling_factor_for_adjoint_variables
Design: SteadyAndAdjoint
Issue(s): #25646 #29570
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
27

optimization: Optimizationreporter
11.5.9
The system shall throw an error when performing inverse optimization on mesh-based parameters if there is a mismatch between the number of parameters and the number of
1. meshes;
2. finite-element families;
3. finite-element orders;
4. initial conditions;
Specification(s): mismatch_errors/meshes, mismatch_errors/family, mismatch_errors/order, mismatch_errors/initial_condition
Design: ParameterMeshOptimization ParameterMeshFunction
Issue(s): #22995
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
27 27 27 27
11.5.10
The system shall throw an error when performing inverse optimization on mesh-based parameters if the parameter function spaces do not match the space defined in the
1. forward problem;
2. adjoint problem;
Specification(s): interpolation_errors/forward, interpolation_errors/adjoint
Design: ParameterMeshOptimization ParameterMeshFunction
Issue(s): #22995
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
Prerequisite(s): 11.5.8
27 27
11.5.12
The system shall correctly read in parameter data defined in the input file
1. measurement data from the input file;
2. with lower bounds, upper bounds and initial conditions provided for every parameter and measurement data from a CSV file;
3. with lower bounds, upper bounds and initial conditions constant for each group and measurement data from a CSV file;
4. with lower bounds, upper bounds and initial conditions are a mix of constant per group and every parameter in a group and measurement data from a CSV file;
5. and error if parameters are provided but do not include a parameter for every group;
6. and error if an incorrect number of parameters are provided for a group;
Specification(s): optimizationReporter/input, optimizationReporter/csv_paramBounds, optimizationReporter/csv_groupBounds, optimizationReporter/csv_mixBounds, optimizationReporter/missing_group_params, optimizationReporter/too_many_params
Design: OptimizationReporter
Issue(s): #22212 #23867
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunExceptionJSONDiff
30 30 27 30 30 27
11.5.16
The system shall throw an error when parameter data is incorrectly defined
1. by having input and mesh parameters for the same bound;
2. by having a parameter not on the exodus mesh;
3. by using nodal and elemental exodus variables to define parameter data in the same parameter group;
4. by not having the same number of optimization timesteps and timesteps for reading parameter data from the mesh;
5. by specifying a timestep for reading parameter data from the exodus file but not parameter data is being read from the mesh because it is all specified in the input file;
6. by specifying a timestep that is bigger than the timestpes on the exodus the exodus mesh.
Specification(s): errors/errorMixedParams, errors/errorMissingMeshParam, errors/errorMixedParameterTypes, errors/errorMismatchSteps, errors/errorNoSteps, errors/errorBadStep
Design: ParameterMeshOptimization
Issue(s): #24034
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
27 27 27 27 27 27

optimization: Reporters
11.8.3The system shall throw a reasonable error when reducing a vectors of vectors into a single vector and the input vectors contained in the vector of vectors do not have the same size.
Specification(s): errorRowSum
Design: ParsedVectorRealReductionReporter ParsedVectorVectorRealReductionReporter ParsedVectorReporter ParsedScalarReporter
Issue(s): #21885
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
27
11.8.4The system shall throw a reasonable error when the vectors being combined into a single vector using arithmetic operations are not the same size.
Specification(s): errorDotProduct
Design: ParsedVectorRealReductionReporter ParsedVectorVectorRealReductionReporter ParsedVectorReporter ParsedScalarReporter
Issue(s): #21885
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunException
27

optimization: Userobjects
11.10.1
The system shall be able to load a time-dependent solution from an exodus file while reversing the timesteps by
1. producing the exodus file;
2. loading on to the same mesh;
3. loading on to a coarser mesh;
4. interpolating different time steps;
5. erroring if file is not exodus;
Specification(s): adjoint_solution/forward, adjoint_solution/reverse, adjoint_solution/reverse_space_interp, adjoint_solution/reverse_time_interp, adjoint_solution/error_file_format
Design: AdjointSolutionUserObject
Issue(s): #22215
Collection(s): FUNCTIONALFAILURE_ANALYSIS
Type(s): RunAppCheckFilesRunException
30 30 30 27 30


[v]
  type = RunException
  input = nearest_reporter_point.i
  cli_args = 'Functions/active=errorv AuxKernels/val_aux/function=errorv'
  expect_err = 'Size of value vector \(\d*\) does not match number of coordinates specified \(\d*\).'
  detail = 'the size of value vector is wrong;'
[]


[x]
  type = RunException
  input = nearest_reporter_point.i
  cli_args = 'Functions/active=errorx AuxKernels/val_aux/function=errorx'
  expect_err = 'Number of x coordinates \(\d*\) does not match number of values \(\d*\).'
  detail = 'x-coordinate data is wrong size;'
[]


[y]
  type = RunException
  input = nearest_reporter_point.i
  cli_args = 'Functions/active=errory AuxKernels/val_aux/function=errory'
  expect_err = 'Number of y coordinates \(\d*\) does not match number of values \(\d*\).'
  detail = 'y-coordinate data is wrong size;'
[]


[z]
  type = RunException
  input = nearest_reporter_point.i
  cli_args = 'Functions/active=errorz AuxKernels/val_aux/function=errorz'
  expect_err = 'Number of z coordinates \(\d*\) does not match number of values \(\d*\).'
  detail = 'z-coordinate data is wrong size;'
[]


[t]
  type = RunException
  input = nearest_reporter_point.i
  cli_args = 'Functions/active=errort AuxKernels/val_aux/function=errort'
  expect_err = 'Number of times \(\d*\) does not match number of values \(\d*\).'
  detail = 'time data is wrong size;'
[]


[create_second]
  type = CheckFiles
  input = create_mesh_2d.i
  cli_args = 'Mesh/gmg/elem_type=QUAD8'
  check_files = 'create_mesh_2d_out.e create_mesh_2d_out_param_vec_0001.csv'
  detail = 'using second order element meshes'
  recover = false
[]


[evaluate_second]
  type = RunException
  input = parameter_mesh_2d.i
  prereq = check_dbgs/create_second
  expect_err = "Closet point projection currently does not support second order elements."
  detail = 'with closest point projection;'
  recover = false
[]


[wrong_vector_size]
  type = RunException
  input = parsed_function.i
  allow_test_objects = true
  cli_args = "Reporters/params/real_vector_values='1 2 3'"
  expect_err = "Size of vector \(\d+\) does not match number of specified 'param_names' \(\d+\)\."
  detail = 'erroring if vector is incorrect size;'
[]


[scaling_factor_for_adjoint_variables]
  type = 'RunException'
  input = main.i
  max_threads = 1 # Optimize executioner does not support multiple threads
  cli_args = "MultiApps/forward/cli_args='Variables/T_real_adj/scaling=5'"
  expect_err = 'User cannot supply scaling factors for adjoint variables.   Adjoint system is scaled automatically by the forward system.'
  detail = "scalings are manually assigned to adjoint variables to remind users that no scaling will be performed for adjoint system."
[]


[meshes]
  type = RunException
  input = main.i
  cli_args = 'OptimizationReporter/parameter_meshes=\'parameter_mesh_in.e parameter_mesh_in.e\''
  max_threads = 1 # Optimize executioner does not support multiple threads
  expect_err = 'There must be a mesh associated with each group of parameters\.'
  detail = 'meshes;'
[]


[family]
  type = RunException
  input = main.i
  cli_args = 'OptimizationReporter/parameter_families=\'LAGRANGE LAGRANGE\''
  max_threads = 1 # Optimize executioner does not support multiple threads
  expect_err = 'There must be a family associated with each group of parameters\.'
  detail = 'finite-element families;'
[]


[order]
  type = RunException
  input = main.i
  cli_args = 'OptimizationReporter/parameter_orders=\'FIRST FIRST\''
  max_threads = 1 # Optimize executioner does not support multiple threads
  expect_err = 'There must be an order associated with each group of parameters\.'
  detail = 'finite-element orders;'
[]


[initial_condition]
  type = RunException
  input = main.i
  cli_args = 'OptimizationReporter/initial_condition=\'0; 0\''
  max_threads = 1 # Optimize executioner does not support multiple threads
  expect_err = 'There must be a vector of initial_condition per parameter group\.'
  detail = 'initial conditions;'
[]


[forward]
  type = RunException
  input = main.i
  cli_args = 'forward:Functions/src_func/order=SECOND'
  expect_err = 'Size of parameter vector \(\d+\) does not match number of degrees of freedom in mesh \(\d+\)\.'
  max_threads = 1 # Optimize executioner does not support multiple threads
  prereq = 'mesh_source/mesh'
  detail = 'forward problem;'
[]


[adjoint]
  type = RunException
  input = main.i
  cli_args = 'adjoint:Functions/src_func/order=SECOND'
  expect_err = 'The gradient for parameter \w+ has changed, expected \d+ versus \d+\.'
  max_threads = 1 # Optimize executioner does not support multiple threads
  prereq = 'mesh_source/mesh'
  detail = 'adjoint problem;'
[]


[csv_paramBounds]
  type = JSONDiff
  input = optRep_fromCsv_paramBounds.i
  jsondiff = optRep_fromCsv_paramBounds_out.json
  allow_test_objects = true
  detail = "with lower bounds, upper bounds and initial conditions provided for every parameter and measurement data from a CSV file; "
[]


[csv_groupBounds]
  type = JSONDiff
  input = optRep_fromCsv_groupBounds.i
  jsondiff = optRep_fromCsv_groupBounds_out.json
  allow_test_objects = true
  detail = "with lower bounds, upper bounds and initial conditions constant for each group and measurement data from a CSV file; "
[]


[csv_mixBounds]
  type = JSONDiff
  input = optRep_fromCsv_mixBounds.i
  jsondiff = optRep_fromCsv_mixBounds_out.json
  allow_test_objects = true
  detail = "with lower bounds, upper bounds and initial conditions are a mix of constant per group and every parameter in a group and measurement data from a CSV file; "
[]


[missing_group_params]
  type = RunException
  input = optRep_fromCsv_mixBounds.i
  allow_test_objects = true
  cli_args = 'OptimizationReporter/upper_bounds=\'0\''
  max_threads = 1 # Optimize executioner does not support multiple threads
  expect_err = 'There must be a vector of upper_bounds per parameter group\.  The upper_bounds input format is std::vector<std::vector<Real>> so each vector should be seperated by \";\" even if it is a single value per group for a constant upper_bounds\.'
  detail = ' and error if parameters are provided but do not include a parameter for every group; '
[]


[too_many_params]
  type = RunException
  input = optRep_fromCsv_mixBounds.i
  allow_test_objects = true
  cli_args = 'OptimizationReporter/upper_bounds=\'0;0;0 0\''
  max_threads = 1 # Optimize executioner does not support multiple threads
  expect_err = 'When upper_bounds are given in input file, there must either be a single value per parameter group or a value for every parameter in the group\.'
  detail = ' and error if an incorrect number of parameters are provided for a group; '
[]


[errorMixedParams]
  type = RunException
  input = paramMeshOptRep.i
  cli_args = 'OptimizationReporter/initial_condition=6
                  OptimizationReporter/lower_bound_mesh_variable=lowerBounds
                  OptimizationReporter/lower_bounds=5
                  OptimizationReporter/upper_bound_mesh_variable=upperBounds
                  OptimizationReporter/num_parameter_times=1'
  allow_test_objects = true
  expect_err = 'Lower bounds for all parameter groups can only be defined by lower_bound_mesh_variable or lower_bounds but not both.'
  detail = "by having input and mesh parameters for the same bound; "
[]


[errorMissingMeshParam]
  type = RunException
  input = paramMeshOptRep.i
  cli_args = 'OptimizationReporter/lower_bound_mesh_variable=notOnMesh'
  allow_test_objects = true
  expect_err = 'Exodus file did not contain all of the parameter names being intitialized.'
  detail = "by having a parameter not on the exodus mesh; "
[]


[errorMixedParameterTypes]
  type = RunException
  input = paramMeshOptRep.i
  cli_args = 'OptimizationReporter/initial_condition_mesh_variable=initialConditions
                  OptimizationReporter/lower_bound_mesh_variable=lowerBounds
                  OptimizationReporter/upper_bound_mesh_variable=elemUpperBounds'
  allow_test_objects = true
  expect_err = 'Parameter group contains nodal and elemental variables, this is not allowed.'
  detail = "by using nodal and elemental exodus variables to define parameter data in the same parameter group; "
[]


[errorMismatchSteps]
  type = RunException
  input = paramMeshOptRep.i
  cli_args = 'OptimizationReporter/lower_bound_mesh_variable=lowerBounds
                  OptimizationReporter/num_parameter_times=2
                  OptimizationReporter/exodus_timesteps_for_parameter_mesh_variable=\'2 3 4\''
  allow_test_objects = true
  expect_err = 'Number of timesteps to read mesh data specified by \"exodus_timesteps_for_parameter_mesh_variable\" incorrect.'
  detail = "by not having the same number of optimization timesteps and timesteps for reading parameter data from the mesh; "
[]


[errorNoSteps]
  type = RunException
  input = paramMeshOptRep.i
  cli_args = 'OptimizationReporter/lower_bounds=5
                  OptimizationReporter/num_parameter_times=3
                  OptimizationReporter/exodus_timesteps_for_parameter_mesh_variable=\'2 3 4\''
  allow_test_objects = true
  expect_err = '\"exodus_timesteps_for_parameter_mesh_variable\" should only be specified if reading values from a mesh.'
  detail = "by specifying a timestep for reading parameter data from the exodus file but not parameter data is being read from the mesh because it is all specified in the input file; "
[]


[errorBadStep]
  type = RunException
  input = paramMeshOptRep.i
  cli_args = 'OptimizationReporter/lower_bound_mesh_variable=lowerBounds
      OptimizationReporter/upper_bound_mesh_variable=upperBounds
      UserObjects/optReporterTester/expected_lower_bounds=\'5 5 5 5 5 5\'
      UserObjects/optReporterTester/expected_upper_bounds=\'2 3.5 3.5 2 5 5\'
                  OptimizationReporter/num_parameter_times=3
                  OptimizationReporter/exodus_timesteps_for_parameter_mesh_variable=\'2 3 8\''
  allow_test_objects = true
  expect_err = 'Invalid value passed as "time_step". Expected a valid integer less than 4, received 8'
  detail = "by specifying a timestep that is bigger than the timestpes on the exodus the exodus mesh."
[]


[errorRowSum]
  type = RunException
  input = vectorMath.i
  cli_args = "Reporters/dataFromVofV/vector_of_vectors='101 201; 102 202; 103'"
  allow_test_objects = true
  expect_err = "Every vector in 'reporter_name=dataFromVofV/v_of_v' must be the same size."
  requirement = "The system shall throw a reasonable error when reducing a vectors of vectors into a single vector and the input vectors contained in the vector of vectors do not have the same size."
[]


[errorDotProduct]
  type = RunException
  input = vectorMath.i
  cli_args = "Reporters/vectorOperation/reporter_names='vecs/vec_a vecs/vec_b vec_d/vec_d'"
  allow_test_objects = true
  expect_err = "All vectors being operated on must be the same size."
  requirement = "The system shall throw a reasonable error when the vectors being combined into a single vector using arithmetic operations are not the same size."
[]


[reverse_time_interp]
  type = RunApp
  input = adjoint.i
  cli_args = 'Executioner/dt=1.25 Functions/u_reverse_fun/expression="(x + y) * (11.25 - t)"'
  prereq = adjoint_solution/forward
  detail = 'interpolating different time steps;'
[]


[error_file_format]
  type = RunException
  input = adjoint.i
  cli_args = 'UserObjects/u_reverse_solution/mesh=forward_out.xda'
  expect_err = 'Performing transient adjoint simulation currently only works if the forward solution is written and read from exodus format.'
  detail = 'erroring if file is not exodus;'
[]

Introduction
Dependencies
Failure Analysis Requirements