PhysicsBasedPreconditioner.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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

// MOOSE includes
#include "MoosePreconditioner.h"

// libMesh includes
#include "libmesh/preconditioner.h"
#include "libmesh/linear_implicit_system.h"
#include "libmesh/enum_preconditioner_type.h"

// C++ includes
#include <vector>

// Forward declarations
class NonlinearSystemBase;
class PhysicsBasedPreconditioner : public MoosePreconditioner, public Preconditioner<Number>
{
public:
  static InputParameters validParams();

  PhysicsBasedPreconditioner(const InputParameters & params);
  virtual ~PhysicsBasedPreconditioner();

  // FIXME: use better name
  void addSystem(unsigned int var,
                 std::vector<unsigned int> off_diag,
                 PreconditionerType type = AMG_PRECOND);

  virtual void apply(const NumericVector<Number> & x, NumericVector<Number> & y);

  virtual void clear();

  virtual void init();

  virtual void setup();

protected:
  NonlinearSystemBase & _nl;
  std::vector<LinearImplicitSystem *> _systems;
  std::vector<std::unique_ptr<Preconditioner<Number>>> _preconditioners;
  std::vector<unsigned int> _solve_order;
  std::vector<PreconditionerType> _pre_type;
  std::vector<std::vector<unsigned int>> _off_diag;

  std::vector<std::vector<SparseMatrix<Number> *>> _off_diag_mats;
};