Hex: LUft_MUMPS Class Reference

| Hex 2.2 Hydrogen-electron collision solver

Data Structures | Public Member Functions
LUft_MUMPS Class Reference

LU factorization object - MUMPS specialization. More...

`#include <lu-mumps.h>`

Inheritance diagram for LUft_MUMPS:
[legend]
Collaboration diagram for LUft_MUMPS:
[legend]

## Data Structures

struct | Data

## Public Member Functions

| factorizerRunTimeSelectionDefinitions (LUft_MUMPS, "mumps") LUft_MUMPS()
| Default constructor. More...
virtual | ~LUft_MUMPS ()
| Destructor. More...
LUft_MUMPS const & | operator= (LUft_MUMPS const &)=delete
virtual void | factorize (CsrMatrix< LU_int_t, Complex > const &matrix, LUftData data)
| Factorize. More...
virtual bool | valid () const
| Validity indicator. More...
virtual std::size_t | size () const
| Return LU byte size. More...
virtual Real | cond () const
| Condition number. More...
virtual void | solve (const cArrayView b, cArrayView x, int eqs) const
| Solve equations. More...
virtual void | save (std::string name) const
| Save large data to disk. More...
virtual void | load (std::string name, bool throw_on_io_failure=true)
| Load large data from disk. More...
virtual void | drop ()
| Release memory. More...
Public Member Functions inherited from LUft
| baseClassRunTimeSelectionDefinitions (LUft,()) LUft()
| Default constructor. More...
virtual | ~LUft ()
| Destructor. More...
virtual cArray | solve (const cArrayView b, int eqs=1) const
| Solve equations. More...
virtual void | link (std::string name)
| Link to a disk file. More...
virtual void | unlink ()
| Unlink disk file. More...
virtual std::string | filename () const
| Name of the linked disk file. More...
virtual void | save () const
virtual void | load ()
virtual void | silent_load ()

## Detailed Description

This class holds information on LU factorization as computed by the free library MUMPS. It is derived from LUft and shares interface with that class.

Warning
  This class expect only symmetric matrices. The COO matrix passed to this class should contain only upper or lower part of the matrix (together with the main diagonal).

## Constructor & Destructor Documentation

## ◆ ~LUft_MUMPS()

LUft_MUMPS::~LUft_MUMPS | ( |  | ) |

virtual

## Member Function Documentation

## ◆ cond()

virtual Real LUft_MUMPS::cond | ( |  | ) | const

inlinevirtual

Reimplemented from LUft.

## ◆ drop()

virtual void LUft_MUMPS::drop | ( |  | ) |

inlinevirtual

Reimplemented from LUft.

## ◆ factorize()

void LUft_MUMPS::factorize | ( | CsrMatrix< LU_int_t, Complex > const & | matrix,
|  | LUftData | data
| ) |  |

virtual

Implements LUft.

## ◆ factorizerRunTimeSelectionDefinitions()

LUft_MUMPS::factorizerRunTimeSelectionDefinitions | ( | LUft_MUMPS | ,
|  | "mumps" |
| ) |  |

## ◆ load()

virtual void LUft_MUMPS::load | ( | std::string | name,
|  | bool | throw_on_io_failure = `true`
| ) |  |

inlinevirtual

Implements LUft.

## ◆ operator=()

LUft_MUMPS const& LUft_MUMPS::operator= | ( | LUft_MUMPS const & |  | ) |

delete

## ◆ save()

virtual void LUft_MUMPS::save | ( | std::string | name | ) | const

inlinevirtual

Implements LUft.

## ◆ size()

std::size_t LUft_MUMPS::size | ( |  | ) | const

virtual

Reimplemented from LUft.

## ◆ solve()

void LUft_MUMPS::solve | ( | const cArrayView | b,
|  | cArrayView | x,
|  | int | eqs
| ) |  | const

virtual

Implements LUft.

## ◆ valid()

virtual bool LUft_MUMPS::valid | ( |  | ) | const

inlinevirtual

Reimplemented from LUft.

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

- src/factorizers/lu-mumps.h
- src/factorizers/lu-mumps.cpp