www.mooseframework.org
InversePowerMethod.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef INVERSEPOWERMETHOD_H
16 #define INVERSEPOWERMETHOD_H
17 
18 #include "EigenExecutionerBase.h"
19 
20 // Forward Declarations
21 class InversePowerMethod;
22 
23 template <>
25 
27 {
28 public:
30 
31  virtual void init() override;
32 
33  virtual void execute() override;
34 
35 protected:
36  virtual void takeStep();
37 
39  std::string _solution_diff_name;
43  const unsigned int & _min_iter;
45  const unsigned int & _max_iter;
47  const Real & _eig_check_tol;
49  const Real & _sol_check_tol;
51  const Real & _pfactor;
53  const bool & _cheb_on;
54 };
55 
56 #endif // INVERSEPOWERMETHOD_H
const unsigned int & _min_iter
minimum number of power iterations
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const Real & _pfactor
tolerance on each power iteration (always one nonlinear iteration)
InversePowerMethod(const InputParameters &parameters)
virtual void takeStep()
const bool & _cheb_on
indicating if Chebyshev acceleration is turned on
const unsigned int & _max_iter
maximum number of power iterations
virtual void execute() override
Pure virtual execute function MUST be overridden by children classes.
This class provides reusable routines for eigenvalue executioners.
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:73
const PostprocessorValue * _solution_diff
postprocessor for evaluating |x-xprevious|
const Real & _sol_check_tol
convergence tolerance on solution difference
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
std::string _solution_diff_name
name of the postprocessor for evaluating |x-xprevious|; empty means that no postprocessor is provided...
const Real & _eig_check_tol
convergence tolerance on eigenvalue
InputParameters validParams< InversePowerMethod >()
virtual void init() override
Initialize the executioner.