Loading...
Searching...
No Matches
LinearSolver.h
// Copyright (C) 2004-2016 Anders Logg and Garth N. 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/>.
//
// Modified by Garth N. Wells 2006-2010
// Modified by Ola Skavhaug 2008
//
// First added: 2004-06-19
// Last changed: 2016-06-22
#ifndef __LINEAR_SOLVER_H
#define __LINEAR_SOLVER_H
#include <memory>
#include <string>
#include <memory>
#include <dolfin/common/types.h>
#include "GenericLinearSolver.h"
#include <dolfin/common/MPI.h>
namespace dolfin
{
class GenericLinearOperator;
class GenericVector;
class LUSolver;
class KrylovSolver;
class LinearVariationalSolver;
class LinearSolver : public GenericLinearSolver
{
public:
explicit LinearSolver(std::string method="default",
std::string preconditioner="default")
: LinearSolver(MPI_COMM_WORLD, method, preconditioner) {}
explicit LinearSolver(MPI_Comm comm,
std::string method="default",
std::string preconditioner="default");
~LinearSolver();
void set_operator(std::shared_ptr<const GenericLinearOperator> A);
void set_operators(std::shared_ptr<const GenericLinearOperator> A,
std::shared_ptr<const GenericLinearOperator> P);
std::size_t solve(const GenericLinearOperator& A,
GenericVector& x, const GenericVector& b);
std::size_t solve(GenericVector& x, const GenericVector& b);
static Parameters default_parameters()
{
Parameters p("linear_solver");
return p;
}
virtual void update_parameters(const Parameters& parameters)
{
this->parameters.update(parameters);
solver->update_parameters(parameters);
}
// FIXME: This should not be needed. Need to cleanup linear solver
// name jungle: default, lu, iterative, direct, krylov, etc
std::string parameter_type() const
{ return _parameter_type; }
private:
// Friends
friend class LUSolver;
friend class KrylovSolver;
friend class LinearVariationalSolver;
friend class MixedLinearVariationalSolver;
friend class NewtonSolver;
// Check whether string is contained in list
static bool in_list(const std::string& method,
const std::map<std::string, std::string>& methods);
// Solver
std::unique_ptr<GenericLinearSolver> solver;
// FIXME: This should not be needed
// Parameter type
std::string _parameter_type;
};
}
#endif
dolfin::GenericLinearOperator
Definition GenericLinearOperator.h:43
dolfin::GenericLinearSolver
This class provides a general solver for linear systems Ax = b.
Definition GenericLinearSolver.h:38
dolfin::GenericVector
This class defines a common interface for vectors.
Definition GenericVector.h:48
dolfin::KrylovSolver
Definition KrylovSolver.h:39
dolfin::LUSolver
LU solver for the built-in LA backends.
Definition LUSolver.h:36
dolfin::LinearSolver::~LinearSolver
~LinearSolver()
Destructor.
Definition LinearSolver.cpp:103
dolfin::LinearSolver::update_parameters
virtual void update_parameters(const Parameters &parameters)
Definition LinearSolver.h:85
dolfin::LinearSolver::set_operator
void set_operator(std::shared_ptr< const GenericLinearOperator > A)
Set the operator (matrix).
Definition LinearSolver.cpp:109
dolfin::LinearSolver::LinearSolver
LinearSolver(std::string method="default", std::string preconditioner="default")
Create linear solver.
Definition LinearSolver.h:50
dolfin::LinearSolver::parameter_type
std::string parameter_type() const
Return parameter type: "krylov_solver" or "lu_solver".
Definition LinearSolver.h:94
dolfin::LinearSolver::set_operators
void set_operators(std::shared_ptr< const GenericLinearOperator > A, std::shared_ptr< const GenericLinearOperator > P)
Set the operator (matrix) and preconditioner matrix.
Definition LinearSolver.cpp:117
dolfin::LinearSolver::default_parameters
static Parameters default_parameters()
Default parameter values.
Definition LinearSolver.h:77
dolfin::LinearSolver::solve
std::size_t solve(const GenericLinearOperator &A, GenericVector &x, const GenericVector &b)
Solve linear system Ax = b.
Definition LinearSolver.cpp:125
dolfin::LinearVariationalSolver
This class implements a solver for linear variational problems.
Definition LinearVariationalSolver.h:39
dolfin::MixedLinearVariationalSolver
This class implements a solver for mixed linear variational problems.
Definition MixedLinearVariationalSolver.h:40
dolfin::NewtonSolver
Definition NewtonSolver.h:47
dolfin::Parameters
Definition Parameters.h:95
dolfin::Parameters::update
void update(const Parameters &parameters)
Update parameters with another set of parameters.
Definition Parameters.cpp:245
dolfin::Variable::parameters
Parameters parameters
Parameters.
Definition Variable.h:74
dolfin
Definition adapt.h:30