stokes_matrix_free.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 2025 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_simulator_solver_stokes_matrix_free_h
#define _aspect_simulator_solver_stokes_matrix_free_h

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

#include <deal.II/multigrid/mg_transfer_matrix_free.h>
#include <deal.II/multigrid/mg_transfer_global_coarsening.templates.h>

using GMGNumberType = double;

namespace aspect
{
  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>
  std::unique_ptr<StokesMatrixFreeHandler<dim>> create_matrix_free_solver(Simulator<dim> &simulator, const Parameters<dim> &parameters);

}

#endif