Teko_DiagonallyScaledPreconditionerFactory.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

*/

// Teko includes
#include "Teko_DiagonallyScaledPreconditionerFactory.hpp"

#include "Teko_PreconditionerInverseFactory.hpp"

namespace Teko {

DiagonallyScaledPreconditionerFactory::DiagonallyScaledPreconditionerFactory()
    : invFactory_(Teuchos::null), scalingType_(ROW_SCALING), diagonalType_(AbsRowSum) {}

DiagonallyScaledPreconditionerFactory::DiagonallyScaledPreconditionerFactory(
    const Teuchos::RCP<Teko::InverseFactory>& invFactory, ScalingType scalingType,
    DiagonalType diagonalType)
    : invFactory_(invFactory), scalingType_(scalingType), diagonalType_(diagonalType) {}

DiagonallyScaledPreconditionerFactory::~DiagonallyScaledPreconditionerFactory() {}

LinearOp DiagonallyScaledPreconditionerFactory::buildPreconditionerOperator(
    LinearOp& lo, PreconditionerState& state) const {
  using Teuchos::RCP;
  using Teuchos::rcp_dynamic_cast;
  Teko_DEBUG_SCOPE("DiagonallyScaledPreconditionerFactory::buildPreconditionerOperator", 10);

  TEUCHOS_TEST_FOR_EXCEPTION(
      invFactory_ == Teuchos::null, std::runtime_error,
      "ERROR: Teko::DiagonallyScaledPreconditionerFactory::buildPreconditionerOperator requires "
      "that an "
          << "inverse factory has been set. Currently it is null!");

  // get diagonal matrix
  LinearOp invD = getInvDiagonalOp(lo, diagonalType_);

  // M = A * invD
  ModifiableLinearOp& M = state.getModifiableOp("op_M");
  if (scalingType_ == COLUMN_SCALING)
    M = explicitMultiply(lo, invD, M);
  else
    M = explicitMultiply(invD, lo, M);

  // build inverse operator
  ModifiableLinearOp& invM = state.getModifiableOp("op_invM");
  if (invM == Teuchos::null)
    invM = buildInverse(*invFactory_, M);
  else
    rebuildInverse(*invFactory_, M, invM);

  // return invD * invM
  if (scalingType_ == COLUMN_SCALING)
    return multiply(invD, invM.getConst());
  else
    return multiply(invM.getConst(), invD);
}

void DiagonallyScaledPreconditionerFactory::initializeFromParameterList(
    const Teuchos::ParameterList& settings) {
  TEUCHOS_TEST_FOR_EXCEPTION(
      not settings.isParameter("Inverse Factory"), std::runtime_error,
      "Parameter \"Inverse Factory\" is required by a Teko::DiagonallyScaledPreconditionerFactory");

  // grab library and preconditioner name
  std::string invName = settings.get<std::string>("Inverse Factory");

  // build preconditioner factory
  Teuchos::RCP<const InverseLibrary> il = getInverseLibrary();
  invFactory_                           = il->getInverseFactory(invName);
  TEUCHOS_TEST_FOR_EXCEPTION(invFactory_ == Teuchos::null, std::runtime_error,
                             "ERROR: \"Inverse Factory\" = " << invName << " could not be found");

  // get scaling type specified by XML file
  const std::string defaultScaleType  = "Row";
  const std::string scalingTypeString = "Scaling Type";
  std::string scaleType               = defaultScaleType;
  if (settings.isParameter(scalingTypeString))
    scaleType = settings.get<std::string>(scalingTypeString);

  if (defaultScaleType == scaleType)
    scalingType_ = ROW_SCALING;
  else
    scalingType_ = COLUMN_SCALING;

  if (settings.isParameter("Diagonal Type"))
    diagonalType_ = Teko::getDiagonalType(settings.get<std::string>("Diagonal Type"));
}

}  // end namespace Teko