LevelSetOlssonTerminator Class Reference

Terminates the solve based on the criteria defined in Olsson et. More...

#include <LevelSetOlssonTerminator.h>

Inheritance diagram for LevelSetOlssonTerminator:

Public Member Functions
	LevelSetOlssonTerminator (const InputParameters &parameters)
virtual void	execute () override
virtual void	initialize () override
virtual void	finalize () override

Protected Attributes
NumericVector< Number > &	_solution_diff
	The difference of current and old solutions. More...
const Real &	_tol
	The steady-state convergence tolerance. More...
const int &	_min_t_steps
	The required minimum number of timesteps. More...

Detailed Description

Terminates the solve based on the criteria defined in Olsson et.

al. (2007).

Definition at line 24 of file LevelSetOlssonTerminator.h.

Constructor & Destructor Documentation

LevelSetOlssonTerminator()

LevelSetOlssonTerminator::LevelSetOlssonTerminator

(

const InputParameters &

parameters

)

Definition at line 28 of file LevelSetOlssonTerminator.C.

  : GeneralUserObject(params),
    _solution_diff(_fe_problem.getNonlinearSystem().addVector("solution_diff", false, PARALLEL)),
    _tol(getParam<Real>("tol")),
    _min_t_steps(getParam<int>("min_steps"))
{
}

Member Function Documentation

execute()

void LevelSetOlssonTerminator::execute ( )

overridevirtual

Definition at line 37 of file LevelSetOlssonTerminator.C.

{
  _solution_diff = *_fe_problem.getNonlinearSystem().currentSolution();
  _solution_diff -= _fe_problem.getNonlinearSystem().solutionOld();
  Real delta = _solution_diff.l2_norm() / _dt;
  _console << "Computed convergence criteria: " << delta << std::endl;
 
  if (_fe_problem.timeStep() < _min_t_steps)
    return;
  else if (delta < _tol)
    _fe_problem.terminateSolve();
}

finalize()

virtual void LevelSetOlssonTerminator::finalize ( )

inlineoverridevirtual

Definition at line 30 of file LevelSetOlssonTerminator.h.

{}

initialize()

virtual void LevelSetOlssonTerminator::initialize ( )

inlineoverridevirtual

Definition at line 29 of file LevelSetOlssonTerminator.h.

{}

Member Data Documentation

_min_t_steps

const int& LevelSetOlssonTerminator::_min_t_steps

protected

The required minimum number of timesteps.

Definition at line 40 of file LevelSetOlssonTerminator.h.

Referenced by execute().

_solution_diff

NumericVector<Number>& LevelSetOlssonTerminator::_solution_diff

protected

The difference of current and old solutions.

Definition at line 34 of file LevelSetOlssonTerminator.h.

Referenced by execute().

_tol

const Real& LevelSetOlssonTerminator::_tol

protected

The steady-state convergence tolerance.

Definition at line 37 of file LevelSetOlssonTerminator.h.

Referenced by execute().

---

The documentation for this class was generated from the following files:

• level_set/include/userobjects/LevelSetOlssonTerminator.h
• level_set/src/userobjects/LevelSetOlssonTerminator.C