Precond_base

Precond_base#

#include <Precond_base.h>
Brief description

How to reference this class#

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

Detailed description#

Inherits from#

Inherited by#

Inheritance graph#

If the image is too small, right-click and open in new tab

../../../../../_images/classPrecond__base__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

get_flag_updated_input#

Definition
virtual int Precond_base::get_flag_updated_input() const
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

get_info#

Definition
const Type_info * Precond_base::get_info() const override
Brief description

Donne des informations sur le type de l’ Objet_U .

Detailed description

Reimplements:

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

get_status#

Definition
Init_Status Precond_base::get_status()
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

Precond_base#

Definition
Precond_base::Precond_base()
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

preconditionner#

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

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

Detailed description
References
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

prepare#

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

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

Detailed description

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
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

reinit#

Definition
void Precond_base::reinit(Init_Status x=REINIT_ALL)
Brief description

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

Detailed description

tell the object to recompute some matrix related data.

References
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

set_echange_espace_virtuel_resultat#

Definition
void Precond_base::set_echange_espace_virtuel_resultat(int flag)
Brief description

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

Detailed description

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

References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

supporte_matrice_morse_sym#

Definition
int Precond_base::supporte_matrice_morse_sym()
Brief description

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

Detailed description

(must be reimplemented if answer is 0)

Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

~Precond_base#

Definition
Precond_base::~Precond_base() override
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

info#

Definition
const Type_info * Precond_base::info()
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

self_cast#

Definition
const Precond_base & Precond_base::self_cast(const Objet_U &)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

self_cast#

Definition
Precond_base & Precond_base::self_cast(Objet_U &)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

preconditionner_#

Definition
virtual int Precond_base::preconditionner_(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution)=0
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

prepare_#

Definition
void Precond_base::prepare_(const Matrice_Base &, const DoubleVect &)
Brief description

this method must be overloaded if some preparation is necessary.

Detailed description

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
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

printOn#

Definition
Sortie & Precond_base::printOn(Sortie &x) const override
Brief description

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

Detailed description

Reimplements:

References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

readOn#

Definition
Entree & Precond_base::readOn(Entree &) override
Brief description

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

Detailed description

Reimplements:

How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

[Entree & Precond_base::readOn(Entree &) override](#precond-base-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: Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

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

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

  • READY

  • REINIT_COEFF

  • REINIT_ALL

Contents