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

#include <LinearAlgebraObject.h>

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

Public Member Functions

virtual const LinearAlgebraObjectinstance () const
 Return concrete instance / unwrap (const version) More...
 
virtual LinearAlgebraObjectinstance ()
 Return concrete instance / unwrap (non-const version) More...
 
virtual std::shared_ptr< const LinearAlgebraObjectshared_instance () const
 Return concrete shared ptr instance / unwrap (const version) More...
 
virtual std::shared_ptr< LinearAlgebraObjectshared_instance ()
 Return concrete shared ptr instance / unwrap (non-const version) More...
 
virtual MPI_Comm mpi_comm () const =0
 Return MPI communicator. More...
 
- 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) More...
 

Additional Inherited Members

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

Detailed Description

This is a common base class for all DOLFIN linear algebra objects. In particular, it provides casting mechanisms between different types.

Member Function Documentation

◆ instance() [1/2]

virtual LinearAlgebraObject * dolfin::LinearAlgebraObject::instance ( )
inlinevirtual

Return concrete instance / unwrap (non-const version)

Reimplemented in dolfin::LinearOperator, dolfin::Matrix, and dolfin::Vector.

◆ instance() [2/2]

virtual const LinearAlgebraObject * dolfin::LinearAlgebraObject::instance ( ) const
inlinevirtual

Return concrete instance / unwrap (const version)

Reimplemented in dolfin::LinearOperator, dolfin::Matrix, and dolfin::Vector.

◆ mpi_comm()

virtual MPI_Comm dolfin::LinearAlgebraObject::mpi_comm ( ) const
pure virtual

◆ shared_instance() [1/2]

virtual std::shared_ptr< LinearAlgebraObject > dolfin::LinearAlgebraObject::shared_instance ( )
inlinevirtual

Return concrete shared ptr instance / unwrap (non-const version)

Reimplemented in dolfin::LinearOperator, dolfin::Matrix, and dolfin::Vector.

◆ shared_instance() [2/2]

virtual std::shared_ptr< const LinearAlgebraObject > dolfin::LinearAlgebraObject::shared_instance ( ) const
inlinevirtual

Return concrete shared ptr instance / unwrap (const version)

Reimplemented in dolfin::LinearOperator, dolfin::Matrix, and dolfin::Vector.


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