Precond_base

#include <Precond_base.h>

How to cite this class in this doc

RST

:ref:`Precond\_base <class-precond-base>`

Markdown

[Precond\_base](#class-precond-base)

Detailed description

Inherits from

• public : Objet_U

Inherited by

• public : ILU_SP

• public : PrecondA

• public : PrecondSolv

• public : Precond_local

• public : SSOR

List of Public Methods

• get_flag_updated_input

• get_info

• get_status

• Precond_base

• preconditionner

• prepare

• reinit

• set_echange_espace_virtuel_resultat

• supporte_matrice_morse_sym

• ~Precond_base

List of Public Static Methods

• info

• self_cast

• self_cast

List of Protected Methods

• preconditionner_

• prepare_

• printOn

• readOn

Complete Member Function Documentation

get_flag_updated_input

virtual int Precond_base::get_flag_updated_input() const

Referenced By

• Solv_GCP::resoudre_

How to cite in this doc:

RST

:ref:`virtual int Precond_base::get_flag_updated_input() const <public-virtual-int-precond-base-get-flag-updated-input-const>`

Markdown

[virtual int Precond_base::get_flag_updated_input() const](#public-virtual-int-precond-base-get-flag-updated-input-const)

get_info

const Type_info * Precond_base::get_info() const override

Donne des informations sur le type de l’ Objet_U .

Reimplements:

• get_info

How to cite in this doc:

RST

:ref:`const Type_info * Precond_base::get_info() const override <public-const-type-info-ptr-precond-base-get-info-const-override>`

Markdown

[const Type_info * Precond_base::get_info() const override](#public-const-type-info-ptr-precond-base-get-info-const-override)

get_status

Init_Status Precond_base::get_status()

Referenced By

• ILU_SP::prepare_

• SSOR::prepare_

• PrecondA::prepare_

How to cite in this doc:

RST

:ref:`Init_Status Precond_base::get_status() <public-init-status-precond-base-get-status>`

Markdown

[Init_Status Precond_base::get_status()](#public-init-status-precond-base-get-status)

Precond_base

Precond_base::Precond_base()

References

• echange_ev_solution_

• REINIT_ALL

How to cite in this doc:

RST

:ref:`Precond_base::Precond_base() <public-precond-base-precond-base>`

Markdown

[Precond_base::Precond_base()](#public-precond-base-precond-base)

preconditionner

int Precond_base::preconditionner(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)

Call to the prepare() method if reinit() has been called previously, then call to preconditionner_() .

References

• preconditionner_

• prepare

• READY

Referenced By

• Testeur::interpreter

• PrecondA::preconditionner_

• Solv_GCP_NS::resoudre_systeme

• Solv_Gen::solve

How to cite in this doc:

RST

:ref:`int Precond_base::preconditionner(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution) <public-int-precond-base-preconditionner-const-matrice-base-ref-const-doublevect-ref-src-doublevect-ref-solution>`

Markdown

[int Precond_base::preconditionner(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)](#public-int-precond-base-preconditionner-const-matrice-base-ref-const-doublevect-ref-src-doublevect-ref-solution)

prepare

void Precond_base::prepare(const Matrice_Base &, const DoubleVect &src)

prepares the preconditionner if needed after a matrix change ( reinit() call).

prepare() is public, in case we want to perform preparation separately from preconditionning (eg nested solvers) but calling prepare() is not mandatory (done automatically in preconditionner() ) m is the new matrix, and md is the descriptor of the solution vector.

References

• prepare_

• READY

Referenced By

• preconditionner

How to cite in this doc:

RST

:ref:`void Precond_base::prepare(const Matrice_Base &, const DoubleVect &src) <public-void-precond-base-prepare-const-matrice-base-ref-const-doublevect-ref-src>`

Markdown

[void Precond_base::prepare(const Matrice_Base &, const DoubleVect &src)](#public-void-precond-base-prepare-const-matrice-base-ref-const-doublevect-ref-src)

reinit

void Precond_base::reinit(Init_Status x=REINIT_ALL)

this method must be called before preconditionner() whenever the matrix changes (coefficients only or coefficients and structure) to

tell the object to recompute some matrix related data.

References

• Process::exit

• READY

• REINIT_ALL

• REINIT_COEFF

Referenced By

• Solv_GCP::reinit

• Solv_Gen::reinit

• SSOR::set_omega

How to cite in this doc:

RST

:ref:`void Precond_base::reinit(Init_Status x=REINIT_ALL) <public-void-precond-base-reinit-init-status-x-equal-reinit-all>`

Markdown

[void Precond_base::reinit(Init_Status x=REINIT_ALL)](#public-void-precond-base-reinit-init-status-x-equal-reinit-all)

set_echange_espace_virtuel_resultat

void Precond_base::set_echange_espace_virtuel_resultat(int flag)

Call this method to change the behaviour of the preconditionner() method 0 - > result will not have an up - to - date virtual space.

1 - > yes it will (this must be the default value in the implementation)

References

• echange_ev_solution_

How to cite in this doc:

RST

:ref:`void Precond_base::set_echange_espace_virtuel_resultat(int flag) <public-void-precond-base-set-echange-espace-virtuel-resultat-int-flag>`

Markdown

[void Precond_base::set_echange_espace_virtuel_resultat(int flag)](#public-void-precond-base-set-echange-espace-virtuel-resultat-int-flag)

supporte_matrice_morse_sym

int Precond_base::supporte_matrice_morse_sym()

returns 1 if the implementation accepts Matrice_Morse_Sym matrices, otherwise 0.

(must be reimplemented if answer is 0)

Referenced By

• Solv_GCP::supporte_matrice_morse_sym

How to cite in this doc:

RST

:ref:`int Precond_base::supporte_matrice_morse_sym() <public-int-precond-base-supporte-matrice-morse-sym>`

Markdown

[int Precond_base::supporte_matrice_morse_sym()](#public-int-precond-base-supporte-matrice-morse-sym)

~Precond_base

Precond_base::~Precond_base() override

How to cite in this doc:

RST

:ref:`Precond_base::~Precond_base() override <public-precond-base-dtor-precond-base-override>`

Markdown

[Precond_base::~Precond_base() override](#public-precond-base-dtor-precond-base-override)

info

const Type_info * Precond_base::info()

How to cite in this doc:

RST

:ref:`const Type_info * Precond_base::info() <public-static-const-type-info-ptr-precond-base-info>`

Markdown

[const Type_info * Precond_base::info()](#public-static-const-type-info-ptr-precond-base-info)

self_cast

const Precond_base & Precond_base::self_cast(const Objet_U &)

How to cite in this doc:

RST

:ref:`const Precond_base & Precond_base::self_cast(const Objet_U &) <public-static-const-precond-base-ref-precond-base-self-cast-const-objet-u-ref>`

Markdown

[const Precond_base & Precond_base::self_cast(const Objet_U &)](#public-static-const-precond-base-ref-precond-base-self-cast-const-objet-u-ref)

self_cast

Precond_base & Precond_base::self_cast(Objet_U &)

How to cite in this doc:

RST

:ref:`Precond_base & Precond_base::self_cast(Objet_U &) <public-static-precond-base-ref-precond-base-self-cast-objet-u-ref>`

Markdown

[Precond_base & Precond_base::self_cast(Objet_U &)](#public-static-precond-base-ref-precond-base-self-cast-objet-u-ref)

preconditionner_

virtual int Precond_base::preconditionner_(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)=0

Referenced By

• preconditionner

How to cite in this doc:

RST

:ref:`virtual int Precond_base::preconditionner_(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)=0 <protected-virtual-int-precond-base-preconditionner-underscore-const-matrice-base-ref-const-doublevect-ref-src-doublevect-ref-solution-equal-0>`

Markdown

[virtual int Precond_base::preconditionner_(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)=0](#protected-virtual-int-precond-base-preconditionner-underscore-const-matrice-base-ref-const-doublevect-ref-src-doublevect-ref-solution-equal-0)

prepare_

void Precond_base::prepare_(const Matrice_Base &, const DoubleVect &)

this method must be overloaded if some preparation is necessary.

It is called after a call to reinit() and before the next call to preconditionner_() . Do not forget to call the prepare_() method of the ancestor (at the end of the routine, otherwise status will be put to READY) and use get_status() to know what should be prepared.

References

• READY

Referenced By

• prepare

• ILU_SP::prepare_

• Precond_local::prepare_

• PrecondA::prepare_

• PrecondSolv::prepare_

How to cite in this doc:

RST

:ref:`void Precond_base::prepare_(const Matrice_Base &, const DoubleVect &) <protected-void-precond-base-prepare-underscore-const-matrice-base-ref-const-doublevect-ref>`

Markdown

[void Precond_base::prepare_(const Matrice_Base &, const DoubleVect &)](#protected-void-precond-base-prepare-underscore-const-matrice-base-ref-const-doublevect-ref)

printOn

Sortie & Precond_base::printOn(Sortie &x) const override

Ecriture de l’objet sur un flot de sortie Methode a surcharger.

Reimplements:

• printOn

References

• Objet_U::que_suis_je

How to cite in this doc:

RST

:ref:`Sortie & Precond_base::printOn(Sortie &x) const override <protected-sortie-ref-precond-base-printon-sortie-ref-x-const-override>`

Markdown

[Sortie & Precond_base::printOn(Sortie &x) const override](#protected-sortie-ref-precond-base-printon-sortie-ref-x-const-override)

readOn

Entree & Precond_base::readOn(Entree &) override

Lecture d’un Objet_U sur un flot d’entree Methode a surcharger.

Reimplements:

• readOn

How to cite in this doc:

RST

:ref:`Entree & Precond_base::readOn(Entree &) override <protected-entree-ref-precond-base-readon-entree-ref-override>`

Markdown

[Entree & Precond_base::readOn(Entree &) override](#protected-entree-ref-precond-base-readon-entree-ref-override)

Attributes Documentation

info_obj (public)

const Type_info Precond_base::info_obj

echange_ev_solution_ (protected)

int Precond_base::echange_ev_solution_

status_ (private)

Init_Status Precond_base::status_

Enums

Precond_base::Init_Status

Location: trust-code/src/Kernel/Math/SolvSys/Precond_base.h:30

How to cite in this doc:

RST

:ref:`Precond\_base::Init\_Status <enum-none-precond-base-init-status>`

Markdown

[Precond\_base::Init\_Status](#enum-none-precond-base-init-status)

• READY

• REINIT_COEFF

• REINIT_ALL