#include <OptimizationData.h>

Inheritance diagram for OptimizationDataTempl< T >:

Public Member Functions
	OptimizationDataTempl (const InputParameters &parameters)

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

void	computeMisfit ()
	Compute misfit vectors from the simulations and measurement values.

Real	computeMisfitValue ()
	Compute half the sum of the misfit (squared) values.

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
std::vector< Real > &	_simulation_values
	simulated values at measurement xyzt

std::vector< Real > &	_misfit_values
	difference between simulation and measurement values at measurement xyzt

Real &	_objective_val
	Reporter value that will hold the objective value.


std::vector< Real > &	_measurement_xcoord

std::vector< Real > &	_measurement_ycoord

std::vector< Real > &	_measurement_zcoord

std::vector< Real > &	_measurement_time

std::vector< Real > &	_measurement_values

Private Member Functions
void	readMeasurementsFromFile ()
	parse measurement data from csv file

void	readMeasurementsFromInput ()
	parse measurement data from input file

void	errorCheckDataSize ()
	helper to check data sizes

Private Attributes
std::vector< MooseVariableFieldBase * >	_var_vec
	variable

std::vector< std::vector< Real > * >	_variable_weights
	Weight names to reporter values.

std::map< std::string, std::vector< Real > * >	_weight_names_weights_map
	Weight names to reporter values map created from input file.

Detailed Description

template<typename T>
class OptimizationDataTempl< T >

Definition at line 32 of file OptimizationData.h.

Constructor & Destructor Documentation

◆ OptimizationDataTempl()

template<typename T >

OptimizationDataTempl< T >::OptimizationDataTempl ( const InputParameters & parameters )

Definition at line 63 of file OptimizationData.C.

  : T(parameters),
    _measurement_xcoord(this->template declareValueByName<std::vector<Real>>(
        "measurement_xcoord", REPORTER_MODE_REPLICATED)),
    _measurement_ycoord(this->template declareValueByName<std::vector<Real>>(
        "measurement_ycoord", REPORTER_MODE_REPLICATED)),
    _measurement_zcoord(this->template declareValueByName<std::vector<Real>>(
        "measurement_zcoord", REPORTER_MODE_REPLICATED)),
    _measurement_time(this->template declareValueByName<std::vector<Real>>(
        "measurement_time", REPORTER_MODE_REPLICATED)),
    _measurement_values(this->template declareValueByName<std::vector<Real>>(
        "measurement_values", REPORTER_MODE_REPLICATED)),
    _simulation_values(this->template declareValueByName<std::vector<Real>>(
        "simulation_values", REPORTER_MODE_REPLICATED)),
    _misfit_values(this->template declareValueByName<std::vector<Real>>("misfit_values",
                                                                        REPORTER_MODE_REPLICATED)),
    _objective_val(this->isParamSetByUser("objective_name")
                       ? this->template declareValueByName<Real>(
                             this->template getParam<ReporterValueName>("objective_name"),
                             REPORTER_MODE_REPLICATED)
                       : this->template declareUnusedValue<Real>())
{
  // read in data
  if (this->isParamValid("measurement_file") && this->isParamValid("measurement_points"))
    mooseError("Input file can only define a single input for measurement data. Use only "
               "measurement_file or measurement_points, but never both");
  else if (this->isParamValid("measurement_file"))
    readMeasurementsFromFile();
  else if (this->isParamValid("measurement_points"))
    readMeasurementsFromInput();
 
  _misfit_values.resize(_measurement_values.size());
 
  if (this->isParamValid("variable"))
  {
    std::vector<VariableName> var_names(
        this->template getParam<std::vector<VariableName>>("variable"));
    for (const auto & name : var_names)
      _var_vec.push_back(&this->_fe_problem.getVariable(
          this->_tid, name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_STANDARD));
  }
  if (this->isParamValid("variable_weight_names"))
  {
    std::vector<std::string> weight_names(
        this->template getParam<std::vector<std::string>>("variable_weight_names"));
    for (const auto & name : weight_names)
    {
      if (_weight_names_weights_map.count(name) == 1)
      {
        _variable_weights.push_back(_weight_names_weights_map[name]);
      }
      else
      {
        // default is to create a new weight reporter and fill it with 1's
        // these will be overwritten by a reporter transfer.
        _variable_weights.push_back(
            &this->template declareValueByName<std::vector<Real>>(name, REPORTER_MODE_REPLICATED));
        _variable_weights.back()->assign(_measurement_xcoord.size(), 1);
      }
    }
  }
  if (this->isParamValid("variable") && this->isParamValid("variable_weight_names") &&
      _variable_weights.size() != _var_vec.size())
  {
    this->paramError(
        "variable_weight_names",
        "The same number of names must be in both 'variable_weight_names' and 'variable'.");
  }
}

