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 "Convergence.h"
#include "MooseApp.h"
#include "Executioner.h"

class DefaultNonlinearConvergence : public Convergence
{
public:
  static InputParameters validParams();

  static InputParameters residualConvergenceParams();

  DefaultNonlinearConvergence(const InputParameters & parameters);

  virtual void initialSetup() override;

  virtual MooseConvergenceStatus checkConvergence(unsigned int iter) override;

protected:
  virtual bool checkRelativeConvergence(const unsigned int it,
                                        const Real fnorm,
                                        const Real ref_norm,
                                        const Real rel_tol,
                                        const Real abs_tol,
                                        std::ostringstream & oss);

  virtual void nonlinearConvergenceSetup() {}

  template <typename T>
  const T & getSharedExecutionerParam(const std::string & name);

  void checkDuplicateSetSharedExecutionerParams() const;

private:
  const bool _added_as_default;

  std::vector<std::string> _duplicate_shared_executioner_params;

protected:
  FEProblemBase & _fe_problem;
  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;
};

template <typename T>
const T &
DefaultNonlinearConvergence::getSharedExecutionerParam(const std::string & param)
{
  const auto * executioner = getMooseApp().getExecutioner();
  if (executioner->isParamSetByUser(param))
  {
    if (isParamSetByUser(param))
      _duplicate_shared_executioner_params.push_back(param);
    return executioner->getParam<T>(param);
  }
  else
    return getParam<T>(param);
}