OptimizationReporterBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "GeneralReporter.h"
#include "libmesh/petsc_matrix.h"

namespace libMesh
{
template <typename Number>
class PetscVector;
}

class OptimizationReporterBase : public GeneralReporter
{
public:
  static InputParameters validParams();
  OptimizationReporterBase(const InputParameters & parameters);

  virtual void initialize() override {}
  virtual void execute() override {}
  virtual void finalize() override {}
  virtual Real computeObjective() = 0;

  virtual void computeGradient(libMesh::PetscVector<Number> & gradient) const;

  void setInitialCondition(libMesh::PetscVector<Number> & param);

  virtual void setMisfitToSimulatedValues(){};

  Real getUpperBound(dof_id_type i) const;
  Real getLowerBound(dof_id_type i) const;

  virtual dof_id_type getNumParams() const { return _ndof; }

  virtual void computeEqualityConstraints(libMesh::PetscVector<Number> & eqs_constraints) const;

  virtual void computeInequalityConstraints(libMesh::PetscVector<Number> & ineqs_constraints) const;

  virtual void computeEqualityGradient(libMesh::PetscMatrix<Number> & gradient) const;

  virtual void computeInequalityGradient(libMesh::PetscMatrix<Number> & gradient) const;

  dof_id_type getNumEqCons() const { return _n_eq_cons; }

  dof_id_type getNumInEqCons() const { return _n_ineq_cons; }

protected:
  virtual void updateParameters(const libMesh::PetscVector<Number> & x);

  std::vector<Real>
  parseInputData(std::string type, Real default_value, unsigned int param_id) const;

  virtual void setICsandBounds(){};

  const std::vector<ReporterValueName> & _parameter_names;
  const unsigned int _nparams;

  std::vector<std::vector<Real> *> _parameters;
  std::vector<std::vector<Real> *> _gradients;

  const Real _tikhonov_coeff;

  const std::vector<ReporterValueName> * _equality_names;
  const unsigned int _n_eq_cons;
  std::vector<std::vector<Real> *> _eq_constraints;
  std::vector<std::vector<Real> *> _eq_gradients;

  const std::vector<ReporterValueName> * _inequality_names;
  const unsigned int _n_ineq_cons;
  std::vector<std::vector<Real> *> _ineq_constraints;
  std::vector<std::vector<Real> *> _ineq_gradients;

  std::vector<Real> _lower_bounds;
  std::vector<Real> _upper_bounds;

  std::vector<dof_id_type> _nvalues;
  dof_id_type _ndof;

private:
  friend class OptimizeSolve;
  friend class OptimizationReporterTest;
};