www.mooseframework.org
LevelSetOlssonTerminator.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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
16 class Transient;
17 
18 template <>
20 
24 class LevelSetOlssonTerminator : public GeneralUserObject
25 {
26 public:
27  LevelSetOlssonTerminator(const InputParameters & parameters);
28  virtual void execute() override;
29  virtual void initialize() override {}
30  virtual void finalize() override {}
31 
32 protected:
34  NumericVector<Number> & _solution_diff;
35 
37  const Real & _tol;
38 
40  const int & _min_t_steps;
41 };
42 
LevelSetOlssonTerminator::initialize
virtual void initialize() override
Definition: LevelSetOlssonTerminator.h:29
LevelSetOlssonTerminator
Terminates the solve based on the criteria defined in Olsson et.
Definition: LevelSetOlssonTerminator.h:24
LevelSetOlssonTerminator::execute
virtual void execute() override
Definition: LevelSetOlssonTerminator.C:37
LevelSetOlssonTerminator::finalize
virtual void finalize() override
Definition: LevelSetOlssonTerminator.h:30
LevelSetOlssonTerminator::_solution_diff
NumericVector< Number > & _solution_diff
The difference of current and old solutions.
Definition: LevelSetOlssonTerminator.h:34
LevelSetOlssonTerminator::_min_t_steps
const int & _min_t_steps
The required minimum number of timesteps.
Definition: LevelSetOlssonTerminator.h:40
LevelSetOlssonTerminator::_tol
const Real & _tol
The steady-state convergence tolerance.
Definition: LevelSetOlssonTerminator.h:37
LevelSetOlssonTerminator::LevelSetOlssonTerminator
LevelSetOlssonTerminator(const InputParameters &parameters)
Definition: LevelSetOlssonTerminator.C:28
validParams< LevelSetOlssonTerminator >
InputParameters validParams< LevelSetOlssonTerminator >()
Definition: LevelSetOlssonTerminator.C:17