Loading...
Searching...
No Matches
LinearOperator.h
// Copyright (C) 2012 Anders Logg
//
// 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: 2012-08-20
// Last changed: 2012-12-12
#ifndef __LINEAR_OPERATOR_H
#define __LINEAR_OPERATOR_H
#include <memory>
#include <dolfin/common/MPI.h>
#include "GenericLinearOperator.h"
namespace dolfin
{
class LinearOperator : public GenericLinearOperator
{
public:
LinearOperator();
LinearOperator(const GenericVector& x, const GenericVector& y);
virtual ~LinearOperator() {}
virtual std::size_t size(std::size_t dim) const = 0;
virtual void mult(const GenericVector& x, GenericVector& y) const = 0;
virtual MPI_Comm mpi_comm() const
{ dolfin_assert(_matA); return _matA->mpi_comm(); }
std::string str(bool verbose) const;
//--- Special functions, intended for library use only ---
virtual const GenericLinearOperator* instance() const;
virtual GenericLinearOperator* instance();
virtual std::shared_ptr<const LinearAlgebraObject> shared_instance() const;
virtual std::shared_ptr<LinearAlgebraObject> shared_instance();
private:
// Pointer to concrete implementation
std::shared_ptr<GenericLinearOperator> _matA;
};
}
#endif
dolfin::GenericLinearOperator
Definition GenericLinearOperator.h:43
dolfin::GenericVector
This class defines a common interface for vectors.
Definition GenericVector.h:48
dolfin::LinearOperator::shared_instance
virtual std::shared_ptr< const LinearAlgebraObject > shared_instance() const
Return concrete instance / unwrap (const shared pointer version).
Definition LinearOperator.cpp:63
dolfin::LinearOperator::mpi_comm
virtual MPI_Comm mpi_comm() const
Return the MPI communicator.
Definition LinearOperator.h:61
dolfin::LinearOperator::str
std::string str(bool verbose) const
Return informal string representation (pretty-print).
Definition LinearOperator.cpp:48
dolfin::LinearOperator::LinearOperator
LinearOperator()
Create linear operator.
Definition LinearOperator.cpp:28
dolfin::LinearOperator::mult
virtual void mult(const GenericVector &x, GenericVector &y) const =0
Compute matrix-vector product y = Ax.
dolfin::LinearOperator::~LinearOperator
virtual ~LinearOperator()
Destructor.
Definition LinearOperator.h:52
dolfin::LinearOperator::instance
virtual const GenericLinearOperator * instance() const
Return concrete instance / unwrap (const version).
Definition LinearOperator.cpp:53
dolfin::LinearOperator::size
virtual std::size_t size(std::size_t dim) const =0
Return size of given dimension.
dolfin
Definition adapt.h:30