SSOR

SSOR#

#include <SSOR.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:`SSOR <class-ssor>`

[SSOR](#class-ssor)

Detailed description#

Inherits from#

Inheritance graph#

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

../../../../../_images/classSSOR__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

duplique#

Definition
int SSOR::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 SSOR::duplique() const override <ssor-public-int-ssor-duplique-const-override>`

[int SSOR::duplique() const override](#ssor-public-int-ssor-duplique-const-override)

get_flag_updated_input#

Definition
int SSOR::get_flag_updated_input() 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 SSOR::get_flag_updated_input() const override <ssor-public-int-ssor-get-flag-updated-input-const-override>`

[int SSOR::get_flag_updated_input() const override](#ssor-public-int-ssor-get-flag-updated-input-const-override)

get_info#

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

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

get_omega#

Definition
double SSOR::get_omega()
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:`double SSOR::get_omega() <ssor-public-double-ssor-get-omega>`

[double SSOR::get_omega()](#ssor-public-double-ssor-get-omega)

set_omega#

Definition
void SSOR::set_omega(double x)
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:`void SSOR::set_omega(double x) <ssor-public-void-ssor-set-omega-double-x>`

[void SSOR::set_omega(double x)](#ssor-public-void-ssor-set-omega-double-x)

SSOR#

Definition
SSOR::SSOR()
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:`SSOR::SSOR() <ssor-public-ssor-ssor>`

[SSOR::SSOR()](#ssor-public-ssor-ssor)

taille_memoire#

Definition
unsigned SSOR::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 SSOR::taille_memoire() const override <ssor-public-unsigned-ssor-taille-memoire-const-override>`

[unsigned SSOR::taille_memoire() const override](#ssor-public-unsigned-ssor-taille-memoire-const-override)

~SSOR#

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

[SSOR::~SSOR()](#ssor-public-ssor-dtor-ssor)

cree_instance#

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

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

info#

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

[const Type_info * SSOR::info()](#ssor-public-static-const-type-info-ptr-ssor-info)

self_cast#

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

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

self_cast#

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

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

preconditionner_#

Definition
int SSOR::preconditionner_(const Matrice_Base &, const DoubleVect &secmem, DoubleVect &solution) override
Brief description

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

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

[int SSOR::preconditionner_(const Matrice_Base &, const DoubleVect &secmem, DoubleVect &solution) override](#ssor-protected-int-ssor-preconditionner-underscore-const-matrice-base-ref-const-doublevect-ref-secmem-doublevect-ref-solution-override)

prepare_#

Definition
void SSOR::prepare_(const Matrice_Base &, const DoubleVect &secmem) 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 SSOR::prepare_(const Matrice_Base &, const DoubleVect &secmem) override <ssor-protected-void-ssor-prepare-underscore-const-matrice-base-ref-const-doublevect-ref-secmem-override>`

[void SSOR::prepare_(const Matrice_Base &, const DoubleVect &secmem) override](#ssor-protected-void-ssor-prepare-underscore-const-matrice-base-ref-const-doublevect-ref-secmem-override)

printOn#

Definition
Sortie & SSOR::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 & SSOR::printOn(Sortie &x) const override <ssor-protected-sortie-ref-ssor-printon-sortie-ref-x-const-override>`

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

readOn#

Definition
Entree & SSOR::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 & SSOR::readOn(Entree &) override <ssor-protected-entree-ref-ssor-readon-entree-ref-override>`

[Entree & SSOR::readOn(Entree &) override](#ssor-protected-entree-ref-ssor-readon-entree-ref-override)

ssor#

Definition
void SSOR::ssor(const Matrice_Bloc_Sym &, DoubleVect &)
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:`void SSOR::ssor(const Matrice_Bloc_Sym &, DoubleVect &) <ssor-protected-void-ssor-ssor-const-matrice-bloc-sym-ref-doublevect-ref>`

[void SSOR::ssor(const Matrice_Bloc_Sym &, DoubleVect &)](#ssor-protected-void-ssor-ssor-const-matrice-bloc-sym-ref-doublevect-ref)

ssor#

Definition
void SSOR::ssor(const Matrice_Morse_Sym &, DoubleVect &)
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 SSOR::ssor(const Matrice_Morse_Sym &, DoubleVect &) <ssor-protected-void-ssor-ssor-const-matrice-morse-sym-ref-doublevect-ref>`

[void SSOR::ssor(const Matrice_Morse_Sym &, DoubleVect &)](#ssor-protected-void-ssor-ssor-const-matrice-morse-sym-ref-doublevect-ref)

Attributes Documentation#

info_obj (public)
const Type_info SSOR::info_obj
algo_fortran_ (protected)
int SSOR::algo_fortran_
algo_items_communs_ (protected)
int SSOR::algo_items_communs_
avec_assert_ (protected)
int SSOR::avec_assert_
items_a_traiter_ (protected)
IntTab SSOR::items_a_traiter_
line_size_ (protected)
int SSOR::line_size_
md_secmem_ (protected)
MD_Vector SSOR::md_secmem_
omega_ (protected)
double SSOR::omega_
omega_diag_ (protected)
ArrOfDouble SSOR::omega_diag_
Contents