https://mooseframework.inl.gov
Loading...
Searching...
No Matches
InversePowerMethod.h
Go to the documentation of this file.
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
13
15{
16public:
18
20
21 virtual void init() override;
22
23 virtual void execute() override;
24
25 virtual bool lastSolveConverged() const override { return _last_solve_converged; }
26
27protected:
28 virtual void takeStep();
29
31 const PostprocessorName & _solution_diff_name;
33 const unsigned int & _min_iter;
35 const unsigned int & _max_iter;
37 const Real & _eig_check_tol;
39 const Real & _sol_check_tol;
41 const Real & _l_tol;
43 const bool & _cheb_on;
46};
This class provides reusable routines for eigenvalue executioners.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
bool _last_solve_converged
flag to indicate if inverse power iteration converged
const unsigned int & _max_iter
maximum number of power iterations
virtual void execute() override
Pure virtual execute function MUST be overridden by children classes.
static InputParameters validParams()
const Real & _l_tol
tolerance on each power iteration (always one nonlinear iteration)
const PostprocessorName & _solution_diff_name
name of the postprocessor for evaluating |x-xprevious|; empty means that no postprocessor is provided...
const unsigned int & _min_iter
minimum number of power iterations
const Real & _sol_check_tol
convergence tolerance on solution difference
virtual bool lastSolveConverged() const override
Whether or not the last solve converged.
const Real & _eig_check_tol
convergence tolerance on eigenvalue
virtual void takeStep()
const bool & _cheb_on
indicating if Chebyshev acceleration is turned on
virtual void init() override
Initialize the executioner.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131