Teko_BlockInvDiagonalStrategy.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __Teko_BlockInvDiagonalStrategy_hpp__
#define __Teko_BlockInvDiagonalStrategy_hpp__

#include <vector>

// Teuchos includes
#include "Teuchos_RCP.hpp"

// Thyra includes
#include "Thyra_LinearOpBase.hpp"

// Teko includes
#include "Teko_Utilities.hpp"
#include "Teko_InverseFactory.hpp"
#include "Teko_BlockPreconditionerFactory.hpp"

namespace Teko {

class BlockInvDiagonalStrategy {
 public:
  virtual ~BlockInvDiagonalStrategy() {}

  virtual void getInvD(const BlockedLinearOp &A, BlockPreconditionerState &state,
                       std::vector<LinearOp> &invDiag) const = 0;
};

class StaticInvDiagStrategy : public BlockInvDiagonalStrategy {
 public:
  StaticInvDiagStrategy(const LinearOp &invD0, const LinearOp &invD1) {
    invDiag_.push_back(invD0);
    invDiag_.push_back(invD1);
  }

  StaticInvDiagStrategy(const std::vector<LinearOp> &invD) : invDiag_(invD) {}

  virtual ~StaticInvDiagStrategy() {}

  virtual void getInvD(const BlockedLinearOp & /* A */, BlockPreconditionerState & /* state */,
                       std::vector<LinearOp> &invDiag) const {
    invDiag.clear();
    invDiag = invDiag_;
  }

 protected:
  // stored inverse operators
  std::vector<Teuchos::RCP<const Thyra::LinearOpBase<double> > > invDiag_;
};

class InvFactoryDiagStrategy : public BlockInvDiagonalStrategy {
 public:
  InvFactoryDiagStrategy(const Teuchos::RCP<InverseFactory> &factory);

  InvFactoryDiagStrategy(const std::vector<Teuchos::RCP<InverseFactory> > &factories,
                         const Teuchos::RCP<InverseFactory> &defaultFact = Teuchos::null);

  InvFactoryDiagStrategy(
      const std::vector<Teuchos::RCP<InverseFactory> > &inverseFactories,
      const std::vector<Teuchos::RCP<InverseFactory> > &preconditionerFactories,
      const Teuchos::RCP<InverseFactory> &defaultInverseFact        = Teuchos::null,
      const Teuchos::RCP<InverseFactory> &defaultPreconditionerFact = Teuchos::null);

  virtual ~InvFactoryDiagStrategy() {}

  virtual void getInvD(const BlockedLinearOp &A, BlockPreconditionerState &state,
                       std::vector<LinearOp> &invDiag) const;

  const std::vector<Teuchos::RCP<InverseFactory> > &getFactories() const { return invDiagFact_; }

 protected:
  // stored inverse operators
  std::vector<Teuchos::RCP<InverseFactory> > invDiagFact_;
  std::vector<Teuchos::RCP<InverseFactory> > precDiagFact_;
  Teuchos::RCP<InverseFactory> defaultInvFact_;
  Teuchos::RCP<InverseFactory> defaultPrecFact_;

  LinearOp buildInverse(const InverseFactory &invFact, Teuchos::RCP<InverseFactory> &precFact,
                        const LinearOp &matrix, BlockPreconditionerState &state,
                        const std::string &opPrefix, int i) const;

 private:
  InvFactoryDiagStrategy();
  InvFactoryDiagStrategy(const InvFactoryDiagStrategy &);
};

}  // end namespace Teko

#endif