Stokhos_SGPreconditionerFactory.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_SGPreconditionerFactory.hpp"
#include "Stokhos_MeanBasedPreconditioner.hpp"
#include "Stokhos_ApproxGaussSeidelPreconditioner.hpp"
#include "Stokhos_ApproxJacobiPreconditioner.hpp"
#include "Stokhos_ApproxSchurComplementPreconditioner.hpp"
#include "Stokhos_GaussSeidelPreconditioner.hpp"
#include "Stokhos_KroneckerProductPreconditioner.hpp"
#include "Stokhos_FullyAssembledPreconditioner.hpp"
#include "Stokhos_PreconditionerFactory.hpp"
#include "Teuchos_Assert.hpp"

Stokhos::SGPreconditionerFactory::
SGPreconditionerFactory(const Teuchos::RCP<Teuchos::ParameterList>& params_) :
  params(params_)
{
  prec_method = params->get("Preconditioner Method", "Mean-based");
}

bool
Stokhos::SGPreconditionerFactory::
isPrecSupported() const
{
  return prec_method != "None";
}

Teuchos::RCP<Stokhos::SGPreconditioner> 
Stokhos::SGPreconditionerFactory::
build(const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
      const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
      const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
      const Teuchos::RCP<const Epetra_Map>& base_map,
      const Teuchos::RCP<const Epetra_Map>& sg_map)
{
  Teuchos::RCP<Stokhos::SGPreconditioner> sg_prec;
  
  if (prec_method == "Mean-based") {
    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory = 
      buildMeanPreconditionerFactory();
    sg_prec = Teuchos::rcp(new Stokhos::MeanBasedPreconditioner(
           sg_comm, sg_basis, epetraCijk, 
           base_map, sg_map, prec_factory, 
           params));
  }
  else if (prec_method == "Approximate Gauss-Seidel") {
    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory = 
      buildMeanPreconditionerFactory();
    sg_prec = Teuchos::rcp(new Stokhos::ApproxGaussSeidelPreconditioner(
           sg_comm, sg_basis, epetraCijk, 
           base_map, sg_map, prec_factory, 
           params));
  }
  else if (prec_method == "Approximate Jacobi") {
    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory = 
      buildMeanPreconditionerFactory();
    sg_prec = Teuchos::rcp(new Stokhos::ApproxJacobiPreconditioner(
           sg_comm, sg_basis, epetraCijk, 
           base_map, sg_map, prec_factory, 
           params));
  }
  else if (prec_method == "Approximate Schur Complement") {
    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory = 
      buildMeanPreconditionerFactory();
    sg_prec = Teuchos::rcp(new Stokhos::ApproxSchurComplementPreconditioner(
           sg_comm, sg_basis, epetraCijk, 
           base_map, sg_map, prec_factory, 
           params));
  }
#ifdef HAVE_STOKHOS_NOX
  else if (prec_method == "Gauss-Seidel") {
    Teuchos::RCP<NOX::Epetra::LinearSystem> det_solver = 
      params->get< Teuchos::RCP<NOX::Epetra::LinearSystem> >("Deterministic Solver");
    sg_prec = Teuchos::rcp(new Stokhos::GaussSeidelPreconditioner(
           sg_comm, sg_basis, epetraCijk, 
           base_map, sg_map, det_solver, 
           params));
  }
#endif
  else if (prec_method == "Kronecker Product") {
    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> mean_prec_factory = 
      buildMeanPreconditionerFactory();
    std::string G_prec_name = 
      params->get("G Preconditioner Type", "Ifpack");
    Teuchos::RCP<Teuchos::ParameterList> G_prec_params =
      Teuchos::rcp(&(params->sublist("G Preconditioner Parameters")),false);
    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> G_prec_factory = 
      Teuchos::rcp(new Stokhos::PreconditionerFactory(G_prec_name, 
                  G_prec_params));
    sg_prec = Teuchos::rcp(new Stokhos::KroneckerProductPreconditioner(
           sg_comm, sg_basis, epetraCijk, base_map, sg_map, 
           mean_prec_factory, G_prec_factory, params));
  }
  else if (prec_method == "Fully Assembled") {
     std::string prec_name = 
       params->get("Fully Assembled Preconditioner Type", "Ifpack");
    Teuchos::RCP<Teuchos::ParameterList> prec_params =
      Teuchos::rcp(&(params->sublist("Fully Assembled Preconditioner Parameters")),false);
    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory = 
      Teuchos::rcp(new Stokhos::PreconditionerFactory(prec_name, prec_params));
    sg_prec = Teuchos::rcp(new Stokhos::FullyAssembledPreconditioner(
           prec_factory, params));
  }
  else if (prec_method == "None")
    sg_prec = Teuchos::null;
  else
    TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
           "Error!  Unknown preconditioner method " << prec_method
           << "." << std::endl);

  return sg_prec;
}

Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>
Stokhos::SGPreconditionerFactory::
buildMeanPreconditionerFactory()
{
  std::string prec_name = 
    params->get("Mean Preconditioner Type", "Ifpack");
  Teuchos::RCP<Teuchos::ParameterList> precParams = 
    Teuchos::rcp(&params->sublist("Mean Preconditioner Parameters"),false);
  return Teuchos::rcp(new Stokhos::PreconditionerFactory(prec_name, 
               precParams));
}