diff_qoi.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 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_DIFF_QOI_H
#define LIBMESH_DIFF_QOI_H

// Local Includes
#include "libmesh/diff_context.h"

// C++ includes
#include <memory>

namespace libMesh
{

// Forward declarations
class DiffContext;
class QoISet;

namespace Parallel {
  class Communicator;
}

class DifferentiableQoI
{
public:

  DifferentiableQoI ();

  virtual ~DifferentiableQoI () = default;

  virtual void init_qoi_count( System & /*sys*/){}

  virtual void clear_qoi () {}

  bool assemble_qoi_sides;

  bool assemble_qoi_internal_sides;

  bool assemble_qoi_elements;

  virtual void element_qoi (DiffContext &,
                            const QoISet &)
  {}

  virtual void element_qoi_derivative (DiffContext &,
                                       const QoISet &)
  {}

  virtual void side_qoi (DiffContext &,
                         const QoISet &)
  {}

  virtual void side_qoi_derivative (DiffContext &,
                                    const QoISet &)
  {}

  virtual void init_context(DiffContext &) { libmesh_deprecated(); }

  virtual std::unique_ptr<DifferentiableQoI> clone() =0;

  virtual void thread_join(std::vector<Number> & qoi,
                           const std::vector<Number> & other_qoi,
                           const QoISet & qoi_indices);

  virtual void parallel_op(const Parallel::Communicator & communicator,
                           std::vector<Number> & sys_qoi,
                           std::vector<Number> & local_qoi,
                           const QoISet & qoi_indices);

  virtual void finalize_derivative(NumericVector<Number> & derivatives, std::size_t qoi_index);
};

} // namespace libMesh


#endif // LIBMESH_DIFF_QOI_H