Loading...
Searching...
No Matches
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
dolfin::EigenFactory
Eigen linear algebra factory.
Definition EigenFactory.h:44
dolfin::EigenFactory::~EigenFactory
virtual ~EigenFactory()
Destructor.
Definition EigenFactory.h:48
dolfin::EigenFactory::create_matrix
std::shared_ptr< GenericMatrix > create_matrix(MPI_Comm comm) const
Create empty matrix.
Definition EigenFactory.h:51
dolfin::EigenFactory::krylov_solver_methods
std::map< std::string, std::string > krylov_solver_methods() const
Return a list of available Krylov solver methods.
Definition EigenFactory.h:99
dolfin::EigenFactory::create_krylov_solver
std::shared_ptr< GenericLinearSolver > create_krylov_solver(MPI_Comm comm, std::string method, std::string preconditioner) const
Create Krylov solver.
Definition EigenFactory.h:85
dolfin::EigenFactory::create_vector
std::shared_ptr< GenericVector > create_vector(MPI_Comm comm) const
Create empty vector.
Definition EigenFactory.h:55
dolfin::EigenFactory::create_linear_operator
std::shared_ptr< GenericLinearOperator > create_linear_operator(MPI_Comm comm) const
Create empty linear operator.
Definition EigenFactory.h:69
dolfin::EigenFactory::create_lu_solver
std::shared_ptr< GenericLinearSolver > create_lu_solver(MPI_Comm comm, std::string method) const
Create LU solver.
Definition EigenFactory.h:78
dolfin::EigenFactory::create_layout
std::shared_ptr< TensorLayout > create_layout(MPI_Comm comm, std::size_t rank) const
Create empty tensor layout.
Definition EigenFactory.h:59
dolfin::EigenFactory::instance
static EigenFactory & instance()
Return singleton instance.
Definition EigenFactory.h:107
dolfin::EigenFactory::lu_solver_methods
std::map< std::string, std::string > lu_solver_methods() const
Return a list of available LU solver methods.
Definition EigenFactory.h:95
dolfin::EigenFactory::krylov_solver_preconditioners
std::map< std::string, std::string > krylov_solver_preconditioners() const
Return a list of available preconditioners.
Definition EigenFactory.h:103
dolfin::EigenKrylovSolver
Definition EigenKrylovSolver.h:41
dolfin::EigenKrylovSolver::preconditioners
static std::map< std::string, std::string > preconditioners()
Return a list of available preconditioners.
Definition EigenKrylovSolver.cpp:63
dolfin::EigenKrylovSolver::methods
static std::map< std::string, std::string > methods()
Return a list of available solver methods.
Definition EigenKrylovSolver.cpp:58
dolfin::EigenLUSolver::methods
static std::map< std::string, std::string > methods()
Return a list of available solver methods.
Definition EigenLUSolver.cpp:137
dolfin::GenericLinearAlgebraFactory::GenericLinearAlgebraFactory
GenericLinearAlgebraFactory()
Constructor.
Definition GenericLinearAlgebraFactory.h:51
dolfin::GenericLinearSolver
This class provides a general solver for linear systems Ax = b.
Definition GenericLinearSolver.h:38
dolfin::TensorLayout::Sparsity
Sparsity
Sparse or dense layout.
Definition TensorLayout.h:47
dolfin
Definition adapt.h:30