stokes_matrix_free.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2011-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_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>

namespace aspect
{
  using GMGNumberType = double;

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

      virtual void setup_multigrid_hierarchy();

      virtual const std::vector<std::shared_ptr<const Triangulation<dim, dim>>> &
      get_multigrid_triangulations() const = 0;

      virtual void assemble(LinearAlgebra::BlockVector &system_rhs)=0;

      virtual void build_preconditioner()=0;

      static
      void declare_parameters (ParameterHandler &prm);

      virtual std::size_t get_dof_handler_memory_consumption() const = 0;

      virtual std::size_t get_mg_transfer_memory_consumption() const = 0;

      virtual std::size_t get_constraint_memory_consumption() 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