|
Template Numerical Library version\ main:20cf9b156
|


Public Types | |
| using | ConstVectorViewType = typename Base::ConstVectorViewType |
| using | DeviceType = typename Base::DeviceType |
| using | IndexType = typename Base::IndexType |
| using | MatrixPointer = typename Base::MatrixPointer |
| using | RealType = typename Base::RealType |
| using | VectorViewType = typename Base::VectorViewType |
| Public Types inherited from TNL::Solvers::Linear::LinearSolver< Matrix > | |
| using | ConstVectorViewType = typename Traits< Matrix >::ConstVectorViewType |
| Type for constant vector view. | |
| using | DeviceType = typename Matrix::DeviceType |
| Device where the solver will run on and auxiliary data will alloacted on. | |
| using | IndexType = typename Matrix::IndexType |
| Type for indexing. | |
| using | MatrixPointer = std::shared_ptr< std::add_const_t< MatrixType > > |
| Type of shared pointer to the matrix. | |
| using | MatrixType = Matrix |
| Type of the matrix representing the linear system. | |
| using | PreconditionerPointer = std::shared_ptr< std::add_const_t< PreconditionerType > > |
| Type of shared pointer to the preconditioner. | |
| using | PreconditionerType = Preconditioners::Preconditioner< MatrixType > |
| Type of preconditioner. | |
| using | RealType = typename Matrix::RealType |
| Floating point type used for computations. | |
| using | VectorViewType = typename Traits< Matrix >::VectorViewType |
| Type for vector view. | |
| Public Types inherited from TNL::Solvers::IterativeSolver< Matrix::RealType, Matrix::IndexType > | |
| using | SolverMonitorType |
| Type of an object used for monitoring of the convergence. | |
Public Member Functions | |
| void | setMatrix (const MatrixPointer &matrix) override |
| Set the matrix of the linear system. | |
| bool | solve (ConstVectorViewType b, VectorViewType x) override |
| Method for solving a linear system. | |
| Public Member Functions inherited from TNL::Solvers::Linear::LinearSolver< Matrix > | |
| virtual | ~LinearSolver ()=default |
| Default destructor. | |
| void | setPreconditioner (const PreconditionerPointer &preconditioner) |
| Set the preconditioner. | |
| virtual bool | setup (const Config::ParameterContainer ¶meters, const String &prefix="") |
| Method for setup of the linear iterative solver based on configuration parameters. | |
| Public Member Functions inherited from TNL::Solvers::IterativeSolver< Matrix::RealType, Matrix::IndexType > | |
| IterativeSolver ()=default | |
| Default constructor. | |
| bool | checkConvergence () |
| Checks whether the convergence occurred already. | |
| bool | checkNextIteration () |
| Checks if the solver is allowed to do the next iteration. | |
| const Matrix::RealType & | getConvergenceResidue () const |
| Gets the the convergence threshold. | |
| const Matrix::RealType & | getDivergenceResidue () const |
| Gets the limit for the divergence criterion. | |
| const Matrix::IndexType & | getIterations () const |
| Gets the number of iterations performed by the solver so far. | |
| const Matrix::IndexType & | getMaxIterations () const |
| Gets the maximal number of iterations the solver is allowed to perform. | |
| const Matrix::IndexType & | getMinIterations () const |
| Gets the minimal number of iterations the solver is supposed to do. | |
| const Matrix::RealType & | getResidue () const |
| Gets the residue reached at the current iteration. | |
| bool | nextIteration () |
| Proceeds to the next iteration. | |
| void | resetIterations () |
| Sets the the number of the current iterations to zero. | |
| void | setConvergenceResidue (const Matrix::RealType &convergenceResidue) |
| Sets the threshold for the convergence. | |
| void | setDivergenceResidue (const Matrix::RealType &divergenceResidue) |
| Sets the residue limit for the divergence criterion. | |
| void | setMaxIterations (const Matrix::IndexType &maxIterations) |
| Sets the maximal number of iterations the solver is allowed to perform. | |
| void | setMinIterations (const Matrix::IndexType &minIterations) |
| Sets the minimal number of iterations the solver is supposed to do. | |
| void | setRefreshRate (const Matrix::IndexType &refreshRate) |
| Sets the refresh rate (in milliseconds) for the solver monitor. | |
| void | setResidue (const Matrix::RealType &residue) |
| Sets the residue reached at the current iteration. | |
| void | setSolverMonitor (SolverMonitorType &solverMonitor) |
| Sets the solver monitor object. | |
| bool | setup (const Config::ParameterContainer ¶meters, const std::string &prefix="") |
| Method for setup of the iterative solver based on configuration parameters. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from TNL::Solvers::Linear::LinearSolver< Matrix > | |
| static void | configSetup (Config::ConfigDescription &config, const String &prefix="") |
| This method defines configuration entries for setup of the linear iterative solver. | |
| Static Public Member Functions inherited from TNL::Solvers::IterativeSolver< Matrix::RealType, Matrix::IndexType > | |
| static void | configSetup (Config::ConfigDescription &config, const std::string &prefix="") |
| This method defines configuration entries for setup of the iterative solver. | |
| Protected Attributes inherited from TNL::Solvers::Linear::LinearSolver< Matrix > | |
| MatrixPointer | matrix = nullptr |
| PreconditionerPointer | preconditioner = nullptr |
| Protected Attributes inherited from TNL::Solvers::IterativeSolver< Matrix::RealType, Matrix::IndexType > | |
| Matrix::RealType | convergenceResidue |
| Matrix::IndexType | currentIteration |
| Matrix::RealType | currentResidue |
| Matrix::RealType | divergenceResidue |
| Matrix::IndexType | maxIterations |
| Matrix::IndexType | minIterations |
| Matrix::IndexType | refreshRate |
| std::ofstream | residualHistoryFile |
| std::string | residualHistoryFileName |
| IterativeSolverMonitor< double > * | solverMonitor |
|
inlineoverridevirtual |
Set the matrix of the linear system.
| matrix | is a shared pointer to the matrix of the linear system |
Reimplemented from TNL::Solvers::Linear::LinearSolver< Matrix >.
|
inlineoverridevirtual |
Method for solving a linear system.
The linear system is defined by the matrix given by the method LinearSolver::setMatrix and by the right-hand side vector represented by the vector b. The result is stored in the vector b. The solver can be accelerated with appropriate preconditioner set by the methods LinearSolver::setPreconditioner.
| b | vector with the right-hand side of the linear system. |
| x | vector for the solution of the linear system. |
Implements TNL::Solvers::Linear::LinearSolver< Matrix >.