Teko_StridedTpetraOperator.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_StridedTpetraOperator.hpp"
#include "Teko_TpetraStridedMappingStrategy.hpp"
#include "Teko_TpetraReorderedMappingStrategy.hpp"

#include "Teuchos_VerboseObject.hpp"

#include "Thyra_LinearOpBase.hpp"
#include "Thyra_TpetraLinearOp.hpp"
#include "Thyra_TpetraThyraWrappers.hpp"
#include "Thyra_DefaultProductMultiVector.hpp"
#include "Thyra_DefaultProductVectorSpace.hpp"
#include "Thyra_DefaultBlockedLinearOp.hpp"

#include "Tpetra_Vector.hpp"
#include "MatrixMarket_Tpetra.hpp"

#include "Teko_Utilities.hpp"

namespace Teko {
namespace TpetraHelpers {

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

StridedTpetraOperator::StridedTpetraOperator(
    int numVars, const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& content,
    const std::string& label)
    : Teko::TpetraHelpers::TpetraOperatorWrapper(), label_(label) {
  std::vector<int> vars;

  // build vector describing the sub maps
  for (int i = 0; i < numVars; i++) vars.push_back(1);

  SetContent(vars, content);
}

StridedTpetraOperator::StridedTpetraOperator(
    const std::vector<int>& vars,
    const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& content, const std::string& label)
    : Teko::TpetraHelpers::TpetraOperatorWrapper(), label_(label) {
  SetContent(vars, content);
}

void StridedTpetraOperator::SetContent(
    const std::vector<int>& vars,
    const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> >& content) {
  fullContent_    = content;
  stridedMapping_ = rcp(new TpetraStridedMappingStrategy(vars, fullContent_->getDomainMap(),
                                                         *fullContent_->getDomainMap()->getComm()));
  SetMapStrategy(stridedMapping_);

  // build thyra operator
  BuildBlockedOperator();
}

void StridedTpetraOperator::BuildBlockedOperator() {
  TEUCHOS_ASSERT(stridedMapping_ != Teuchos::null);

  // get a CRS matrix
  const RCP<const Tpetra::CrsMatrix<ST, LO, GO, NT> > crsContent =
      rcp_dynamic_cast<const Tpetra::CrsMatrix<ST, LO, GO, NT> >(fullContent_);

  // ask the strategy to build the Thyra operator for you
  if (stridedOperator_ == Teuchos::null) {
    stridedOperator_ = stridedMapping_->buildBlockedThyraOp(crsContent, label_);
  } else {
    const RCP<Thyra::BlockedLinearOpBase<ST> > blkOp =
        rcp_dynamic_cast<Thyra::BlockedLinearOpBase<ST> >(stridedOperator_, true);
    stridedMapping_->rebuildBlockedThyraOp(crsContent, blkOp);
  }

  // set whatever is returned
  SetOperator(stridedOperator_, false);

  // reorder if neccessary
  if (reorderManager_ != Teuchos::null) Reorder(*reorderManager_);
}

const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > StridedTpetraOperator::GetBlock(
    int i, int j) const {
  const RCP<const Thyra::BlockedLinearOpBase<ST> > blkOp =
      Teuchos::rcp_dynamic_cast<const Thyra::BlockedLinearOpBase<ST> >(getThyraOp());

  RCP<const Thyra::TpetraLinearOp<ST, LO, GO, NT> > tOp =
      rcp_dynamic_cast<const Thyra::TpetraLinearOp<ST, LO, GO, NT> >(blkOp->getBlock(i, j), true);
  return tOp->getConstTpetraOperator();
}

void StridedTpetraOperator::Reorder(const BlockReorderManager& brm) {
  reorderManager_ = rcp(new BlockReorderManager(brm));

  // build reordered objects
  RCP<const MappingStrategy> reorderMapping =
      rcp(new TpetraReorderedMappingStrategy(*reorderManager_, stridedMapping_));
  RCP<const Thyra::BlockedLinearOpBase<ST> > blockOp =
      rcp_dynamic_cast<const Thyra::BlockedLinearOpBase<ST> >(stridedOperator_);

  RCP<const Thyra::LinearOpBase<ST> > A = buildReorderedLinearOp(*reorderManager_, blockOp);

  // set them as working values
  SetMapStrategy(reorderMapping);
  SetOperator(A, false);
}

void StridedTpetraOperator::RemoveReording() {
  SetMapStrategy(stridedMapping_);
  SetOperator(stridedOperator_, false);
  reorderManager_ = Teuchos::null;
}

void StridedTpetraOperator::WriteBlocks(const std::string& prefix) const {
  RCP<Thyra::PhysicallyBlockedLinearOpBase<ST> > blockOp =
      rcp_dynamic_cast<Thyra::PhysicallyBlockedLinearOpBase<ST> >(stridedOperator_);

  // get size of strided block operator
  int rows = Teko::blockRowCount(blockOp);

  for (int i = 0; i < rows; i++) {
    for (int j = 0; j < rows; j++) {
      // get the row matrix object (Note: can't use "GetBlock" method b/c matrix might be reordered)
      RCP<const Thyra::TpetraLinearOp<ST, LO, GO, NT> > tOp =
          rcp_dynamic_cast<const Thyra::TpetraLinearOp<ST, LO, GO, NT> >(blockOp->getBlock(i, j));
      RCP<const Tpetra::CrsMatrix<ST, LO, GO, NT> > mat =
          Teuchos::rcp_dynamic_cast<const Tpetra::CrsMatrix<ST, LO, GO, NT> >(
              tOp->getConstTpetraOperator());

      // write to file
      Tpetra::MatrixMarket::Writer<Tpetra::CrsMatrix<ST, LO, GO, NT> >::writeSparseFile(
          formatBlockName(prefix, i, j, rows).c_str(), mat);
    }
  }
}

std::string StridedTpetraOperator::PrintNorm(const eNormType& nrmType, const char newline) {
  BlockedLinearOp blockOp = toBlockedLinearOp(stridedOperator_);

  // get size of strided block operator
  int rowCount = Teko::blockRowCount(blockOp);
  int colCount = Teko::blockRowCount(blockOp);

  std::stringstream ss;
  ss.precision(4);
  ss << std::scientific;
  for (int row = 0; row < rowCount; row++) {
    for (int col = 0; col < colCount; col++) {
      // get the row matrix object (Note: can't use "GetBlock" method b/c matrix might be reordered)
      RCP<const Thyra::TpetraLinearOp<ST, LO, GO, NT> > Aij =
          rcp_dynamic_cast<const Thyra::TpetraLinearOp<ST, LO, GO, NT> >(
              blockOp->getBlock(row, col), true);
      RCP<const Tpetra::CrsMatrix<ST, LO, GO, NT> > mat =
          Teuchos::rcp_dynamic_cast<const Tpetra::CrsMatrix<ST, LO, GO, NT> >(
              Aij->getConstTpetraOperator(), true);

      // compute the norm
      ST norm = 0.0;
      switch (nrmType) {
        // case Inf:
        //    norm = mat->normInf();
        //    break;
        // case One:
        //    norm = mat->normOne();
        //    break;
        case Frobenius: norm = mat->getFrobeniusNorm(); break;
        default:
          TEUCHOS_TEST_FOR_EXCEPTION(true, std::runtime_error,
                                     "StridedTpetraOperator::NormType incorrectly specified. Only "
                                     "Frobenius norm implemented for Tpetra matrices.");
      }

      ss << norm << " ";
    }
    ss << newline;
  }

  return ss.str();
}

bool StridedTpetraOperator::testAgainstFullOperator(int count, ST tol) const {
  Tpetra::Vector<ST, LO, GO, NT> xf(getRangeMap());
  Tpetra::Vector<ST, LO, GO, NT> xs(getRangeMap());
  Tpetra::Vector<ST, LO, GO, NT> y(getDomainMap());

  // test operator many times
  bool result = true;
  ST diffNorm = 0.0, trueNorm = 0.0;
  for (int i = 0; i < count; i++) {
    xf.putScalar(0.0);
    xs.putScalar(0.0);
    y.randomize();

    // apply operator
    apply(y, xs);                // xs = A*y
    fullContent_->apply(y, xf);  // xf = A*y

    // compute norms
    xs.update(-1.0, xf, 1.0);
    diffNorm = xs.norm2();
    trueNorm = xf.norm2();

    // check result
    result &= (diffNorm / trueNorm < tol);
  }

  return result;
}

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