https://mooseframework.inl.gov
MFEMEigensolverBase.C
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 #ifdef MOOSE_MFEM_ENABLED
11 
12 #include "MFEMEigensolverBase.h"
13 #include "MFEMProblem.h"
14 
15 namespace Moose::MFEM
16 {
19 {
21  params.addClassDescription("Base class for defining MFEM eigensolver classes for Moose");
22 
23  params.addParam<mfem::real_t>("l_tol", 1e-5, "Set the relative tolerance.");
24  params.addParam<int>("l_max_its", 10000, "Set the maximum number of iterations.");
25  params.addParam<int>("print_level", 2, "Set the solver verbosity.");
26  params.addParam<MFEMSolverName>("preconditioner", "Optional choice of preconditioner to use.");
27  params.suppressParameter<bool>("use_initial_guess");
28 
29  return params;
30 }
31 
33  : LinearSolverBase(parameters), _num_modes(getMFEMProblem().getParam<int>("num_modes"))
34 {
35 }
36 }
37 
38 #endif
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
void suppressParameter(const std::string &name)
This method suppresses an inherited parameter so that it isn&#39;t required or valid in the derived class...
Base class for linear MFEM solvers and preconditioners.
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...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object...
Utilities for converting between vector(s) of libMesh Points and MFEM Vector(s).
EigensolverBase(const InputParameters &parameters)
static InputParameters validParams()
void ErrorVector unsigned int