www.mooseframework.org
Eigenvalue.C
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 // MOOSE includes
16 #include "Eigenvalue.h"
17 #include "EigenProblem.h"
18 #include "Factory.h"
19 #include "MooseApp.h"
20 #include "NonlinearEigenSystem.h"
21 #include "SlepcSupport.h"
22 
23 template <>
26 {
28 
29  params.addClassDescription("Eigenvalue solves a standard/generalized eigenvaue problem");
30 
31  params.addPrivateParam<bool>("_use_eigen_value", true);
32 
33 // Add slepc options and eigen problems
34 #ifdef LIBMESH_HAVE_SLEPC
36 
38 #endif
39  return params;
40 }
41 
43  : Steady(parameters),
44  _eigen_problem(*parameters.getCheckedPointerParam<EigenProblem *>(
45  "_eigen_problem", "This might happen if you don't have a mesh"))
46 {
47 // Extract and store SLEPc options
48 #if LIBMESH_HAVE_SLEPC
50 
53 #endif
54 }
55 
56 void
58 {
59 #if LIBMESH_HAVE_SLEPC
60  // Make sure the SLEPc options are setup for this app
62 #endif
64 }
SolverParams & solverParams()
Get the solver parameters.
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
InputParameters validParams< Eigenvalue >()
Definition: Eigenvalue.C:25
Steady executioners usually only call "solve()" on the NonlinearSystem once.
Definition: Steady.h:37
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters getSlepcValidParams(InputParameters &params)
Definition: SlepcSupport.C:43
Moose::EigenProblemType _eigen_problem_type
Definition: SolverParams.h:31
virtual void execute() override
Pure virtual execute function MUST be overridden by children classes.
Definition: Eigenvalue.C:57
InputParameters validParams< Steady >()
Definition: Steady.C:26
Eigenvalue(const InputParameters &parameters)
Constructor.
Definition: Eigenvalue.C:42
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:111
void storeSlepcEigenProblemOptions(EigenProblem &eigen_problem, const InputParameters &params)
Definition: SlepcSupport.C:176
void storeSlepcOptions(FEProblemBase &fe_problem, const InputParameters &params)
Definition: SlepcSupport.C:213
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
virtual void execute() override
Pure virtual execute function MUST be overridden by children classes.
Definition: Steady.C:59
EigenProblem & _eigen_problem
Definition: Eigenvalue.h:44
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition: EigenProblem.h:32
void setEigenproblemType(Moose::EigenProblemType eigen_problem_type)
Definition: EigenProblem.C:71
void slepcSetOptions(EigenProblem &eigen_problem, const InputParameters &params)
Definition: SlepcSupport.C:438
InputParameters getSlepcEigenProblemValidParams()
Definition: SlepcSupport.C:71
FEProblemBase & _fe_problem
Definition: Executioner.h:126