interface.h

Go to the documentation of this file.

/*
  Copyright (C) 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_interface_h
#define _aspect_simulator_solver_interface_h

#include <aspect/global.h>
#include <aspect/simulator_access.h>


namespace aspect
{
  namespace StokesSolver
  {
    struct SolverOutputs
    {
      SolverOutputs()
        :
        initial_nonlinear_residual(numbers::signaling_nan<double>()),
        final_linear_residual(numbers::signaling_nan<double>()),
        pressure_normalization_adjustment(numbers::signaling_nan<double>())
      {}

      double initial_nonlinear_residual;
      double final_linear_residual;

      double pressure_normalization_adjustment;
    };

    template <int dim>
    class Interface: public SimulatorAccess<dim>, public Plugins::InterfaceBase
    {
      public:
        virtual
        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) = 0;

        virtual
        std::string name() const = 0;
    };
  }
}

#endif