diff_context.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 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_CONTEXT_H
#define LIBMESH_DIFF_CONTEXT_H

// Local Includes
#include "libmesh/dense_matrix.h"
#include "libmesh/dense_submatrix.h"
#include "libmesh/dense_subvector.h"
#include "libmesh/dense_vector.h"
#include "libmesh/id_types.h"

// C++ includes
#include <cstddef>
#include <map>
#include <vector>
#include <memory>

namespace libMesh
{

// Forward declarations
template <typename T> class NumericVector;
class System;

class DiffContext
{
public:

  explicit
  DiffContext (const System &,
               bool allocate_local_matrices = true);

  virtual ~DiffContext ();

  virtual void elem_reinit(Real /* theta */) {}

  virtual void elem_side_reinit(Real /* theta */) {}

  virtual void elem_edge_reinit(Real /* theta */) {}

  virtual void nonlocal_reinit(Real /* theta */) {}

  unsigned int n_vars() const
  { return cast_int<unsigned int>(_dof_indices_var.size()); }

  const System & get_system() const
  { return _system; }

  const DenseVector<Number> & get_elem_solution() const
  { return _elem_solution; }

  DenseVector<Number> & get_elem_solution()
  { return _elem_solution; }

  const DenseSubVector<Number> & get_elem_solution( unsigned int var ) const
  {
    libmesh_assert_greater(_elem_subsolutions.size(), var);
    return _elem_subsolutions[var];
  }

  DenseSubVector<Number> & get_elem_solution( unsigned int var )
  {
    libmesh_assert_greater(_elem_subsolutions.size(), var);
    return _elem_subsolutions[var];
  }

  const DenseVector<Number> & get_elem_solution_rate() const
  { return _elem_solution_rate; }

  DenseVector<Number> & get_elem_solution_rate()
  { return _elem_solution_rate; }

  const DenseSubVector<Number> & get_elem_solution_rate( unsigned int var ) const
  {
    libmesh_assert_greater(_elem_subsolution_rates.size(), var);
    return _elem_subsolution_rates[var];
  }

  DenseSubVector<Number> & get_elem_solution_rate( unsigned int var )
  {
    libmesh_assert_greater(_elem_subsolution_rates.size(), var);
    return _elem_subsolution_rates[var];
  }

  const DenseVector<Number> & get_elem_solution_accel() const
  { return _elem_solution_accel; }

  DenseVector<Number> & get_elem_solution_accel()
  { return _elem_solution_accel; }

  const DenseSubVector<Number> & get_elem_solution_accel( unsigned int var ) const
  {
    libmesh_assert_greater(_elem_subsolution_accels.size(), var);
    return _elem_subsolution_accels[var];
  }

  DenseSubVector<Number> & get_elem_solution_accel( unsigned int var )
  {
    libmesh_assert_greater(_elem_subsolution_accels.size(), var);
    return _elem_subsolution_accels[var];
  }

  const DenseVector<Number> & get_elem_fixed_solution() const
  { return _elem_fixed_solution; }

  DenseVector<Number> & get_elem_fixed_solution()
  { return _elem_fixed_solution; }

  const DenseSubVector<Number> & get_elem_fixed_solution( unsigned int var ) const
  {
    libmesh_assert_greater(_elem_fixed_subsolutions.size(), var);
    return _elem_fixed_subsolutions[var];
  }

  DenseSubVector<Number> & get_elem_fixed_solution( unsigned int var )
  {
    libmesh_assert_greater(_elem_fixed_subsolutions.size(), var);
    return _elem_fixed_subsolutions[var];
  }

  const DenseVector<Number> & get_elem_residual() const
  { return _elem_residual; }

  DenseVector<Number> & get_elem_residual()
  { return _elem_residual; }

  const DenseSubVector<Number> & get_elem_residual( unsigned int var ) const
  {
    libmesh_assert_greater(_elem_subresiduals.size(), var);
    return _elem_subresiduals[var];
  }

  DenseSubVector<Number> & get_elem_residual( unsigned int var )
  {
    libmesh_assert_greater(_elem_subresiduals.size(), var);
    return _elem_subresiduals[var];
  }

  const DenseMatrix<Number> & get_elem_jacobian() const
  {
    libmesh_assert(_have_local_matrices);
    return _elem_jacobian;
  }

  DenseMatrix<Number> & get_elem_jacobian()
  {
    libmesh_assert(_have_local_matrices);
    return _elem_jacobian;
  }

  const DenseSubMatrix<Number> & get_elem_jacobian( unsigned int var1, unsigned int var2 ) const
  {
    libmesh_assert(_have_local_matrices);
    libmesh_assert_greater(_elem_subjacobians.size(), var1);
    libmesh_assert_greater(_elem_subjacobians[var1].size(), var2);
    return _elem_subjacobians[var1][var2];
  }

  DenseSubMatrix<Number> & get_elem_jacobian( unsigned int var1, unsigned int var2 )
  {
    libmesh_assert(_have_local_matrices);
    libmesh_assert_greater(_elem_subjacobians.size(), var1);
    libmesh_assert_greater(_elem_subjacobians[var1].size(), var2);
    return _elem_subjacobians[var1][var2];
  }

