PrecondA

PrecondA#

#include <PrecondA.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:`PrecondA <class-preconda>`

[PrecondA](#class-preconda)

Detailed description#

Inherits from#

Inheritance graph#

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

../../../../../_images/classPrecondA__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

duplique#

Definition
int PrecondA::duplique() const override
Brief description
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:`int PrecondA::duplique() const override <preconda-public-int-preconda-duplique-const-override>`

[int PrecondA::duplique() const override](#preconda-public-int-preconda-duplique-const-override)

get_info#

Definition
const Type_info * PrecondA::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 * PrecondA::get_info() const override <preconda-public-const-type-info-ptr-preconda-get-info-const-override>`

[const Type_info * PrecondA::get_info() const override](#preconda-public-const-type-info-ptr-preconda-get-info-const-override)

PrecondA#

Definition
PrecondA::PrecondA()
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:`PrecondA::PrecondA() <preconda-public-preconda-preconda>`

[PrecondA::PrecondA()](#preconda-public-preconda-preconda)

supporte_matrice_morse_sym#

Definition
int PrecondA::supporte_matrice_morse_sym() override
Brief description

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

Detailed description

(must be reimplemented if answer is 0)

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:`int PrecondA::supporte_matrice_morse_sym() override <preconda-public-int-preconda-supporte-matrice-morse-sym-override>`

[int PrecondA::supporte_matrice_morse_sym() override](#preconda-public-int-preconda-supporte-matrice-morse-sym-override)

taille_memoire#

Definition
unsigned PrecondA::taille_memoire() const override
Brief description
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:`unsigned PrecondA::taille_memoire() const override <preconda-public-unsigned-preconda-taille-memoire-const-override>`

[unsigned PrecondA::taille_memoire() const override](#preconda-public-unsigned-preconda-taille-memoire-const-override)

~PrecondA#

Definition
PrecondA::~PrecondA()
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:`PrecondA::~PrecondA() <preconda-public-preconda-dtor-preconda>`

[PrecondA::~PrecondA()](#preconda-public-preconda-dtor-preconda)

cree_instance#

Definition
Objet_U * PrecondA::cree_instance()
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:`Objet_U * PrecondA::cree_instance() <preconda-public-static-objet-u-ptr-preconda-cree-instance>`

[Objet_U * PrecondA::cree_instance()](#preconda-public-static-objet-u-ptr-preconda-cree-instance)

info#

Definition
const Type_info * PrecondA::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 * PrecondA::info() <preconda-public-static-const-type-info-ptr-preconda-info>`

[const Type_info * PrecondA::info()](#preconda-public-static-const-type-info-ptr-preconda-info)

self_cast#

Definition
const PrecondA & PrecondA::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 PrecondA & PrecondA::self_cast(const Objet_U &) <preconda-public-static-const-preconda-ref-preconda-self-cast-const-objet-u-ref>`

[const PrecondA & PrecondA::self_cast(const Objet_U &)](#preconda-public-static-const-preconda-ref-preconda-self-cast-const-objet-u-ref)

self_cast#

Definition
PrecondA & PrecondA::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:`PrecondA & PrecondA::self_cast(Objet_U &) <preconda-public-static-preconda-ref-preconda-self-cast-objet-u-ref>`

[PrecondA & PrecondA::self_cast(Objet_U &)](#preconda-public-static-preconda-ref-preconda-self-cast-objet-u-ref)

preconditionner_#

Definition
int PrecondA::preconditionner_(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution) override
Brief description

Calcule la solution du systeme lineaire: A * solution = b avec la methode de relaxation PrecondA .

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:`int PrecondA::preconditionner_(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution) override <preconda-protected-int-preconda-preconditionner-underscore-const-matrice-base-ref-const-doublevect-ref-src-doublevect-ref-solution-override>`

[int PrecondA::preconditionner_(const Matrice_Base &, const DoubleVect &src, DoubleVect &solution) override](#preconda-protected-int-preconda-preconditionner-underscore-const-matrice-base-ref-const-doublevect-ref-src-doublevect-ref-solution-override)

prepare_#

Definition
void PrecondA::prepare_(const Matrice_Base &, const DoubleVect &src) override
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.

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:`void PrecondA::prepare_(const Matrice_Base &, const DoubleVect &src) override <preconda-protected-void-preconda-prepare-underscore-const-matrice-base-ref-const-doublevect-ref-src-override>`

[void PrecondA::prepare_(const Matrice_Base &, const DoubleVect &src) override](#preconda-protected-void-preconda-prepare-underscore-const-matrice-base-ref-const-doublevect-ref-src-override)

printOn#

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

Ecriture de l’objet sur un flot de sortie 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:`Sortie & PrecondA::printOn(Sortie &x) const override <preconda-protected-sortie-ref-preconda-printon-sortie-ref-x-const-override>`

[Sortie & PrecondA::printOn(Sortie &x) const override](#preconda-protected-sortie-ref-preconda-printon-sortie-ref-x-const-override)

readOn#

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

Lecture d’un Objet_U sur un flot d’entree 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:`Entree & PrecondA::readOn(Entree &) override <preconda-protected-entree-ref-preconda-readon-entree-ref-override>`

[Entree & PrecondA::readOn(Entree &) override](#preconda-protected-entree-ref-preconda-readon-entree-ref-override)

set_param#

Definition
void PrecondA::set_param(Param &param)
Brief description
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:`void PrecondA::set_param(Param &param) <preconda-protected-void-preconda-set-param-param-ref-param>`

[void PrecondA::set_param(Param &param)](#preconda-protected-void-preconda-set-param-param-ref-param)

Attributes Documentation#

info_obj (public)
const Type_info PrecondA::info_obj
alpha_0 (protected)
double PrecondA::alpha_0 = - 100.
alpha_1 (protected)
double PrecondA::alpha_1 = - 100.
alpha_a (protected)
double PrecondA::alpha_a = - 100.
le_precond_0 (protected)
TRUST_Deriv<Precond_base> PrecondA::le_precond_0
le_precond_1 (protected)
TRUST_Deriv<Precond_base> PrecondA::le_precond_1
le_precond_a (protected)
TRUST_Deriv<Precond_base> PrecondA::le_precond_a
Contents