LCOV - code coverage report
Current view: top level - include/reporters - OptimizationData.h (source / functions) Hit Total Coverage
Test: idaholab/moose optimization: #31405 (292dce) with base fef103 Lines: 2 2 100.0 %
Date: 2025-09-04 07:54:57 Functions: 4 4 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : // MOOSE includes
      13             : #include "MooseTypes.h"
      14             : #include "MooseUtils.h"
      15             : #include "InputParameters.h"
      16             : #include "FEProblemBase.h"
      17             : #include "MooseError.h"
      18             : #include "MooseObject.h"
      19             : #include "Reporter.h"
      20             : #include "DelimitedFileReader.h"
      21             : #include "SystemBase.h"
      22             : #include "GeneralReporter.h"
      23             : #include "OptimizationReporterBase.h"
      24             : 
      25             : // Forward Declarations
      26             : template <typename T>
      27             : class OptimizationDataTempl;
      28             : 
      29             : typedef OptimizationDataTempl<GeneralReporter> OptimizationData;
      30             : 
      31             : template <typename T>
      32             : class OptimizationDataTempl : public T
      33             : {
      34             : public:
      35             :   static InputParameters validParams();
      36             :   OptimizationDataTempl(const InputParameters & parameters);
      37             : 
      38       45897 :   virtual void initialize() override {}
      39             :   virtual void execute() override;
      40       45897 :   virtual void finalize() override {}
      41             : 
      42             :   /**
      43             :    * Compute misfit vectors from the simulations and measurement values.
      44             :    */
      45             :   void computeMisfit();
      46             : 
      47             :   /**
      48             :    * Compute half the sum of the misfit (squared) values
      49             :    * @return 1/2 of the sum of the misfit values.
      50             :    */
      51             :   Real computeMisfitValue();
      52             : 
      53             : protected:
      54             :   ///@{
      55             :   /// x,y,z,t and value measurement data
      56             :   std::vector<Real> & _measurement_xcoord;
      57             :   std::vector<Real> & _measurement_ycoord;
      58             :   std::vector<Real> & _measurement_zcoord;
      59             :   std::vector<Real> & _measurement_time;
      60             :   std::vector<Real> & _measurement_values;
      61             :   ///@}
      62             :   /// simulated values at measurement xyzt
      63             :   std::vector<Real> & _simulation_values;
      64             :   /// difference between simulation and measurement values at measurement xyzt
      65             :   std::vector<Real> & _misfit_values;
      66             : 
      67             :   /// Reporter value that will hold the objective value
      68             :   Real & _objective_val;
      69             : 
      70             : private:
      71             :   /// parse measurement data from csv file
      72             :   void readMeasurementsFromFile();
      73             :   /// parse measurement data from input file
      74             :   void readMeasurementsFromInput();
      75             :   /// variable
      76             :   std::vector<MooseVariableFieldBase *> _var_vec;
      77             :   /// Weight names to reporter values
      78             :   std::vector<std::vector<Real> *> _variable_weights;
      79             :   /// Weight names to reporter values map created from input file
      80             :   std::map<std::string, std::vector<Real> *> _weight_names_weights_map;
      81             :   /// helper to check data sizes
      82             :   void errorCheckDataSize();
      83             : };

Generated by: LCOV version 1.14