MFEMSolverBase.h

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 MFEM_ENABLED

#pragma once
#include "MFEMGeneralUserObject.h"
#include "libmesh/ignore_warnings.h"
#include <mfem.hpp>
#include "libmesh/restore_warnings.h"
#include <memory>

class MFEMSolverBase : public MFEMGeneralUserObject
{
public:
  static InputParameters validParams();

  MFEMSolverBase(const InputParameters & parameters);

  template <typename T>
  void setPreconditioner(T & solver);

  mfem::Solver & getSolver();

  virtual void updateSolver(mfem::ParBilinearForm & a, mfem::Array<int> & tdofs) = 0;

  bool isLOR() const { return _lor || (_preconditioner && _preconditioner->isLOR()); }

protected:
  virtual void constructSolver(const InputParameters & parameters) = 0;

  virtual bool checkSpectralEquivalence(mfem::ParBilinearForm & blf) const;

  // Variable defining whether to use LOR solver
  bool _lor;

  // Solver and preconditioner to be used for the problem
  std::unique_ptr<mfem::Solver> _solver;
  MFEMSolverBase * _preconditioner;
};

inline mfem::Solver &
MFEMSolverBase::getSolver()
{
  mooseAssert(_solver, "Attempting to retrieve solver before it's been constructed");
  return *_solver;
}

#endif