Loading...
Searching...
No Matches
GenericLinearAlgebraFactory.h
// Copyright (C) 2007 Ola Skavhaug
//
// 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/>.
//
// Modified by Anders Logg 2011-2012
//
// First added: 2007-11-30
// Last changed: 2012-08-22
#ifndef __GENERIC_LINEAR_ALGEBRA_FACTORY_H
#define __GENERIC_LINEAR_ALGEBRA_FACTORY_H
#include <string>
#include <vector>
#include <memory>
#include <dolfin/common/MPI.h>
#include <dolfin/common/types.h>
#include <dolfin/log/log.h>
// Included here so we can define dummy class below
#include "GenericLinearOperator.h"
namespace dolfin
{
class GenericLinearSolver;
class GenericMatrix;
class GenericVector;
class TensorLayout;
class GenericLinearAlgebraFactory
{
public:
GenericLinearAlgebraFactory() {}
virtual ~GenericLinearAlgebraFactory() {}
virtual std::shared_ptr<GenericMatrix> create_matrix(MPI_Comm comm) const = 0;
virtual std::shared_ptr<GenericVector>
create_vector(MPI_Comm comm) const = 0;
virtual std::shared_ptr<TensorLayout>
create_layout(MPI_Comm comm, std::size_t rank) const = 0;
virtual std::shared_ptr<GenericLinearOperator>
create_linear_operator(MPI_Comm comm) const = 0;
virtual std::shared_ptr<GenericLinearSolver>
create_lu_solver(MPI_Comm comm, std::string method) const = 0;
virtual std::shared_ptr<GenericLinearSolver>
create_krylov_solver(MPI_Comm comm,
std::string method,
std::string preconditioner) const = 0;
virtual std::map<std::string, std::string> lu_solver_methods() const
{ return std::map<std::string, std::string>(); }
virtual std::map<std::string, std::string> krylov_solver_methods() const
{ return std::map<std::string, std::string>(); }
virtual std::map<std::string, std::string>
krylov_solver_preconditioners() const
{ return std::map<std::string, std::string>(); }
protected:
// Dummy class that can be returned for linear algebra backends
// that do not support the GenericLinearOperator interface
class NotImplementedLinearOperator : public GenericLinearOperator
{
public:
std::size_t size(std::size_t dim) const
{ return 0; }
void mult(const GenericVector& x, GenericVector& y) const
{ dolfin_not_implemented(); }
MPI_Comm mpi_comm() const
{ dolfin_not_implemented(); return MPI_COMM_WORLD; }
std::string str(bool verbose) const
{ dolfin_not_implemented(); return ""; }
};
};
}
#endif
dolfin::GenericLinearAlgebraFactory::NotImplementedLinearOperator
Definition GenericLinearAlgebraFactory.h:102
dolfin::GenericLinearAlgebraFactory::NotImplementedLinearOperator::mult
void mult(const GenericVector &x, GenericVector &y) const
Compute matrix-vector product y = Ax.
Definition GenericLinearAlgebraFactory.h:108
dolfin::GenericLinearAlgebraFactory::NotImplementedLinearOperator::str
std::string str(bool verbose) const
Return informal string representation (pretty-print).
Definition GenericLinearAlgebraFactory.h:114
dolfin::GenericLinearAlgebraFactory::NotImplementedLinearOperator::size
std::size_t size(std::size_t dim) const
Return size of given dimension.
Definition GenericLinearAlgebraFactory.h:105
dolfin::GenericLinearAlgebraFactory::NotImplementedLinearOperator::mpi_comm
MPI_Comm mpi_comm() const
Return MPI communicator.
Definition GenericLinearAlgebraFactory.h:111
dolfin::GenericLinearAlgebraFactory::krylov_solver_preconditioners
virtual std::map< std::string, std::string > krylov_solver_preconditioners() const
Definition GenericLinearAlgebraFactory.h:94
dolfin::GenericLinearAlgebraFactory::~GenericLinearAlgebraFactory
virtual ~GenericLinearAlgebraFactory()
Destructor.
Definition GenericLinearAlgebraFactory.h:54
dolfin::GenericLinearAlgebraFactory::create_vector
virtual std::shared_ptr< GenericVector > create_vector(MPI_Comm comm) const =0
Create empty vector.
dolfin::GenericLinearAlgebraFactory::krylov_solver_methods
virtual std::map< std::string, std::string > krylov_solver_methods() const
Definition GenericLinearAlgebraFactory.h:88
dolfin::GenericLinearAlgebraFactory::create_lu_solver
virtual std::shared_ptr< GenericLinearSolver > create_lu_solver(MPI_Comm comm, std::string method) const =0
Create LU solver.
dolfin::GenericLinearAlgebraFactory::create_matrix
virtual std::shared_ptr< GenericMatrix > create_matrix(MPI_Comm comm) const =0
Create empty matrix.
dolfin::GenericLinearAlgebraFactory::create_krylov_solver
virtual std::shared_ptr< GenericLinearSolver > create_krylov_solver(MPI_Comm comm, std::string method, std::string preconditioner) const =0
Create Krylov solver.
dolfin::GenericLinearAlgebraFactory::create_linear_operator
virtual std::shared_ptr< GenericLinearOperator > create_linear_operator(MPI_Comm comm) const =0
Create empty linear operator.
dolfin::GenericLinearAlgebraFactory::lu_solver_methods
virtual std::map< std::string, std::string > lu_solver_methods() const
Definition GenericLinearAlgebraFactory.h:83
dolfin::GenericLinearAlgebraFactory::create_layout
virtual std::shared_ptr< TensorLayout > create_layout(MPI_Comm comm, std::size_t rank) const =0
Create empty tensor layout.
dolfin::GenericLinearAlgebraFactory::GenericLinearAlgebraFactory
GenericLinearAlgebraFactory()
Constructor.
Definition GenericLinearAlgebraFactory.h:51
dolfin::GenericLinearOperator
Definition GenericLinearOperator.h:43
dolfin::GenericLinearSolver
This class provides a general solver for linear systems Ax = b.
Definition GenericLinearSolver.h:38
dolfin::GenericMatrix
This class defines a common interface for matrices.
Definition GenericMatrix.h:47
dolfin::GenericVector
This class defines a common interface for vectors.
Definition GenericVector.h:48
dolfin::TensorLayout
Definition TensorLayout.h:42
dolfin
Definition adapt.h:30