FieldSplitPreconditioner.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

#pragma once

#include "MoosePreconditioner.h"

// Forward declarations
class NonlinearSystemBase;
class InputParameters;
namespace libMesh
{
class DofMapBase;
}

#include <vector>
#include <string>

class FieldSplitPreconditionerBase
{
public:
  FieldSplitPreconditionerBase() = default;

  virtual void setupDM() = 0;

  virtual KSP getKSP() = 0;
};

template <typename Base>
class FieldSplitPreconditionerTempl : public FieldSplitPreconditionerBase, public Base
{
public:
  static InputParameters validParams();

  FieldSplitPreconditionerTempl(const InputParameters & parameters);

protected:
  virtual const libMesh::DofMapBase & dofMap() const = 0;

  virtual const libMesh::System & system() const = 0;

  virtual std::string prefix() const = 0;

  void createMooseDM(DM * dm);

  NonlinearSystemBase & _nl;

  std::string _decomposition_split;
};

class FieldSplitPreconditioner : public FieldSplitPreconditionerTempl<MoosePreconditioner>
{
public:
  static InputParameters validParams();

  FieldSplitPreconditioner(const InputParameters & parameters);

  virtual void setupDM() override;
  virtual KSP getKSP() override;

protected:
  virtual const libMesh::DofMapBase & dofMap() const override;
  virtual const libMesh::System & system() const override;
  virtual std::string prefix() const override;
};