stokes_matrix_free.h

Go to the documentation of this file.

/*
  Copyright (C) 2018 - 2024 by the authors of the ASPECT code.

  This file is part of ASPECT.

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

  ASPECT 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with ASPECT; see the file LICENSE.  If not see
  <http://www.gnu.org/licenses/>.
*/


#ifndef _aspect_stokes_matrix_free_h
#define _aspect_stokes_matrix_free_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>

using GMGNumberType = double;

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

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

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

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

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

  namespace MatrixFreeStokesOperators
  {

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

      double pressure_scaling;

      bool enable_newton_derivatives;

      bool symmetrize_newton_system;

      bool apply_stabilization_free_surface_faces;

      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, 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, 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_p, typename number>
    class MassMatrixOperator
      : public MatrixFreeOperators::Base<dim, ::LinearAlgebra::distributed::Vector<number>>
    {
      public:

        MassMatrixOperator ();

        void clear () override;

        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 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;
    };
  }

  template <int dim>
  class StokesMatrixFreeHandler: public StokesSolver::Interface<dim>
  {
    public:
      virtual void setup_dofs()=0;

      virtual void assemble()=0;

      virtual void build_preconditioner()=0;

      static
      void declare_parameters (ParameterHandler &prm);

      virtual const DoFHandler<dim> &
      get_dof_handler_v () const = 0;

      virtual const DoFHandler<dim> &
      get_dof_handler_p () const = 0;

      virtual const DoFHandler<dim> &
      get_dof_handler_projection () const = 0;

      virtual const AffineConstraints<double> &
      get_constraints_v () const = 0;

      virtual const AffineConstraints<double> &
      get_constraints_p () const = 0;

      virtual const MGTransferMF<dim,GMGNumberType> &
      get_mg_transfer_A () const = 0;

      virtual const MGTransferMF<dim,GMGNumberType> &
      get_mg_transfer_S () const = 0;

      virtual std::size_t get_cell_data_memory_consumption() const = 0;
  };

  template <int dim, int velocity_degree>
  class StokesMatrixFreeHandlerImplementation: public StokesMatrixFreeHandler<dim>
  {
    public:
      StokesMatrixFreeHandlerImplementation(Simulator<dim> &simulator,
                                            const Parameters<dim> &parameters);

      ~StokesMatrixFreeHandlerImplementation() override = default;

      void initialize() override;

      std::string name() const override;

      StokesSolver::SolverOutputs
      solve(const LinearAlgebra::BlockSparseMatrix &system_matrix,
            const LinearAlgebra::BlockVector &system_rhs,
            const bool solve_newton_system,
            const double last_pressure_normalization_adjustment,
            LinearAlgebra::BlockVector &solution_vector) override;

      void setup_dofs() override;

      void assemble() override;

      void build_preconditioner() override;

      static
      void declare_parameters (ParameterHandler &prm);

      void parse_parameters (ParameterHandler &prm) override;

      const DoFHandler<dim> &
      get_dof_handler_v () const override;

      const DoFHandler<dim> &
      get_dof_handler_p () const override;

      const DoFHandler<dim> &
      get_dof_handler_projection () const override;

      const AffineConstraints<double> &
      get_constraints_v () const override;

      const AffineConstraints<double> &
      get_constraints_p () const override;

      const MGTransferMF<dim,GMGNumberType> &
      get_mg_transfer_A () const override;

      const MGTransferMF<dim,GMGNumberType> &
      get_mg_transfer_S () const override;


      std::size_t get_cell_data_memory_consumption() const override;

    private:
      void evaluate_material_model();

      void correct_stokes_rhs();


      Simulator<dim> &sim;

      bool print_details;

      bool do_timings;

      double minimum_viscosity;
      double maximum_viscosity;

      DoFHandler<dim> dof_handler_v;
      DoFHandler<dim> dof_handler_p;
      DoFHandler<dim> dof_handler_projection;

      FESystem<dim> fe_v;
      FESystem<dim> fe_p;
      FESystem<dim> fe_projection;

      MatrixFreeStokesOperators::OperatorCellData<dim, GMGNumberType> active_cell_data;

      MGLevelObject<MatrixFreeStokesOperators::OperatorCellData<dim, GMGNumberType>> level_cell_data;

      using StokesMatrixType = MatrixFreeStokesOperators::StokesOperator<dim,velocity_degree,double>;
      using SchurComplementMatrixType = MatrixFreeStokesOperators::MassMatrixOperator<dim,velocity_degree-1,double>;
      using ABlockMatrixType = MatrixFreeStokesOperators::ABlockOperator<dim,velocity_degree,double>;

      using GMGSchurComplementMatrixType = MatrixFreeStokesOperators::MassMatrixOperator<dim,velocity_degree-1,GMGNumberType>;
      using GMGABlockMatrixType = MatrixFreeStokesOperators::ABlockOperator<dim,velocity_degree,GMGNumberType>;

      StokesMatrixType stokes_matrix;
      ABlockMatrixType A_block_matrix;
      SchurComplementMatrixType Schur_complement_block_matrix;

      AffineConstraints<double> constraints_v;
      AffineConstraints<double> constraints_p;

      MGLevelObject<GMGABlockMatrixType> mg_matrices_A_block;
      MGLevelObject<GMGSchurComplementMatrixType> mg_matrices_Schur_complement;

      MGConstrainedDoFs mg_constrained_dofs_A_block;
      MGConstrainedDoFs mg_constrained_dofs_Schur_complement;
      MGConstrainedDoFs mg_constrained_dofs_projection;

      MGTransferMF<dim,GMGNumberType> mg_transfer_A_block;
      MGTransferMF<dim,GMGNumberType> mg_transfer_Schur_complement;

      std::vector<std::shared_ptr<MatrixFree<dim,double>>> matrix_free_objects;
  };
}


#endif