Detailed Description

The Options struct allows to specify several options of factorization.

Not all sparse factorization routines respect all of the options.

Definition at line 25 of file factorizationOptions.hh.

Classes
struct	Mumps
	The Mumps struct allows to specify options which are exclusively relevant for the MUMPS solver. More...

Public Member Functions
	FactorizationOptions ()=default

	FactorizationOptions (MatrixProperties matrixProperty_)

	FactorizationOptions (MatrixProperties matrixProperty_, int verbosity_)

Public Attributes
MatrixProperties	matrixProperty = MatrixProperties::GENERAL
	We can specify the properties of the matrix, which might be taken into account for selecing an ordering. More...

int	verbosity = 0
	How detailed information should be reported. More...

int	refinementIterations = -1
	Number of refinement iterations. More...

struct Kaskade::FactorizationOptions::Mumps	mumps

Constructor & Destructor Documentation

◆ FactorizationOptions() [1/3]

Kaskade::FactorizationOptions::FactorizationOptions ( )

default

◆ FactorizationOptions() [2/3]

Kaskade::FactorizationOptions::FactorizationOptions ( MatrixProperties matrixProperty_ )

inline

Definition at line 29 of file factorizationOptions.hh.

◆ FactorizationOptions() [3/3]

Kaskade::FactorizationOptions::FactorizationOptions	(	MatrixProperties	matrixProperty_,
		int	verbosity_
	)

inline

Definition at line 32 of file factorizationOptions.hh.

Member Data Documentation

◆ matrixProperty

MatrixProperties Kaskade::FactorizationOptions::matrixProperty = MatrixProperties::GENERAL

We can specify the properties of the matrix, which might be taken into account for selecing an ordering.

Definition at line 39 of file factorizationOptions.hh.

Referenced by Kaskade::MUMPSFactorization< Scalar >::analyze(), Kaskade::MUMPSFactorization< Scalar >::factorize(), Kaskade::MUMPSFactorization< Scalar >::init(), and Kaskade::MUMPSFactorization< Scalar >::MUMPSFactorization().

◆ mumps

struct Kaskade::FactorizationOptions::Mumps Kaskade::FactorizationOptions::mumps

Referenced by Kaskade::MUMPSFactorization< Scalar >::analyze().

◆ refinementIterations

int Kaskade::FactorizationOptions::refinementIterations = -1

Number of refinement iterations.

Some solvers can perform iterative refinement for stability and accuracy. This controls how many iterations to perform. Negative values mean use the solver's default. Zero means just solve once.

Definition at line 55 of file factorizationOptions.hh.

◆ verbosity

int Kaskade::FactorizationOptions::verbosity = 0

How detailed information should be reported.

0 is the most basic information, higher values correspond to more detailed reporting.

Definition at line 46 of file factorizationOptions.hh.

Referenced by Kaskade::Factorization< Scalar >::getVerbose(), Kaskade::MUMPSFactorization< Scalar >::init(), and Kaskade::Factorization< Scalar >::setVerbose().

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

factorizationOptions.hh