matrix_free_operators.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2018-2026 by the ASPECT authors.
//
// This file is part of ASPECT.
//
// Detailed license information governing the source code and
// contributions can be found in the folder LICENSES and in
// LICENSE and CONTRIBUTING.md at the top level directory.
//
// ------------------------------------------------------

#ifndef _aspect_simulator_stokes_matrix_free_operators_h
#define _aspect_simulator_stokes_matrix_free_operators_h

#include <aspect/global.h>
#include <aspect/simulator/solver/interface.h>
#include <aspect/simulator.h>

#include <deal.II/matrix_free/matrix_free.h>
#include <deal.II/matrix_free/operators.h>
#include <deal.II/matrix_free/fe_evaluation.h>

#include <deal.II/multigrid/mg_constrained_dofs.h>
#include <deal.II/multigrid/multigrid.h>
#include <deal.II/multigrid/mg_transfer_matrix_free.h>
#include <deal.II/multigrid/mg_transfer_global_coarsening.templates.h>
#include <deal.II/multigrid/mg_tools.h>
#include <deal.II/multigrid/mg_coarse.h>
#include <deal.II/multigrid/mg_smoother.h>
#include <deal.II/multigrid/mg_matrix.h>

#include <deal.II/lac/vector.h>
#include <deal.II/lac/block_vector.h>
#include <deal.II/lac/la_parallel_vector.h>
#include <deal.II/lac/la_parallel_block_vector.h>

namespace aspect
{
  namespace internal
  {
    namespace ChangeVectorTypes
    {
      void import(aspect::LinearAlgebra::Vector &out,
                  const ::LinearAlgebra::ReadWriteVector<double> &rwv,
                  const VectorOperation::values                 operation);

      void copy(aspect::LinearAlgebra::Vector &out,
                const ::LinearAlgebra::distributed::Vector<double> &in);

      void copy(::LinearAlgebra::distributed::Vector<double> &out,
                const aspect::LinearAlgebra::Vector &in);

      void copy(aspect::LinearAlgebra::BlockVector &out,
                const ::LinearAlgebra::distributed::BlockVector<double> &in);

      void copy(::LinearAlgebra::distributed::BlockVector<double> &out,
                const aspect::LinearAlgebra::BlockVector &in);
    }
  }

  namespace MatrixFreeStokesOperators
  {

    template <int dim, typename number>
    struct OperatorCellData
    {
      bool is_compressible;

      double pressure_scaling;

      bool enable_newton_derivatives;

      bool enable_prescribed_dilation;

      bool symmetrize_newton_system;

      bool apply_stabilization_free_surface_faces;

      bool average_newton_factors;

      Table<2, VectorizedArray<number>> viscosity;

      Table<2, SymmetricTensor<2, dim, VectorizedArray<number>>> strain_rate_table;

      Table<2, VectorizedArray<number>> newton_factor_wrt_pressure_table;

      Table<2, SymmetricTensor<2, dim, VectorizedArray<number>>>
      newton_factor_wrt_strain_rate_table;

      Table<2, VectorizedArray<number>> dilation_lhs_term_table;

      Table<2, VectorizedArray<number>>
      dilation_derivative_wrt_pressure_table;

      Table<2, SymmetricTensor<2, dim, VectorizedArray<number>>>
      dilation_derivative_wrt_strain_rate_table;

      Table<2, Tensor<1, dim, VectorizedArray<number>>> free_surface_stabilization_term_table;

      std::set<types::boundary_id> free_surface_boundary_indicators;

      std::size_t
      memory_consumption() const;

      void clear();
    };

    template <int dim, typename number>
    void fill_active_cell_data(const DoFHandler<dim> &dof_handler,
                               const DoFHandler<dim> &dof_handler_projection,
                               const Introspection<dim> &introspection,
                               const Quadrature<dim> &quadrature_formula,
                               const MaterialModel::Interface<dim> &material_model,
                               const MaterialModel::MaterialAveraging::AveragingOperation &material_averaging,
                               const Mapping<dim> &mapping,
                               const MatrixFree<dim, double> &matrix_free,
                               const MatrixFree<dim, double> &matrix_free_schur,
                               const MatrixFree<dim, double> &matrix_free_A,
                               const LinearAlgebra::BlockVector &current_linearization_point,
                               const MPI_Comm &mpi_comm,
                               ::LinearAlgebra::distributed::Vector<double> &active_viscosity_vector,
                               OperatorCellData<dim, number> &active_cell_data,
                               double &minimum_viscosity,
                               double &maximum_viscosity);

