SOFA API  ca665544
Open source framework for multi-physics simuation
sofa::component::linearsystem::LinearSystemData< TMatrix, TVector > Struct Template Reference

#include <LinearSystemData.h>

Public Attributes

StoredMatrixType matrix { nullptr }
 The global matrix of the linear system. If the linear system is written as Ax=b, it is A. More...
 
StoredVectorType rhs { nullptr }
 The right-hand side of the linear system. If the linear system is written as Ax=b, it is b. More...
 
StoredVectorType solution { nullptr }
 The solution of the linear system. If the linear system is written as Ax=b, it is x. More...
 

Public Member Functions

MatrixTypegetMatrix () const
 
VectorTypegetRHS () const
 
VectorTypegetSolution () const
 
void allocateSystem ()
 
void createSystemMatrix ()
 Allocate the object for the global matrix. More...
 
void createSystemRHSVector ()
 Allocate the object for the RHS. More...
 
void createSystemSolutionVector ()
 Allocate the object for the solution. More...
 
void resizeSystem (sofa::Size n)
 
void clearSystem ()
 
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void createSystemRHSVector ()
 
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void createSystemSolutionVector ()
 
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void resizeSystem (sofa::Size n)
 
SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void clearSystem ()
 
void createSystemRHSVector ()
 
void createSystemSolutionVector ()
 
void resizeSystem (sofa::Size n)
 
void clearSystem ()
 

Attribute details

◆ matrix

template<typename TMatrix , typename TVector >
StoredMatrixType sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::matrix { nullptr }

The global matrix of the linear system. If the linear system is written as Ax=b, it is A.

◆ rhs

template<typename TMatrix , typename TVector >
StoredVectorType sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::rhs { nullptr }

The right-hand side of the linear system. If the linear system is written as Ax=b, it is b.

◆ solution

template<typename TMatrix , typename TVector >
StoredVectorType sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::solution { nullptr }

The solution of the linear system. If the linear system is written as Ax=b, it is x.

Function details

◆ allocateSystem()

template<typename TMatrix , typename TVector >
void sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::allocateSystem

◆ clearSystem() [1/3]

SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void sofa::component::linearsystem::LinearSystemData< GraphScatteredMatrix, GraphScatteredVector >::clearSystem ( )

◆ clearSystem() [2/3]

◆ clearSystem() [3/3]

template<typename TMatrix , typename TVector >
void sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::clearSystem

◆ createSystemMatrix()

template<typename TMatrix , typename TVector >
void sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::createSystemMatrix

Allocate the object for the global matrix.

◆ createSystemRHSVector() [1/3]

SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void sofa::component::linearsystem::LinearSystemData< GraphScatteredMatrix, GraphScatteredVector >::createSystemRHSVector ( )

◆ createSystemRHSVector() [2/3]

◆ createSystemRHSVector() [3/3]

template<typename TMatrix , typename TVector >
void sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::createSystemRHSVector

Allocate the object for the RHS.

◆ createSystemSolutionVector() [1/3]

SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void sofa::component::linearsystem::LinearSystemData< GraphScatteredMatrix, GraphScatteredVector >::createSystemSolutionVector ( )

◆ createSystemSolutionVector() [2/3]

◆ createSystemSolutionVector() [3/3]

template<typename TMatrix , typename TVector >
void sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::createSystemSolutionVector

Allocate the object for the solution.

◆ getMatrix()

template<typename TMatrix , typename TVector >
MatrixType* sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::getMatrix ( ) const
inline

◆ getRHS()

template<typename TMatrix , typename TVector >
VectorType* sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::getRHS ( ) const
inline

◆ getSolution()

template<typename TMatrix , typename TVector >
VectorType* sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::getSolution ( ) const
inline

◆ resizeSystem() [1/3]

SOFA_COMPONENT_LINEARSOLVER_ITERATIVE_API void sofa::component::linearsystem::LinearSystemData< GraphScatteredMatrix, GraphScatteredVector >::resizeSystem ( sofa::Size  n)

◆ resizeSystem() [2/3]

◆ resizeSystem() [3/3]

template<typename TMatrix , typename TVector >
void sofa::component::linearsystem::LinearSystemData< TMatrix, TVector >::resizeSystem ( sofa::Size  n)