Teko_TpetraInverseFactoryOperator.cpp

/*
// @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

*/

#include "Teko_TpetraInverseFactoryOperator.hpp"

// Teko includes
#include "Teko_TpetraBasicMappingStrategy.hpp"

// Thyra includes
#include "Thyra_TpetraLinearOp.hpp"

using Teuchos::RCP;
using Teuchos::rcp;
using Teuchos::rcp_dynamic_cast;
using Teuchos::rcpFromRef;

namespace Teko {
namespace TpetraHelpers {

InverseFactoryOperator::InverseFactoryOperator(const Teuchos::RCP<const InverseFactory>& ifp)
    : inverseFactory_(ifp), firstBuildComplete_(false), setConstFwdOp_(true) {}

void InverseFactoryOperator::initInverse(bool clearOld) {
  if (not clearOld) return;
  invOperator_ = Teuchos::null;
}

void InverseFactoryOperator::buildInverseOperator(
    const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& A, bool clear) {
  Teko_DEBUG_SCOPE("InverseFactoryOperator::buildInverseOperator", 10);

  // extract EpetraOperatorWrapper (throw on failure) and corresponding thyra operator
  RCP<const Thyra::LinearOpBase<ST> > thyraA = extractLinearOp(A);

  // set the mapping strategy
  SetMapStrategy(rcp(new InverseMappingStrategy(extractMappingStrategy(A))));

  initInverse(clear);

  // actually build the inverse operator
  invOperator_ = Teko::buildInverse(*inverseFactory_, thyraA);

  SetOperator(invOperator_, false);

  firstBuildComplete_ = true;

  if (setConstFwdOp_) fwdOp_ = A;

  setConstFwdOp_ = true;

  TEUCHOS_ASSERT(invOperator_ != Teuchos::null);
  TEUCHOS_ASSERT(getForwardOp() != Teuchos::null);
  TEUCHOS_ASSERT(getThyraOp() != Teuchos::null);
  TEUCHOS_ASSERT(getMapStrategy() != Teuchos::null);
  TEUCHOS_ASSERT(firstBuildComplete_ == true);
}

void InverseFactoryOperator::buildInverseOperator(
    const Teuchos::RCP<Tpetra::Operator<ST, LO, GO, NT> >& A, bool /* clear */) {
  setConstFwdOp_ = false;

  fwdOp_.initialize(A);

  buildInverseOperator(A.getConst());

  TEUCHOS_ASSERT(setConstFwdOp_ == true);
}

void InverseFactoryOperator::rebuildInverseOperator(
    const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& A) {
  Teko_DEBUG_SCOPE("InverseFactoryOperator::rebuildPreconditioner", 10);

  // if the inverse hasn't been built yet, rebuild from scratch
  if (not firstBuildComplete_) {
    buildInverseOperator(A, false);
    return;
  }

  RCP<const Thyra::LinearOpBase<ST> > thyraA = extractLinearOp(A);
  Teko::rebuildInverse(*inverseFactory_, thyraA, invOperator_);

  if (setConstFwdOp_) fwdOp_.initialize(A);

  SetOperator(invOperator_, false);

  setConstFwdOp_ = true;

  TEUCHOS_ASSERT(getForwardOp() != Teuchos::null);
  TEUCHOS_ASSERT(invOperator_ != Teuchos::null);
  TEUCHOS_ASSERT(getThyraOp() != Teuchos::null);
  TEUCHOS_ASSERT(firstBuildComplete_ == true);
}

void InverseFactoryOperator::rebuildInverseOperator(
    const Teuchos::RCP<Tpetra::Operator<ST, LO, GO, NT> >& A) {
  setConstFwdOp_ = false;

  fwdOp_.initialize(A);

  // build from constant epetra operator
  rebuildInverseOperator(A.getConst());

  TEUCHOS_ASSERT(setConstFwdOp_ == true);
}

Teuchos::RCP<const Thyra::LinearOpBase<ST> > InverseFactoryOperator::extractLinearOp(
    const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& A) const {
  // extract EpetraOperatorWrapper (throw on failure) and corresponding thyra operator
  const RCP<const TpetraOperatorWrapper>& eow = rcp_dynamic_cast<const TpetraOperatorWrapper>(A);

  // if it is an EpetraOperatorWrapper, then get the Thyra operator
  if (eow != Teuchos::null) return eow->getThyraOp();

  // otherwise wrap it up as a thyra operator
  return Thyra::constTpetraLinearOp<ST, LO, GO, NT>(
      Thyra::tpetraVectorSpace<ST, LO, GO, NT>(A->getRangeMap()),
      Thyra::tpetraVectorSpace<ST, LO, GO, NT>(A->getDomainMap()), A);
}

Teuchos::RCP<const MappingStrategy> InverseFactoryOperator::extractMappingStrategy(
    const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& A) const {
  // extract EpetraOperatorWrapper (throw on failure) and corresponding thyra operator
  const RCP<const TpetraOperatorWrapper>& eow = rcp_dynamic_cast<const TpetraOperatorWrapper>(A);

  // if it is an EpetraOperatorWrapper, then get the Thyra operator
  if (eow != Teuchos::null) return eow->getMapStrategy();

  // otherwise wrap it up as a thyra operator
  RCP<const Tpetra::Map<LO, GO, NT> > range  = A->getRangeMap();
  RCP<const Tpetra::Map<LO, GO, NT> > domain = A->getDomainMap();
  return rcp(
      new BasicMappingStrategy(range, domain, *Thyra::convertTpetraToThyraComm(range->getComm())));
}

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