EigenFactory.h

// Copyright (C) 2015 Chris Richardson and Garth Wells
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// First added:  2015-02-01

#ifndef __EIGEN_FACTORY_H
#define __EIGEN_FACTORY_H

#include <map>
#include <memory>
#include <string>

#include <dolfin/common/MPI.h>
#include <dolfin/log/log.h>
#include "EigenKrylovSolver.h"
#include "EigenLUSolver.h"
#include "EigenMatrix.h"
#include "EigenVector.h"
#include "TensorLayout.h"
#include "GenericLinearAlgebraFactory.h"

namespace dolfin
{
  // Forward declaration
  class GenericLinearSolver;


  class EigenFactory : public GenericLinearAlgebraFactory
  {
  public:

    virtual ~EigenFactory() {}

    std::shared_ptr<GenericMatrix> create_matrix(MPI_Comm comm) const
    { return std::make_shared<EigenMatrix>(); }

    std::shared_ptr<GenericVector> create_vector(MPI_Comm comm) const
    { return std::make_shared<EigenVector>(comm); }

    std::shared_ptr<TensorLayout> create_layout(MPI_Comm comm,
                                                std::size_t rank) const
    {
      TensorLayout::Sparsity sparsity = TensorLayout::Sparsity::DENSE;
      if (rank > 1)
        sparsity = TensorLayout::Sparsity::SPARSE;
      return std::make_shared<TensorLayout>(comm, 0, sparsity);
    }

    std::shared_ptr<GenericLinearOperator> create_linear_operator(MPI_Comm comm) const
    {
      dolfin_not_implemented();
      std::shared_ptr<GenericLinearOperator> A;
      return A;
    }

    std::shared_ptr<GenericLinearSolver>
    create_lu_solver(MPI_Comm comm, std::string method) const
    {
      return std::make_shared<EigenLUSolver>(method);
    }

    std::shared_ptr<GenericLinearSolver>
    create_krylov_solver(MPI_Comm comm,
                         std::string method,
                         std::string preconditioner) const
    {
      std::shared_ptr<GenericLinearSolver>
        solver(new EigenKrylovSolver(method, preconditioner));
      return solver;
    }

    std::map<std::string, std::string> lu_solver_methods() const
    { return EigenLUSolver::methods(); }

    std::map<std::string, std::string> krylov_solver_methods() const
    { return EigenKrylovSolver::methods(); }

    std::map<std::string, std::string> krylov_solver_preconditioners() const
    { return EigenKrylovSolver::preconditioners(); }

    static EigenFactory& instance()
    { return factory; }

  private:

    // Private Constructor
    EigenFactory() {}

    // Singleton instance
    static EigenFactory factory;
  };

}
#endif