DOLFIN
DOLFIN C++ interface
Public Member Functions | Static Protected Member Functions | List of all members
dolfin::GenericLinearSolver Class Referenceabstract

This class provides a general solver for linear systems Ax = b. More...

#include <GenericLinearSolver.h>

Inheritance diagram for dolfin::GenericLinearSolver:
Inheritance graph
[legend]
Collaboration diagram for dolfin::GenericLinearSolver:
Collaboration graph
[legend]

Public Member Functions

virtual void set_operator (std::shared_ptr< const GenericLinearOperator > A)=0
 Set operator (matrix)
 
virtual void set_operators (std::shared_ptr< const GenericLinearOperator > A, std::shared_ptr< const GenericLinearOperator > P)
 Set operator (matrix) and preconditioner matrix.
 
virtual std::size_t solve (const GenericLinearOperator &A, GenericVector &x, const GenericVector &b)
 Solve linear system Ax = b.
 
virtual std::size_t solve (GenericVector &x, const GenericVector &b)=0
 Solve linear system Ax = b.
 
virtual std::string parameter_type () const
 Return parameter type: "krylov_solver" or "lu_solver".
 
virtual void update_parameters (const Parameters &parameters)
 Update solver parameters (useful for LinearSolver wrapper)
 
- Public Member Functions inherited from dolfin::Variable
 Variable ()
 Create unnamed variable.
 
 Variable (const std::string name, const std::string label)
 Create variable with given name and label.
 
 Variable (const Variable &variable)
 Copy constructor.
 
virtual ~Variable ()
 Destructor.
 
const Variableoperator= (const Variable &variable)
 Assignment operator.
 
void rename (const std::string name, const std::string label)
 Rename variable.
 
std::string name () const
 Return name.
 
std::string label () const
 Return label (description)
 
std::size_t id () const
 
virtual std::string str (bool verbose) const
 Return informal string representation (pretty-print)
 

Static Protected Member Functions

static const GenericMatrixrequire_matrix (const GenericLinearOperator &A)
 
static std::shared_ptr< const GenericMatrixrequire_matrix (std::shared_ptr< const GenericLinearOperator > A)
 

Additional Inherited Members

- Public Attributes inherited from dolfin::Variable
Parameters parameters
 Parameters.
 

Detailed Description

This class provides a general solver for linear systems Ax = b.

Member Function Documentation

◆ require_matrix() [1/2]

const GenericMatrix & GenericLinearSolver::require_matrix ( const GenericLinearOperator A)
staticprotected

Down-cast GenericLinearOperator to GenericMatrix when an actual matrix is required, not only a linear operator. This is the const reference version of the down-cast.

◆ require_matrix() [2/2]

std::shared_ptr< const GenericMatrix > GenericLinearSolver::require_matrix ( std::shared_ptr< const GenericLinearOperator A)
staticprotected

Down-cast GenericLinearOperator to GenericMatrix when an actual matrix is required, not only a linear operator. This is the const reference version of the down-cast.


The documentation for this class was generated from the following files: