Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : #include "FEProblem.h"
      13             : #include "ReferenceResidualInterface.h"
      14             : 
      15             : /**
      16             :  * Problem that checks for convergence relative to a user-supplied reference quantity
      17             :  * rather than the initial residual.
      18             :  */
      19             : class ReferenceResidualProblem : public FEProblem, public ReferenceResidualInterface
      20             : {
      21             : public:
      22             :   static InputParameters validParams();
      23             : 
      24             :   ReferenceResidualProblem(const InputParameters & params);
      25             : 
      26             :   virtual void addDefaultNonlinearConvergence(const InputParameters & params) override;
      27           0 :   virtual bool onlyAllowDefaultNonlinearConvergence() const override { return true; }
      28             : };