numcxx::TSolverUMFPACK< T > Class Template Reference

Description

template<typename T>
class numcxx::TSolverUMFPACK< T >

Bridge class for using umfpack as solver for vmatrix.

UMFPACK is a GPL licensed sparse matrix package by Tim Davis of Texas A&M university, see wikipedia and its homepage

Examples:

15-numcxx-umfpack.cxx, 40-stationary-heat-fe.cxx, 41-stationary-heat-fv.cxx, 42-convtest-fem-sin.cxx, 43-convtest-fvm-sin.cxx, 44-transient-heat-fe.cxx, 45-convdiff1d.cxx, and 46-nonlin-fvm.cxx.

Definition at line 20 of file tsolver-umfpack.hxx.

Inheritance diagram for numcxx::TSolverUMFPACK< T >:

Collaboration diagram for numcxx::TSolverUMFPACK< T >:

Public Member Functions
	TSolverUMFPACK ()
	TSolverUMFPACK (const std::shared_ptr< TSparseMatrix< T >> pA)
	Create LU factorization class. More...
	TSolverUMFPACK (const TSparseMatrix< T > &A)
	Create LU factorization class. More...
	TSolverUMFPACK (const TSolverUMFPACK< T > &A)=delete
	~TSolverUMFPACK ()
void	update ()
	Perform actual computation of LU factorization. More...
void	update (const TSparseMatrix< T > &A)
	Perform actual computation of LU factorization. More...
void	solve (TArray< T > &Sol, const TArray< T > &Rhs)
	Solve LU factorized system. More...
void	solve (std::shared_ptr< TArray< T > > Sol, const std::shared_ptr< TArray< T > > Rhs)
virtual void	solve (TArray< T > &sol, const TArray< T > &rhs) const

Static Public Member Functions
static std::shared_ptr< TSolverUMFPACK< T > >	create (const std::shared_ptr< TSparseMatrix< T >> pA)
	Create LU factorization class. More...

Private Attributes
const std::shared_ptr< TSparseMatrix< T > >	pMatrix
	The corresponding matrix. More...
void *	Symbolic
	Pointer to symbolic factorization data. More...
void *	Numeric
	Pointer to numeric factorization data. More...
std::shared_ptr< TArray1< int > >	pIA
	Row pointer of matrix. More...
std::shared_ptr< TArray1< int > >	pJA
	Column indices. More...
std::shared_ptr< TArray1< T > >	pA
	Entries. More...

Constructor & Destructor Documentation

template<typename T>

numcxx::TSolverUMFPACK< T >::TSolverUMFPACK ( )

inline

Definition at line 41 of file tsolver-umfpack.hxx.

{};

Here is the call graph for this function:

template<typename T >

numcxx::TSolverUMFPACK< T >::TSolverUMFPACK ( const std::shared_ptr< TSparseMatrix< T >>  pA )

inline

Create LU factorization class.

Definition at line 14 of file tsolver-umfpack.ixx.

                                                                                       :
    pMatrix(pMatrix),
    Symbolic(nullptr),
    Numeric(nullptr)
  {
    update();
  }

Here is the call graph for this function:

template<typename T >

numcxx::TSolverUMFPACK< T >::TSolverUMFPACK ( const TSparseMatrix< T > &  A )

inline

Create LU factorization class.

Definition at line 23 of file tsolver-umfpack.ixx.

                                                                        :
    pMatrix(nullptr),
    Symbolic(nullptr),
    Numeric(nullptr)
  {
    update(Matrix);
  }

Here is the call graph for this function:

template<typename T>

numcxx::TSolverUMFPACK< T >::TSolverUMFPACK ( const TSolverUMFPACK< T > &  A )

delete

template<typename T >

numcxx::TSolverUMFPACK< T >::~TSolverUMFPACK ( )

inline

Definition at line 32 of file tsolver-umfpack.ixx.

  {
    if (Symbolic!=nullptr) 
    {
      umfpack_di_free_symbolic(&Symbolic);
      Symbolic=nullptr;
    }
    if (Numeric!=nullptr)
    {
      umfpack_di_free_numeric(&Numeric);
      Numeric=nullptr;
    }
  }

Member Function Documentation

template<typename T >

std::shared_ptr< TSolverUMFPACK< T > > numcxx::TSolverUMFPACK< T >::create ( const std::shared_ptr< TSparseMatrix< T >>  pA )

inlinestatic

Create LU factorization class.

Examples:

16-numcxx-umfpack-sharedptr.cxx.

Definition at line 48 of file tsolver-umfpack.ixx.

  {
    return std::make_shared<TSolverUMFPACK<T>>(pA);
  }

template<typename T >

void numcxx::TSolverUMFPACK< T >::update ( void  )

inlinevirtual

Perform actual computation of LU factorization.

Reimplemented from numcxx::TLinSolver< T >.

Examples:

15-numcxx-umfpack.cxx, 40-stationary-heat-fe.cxx, 41-stationary-heat-fv.cxx, 42-convtest-fem-sin.cxx, 43-convtest-fvm-sin.cxx, 44-transient-heat-fe.cxx, 45-convdiff1d.cxx, and 46-nonlin-fvm.cxx.

Definition at line 55 of file tsolver-umfpack.ixx.

  {
    if (pMatrix==nullptr)
      throw std::runtime_error("numcxx: TSolverUMFPACK created without smartpointer");
    update(*pMatrix);
  }

template<typename T >

