DefaultNonlinearConvergence.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "DefaultConvergenceBase.h"
#include "MooseApp.h"
#include "Executioner.h"

class NonlinearSystemBase;

class DefaultNonlinearConvergence : public DefaultConvergenceBase
{
public:
  static InputParameters validParams();
  static InputParameters residualConvergenceParams();

  DefaultNonlinearConvergence(const InputParameters & parameters);

  virtual void checkIterationType(IterationType it_type) const override;

  virtual MooseConvergenceStatus checkConvergence(unsigned int n_iter) override;

protected:
  virtual NonlinearSystemBase & nonlinearSystem();

  virtual bool checkResidualConvergence(const unsigned int n_iter,
                                        const Real fnorm,
                                        const Real ref_norm,
                                        const Real rel_tol,
                                        const Real abs_tol,
                                        std::ostringstream & oss);

  virtual void nonlinearConvergenceSetup() {}

  FEProblemBase & _fe_problem;
  PetscReal _abs_tol;
  PetscReal _rel_tol;
  const Real _nl_abs_div_tol;
  const Real _nl_rel_div_tol;
  const Real _div_threshold;
  unsigned int _nl_forced_its;
  const unsigned int _nl_max_pingpong;
  unsigned int _nl_current_pingpong;
};