  const std::vector<Number> & get_qois() const
  { return _elem_qoi; }

  std::vector<Number> & get_qois()
  { return _elem_qoi; }

  const std::vector<DenseVector<Number>> & get_qoi_derivatives() const
  { return _elem_qoi_derivative; }

  std::vector<DenseVector<Number>> & get_qoi_derivatives()
  { return _elem_qoi_derivative; }

  const DenseSubVector<Number> & get_qoi_derivatives( std::size_t qoi, unsigned int var ) const
  {
    libmesh_assert_greater(_elem_qoi_subderivatives.size(), qoi);
    libmesh_assert_greater(_elem_qoi_subderivatives[qoi].size(), var);
    return _elem_qoi_subderivatives[qoi][var];
  }

  DenseSubVector<Number> & get_qoi_derivatives( std::size_t qoi, unsigned int var )
  {
    libmesh_assert_greater(_elem_qoi_subderivatives.size(), qoi);
    libmesh_assert_greater(_elem_qoi_subderivatives[qoi].size(), var);
    return _elem_qoi_subderivatives[qoi][var];
  }

  const std::vector<dof_id_type> & get_dof_indices() const
  { return _dof_indices; }

  std::vector<dof_id_type> & get_dof_indices()
  { return _dof_indices; }

  const std::vector<dof_id_type> & get_dof_indices( unsigned int var ) const
  {
    libmesh_assert_greater(_dof_indices_var.size(), var);
    return _dof_indices_var[var];
  }

  std::vector<dof_id_type> & get_dof_indices( unsigned int var )
  {
    libmesh_assert_greater(_dof_indices_var.size(), var);
    return _dof_indices_var[var];
  }

  unsigned int n_dof_indices() const
  { return cast_int<unsigned int>(_dof_indices.size()); }

  unsigned int n_dof_indices( unsigned int var ) const
  {
    libmesh_assert_greater(_dof_indices_var.size(), var);
    return cast_int<unsigned int>(_dof_indices_var[var].size());
  }

  Real get_system_time() const
  { return system_time; }

  Real get_time() const
  { return time; }

  void set_time( Real time_in )
  { time = time_in; }

  Real get_elem_solution_derivative() const
  { return elem_solution_derivative; }

  Real get_elem_solution_rate_derivative() const
  { return elem_solution_rate_derivative; }

  Real get_elem_solution_accel_derivative() const
  { return elem_solution_accel_derivative; }

  Real get_fixed_solution_derivative() const
  { return fixed_solution_derivative; }

  bool is_adjoint() const
  { return _is_adjoint; }

  bool & is_adjoint()
  { return _is_adjoint; }

  Real time;

  const Real system_time;

  Real elem_solution_derivative;

  Real elem_solution_rate_derivative;

  Real elem_solution_accel_derivative;

  Real fixed_solution_derivative;

  void set_deltat_pointer(Real * dt);

  Real get_deltat_value();

  void add_localized_vector (NumericVector<Number> & localized_vector, const System & sys);

  typedef std::map<const NumericVector<Number> *, std::pair<DenseVector<Number>, std::vector<DenseSubVector<Number>>>>::iterator localized_vectors_iterator;

  DenseVector<Number> & get_localized_vector (const NumericVector<Number> & localized_vector);

  const DenseVector<Number> & get_localized_vector (const NumericVector<Number> & localized_vector) const;

  DenseSubVector<Number> & get_localized_subvector (const NumericVector<Number> & localized_vector, unsigned int var);

  const DenseSubVector<Number> & get_localized_subvector (const NumericVector<Number> & localized_vector, unsigned int var) const;

protected:

  std::map<const NumericVector<Number> *, std::pair<DenseVector<Number>, std::vector<DenseSubVector<Number>>>> _localized_vectors;

  const bool _have_local_matrices;

  DenseVector<Number> _elem_solution;
  std::vector<DenseSubVector<Number>> _elem_subsolutions;

  DenseVector<Number> _elem_solution_rate;
  std::vector<DenseSubVector<Number>> _elem_subsolution_rates;

  DenseVector<Number> _elem_solution_accel;
  std::vector<DenseSubVector<Number>> _elem_subsolution_accels;

  DenseVector<Number> _elem_fixed_solution;
  std::vector<DenseSubVector<Number>> _elem_fixed_subsolutions;

  DenseVector<Number> _elem_residual;

  DenseMatrix<Number> _elem_jacobian;

  std::vector<Number> _elem_qoi;

  std::vector<DenseVector<Number>> _elem_qoi_derivative;
  std::vector<std::vector<DenseSubVector<Number>>> _elem_qoi_subderivatives;

  std::vector<DenseSubVector<Number>> _elem_subresiduals;
  std::vector<std::vector<DenseSubMatrix<Number>>> _elem_subjacobians;

  std::vector<dof_id_type> _dof_indices;
  std::vector<std::vector<dof_id_type>> _dof_indices_var;

private:

  Real * _deltat;

  const System & _system;

  bool _is_adjoint;

};

} // namespace libMesh


#endif // LIBMESH_DIFF_CONTEXT_H