Stokhos_MLPreconditionerFactory.cpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                           Stokhos Package
//                 Copyright (2009) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// 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 T. Phipps (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#include "Stokhos_ConfigDefs.h"
#include "Stokhos_MLPreconditionerFactory.hpp"
#include "Epetra_RowMatrix.h"
#include "Epetra_CrsMatrix.h"
#include "Teuchos_Assert.hpp"
#ifdef HAVE_STOKHOS_ML
#include "ml_include.h"
#include "ml_MultiLevelPreconditioner.h"
#endif

Stokhos::MLPreconditionerFactory::
MLPreconditionerFactory(const Teuchos::RCP<Teuchos::ParameterList>& p) :
  precParams(p) 
{
#ifdef HAVE_STOKHOS_ML
  // Set default parameters
  if (precParams->isType<std::string>("default values")) {
    Teuchos::ParameterList ml_defaults;
    ML_Epetra::SetDefaults(precParams->get<std::string>("default values"), 
         ml_defaults);
    precParams->setParametersNotAlreadySet(ml_defaults);
  }
#endif
}

Teuchos::RCP<Epetra_Operator> 
Stokhos::MLPreconditionerFactory::
compute(const Teuchos::RCP<Epetra_Operator>& op, bool compute_prec) {
#ifdef HAVE_STOKHOS_ML
  Teuchos::RCP<Epetra_RowMatrix> mat = 
    Teuchos::rcp_dynamic_cast<Epetra_RowMatrix>(op, true);
  Teuchos::RCP<ML_Epetra::MultiLevelPreconditioner> ml_prec =
    Teuchos::rcp(new ML_Epetra::MultiLevelPreconditioner(*mat, *precParams,
               compute_prec));
  //ml_prec->PrintUnused(0);
  return ml_prec;
#else
  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
         "Stokhos::MLPreconditionerFactory is available " <<
         "only with configured with ML support!");
  return Teuchos::null;
#endif // HAVE_STOKHOS_ML
}

void
Stokhos::MLPreconditionerFactory::
recompute(const Teuchos::RCP<Epetra_Operator>& op,
    const Teuchos::RCP<Epetra_Operator>& prec_op) {
#ifdef HAVE_STOKHOS_ML
  // Copy matrix represented by "op" into underlying matrix in ML
  Teuchos::RCP<Epetra_CrsMatrix> mat = 
    Teuchos::rcp_dynamic_cast<Epetra_CrsMatrix>(op, true);
  Teuchos::RCP<ML_Epetra::MultiLevelPreconditioner> ml_prec =
    Teuchos::rcp_dynamic_cast<ML_Epetra::MultiLevelPreconditioner>(prec_op);
  const Epetra_RowMatrix& prec_mat = ml_prec->RowMatrix();
  const Epetra_CrsMatrix& prec_crs_mat = 
    dynamic_cast<const Epetra_CrsMatrix&>(prec_mat);
  Epetra_CrsMatrix& non_const_prec_crs_mat = 
    const_cast<Epetra_CrsMatrix&>(prec_crs_mat);
  non_const_prec_crs_mat = *mat;

  // Compute preconditioner
  ml_prec->ComputePreconditioner();
#else
  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
         "Stokhos::MLPreconditionerFactory is available " <<
         "only with configured with ML support!");
#endif // HAVE_STOKHOS_ML
}