sensitivity_data.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_SENSITIVITY_DATA_H
#define LIBMESH_SENSITIVITY_DATA_H


// Local Includes
#include "libmesh/libmesh_common.h"
#include "libmesh/parameter_vector.h"
#include "libmesh/system.h"

// C++ Includes
#include <vector>

namespace libMesh
{

// Forward declarations
class QoISet;

class SensitivityData
{
public:
  class Row
  {
  public:
    Row(SensitivityData & sd, unsigned int qoi) : _sd(sd), _qoi(qoi) {}

    Number & operator[] (unsigned int parameter) { return _sd.derivative(_qoi, parameter); }
  private:
    SensitivityData & _sd;
    unsigned int _qoi;
  };

  class ConstRow
  {
  public:
    ConstRow(const SensitivityData & sd, unsigned int qoi) : _sd(sd), _qoi(qoi) {}

    const Number & operator[] (unsigned int parameter) { return _sd.derivative(_qoi, parameter); }
  private:
    const SensitivityData & _sd;
    unsigned int _qoi;
  };

  SensitivityData() {}

  SensitivityData(const QoISet & qoi_indices,
                  const System & sys,
                  const ParameterVector & parameter_vector);

  void clear() { _grad_data.clear(); }

  void allocate_data(const QoISet & qoi_indices,
                     const System & sys,
                     const ParameterVector & parameter_vector);

  void allocate_hessian_data(const QoISet & qoi_indices,
                             const System & sys,
                             const ParameterVector & parameter_vector);

  const Number & derivative (unsigned int qoi_index,
                             unsigned int parameter_index) const;

  const Number & second_derivative (unsigned int qoi_index,
                                    unsigned int parameter_index1,
                                    unsigned int parameter_index2) const;

  Number & derivative (unsigned int qoi_index,
                       unsigned int parameter_index);

  Number & second_derivative (unsigned int qoi_index,
                              unsigned int parameter_index1,
                              unsigned int parameter_index2);

  ConstRow operator[] (unsigned int qoi) const { return ConstRow(*this, qoi); }

  Row operator[] (unsigned int qoi) { return Row(*this, qoi); }

private:
  std::vector<std::vector<Number>> _grad_data;
  std::vector<std::vector<std::vector<Number>>> _hess_data;
};



// ------------------------------------------------------------
// SensitivityData inline methods



inline
SensitivityData::SensitivityData(const QoISet & qoi_indices,
                                 const System & sys,
                                 const ParameterVector & parameter_vector)
{
  this->allocate_data(qoi_indices, sys, parameter_vector);
}



inline
void SensitivityData::allocate_data(const QoISet & qoi_indices,
                                    const System & sys,
                                    const ParameterVector & parameter_vector)
{
  const std::size_t Np = parameter_vector.size();
  const unsigned int Nq = sys.n_qois();

  if (_grad_data.size() < Nq)
    _grad_data.resize(Nq);

  for (unsigned int i=0; i != Nq; ++i)
    if (qoi_indices.has_index(i))
      {
        _grad_data[i].clear();
        _grad_data[i].resize(Np);
      }
}



inline
void SensitivityData::allocate_hessian_data(const QoISet & qoi_indices,
                                            const System & sys,
                                            const ParameterVector & parameter_vector)
{
  const std::size_t Np = parameter_vector.size();
  const unsigned int Nq = sys.n_qois();

  if (_hess_data.size() < Nq)
    _hess_data.resize(Nq);

  for (unsigned int i=0; i != Nq; ++i)
    if (qoi_indices.has_index(i))
      {
        _hess_data[i].clear();
        _hess_data[i].resize(Np);
        for (std::size_t j=0; j != Np; ++j)
          _hess_data[i][j].resize(Np);
      }
}



inline
const Number & SensitivityData::derivative(unsigned int qoi_index,
                                           unsigned int parameter_index) const
{
  libmesh_assert_less (qoi_index, _grad_data.size());
  libmesh_assert_less (parameter_index, _grad_data[qoi_index].size());

  return _grad_data[qoi_index][parameter_index];
}



inline
Number & SensitivityData::derivative(unsigned int qoi_index,
                                     unsigned int parameter_index)
{
  libmesh_assert_less (qoi_index, _grad_data.size());
  libmesh_assert_less (parameter_index, _grad_data[qoi_index].size());

  return _grad_data[qoi_index][parameter_index];
}



inline
const Number & SensitivityData::second_derivative(unsigned int qoi_index,
                                                  unsigned int parameter_index1,
                                                  unsigned int parameter_index2) const
{
  libmesh_assert_less (qoi_index, _hess_data.size());
  libmesh_assert_less (parameter_index1, _hess_data[qoi_index].size());
  libmesh_assert_less (parameter_index2, _hess_data[qoi_index][parameter_index1].size());

  return _hess_data[qoi_index][parameter_index1][parameter_index2];
}



inline
Number & SensitivityData::second_derivative(unsigned int qoi_index,
                                            unsigned int parameter_index1,
                                            unsigned int parameter_index2)
{
  libmesh_assert_less (qoi_index, _hess_data.size());
  libmesh_assert_less (parameter_index1, _hess_data[qoi_index].size());
  libmesh_assert_less (parameter_index2, _hess_data[qoi_index][parameter_index1].size());

  return _hess_data[qoi_index][parameter_index1][parameter_index2];
}

} // namespace libMesh

#endif // LIBMESH_SENSITIVITY_DATA_H