Teko_BlockPreconditionerFactory.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_BlockPreconditionerFactory_hpp__
#define __Teko_BlockPreconditionerFactory_hpp__

#include "Teuchos_ParameterListAcceptor.hpp"

// Thyra includes
#include "Thyra_SolveSupportTypes.hpp"
#include "Thyra_LinearOpSourceBase.hpp"
#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Thyra_DefaultBlockedLinearOp.hpp"
#include "Thyra_DefaultPreconditioner.hpp"

// Teko includes
#include "Teko_Utilities.hpp"
#include "Teko_InverseLibrary.hpp"
#include "Teko_CloneFactory.hpp"
#include "Teko_PreconditionerState.hpp"
#include "Teko_PreconditionerFactory.hpp"

namespace Teko {

using Teuchos::ParameterList;
using Teuchos::rcp;
using Teuchos::RCP;
using Thyra::DefaultPreconditioner;
using Thyra::LinearOpBase;

class BlockPreconditionerState : public PreconditionerState {
 public:
  virtual void setBlockSourceVector(const Teko::BlockedMultiVector &srcVec) {
    setSourceVector(srcVec);
  }

  virtual const Teko::BlockedMultiVector getBlockedSourceVector() const {
    return toBlockedMultiVector(getSourceVector());
  }
};

class BlockPreconditionerFactory : public PreconditionerFactory {
 public:
  virtual LinearOp buildPreconditionerOperator(BlockedLinearOp &blo,
                                               BlockPreconditionerState &state) const = 0;

  virtual RCP<PreconditionerState> buildPreconditionerState() const {
    return rcp(new BlockPreconditionerState());
  }

  RCP<BlockPreconditionerState> buildBlockPreconditionerState() const {
    return Teuchos::rcp_dynamic_cast<BlockPreconditionerState>(buildPreconditionerState());
  }

  virtual LinearOp buildPreconditionerOperator(LinearOp &blo, PreconditionerState &state) const;

  bool isCompatible(const Thyra::LinearOpSourceBase<double> &fwdOpSrc) const;
};

}  // end namespace Teko

#endif