void numcxx::TSolverUMFPACK< T >::update ( const TSparseMatrix< T > &  A )

inline

Perform actual computation of LU factorization.

copy matrix data for use in solve

Definition at line 62 of file tsolver-umfpack.ixx.

  {
    if (Matrix.empty()) return;
    if (Matrix.pattern_changed())
      throw std::runtime_error("numcxx: forgot flush() after sparse pattern changed");
      
    int n=Matrix.shape(0);
    int nia=Matrix.pIA->size();
    int nja=Matrix.pJA->size();


    // double Control[UMFPACK_CONTROL];
    // for (int i=0;i<UMFPACK_CONTROL;i++) Control[i]=0.0;
    // Control[UMFPACK_PIVOT_TOLERANCE]=pivot_tolerance;
    // Control[UMFPACK_DROPTOL]=drop_tolerance;
    // Control[UMFPACK_PRL]=0;
    // double *control=Control;
    // if (pivot_tolerance<0) control=0;
    double *control=nullptr;
        
    int status;
    if (Matrix.pattern_changed() || Symbolic==nullptr)
    {
      if (Symbolic) umfpack_di_free_symbolic(&Symbolic),Symbolic=nullptr;
      if (Numeric) umfpack_di_free_numeric(&Numeric),Numeric=nullptr;
      status=umfpack_di_symbolic (n, n, Matrix.pIA->data(), Matrix.pJA->data(), Matrix.pA->data(), &Symbolic, 0, 0);
      if (status>1)
      {
        char errormsg[80];
        snprintf(errormsg,80,"numcxx::TSolverUMFPACK::update: umfpack_di_symbolic error %d\n",status);
        throw std::runtime_error(errormsg);
      }

    }
    if (Numeric!=nullptr) 
    {
      umfpack_di_free_numeric(&Numeric);
      Numeric=nullptr;
    }
    status =umfpack_di_numeric (Matrix.pIA->data(), Matrix.pJA->data(), Matrix.pA->data(), Symbolic, &Numeric, control, 0) ;
    if (status>1)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverUMFPACK::update: umfpack_di_numeric error %d\n",status);
      throw std::runtime_error(errormsg);
    }
    pIA=Matrix.pIA;
    pJA=Matrix.pJA;
    pA=Matrix.pA;
  }

Here is the call graph for this function:

template<typename T >

void numcxx::TSolverUMFPACK< T >::solve ( TArray< T > &  Sol, const TArray< T > &  Rhs  )

inline

Solve LU factorized system.

Examples:

15-numcxx-umfpack.cxx, 40-stationary-heat-fe.cxx, 41-stationary-heat-fv.cxx, 42-convtest-fem-sin.cxx, 43-convtest-fvm-sin.cxx, 44-transient-heat-fe.cxx, 45-convdiff1d.cxx, and 46-nonlin-fvm.cxx.

Definition at line 116 of file tsolver-umfpack.ixx.

  {
    Sol.resize(Rhs.size());
    double *control=nullptr;
    int status;
    status=umfpack_di_solve (UMFPACK_At,pIA->data(), pJA->data(),pA->data(), Sol.data(), Rhs.data(), Numeric, control, 0 ) ;
    if (status>1)
    {
      char errormsg[80];
      snprintf(errormsg,80,"numcxx::TSolverUMFPACK::update: umfpack_di_solve error %d\n",status);
      throw std::runtime_error(errormsg);
    }
  }

Here is the call graph for this function:

template<typename T>

void numcxx::TSolverUMFPACK< T >::solve ( std::shared_ptr< TArray< T > >  Sol, const std::shared_ptr< TArray< T > >  Rhs  )

inline

Definition at line 66 of file tsolver-umfpack.hxx.

{solve(*Sol,*Rhs);};

Here is the call graph for this function:

template<typename T >

virtual void numcxx::TLinSolver< T >::solve ( TArray< T > &  sol, const TArray< T > &  rhs  ) const

inlinevirtualinherited

Reimplemented in numcxx::TSolverLapackLU< T >, numcxx::TPreconILU< T >, and numcxx::TPreconJacobi< T >.

Definition at line 279 of file tarray.hxx.

{};

Member Data Documentation

template<typename T>

const std::shared_ptr< TSparseMatrix<T> > numcxx::TSolverUMFPACK< T >::pMatrix

private

The corresponding matrix.

Definition at line 23 of file tsolver-umfpack.hxx.

template<typename T>

void* numcxx::TSolverUMFPACK< T >::Symbolic

private

Pointer to symbolic factorization data.

Definition at line 26 of file tsolver-umfpack.hxx.

template<typename T>

void* numcxx::TSolverUMFPACK< T >::Numeric

private

Pointer to numeric factorization data.

Definition at line 29 of file tsolver-umfpack.hxx.

template<typename T>

std::shared_ptr<TArray1<int> > numcxx::TSolverUMFPACK< T >::pIA

private

Row pointer of matrix.

Definition at line 32 of file tsolver-umfpack.hxx.

template<typename T>

std::shared_ptr<TArray1<int> > numcxx::TSolverUMFPACK< T >::pJA

private

Column indices.

Definition at line 35 of file tsolver-umfpack.hxx.

template<typename T>

std::shared_ptr<TArray1 <T> > numcxx::TSolverUMFPACK< T >::pA

private

Entries.

Definition at line 38 of file tsolver-umfpack.hxx.

---

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

• tsolver-umfpack.hxx
• tsolver-umfpack.ixx