Stokhos_SGPreconditionerFactory.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Stokhos Package
//
// Copyright 2009 NTESS and the Stokhos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef STOKHOS_SG_PRECONDITIONER_FACTORY_HPP
#define STOKHOS_SG_PRECONDITIONER_FACTORY_HPP

#include "Teuchos_RCP.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Stokhos_SGPreconditioner.hpp"
#include "EpetraExt_MultiComm.h"
#include "Stokhos_OrthogPolyBasis.hpp"
#include "Stokhos_EpetraSparse3Tensor.hpp"
#include "Epetra_Map.h"
#include "Stokhos_AbstractPreconditionerFactory.hpp"

namespace Stokhos {

  class SGPreconditionerFactory {
  public:

    SGPreconditionerFactory(
      const Teuchos::RCP<Teuchos::ParameterList>& params);

    virtual ~SGPreconditionerFactory() {}

    virtual bool isPrecSupported() const;

    virtual Teuchos::RCP<Stokhos::SGPreconditioner> 
    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);

  protected:

    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> 
    buildMeanPreconditionerFactory();

  private:
    
    SGPreconditionerFactory(const SGPreconditionerFactory&);
    
    SGPreconditionerFactory& operator=(const SGPreconditionerFactory&);

  protected:

    Teuchos::RCP<Teuchos::ParameterList> params;

    std::string prec_method;

  }; // class SGPreconditionerFactory

} // namespace Stokhos

#endif // STOKHOS_SG_PRECONDITIONER_FACTORY_HPP