Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AMP::LinearAlgebra::MatrixFactory Class Referenceabstract

Matrix factory class. More...

#include <MatrixFactory.h>

Public Member Functions

virtual std::shared_ptr< AMP::Discretization::DOFManagergetDOFMap () const =0
 
virtual std::shared_ptr< AMP::Discretization::DOFManagergetDOFMapL () const =0
 
virtual std::shared_ptr< AMP::LinearAlgebra::MatrixgetMatrix () const =0
 
virtual std::shared_ptr< AMP::Mesh::MeshgetMesh () const =0
 
virtual std::shared_ptr< AMP::LinearAlgebra::VectorgetVector () const =0
 
virtual std::string name () const =0
 
const std::string & type () const
 
virtual ~MatrixFactory ()
 

Static Public Member Functions

static std::shared_ptr< Matrixcreate (int64_t fid, AMP::IO::RestartManager *manager)
 Create the matrix from the restart file.
 
static MatrixFactorygetFactory ()
 get a singleton instance of the factory
 
template<class MATRIX >
static void registerMatrix (const std::string &name)
 Register a matrix with the factory.
 

Protected Member Functions

 MatrixFactory (const MatrixFactory &)
 
 MatrixFactory (const std::string &type)
 

Protected Attributes

const std::string d_type
 

Detailed Description

Matrix factory class.

A helper class to generate matricies.

Definition at line 24 of file MatrixFactory.h.

Constructor & Destructor Documentation

◆ ~MatrixFactory()

virtual AMP::LinearAlgebra::MatrixFactory::~MatrixFactory ( )
inlinevirtual

Definition at line 26 of file MatrixTests.h.

◆ MatrixFactory() [1/2]

AMP::LinearAlgebra::MatrixFactory::MatrixFactory ( const std::string &  type)
inlineprotected

Definition at line 36 of file MatrixTests.h.

◆ MatrixFactory() [2/2]

AMP::LinearAlgebra::MatrixFactory::MatrixFactory ( const MatrixFactory )
protected

Member Function Documentation

◆ create()

static std::shared_ptr< Matrix > AMP::LinearAlgebra::MatrixFactory::create ( int64_t  fid,
AMP::IO::RestartManager manager 
)
static

Create the matrix from the restart file.

◆ getDOFMap()

virtual std::shared_ptr< AMP::Discretization::DOFManager > AMP::LinearAlgebra::MatrixFactory::getDOFMap ( ) const
pure virtual

◆ getDOFMapL()

virtual std::shared_ptr< AMP::Discretization::DOFManager > AMP::LinearAlgebra::MatrixFactory::getDOFMapL ( ) const
pure virtual

◆ getFactory()

static MatrixFactory & AMP::LinearAlgebra::MatrixFactory::getFactory ( )
inlinestatic

get a singleton instance of the factory

Definition at line 28 of file MatrixFactory.h.

◆ getMatrix()

virtual std::shared_ptr< AMP::LinearAlgebra::Matrix > AMP::LinearAlgebra::MatrixFactory::getMatrix ( ) const
pure virtual

◆ getMesh()

virtual std::shared_ptr< AMP::Mesh::Mesh > AMP::LinearAlgebra::MatrixFactory::getMesh ( ) const
pure virtual

◆ getVector()

virtual std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::LinearAlgebra::MatrixFactory::getVector ( ) const
pure virtual

◆ name()

virtual std::string AMP::LinearAlgebra::MatrixFactory::name ( ) const
pure virtual

Referenced by registerMatrix().

◆ registerMatrix()

template<class MATRIX >
static void AMP::LinearAlgebra::MatrixFactory::registerMatrix ( const std::string &  name)
inlinestatic

Register a matrix with the factory.

Definition at line 39 of file MatrixFactory.h.

References name().

◆ type()

const std::string & AMP::LinearAlgebra::MatrixFactory::type ( ) const
inline

Definition at line 33 of file MatrixTests.h.

References d_type.

Member Data Documentation

◆ d_type

const std::string AMP::LinearAlgebra::MatrixFactory::d_type
protected

Definition at line 40 of file MatrixTests.h.

Referenced by type().


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



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:42.
Comments on this page