MFEMHypreFGMRES.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#ifdef MOOSE_MFEM_ENABLED
 
#include "MFEMHypreFGMRES.h"
#include "MFEMProblem.h"
 
registerMooseObject("MooseApp", MFEMHypreFGMRES);
 
InputParameters
MFEMHypreFGMRES::validParams()
{
  InputParameters params = Moose::MFEM::LORLinearSolverBase<mfem::HypreFGMRES>::validParams();
  params.addClassDescription("Hypre solver for the iterative solution of MFEM equation systems "
                             "using the flexible generalized minimal residual method.");
  params.addParam<mfem::real_t>("l_tol", 1e-5, "Set the relative tolerance.");
  params.addParam<int>("l_max_its", 10000, "Set the maximum number of iterations.");
  params.addParam<int>("kdim", 10, "Set the k-dimension.");
  params.addParam<int>("print_level", 2, "Set the solver verbosity.");
  params.addParam<MFEMSolverName>("preconditioner", "Optional choice of preconditioner to use.");
 
  return params;
}
 
MFEMHypreFGMRES::MFEMHypreFGMRES(const InputParameters & parameters)
  : Moose::MFEM::LORLinearSolverBase<mfem::HypreFGMRES>(parameters)
{
  ConstructSolver();
}
 
void
MFEMHypreFGMRES::ConstructSolver()
{
  auto solver = std::make_unique<mfem::HypreFGMRES>(getMFEMProblem().getComm());
  SetSolverParameters(*solver);
  _solver = std::move(solver);
}
 
void
MFEMHypreFGMRES::SetSolverParameters(mfem::HypreFGMRES & solver)
{
  solver.iterative_mode = getParam<bool>("use_initial_guess");
  solver.SetTol(getParam<mfem::real_t>("l_tol"));
  solver.SetMaxIter(getParam<int>("l_max_its"));
  solver.SetKDim(getParam<int>("kdim"));
  solver.SetPrintLevel(getParam<int>("print_level"));
}
 
void
MFEMHypreFGMRES::SetPreconditionerImpl()
{
  if (auto * prec = dynamic_cast<mfem::HypreSolver *>(&_preconditioner->GetSolver()))
    cast_ref<mfem::HypreFGMRES &>(GetSolver()).SetPreconditioner(*prec);
  else
    paramError("preconditioner", "MFEMHypreFGMRES requires a hypre solver as its preconditioner");
}
 
#endif