    template <int dim, int degree_v, typename number>
    class StokesOperator
      : public MatrixFreeOperators::Base<dim, ::LinearAlgebra::distributed::BlockVector<number>>
    {
      public:

        StokesOperator ();

        void clear () override;

        void set_cell_data (const OperatorCellData<dim,number> &data);

        void compute_diagonal () override;

      private:

        void apply_add (::LinearAlgebra::distributed::BlockVector<number> &dst,
                        const ::LinearAlgebra::distributed::BlockVector<number> &src) const override;

        void local_apply (const ::MatrixFree<dim, number> &data,
                          ::LinearAlgebra::distributed::BlockVector<number> &dst,
                          const ::LinearAlgebra::distributed::BlockVector<number> &src,
                          const std::pair<unsigned int, unsigned int> &cell_range) const;

        void local_apply_face (const ::MatrixFree<dim, number> &data,
                               ::LinearAlgebra::distributed::BlockVector<number> &dst,
                               const ::LinearAlgebra::distributed::BlockVector<number> &src,
                               const std::pair<unsigned int, unsigned int> &face_range) const;

        void local_apply_boundary_face (const ::MatrixFree<dim, number> &data,
                                        ::LinearAlgebra::distributed::BlockVector<number> &dst,
                                        const ::LinearAlgebra::distributed::BlockVector<number> &src,
                                        const std::pair<unsigned int, unsigned int> &face_range) const;

        const OperatorCellData<dim,number> *cell_data;
    };



    template <int dim, int degree_v, typename number>
    class BTBlockOperator
      : public MatrixFreeOperators::Base<dim, ::LinearAlgebra::distributed::BlockVector<number>>
    {
      public:

        BTBlockOperator ();

        void clear () override;

        void set_cell_data (const OperatorCellData<dim,number> &data);

        void compute_diagonal () override;

      private:

        void apply_add (::LinearAlgebra::distributed::BlockVector<number> &dst,
                        const ::LinearAlgebra::distributed::BlockVector<number> &src) const override;

        void local_apply (const ::MatrixFree<dim, number> &data,
                          ::LinearAlgebra::distributed::BlockVector<number> &dst,
                          const ::LinearAlgebra::distributed::BlockVector<number> &src,
                          const std::pair<unsigned int, unsigned int> &cell_range) const;

        void local_apply_face (const ::MatrixFree<dim, number> &data,
                               ::LinearAlgebra::distributed::BlockVector<number> &dst,
                               const ::LinearAlgebra::distributed::BlockVector<number> &src,
                               const std::pair<unsigned int, unsigned int> &face_range) const;

        const OperatorCellData<dim,number> *cell_data;
    };



    template <int dim, int degree_p, typename number>
    class MassMatrixOperator
      : public MatrixFreeOperators::Base<dim, ::LinearAlgebra::distributed::Vector<number>>
    {
      public:

        MassMatrixOperator ();

        void clear () override;

        void reinit(const Mapping<dim>              &mapping,
                    const DoFHandler<dim>           &dof_handler_v,
                    const DoFHandler<dim>           &dof_handler_p,
                    const AffineConstraints<number> &constraints_v,
                    const AffineConstraints<number> &constraints_p,
                    std::shared_ptr<MatrixFree<dim,double>> mf_storage,
                    const unsigned int level = numbers::invalid_unsigned_int);

        void set_cell_data (const OperatorCellData<dim,number> &data);

        void compute_diagonal () override;

      private:

        void apply_add (::LinearAlgebra::distributed::Vector<number> &dst,
                        const ::LinearAlgebra::distributed::Vector<number> &src) const override;

        void local_apply (const ::MatrixFree<dim, number> &data,
                          ::LinearAlgebra::distributed::Vector<number> &dst,
                          const ::LinearAlgebra::distributed::Vector<number> &src,
                          const std::pair<unsigned int, unsigned int> &cell_range) const;

        void inner_cell_operation(FEEvaluation<dim,
                                  degree_p,
                                  degree_p+2,
                                  1,
                                  number> &pressure) const;

        const OperatorCellData<dim,number> *cell_data;
    };

    template <int dim, int degree_v, typename number>
    class ABlockOperator
      : public MatrixFreeOperators::Base<dim, ::LinearAlgebra::distributed::Vector<number>>
    {
      public:

        ABlockOperator ();

        void clear () override;

        void reinit(const Mapping<dim>              &mapping,
                    const DoFHandler<dim>           &dof_handler_v,
                    const DoFHandler<dim>           &dof_handler_p,
                    const AffineConstraints<number> &constraints_v,
                    const AffineConstraints<number> &constraints_p,
                    std::shared_ptr<MatrixFree<dim,double>> mf_storage,
                    const unsigned int level = numbers::invalid_unsigned_int);
        void set_cell_data (const OperatorCellData<dim,number> &data);

        void compute_diagonal () override;

        void set_diagonal (const ::LinearAlgebra::distributed::Vector<number> &diag);

      private:
        void inner_cell_operation(FEEvaluation<dim,
                                  degree_v,
                                  degree_v+1,
                                  dim,
                                  number> &velocity) const;

        void cell_operation(FEEvaluation<dim,
                            degree_v,
                            degree_v+1,
                            dim,
                            number> &velocity) const;

        void apply_add (::LinearAlgebra::distributed::Vector<number> &dst,
                        const ::LinearAlgebra::distributed::Vector<number> &src) const override;

        void local_apply (const ::MatrixFree<dim, number> &data,
                          ::LinearAlgebra::distributed::Vector<number> &dst,
                          const ::LinearAlgebra::distributed::Vector<number> &src,
                          const std::pair<unsigned int, unsigned int> &cell_range) const;

        const OperatorCellData<dim,number> *cell_data;
    };
  }

}

#endif