MueLu_SubBlockAFactory_def.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//        MueLu: A package for multigrid based preconditioning
//                  Copyright 2012 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
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER

#ifndef MUELU_SUBBLOCKAFACTORY_DEF_HPP_
#define MUELU_SUBBLOCKAFACTORY_DEF_HPP_

#include "MueLu_SubBlockAFactory_decl.hpp"

#include <Xpetra_BlockedCrsMatrix.hpp>
#include <Xpetra_MapExtractor.hpp>
#include <Xpetra_Matrix.hpp>
#include <Xpetra_StridedMapFactory.hpp>

#include "MueLu_Level.hpp"
#include "MueLu_Monitor.hpp"

namespace MueLu {

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
RCP<const ParameterList> SubBlockAFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::GetValidParameterList() const {
  RCP<ParameterList> validParamList = rcp(new ParameterList());

  validParamList->set<RCP<const FactoryBase>>("A", MueLu::NoFactory::getRCP(), "Generating factory for A.");

  validParamList->set<int>("block row", 0, "Block row of subblock matrix A");
  validParamList->set<int>("block col", 0, "Block column of subblock matrix A");

  validParamList->set<std::string>("Range map: Striding info", "{}", "Striding information for range map");
  validParamList->set<LocalOrdinal>("Range map: Strided block id", -1, "Strided block id for range map");
  validParamList->set<std::string>("Domain map: Striding info", "{}", "Striding information for domain map");
  validParamList->set<LocalOrdinal>("Domain map: Strided block id", -1, "Strided block id for domain map");

  return validParamList;
}

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
void SubBlockAFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::DeclareInput(Level& currentLevel) const {
  Input(currentLevel, "A");
}

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
void SubBlockAFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Build(Level& currentLevel) const {
  FactoryMonitor m(*this, "Build", currentLevel);

  const ParameterList& pL = GetParameterList();
  size_t row              = Teuchos::as<size_t>(pL.get<int>("block row"));
  size_t col              = Teuchos::as<size_t>(pL.get<int>("block col"));

  RCP<Matrix> Ain         = currentLevel.Get<RCP<Matrix>>("A", this->GetFactory("A").get());
  RCP<BlockedCrsMatrix> A = rcp_dynamic_cast<BlockedCrsMatrix>(Ain);

  TEUCHOS_TEST_FOR_EXCEPTION(A.is_null(), Exceptions::BadCast, "Input matrix A is not a BlockedCrsMatrix.");
  TEUCHOS_TEST_FOR_EXCEPTION(row > A->Rows(), Exceptions::RuntimeError, "row [" << row << "] > A.Rows() [" << A->Rows() << "].");
  TEUCHOS_TEST_FOR_EXCEPTION(col > A->Cols(), Exceptions::RuntimeError, "col [" << col << "] > A.Cols() [" << A->Cols() << "].");

  // get sub-matrix
  RCP<Matrix> Op = A->getMatrix(row, col);

  // Check if it is a BlockedCrsMatrix object
  // If it is a BlockedCrsMatrix object (most likely a ReorderedBlockedCrsMatrix)
  // we have to distinguish whether it is a 1x1 leaf block in the ReorderedBlockedCrsMatrix
  // or a nxm block. If it is a 1x1 leaf block, we "unpack" it and return the underlying
  // CrsMatrixWrap object.
  RCP<BlockedCrsMatrix> bOp = rcp_dynamic_cast<BlockedCrsMatrix>(Op);
  if (bOp != Teuchos::null) {
    // check if it is a 1x1 leaf block
    if (bOp->Rows() == 1 && bOp->Cols() == 1) {
      // return the unwrapped CrsMatrixWrap object underneath
      Op = bOp->getCrsMatrix();
      TEUCHOS_TEST_FOR_EXCEPTION(rcp_dynamic_cast<CrsMatrixWrap>(Op) == Teuchos::null, Exceptions::BadCast,
                                 "SubBlockAFactory::Build: sub block A[" << row << "," << col << "] must be a single block CrsMatrixWrap object!");
    } else {
      // If it is a regular nxm blocked operator, just return it.
      // We do not set any kind of striding or blocking information as this
      // usually would not make sense for general blocked operators
      GetOStream(Statistics1) << "A(" << row << "," << col << ") is a " << bOp->Rows() << "x" << bOp->Cols() << " block matrix" << std::endl;
      GetOStream(Statistics2) << "with altogether " << bOp->getGlobalNumRows() << "x" << bOp->getGlobalNumCols() << " rows and columns." << std::endl;
      currentLevel.Set("A", Op, this);
      return;
    }
  }

  // The sub-block is not a BlockedCrsMatrix object, that is, we expect
  // it to be of type CrsMatrixWrap allowing direct access to the corresponding
  // data. For a single block CrsMatrixWrap type matrix we can/should set the
  // corresponding striding/blocking information for the algorithms to work
  // properly.
  //
  // TAW: In fact, a 1x1 BlockedCrsMatrix object also allows to access the data
  //      directly, but this feature is nowhere really used in the algorithms.
  //      So let's keep checking for the CrsMatrixWrap class to avoid screwing
  //      things up
  //
  TEUCHOS_TEST_FOR_EXCEPTION(rcp_dynamic_cast<CrsMatrixWrap>(Op) == Teuchos::null, Exceptions::BadCast,
                             "SubBlockAFactory::Build: sub block A[" << row << "," << col << "] is NOT a BlockedCrsMatrix, but also NOT a CrsMatrixWrap object. This cannot be.");

  // strided maps for range and domain map of sub matrix
  RCP<const StridedMap> stridedRangeMap  = Teuchos::null;
  RCP<const StridedMap> stridedDomainMap = Teuchos::null;

  // check for user-specified striding information from XML file
  std::vector<size_t> rangeStridingInfo;
  std::vector<size_t> domainStridingInfo;
  LocalOrdinal rangeStridedBlockId  = 0;
  LocalOrdinal domainStridedBlockId = 0;
  bool bRangeUserSpecified          = CheckForUserSpecifiedBlockInfo(true, rangeStridingInfo, rangeStridedBlockId);
  bool bDomainUserSpecified         = CheckForUserSpecifiedBlockInfo(false, domainStridingInfo, domainStridedBlockId);
  TEUCHOS_TEST_FOR_EXCEPTION(bRangeUserSpecified != bDomainUserSpecified, Exceptions::RuntimeError,
                             "MueLu::SubBlockAFactory[" << row << "," << col << "]: the user has to specify either both domain and range map or none.");

  // extract map information from MapExtractor
  RCP<const MapExtractor> rangeMapExtractor  = A->getRangeMapExtractor();
  RCP<const MapExtractor> domainMapExtractor = A->getDomainMapExtractor();

  RCP<const Map> rangeMap  = rangeMapExtractor->getMap(row);
  RCP<const Map> domainMap = domainMapExtractor->getMap(col);

  // use user-specified striding information if available. Otherwise try to use internal striding information from the submaps!
  if (bRangeUserSpecified)
    stridedRangeMap = rcp(new StridedMap(rangeMap, rangeStridingInfo, rangeMap->getIndexBase(), rangeStridedBlockId, 0));
  else
    stridedRangeMap = rcp_dynamic_cast<const StridedMap>(rangeMap);

  if (bDomainUserSpecified)
    stridedDomainMap = rcp(new StridedMap(domainMap, domainStridingInfo, domainMap->getIndexBase(), domainStridedBlockId, 0));
  else
    stridedDomainMap = rcp_dynamic_cast<const StridedMap>(domainMap);

  // In case that both user-specified and internal striding information from the submaps
  // does not contain valid striding information, try to extract it from the global maps
  // in the map extractor.
  if (stridedRangeMap.is_null()) {
    RCP<const Map> fullRangeMap               = rangeMapExtractor->getFullMap();
    RCP<const StridedMap> stridedFullRangeMap = rcp_dynamic_cast<const StridedMap>(fullRangeMap);
    TEUCHOS_TEST_FOR_EXCEPTION(stridedFullRangeMap.is_null(), Exceptions::BadCast, "Full rangeMap is not a strided map.");

    std::vector<size_t> stridedData = stridedFullRangeMap->getStridingData();
    if (stridedData.size() == 1 && row > 0) {
      // We have block matrices. use striding block information 0
      stridedRangeMap = StridedMapFactory::Build(rangeMap, stridedData, 0, stridedFullRangeMap->getOffset());

    } else {
      // We have strided matrices. use striding information of the corresponding block
      stridedRangeMap = StridedMapFactory::Build(rangeMap, stridedData, row, stridedFullRangeMap->getOffset());
    }
  }

  if (stridedDomainMap.is_null()) {
    RCP<const Map> fullDomainMap               = domainMapExtractor->getFullMap();
    RCP<const StridedMap> stridedFullDomainMap = rcp_dynamic_cast<const StridedMap>(fullDomainMap);
    TEUCHOS_TEST_FOR_EXCEPTION(stridedFullDomainMap.is_null(), Exceptions::BadCast, "Full domainMap is not a strided map");

    std::vector<size_t> stridedData = stridedFullDomainMap->getStridingData();
    if (stridedData.size() == 1 && col > 0) {
      // We have block matrices. use striding block information 0
      stridedDomainMap = StridedMapFactory::Build(domainMap, stridedData, 0, stridedFullDomainMap->getOffset());

    } else {
      // We have strided matrices. use striding information of the corresponding block
      stridedDomainMap = StridedMapFactory::Build(domainMap, stridedData, col, stridedFullDomainMap->getOffset());
    }
  }

  TEUCHOS_TEST_FOR_EXCEPTION(stridedRangeMap.is_null(), Exceptions::BadCast, "rangeMap " << row << " is not a strided map.");
  TEUCHOS_TEST_FOR_EXCEPTION(stridedDomainMap.is_null(), Exceptions::BadCast, "domainMap " << col << " is not a strided map.");

  GetOStream(Statistics1) << "A(" << row << "," << col << ") is a single block and has strided maps:"
                          << "\n  range  map fixed block size = " << stridedRangeMap->getFixedBlockSize() << ", strided block id = " << stridedRangeMap->getStridedBlockId()
                          << "\n  domain map fixed block size = " << stridedDomainMap->getFixedBlockSize() << ", strided block id = " << stridedDomainMap->getStridedBlockId() << std::endl;
  GetOStream(Statistics2) << "A(" << row << "," << col << ") has " << Op->getGlobalNumRows() << "x" << Op->getGlobalNumCols() << " rows and columns." << std::endl;

  // TODO do we really need that? we moved the code to getMatrix...
  if (Op->IsView("stridedMaps") == true)
    Op->RemoveView("stridedMaps");
  Op->CreateView("stridedMaps", stridedRangeMap, stridedDomainMap);

  TEUCHOS_TEST_FOR_EXCEPTION(Op->IsView("stridedMaps") == false, Exceptions::RuntimeError, "Failed to set \"stridedMaps\" view.");

  currentLevel.Set("A", Op, this);
}

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
bool SubBlockAFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::
    CheckForUserSpecifiedBlockInfo(bool bRange, std::vector<size_t>& stridingInfo, LocalOrdinal& stridedBlockId) const {
  const ParameterList& pL = GetParameterList();

  if (bRange == true)
    stridedBlockId = pL.get<LocalOrdinal>("Range map: Strided block id");
  else
    stridedBlockId = pL.get<LocalOrdinal>("Domain map: Strided block id");

  // read in stridingInfo from parameter list and fill the internal member variable
  // read the data only if the parameter "Striding info" exists and is non-empty
  std::string str;
  if (bRange == true)
    str = std::string("Range map: Striding info");
  else
    str = std::string("Domain map: Striding info");

  if (pL.isParameter(str)) {
    std::string strStridingInfo = pL.get<std::string>(str);
    if (strStridingInfo.empty() == false) {
      Array<size_t> arrayVal = Teuchos::fromStringToArray<size_t>(strStridingInfo);
      stridingInfo           = Teuchos::createVector(arrayVal);
    }
  }

  if (stridingInfo.size() > 0) return true;
  return false;
}

}  // namespace MueLu

#endif /* MUELU_SUBBLOCKAFACTORY_DEF_HPP_ */