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 "GeneralUserObject.h"
      13             : 
      14             : // Forward Declarations
      15             : /**
      16             :  * Terminates the solve based on the criteria defined in Olsson et. al. (2007).
      17             :  */
      18             : class LevelSetOlssonTerminator : public GeneralUserObject
      19             : {
      20             : public:
      21             :   static InputParameters validParams();
      22             : 
      23             :   LevelSetOlssonTerminator(const InputParameters & parameters);
      24             :   virtual void execute() override;
      25         482 :   virtual void initialize() override {}
      26         482 :   virtual void finalize() override {}
      27             : 
      28             : protected:
      29             :   /// The difference of current and old solutions
      30             :   NumericVector<Number> & _solution_diff;
      31             : 
      32             :   /// The steady-state convergence tolerance
      33             :   const Real & _tol;
      34             : 
      35             :   /// The required minimum number of timesteps
      36             :   const int & _min_t_steps;
      37             : };