Member Function Documentation

◆ computeMisfit()

template<typename T >

void OptimizationDataTempl< T >::computeMisfit ( )

Compute misfit vectors from the simulations and measurement values.

Definition at line 143 of file OptimizationData.C.

{
  if (_var_vec.empty())
    return;
 
  // FIXME: This is basically copied from PointValue.
  // Implementation can be improved using the functionality in PointSamplerBase,
  // but this will require changes in MOOSE to work for reporters.
 
  const std::size_t nvals = _measurement_values.size();
  _simulation_values.resize(nvals, 0.0);
  _misfit_values.resize(nvals);
 
  errorCheckDataSize();
  for (const auto var_index : make_range(_var_vec.size()))
  {
    const auto & sys = _var_vec[var_index]->sys().system();
    const auto vnum = _var_vec[var_index]->number();
    // A weight reporter is not automatically created and for those cases, we
    // set the weight to 1.
    std::vector<Real> weights(_variable_weights.empty()
                                  ? std::vector<Real>(_measurement_xcoord.size(), 1)
                                  : (*_variable_weights[var_index]));
    for (const auto & i : make_range(nvals))
    {
      if (MooseUtils::absoluteFuzzyEqual(this->_t, _measurement_time[i]))
      {
        // If we are on the first var, make sure reset the simulation values so they aren't
        // accumulated on repeated timesteps
        if (var_index == 0)
          _simulation_values[i] = 0.0;
 
        const Point point(_measurement_xcoord[i], _measurement_ycoord[i], _measurement_zcoord[i]);
        const Real val = sys.point_value(vnum, point, false);
 
        _simulation_values[i] += weights[i] * val;
        _misfit_values[i] = _simulation_values[i] - _measurement_values[i];
      }
    }
  }
}

◆ computeMisfitValue()

template<typename T >

Real OptimizationDataTempl< T >::computeMisfitValue ( )

Compute half the sum of the misfit (squared) values.

Returns: 1/2 of the sum of the misfit values.

Definition at line 332 of file OptimizationData.C.

{
  Real val = 0.0;
  for (auto & misfit : _misfit_values)
    val += misfit * misfit;
 
  return val * 0.5;
}

◆ errorCheckDataSize()

template<typename T >

void OptimizationDataTempl< T >::errorCheckDataSize ( )

private

helper to check data sizes

Definition at line 310 of file OptimizationData.C.

{
  const std::size_t nvals = _measurement_values.size();
  std::string msg = "";
  if (_measurement_xcoord.size() != nvals)
    msg += "x-coordinate data (" + std::to_string(_measurement_xcoord.size()) + "), ";
  if (_measurement_ycoord.size() != nvals)
    msg += "y-coordinate data (" + std::to_string(_measurement_ycoord.size()) + "), ";
  if (_measurement_zcoord.size() != nvals)
    msg += "z-coordinate data (" + std::to_string(_measurement_zcoord.size()) + "), ";
  if (_measurement_time.size() != nvals)
    msg += "time data (" + std::to_string(_measurement_time.size()) + "), ";
  if (!msg.empty())
    mooseError("Number of entries in ",
               std::string(msg.begin(), msg.end() - 2),
               " does not match number of entries in value data (",
               std::to_string(nvals),
               ").");
}

◆ execute()

template<typename T >

void OptimizationDataTempl< T >::execute ( )

overridevirtual

Definition at line 135 of file OptimizationData.C.

{
  computeMisfit();
  _objective_val = computeMisfitValue();
}

◆ finalize()

template<typename T >

virtual void OptimizationDataTempl< T >::finalize ( )

inlineoverridevirtual

Definition at line 40 of file OptimizationData.h.

40{}

◆ initialize()

template<typename T >

virtual void OptimizationDataTempl< T >::initialize ( )

inlineoverridevirtual

Definition at line 38 of file OptimizationData.h.

38{}

◆ readMeasurementsFromFile()

template<typename T >

void OptimizationDataTempl< T >::readMeasurementsFromFile ( )

private

parse measurement data from csv file

Definition at line 187 of file OptimizationData.C.

