Teko_TpetraInverseFactoryOperator.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_TpetraInverseFactoryOperator_hpp__
#define __Teko_TpetraInverseFactoryOperator_hpp__

#include "Teuchos_ConstNonconstObjectContainer.hpp"

#include "Teko_ConfigDefs.hpp"
#include "Teko_InverseFactory.hpp"
#include "Teko_TpetraInverseOpWrapper.hpp"

namespace Teko {
namespace TpetraHelpers {

class InverseFactoryOperator : public TpetraInverseOpWrapper {
 public:
  InverseFactoryOperator(const Teuchos::RCP<const InverseFactory> &bfp);

  virtual void initInverse(bool clearOld = false);

  virtual void buildInverseOperator(const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A,
                                    bool clear = true);

  virtual void buildInverseOperator(const Teuchos::RCP<Tpetra::Operator<ST, LO, GO, NT> > &A,
                                    bool clear = true);

  virtual void rebuildInverseOperator(
      const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A);

  virtual void rebuildInverseOperator(const Teuchos::RCP<Tpetra::Operator<ST, LO, GO, NT> > &A);

  Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > getForwardOp() const {
    return fwdOp_.getConstObj();
  }

  Teuchos::RCP<Tpetra::Operator<ST, LO, GO, NT> > getNonconstForwardOp() const {
    return fwdOp_.getNonconstObj();
  }

 protected:
  Teuchos::RCP<const Thyra::LinearOpBase<ST> > extractLinearOp(
      const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A) const;
  Teuchos::RCP<const MappingStrategy> extractMappingStrategy(
      const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A) const;

  InverseFactoryOperator();
  InverseFactoryOperator(const InverseFactoryOperator &);

  Teuchos::RCP<const Teko::InverseFactory> inverseFactory_;
  Teko::ModifiableLinearOp invOperator_;
  bool firstBuildComplete_;

  Teuchos::ConstNonconstObjectContainer<Tpetra::Operator<ST, LO, GO, NT> > fwdOp_;
  bool setConstFwdOp_;
};

}  // end namespace TpetraHelpers
}  // end namespace Teko

#endif