diff_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

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

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_DIFF_SOLVER_H
#define LIBMESH_DIFF_SOLVER_H

// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/parallel_object.h"

// C++ includes
#include <vector>
#include <memory>

namespace libMesh
{

// Forward Declarations
class ImplicitSystem;
template <typename T> class NumericVector;

class LinearSolutionMonitor
{
public:
  virtual void operator() (const NumericVector<Number> & delta_u,
                           const Real & norm_delta_u,
                           const NumericVector<Number> & u,
                           const Real & norm_u,
                           const NumericVector<Number> & res,
                           const Real & norm_res,
                           const unsigned int iteration) = 0;
  virtual ~LinearSolutionMonitor() = default;
};

class DiffSolver : public ReferenceCountedObject<DiffSolver>,
                   public ParallelObject
{
public:
  typedef ImplicitSystem sys_type;

  DiffSolver (sys_type & s);

  static std::unique_ptr<DiffSolver> build(sys_type & s);

  virtual ~DiffSolver () = default;

  virtual void init ();

  virtual void reinit ();

  virtual unsigned int solve () = 0;

  unsigned int total_outer_iterations() { return _outer_iterations; }

  unsigned int total_inner_iterations() { return _inner_iterations; }

  unsigned int solve_result() { return _solve_result; }

  const sys_type & system () const { return _system; }

  sys_type & system () { return _system; }

  unsigned int max_linear_iterations;

  unsigned int max_nonlinear_iterations;

  bool quiet;

  bool verbose;

  bool continue_after_max_iterations;

  bool continue_after_backtrack_failure;

  Real absolute_residual_tolerance;
  Real relative_residual_tolerance;

  Real absolute_step_tolerance;
  Real relative_step_tolerance;

  double initial_linear_tolerance;

  double minimum_linear_tolerance;

  enum SolveResult {
    INVALID_SOLVE_RESULT = 0,

    CONVERGED_NO_REASON = 1,

    CONVERGED_ABSOLUTE_RESIDUAL = 2,

    CONVERGED_RELATIVE_RESIDUAL = 4,

    CONVERGED_ABSOLUTE_STEP = 8,

    CONVERGED_RELATIVE_STEP = 16,

    DIVERGED_NO_REASON = 32,

    DIVERGED_MAX_NONLINEAR_ITERATIONS = 64,

    DIVERGED_BACKTRACKING_FAILURE = 128,

    DIVERGED_LINEAR_SOLVER_FAILURE = 256
  };

  std::unique_ptr<LinearSolutionMonitor> linear_solution_monitor;

  virtual void set_exact_constraint_enforcement(bool enable)
  {
    _exact_constraint_enforcement = enable;
  }

  bool exact_constraint_enforcement()
  {
    return _exact_constraint_enforcement;
  }

protected:

  bool _exact_constraint_enforcement;

  Real max_solution_norm;

  Real max_residual_norm;

  unsigned int _outer_iterations;

  unsigned int _inner_iterations;

  sys_type & _system;

  unsigned int _solve_result;
};


} // namespace libMesh


#endif // LIBMESH_DIFF_SOLVER_H