{
  std::string xName = this->template getParam<std::string>("file_xcoord");
  std::string yName = this->template getParam<std::string>("file_ycoord");
  std::string zName = this->template getParam<std::string>("file_zcoord");
  std::string tName = this->template getParam<std::string>("file_time");
  std::string valueName = this->template getParam<std::string>("file_value");
  std::vector<std::string> weightNames =
      this->template getParam<std::vector<std::string>>("file_variable_weights");
 
  bool found_x = false;
  bool found_y = false;
  bool found_z = false;
  bool found_t = false;
  bool found_value = false;
 
  MooseUtils::DelimitedFileReader reader(this->template getParam<FileName>("measurement_file"));
  reader.read();
 
  auto const & names = reader.getNames();
  auto const & data = reader.getData();
 
  const std::size_t rows = data[0].size();
  for (std::size_t i = 0; i < names.size(); ++i)
  {
    // make sure all data columns have the same length
    if (data[i].size() != rows)
      this->paramError("file", "Mismatching column lengths in file");
 
    if (names[i] == xName)
    {
      _measurement_xcoord = data[i];
      found_x = true;
    }
    else if (names[i] == yName)
    {
      _measurement_ycoord = data[i];
      found_y = true;
    }
    else if (names[i] == zName)
    {
      _measurement_zcoord = data[i];
      found_z = true;
    }
    else if (names[i] == tName)
    {
      _measurement_time = data[i];
      found_t = true;
    }
    else if (names[i] == valueName)
    {
      _measurement_values = data[i];
      found_value = true;
    }
    else if (std::find(weightNames.begin(), weightNames.end(), names[i]) != weightNames.end())
    {
      _weight_names_weights_map.emplace(names[i],
                                        &(this->template declareValueByName<std::vector<Real>>(
                                            names[i], REPORTER_MODE_REPLICATED)));
      _weight_names_weights_map[names[i]]->assign(data[i].begin(), data[i].end());
    }
  }
 
  // check if all required columns were found
  if (!found_x)
    this->paramError(
        "measurement_file", "Column with name '", xName, "' missing from measurement file");
  if (!found_y)
    this->paramError(
        "measurement_file", "Column with name '", yName, "' missing from measurement file");
  if (!found_z)
    this->paramError(
        "measurement_file", "Column with name '", zName, "' missing from measurement file");
  if (!found_t)
    _measurement_time.assign(rows, 0);
  if (!found_value)
    this->paramError(
        "measurement_file", "Column with name '", valueName, "' missing from measurement file");
  if (_weight_names_weights_map.size() != weightNames.size())
  {
    std::string out("\n   Measurement file column names: ");
    for (const auto & name : names)
      out += " " + name;
    out += "\n   file_variable_weights names: ";
    for (const auto & name : weightNames)
      out += " " + name;
    this->paramError(
        "measurement_file",
        "Not all of the file_variable_weights names were found in the measurement_file.",
        out);
  }
}

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

◆ readMeasurementsFromInput()

template<typename T >

void OptimizationDataTempl< T >::readMeasurementsFromInput ( )

private

parse measurement data from input file

Definition at line 282 of file OptimizationData.C.

{
  if (!this->template getParam<std::vector<std::string>>("file_variable_weights").empty())
    this->paramError(
        "measurement_values",
        "file_variable_weights cannot be used with measurement data read from the input "
        "file, use measure_file input instead.");
 
  for (const auto & p : this->template getParam<std::vector<Point>>("measurement_points"))
  {
    _measurement_xcoord.push_back(p(0));
    _measurement_ycoord.push_back(p(1));
    _measurement_zcoord.push_back(p(2));
  }
 
  if (this->isParamValid("measurement_times"))
    _measurement_time = this->template getParam<std::vector<Real>>("measurement_times");
  else
    _measurement_time.assign(_measurement_xcoord.size(), 0.0);
 
  if (this->isParamValid("measurement_values"))
    _measurement_values = this->template getParam<std::vector<Real>>("measurement_values");
  else
    this->paramError("measurement_values", "Input file must contain measurement points and values");
}

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

◆ validParams()

template<typename T >

InputParameters OptimizationDataTempl< T >::validParams ( )

static

Definition at line 17 of file OptimizationData.C.

