www.mooseframework.org
LevelSetOlssonTerminator.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
3 /* */
4 /* All contents are licensed under LGPL V2.1 */
5 /* See LICENSE for full restrictions */
6 /****************************************************************/
7 
8 #ifndef LEVELSETOLSSONTERMINATOR_H
9 #define LEVELSETOLSSONTERMINATOR_H
10 
11 #include "GeneralUserObject.h"
12 
13 // Forward Declarations
15 class Transient;
16 
17 template <>
19 
23 class LevelSetOlssonTerminator : public GeneralUserObject
24 {
25 public:
26  LevelSetOlssonTerminator(const InputParameters & parameters);
27  virtual void execute() override;
28  virtual void initialize() override {}
29  virtual void finalize() override {}
30 
31 protected:
33  NumericVector<Number> & _solution_diff;
34 
36  const Real & _tol;
37 
39  const int & _min_t_steps;
40 };
41 
42 #endif // LEVELSETOLSSONTERMINATOR_H
InputParameters validParams< LevelSetOlssonTerminator >()
virtual void finalize() override
const Real & _tol
The steady-state convergence tolerance.
Terminates the solve based on the criteria defined in Olsson et.
NumericVector< Number > & _solution_diff
The difference of current and old solutions.
virtual void initialize() override
virtual void execute() override
const int & _min_t_steps
The required minimum number of timesteps.
LevelSetOlssonTerminator(const InputParameters &parameters)