Teko_BlockInvDiagonalStrategy.hpp

/*
// @HEADER
//
// ***********************************************************************
//
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
//
// ***********************************************************************
//
// @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