{
  InputParameters params = T::validParams();
 
  params.addClassDescription(
      "Reporter to hold measurement and simulation data for optimization problems");
  params.addParam<std::vector<Real>>(
      "measurement_values",
      "Measurement values collected from locations given by measurement_points");
  params.addParam<std::vector<Point>>("measurement_points",
                                      "Point locations corresponding to each measurement value");
  params.addParam<std::vector<Real>>("measurement_times",
                                     "Times corresponding to each measurement value");
 
  params.addParam<FileName>("measurement_file",
                            "CSV file with measurement value and coordinates (value, x, y, z).");
  params.addParam<std::string>(
      "file_xcoord", "x", "x coordinate column name from measurement_file csv being read in.");
  params.addParam<std::string>(
      "file_ycoord", "y", "y coordinate column name from csv file being read in.");
  params.addParam<std::string>(
      "file_zcoord", "z", "z coordinate column name from csv file being read in.");
  params.addParam<std::string>(
      "file_time", "time", "time column name from csv file being read in.");
  params.addParam<std::vector<std::string>>(
      "file_variable_weights", {}, "variable weight column names from csv file being read in.");
  params.addParam<std::string>(
      "file_value", "value", "measurement value column name from csv file being read in.");
 
  params.addParam<std::vector<std::string>>(
      "variable_weight_names",
      "Vector of weight reporter names that will create a reporter to transfer weights into.  The "
      "ordering of these weight reporter names corresponds to the ordering used in variable.");
  params.addParam<std::vector<VariableName>>(
      "variable", "Vector of variable names to sample at measurement points.");
  params.addParam<ReporterValueName>("objective_name",
                                     "Name of reporter value defining the objective.");
  params.addParamNamesToGroup("measurement_points measurement_values measurement_times",
                              "Input Measurement Data");
  params.addParamNamesToGroup("measurement_file file_xcoord file_ycoord file_zcoord file_time "
                              "file_value file_variable_weights",
                              "File Measurement Data");
  return params;
}

Referenced by OptimizationReporter::validParams(), and TransientSyntheticDataCreator::validParams().

Member Data Documentation

◆ _measurement_time

template<typename T >

std::vector<Real>& OptimizationDataTempl< T >::_measurement_time

protected

Definition at line 59 of file OptimizationData.h.

◆ _measurement_values

template<typename T >

std::vector<Real>& OptimizationDataTempl< T >::_measurement_values

protected

Definition at line 60 of file OptimizationData.h.

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

◆ _measurement_xcoord

template<typename T >

std::vector<Real>& OptimizationDataTempl< T >::_measurement_xcoord

protected

x,y,z,t and value measurement data

Definition at line 56 of file OptimizationData.h.

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

◆ _measurement_ycoord

template<typename T >

std::vector<Real>& OptimizationDataTempl< T >::_measurement_ycoord

protected

Definition at line 57 of file OptimizationData.h.

◆ _measurement_zcoord

template<typename T >

std::vector<Real>& OptimizationDataTempl< T >::_measurement_zcoord

protected

Definition at line 58 of file OptimizationData.h.

◆ _misfit_values

template<typename T >

std::vector<Real>& OptimizationDataTempl< T >::_misfit_values

protected

difference between simulation and measurement values at measurement xyzt

Definition at line 65 of file OptimizationData.h.

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

◆ _objective_val

template<typename T >

Real& OptimizationDataTempl< T >::_objective_val

protected

Reporter value that will hold the objective value.

Definition at line 68 of file OptimizationData.h.

◆ _simulation_values

template<typename T >

std::vector<Real>& OptimizationDataTempl< T >::_simulation_values

protected

simulated values at measurement xyzt

Definition at line 63 of file OptimizationData.h.

◆ _var_vec

template<typename T >

std::vector<MooseVariableFieldBase *> OptimizationDataTempl< T >::_var_vec

private

variable

Definition at line 76 of file OptimizationData.h.

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

◆ _variable_weights

template<typename T >

std::vector<std::vector<Real> *> OptimizationDataTempl< T >::_variable_weights

private

Weight names to reporter values.

Definition at line 78 of file OptimizationData.h.

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

◆ _weight_names_weights_map

template<typename T >

std::map<std::string, std::vector<Real> *> OptimizationDataTempl< T >::_weight_names_weights_map

private

Weight names to reporter values map created from input file.

Definition at line 80 of file OptimizationData.h.

Referenced by OptimizationDataTempl< OptimizationReporterBase >::errorCheckDataSize().

The documentation for this class was generated from the following files:

optimization/include/reporters/OptimizationData.h
optimization/src/reporters/OptimizationData.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OptimizationDataTempl()

Member Function Documentation

◆ computeMisfit()

◆ computeMisfitValue()

◆ errorCheckDataSize()

◆ execute()

◆ finalize()

◆ initialize()

◆ readMeasurementsFromFile()

◆ readMeasurementsFromInput()

◆ validParams()

Member Data Documentation

◆ _measurement_time

◆ _measurement_values

◆ _measurement_xcoord

◆ _measurement_ycoord

◆ _measurement_zcoord

◆ _misfit_values

◆ _objective_val

◆ _simulation_values

◆ _var_vec

◆ _variable_weights

◆ _weight_names_weights_map