www.mooseframework.org
NonlinearEigen.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 NONLINEAREIGEN_H
16 #define NONLINEAREIGEN_H
17 
18 #include "EigenExecutionerBase.h"
19 
20 // Forward Declarations
21 class NonlinearEigen;
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 
38  const unsigned int & _free_iter;
39  const Real & _abs_tol;
40  const Real & _rel_tol;
41  const Real & _pfactor;
42  bool _output_pi;
44 };
45 
46 #endif // NONLINEAREIGEN_H
const unsigned int & _free_iter
virtual void init() override
Initialize the executioner.
const Real & _abs_tol
virtual void takeStep()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
NonlinearEigen(const InputParameters &parameters)
virtual void execute() override
Pure virtual execute function MUST be overridden by children classes.
This class provides reusable routines for eigenvalue executioners.
const Real & _pfactor
const Real & _rel_tol
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
InputParameters validParams< NonlinearEigen >()