Loi_Fermeture_base#

#include <Loi_Fermeture_base.h>
Brief description

: Classe de base des lois de fermetures.

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:`Loi\_Fermeture\_base <class-loi-fermeture-base>`
[Loi\_Fermeture\_base](#class-loi-fermeture-base)

Detailed description#

Cette classe calcule des champs qui peuvent dependre de plusieurs inconnues, de grandeurs physiques du milieu etc. Les champs de la classe sont rendus accessibles a tout le probleme a travers la methode get_champ() et leur mise a jour est declenchee par le probleme, apres la mise a jour du milieu et des equations.

Inherits from#

Inherited by#

Inheritance graph#

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

../../../../../_images/classLoi__Fermeture__base__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

associer_pb_base#

Definition
void Loi_Fermeture_base::associer_pb_base(const Probleme_base &)
Brief description

Cette methode est la premiere appelee par le probleme pour construire l’objet au moment ou on l’associe au probleme.

Detailed description

On verifie qu’on est pas encore associe.

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 Loi_Fermeture_base::associer_pb_base(const Probleme_base &) <loi-fermeture-base-public-void-loi-fermeture-base-associer-pb-base-const-probleme-base-ref>`
[void Loi_Fermeture_base::associer_pb_base(const Probleme_base &)](#loi-fermeture-base-public-void-loi-fermeture-base-associer-pb-base-const-probleme-base-ref)

completer#

Definition
void Loi_Fermeture_base::completer()
Brief description

Cette methode est appelee apres avoir lu toutes les equations et les lois de fermeture (tous les champs et les conditions aux limites.

Detailed description

du probleme sont disponibles)

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 Loi_Fermeture_base::completer() <loi-fermeture-base-public-void-loi-fermeture-base-completer>`
[void Loi_Fermeture_base::completer()](#loi-fermeture-base-public-void-loi-fermeture-base-completer)

creer_champ#

Definition
void Loi_Fermeture_base::creer_champ(const Motcle &motlu) 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:`void Loi_Fermeture_base::creer_champ(const Motcle &motlu) override <loi-fermeture-base-public-void-loi-fermeture-base-creer-champ-const-motcle-ref-motlu-override>`
[void Loi_Fermeture_base::creer_champ(const Motcle &motlu) override](#loi-fermeture-base-public-void-loi-fermeture-base-creer-champ-const-motcle-ref-motlu-override)

discretiser#

Definition
void Loi_Fermeture_base::discretiser(const Discretisation_base &)
Brief description

Cette methode est appelee par le probleme apres la discretisation des equations et du milieu et avant.

Detailed description

l’appel a readOn() pour lecture des parametres. Dans les classes derivees elle doit discretiser au minimum les champs qui seront requis dans le readOn() des equations ou des autres lois de fermeture.

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 Loi_Fermeture_base::discretiser(const Discretisation_base &) <loi-fermeture-base-public-void-loi-fermeture-base-discretiser-const-discretisation-base-ref>`
[void Loi_Fermeture_base::discretiser(const Discretisation_base &)](#loi-fermeture-base-public-void-loi-fermeture-base-discretiser-const-discretisation-base-ref)

get_champ#

Definition
const Champ_base & Loi_Fermeture_base::get_champ(const Motcle &nom) const override
Brief description

Cette methode renvoie le champ de nom “nom” s’il est compris par la classe, sinon appelle la methode get_champ de l’ancetre.

Detailed description

Dans la classe de base, on leve l’exception Champ_compris_erreur.

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:`const Champ_base & Loi_Fermeture_base::get_champ(const Motcle &nom) const override <loi-fermeture-base-public-const-champ-base-ref-loi-fermeture-base-get-champ-const-motcle-ref-nom-const-override>`
[const Champ_base & Loi_Fermeture_base::get_champ(const Motcle &nom) const override](#loi-fermeture-base-public-const-champ-base-ref-loi-fermeture-base-get-champ-const-motcle-ref-nom-const-override)

get_info#

Definition
const Type_info * Loi_Fermeture_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 * Loi_Fermeture_base::get_info() const override <loi-fermeture-base-public-const-type-info-ptr-loi-fermeture-base-get-info-const-override>`
[const Type_info * Loi_Fermeture_base::get_info() const override](#loi-fermeture-base-public-const-type-info-ptr-loi-fermeture-base-get-info-const-override)

get_noms_champs_postraitables#

Definition
void Loi_Fermeture_base::get_noms_champs_postraitables(Noms &nom, Option opt=NONE) const override
Brief description
Detailed description

Reimplements:

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 Loi_Fermeture_base::get_noms_champs_postraitables(Noms &nom, Option opt=NONE) const override <loi-fermeture-base-public-void-loi-fermeture-base-get-noms-champs-postraitables-noms-ref-nom-option-opt-equal-none-const-override>`
[void Loi_Fermeture_base::get_noms_champs_postraitables(Noms &nom, Option opt=NONE) const override](#loi-fermeture-base-public-void-loi-fermeture-base-get-noms-champs-postraitables-noms-ref-nom-option-opt-equal-none-const-override)

has_champ#

Definition
bool Loi_Fermeture_base::has_champ(const Motcle &nom) const override
Brief description
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:`bool Loi_Fermeture_base::has_champ(const Motcle &nom) const override <loi-fermeture-base-public-bool-loi-fermeture-base-has-champ-const-motcle-ref-nom-const-override>`
[bool Loi_Fermeture_base::has_champ(const Motcle &nom) const override](#loi-fermeture-base-public-bool-loi-fermeture-base-has-champ-const-motcle-ref-nom-const-override)

has_champ#

Definition
bool Loi_Fermeture_base::has_champ(const Motcle &nom, TRUST_Ref< Champ_base * > &ref_champ) const override
Brief description
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:`bool Loi_Fermeture_base::has_champ(const Motcle &nom, TRUST_Ref< Champ_base * > &ref_champ) const override <loi-fermeture-base-public-bool-loi-fermeture-base-has-champ-const-motcle-ref-nom-trust-ref-champ-base-ptr-ref-ref-champ-const-override>`
[bool Loi_Fermeture_base::has_champ(const Motcle &nom, TRUST_Ref< Champ_base * > &ref_champ) const override](#loi-fermeture-base-public-bool-loi-fermeture-base-has-champ-const-motcle-ref-nom-trust-ref-champ-base-ptr-ref-ref-champ-const-override)

le_nom#

Definition
const Nom & Loi_Fermeture_base::le_nom() const override
Brief description

Donne le nom de l’ Objet_U Methode a surcharger : renvoie “neant” dans cette implementation.

Detailed description

Reimplements:

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:`const Nom & Loi_Fermeture_base::le_nom() const override <loi-fermeture-base-public-const-nom-ref-loi-fermeture-base-le-nom-const-override>`
[const Nom & Loi_Fermeture_base::le_nom() const override](#loi-fermeture-base-public-const-nom-ref-loi-fermeture-base-le-nom-const-override)

Loi_Fermeture_base#

Definition
Loi_Fermeture_base::Loi_Fermeture_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:`Loi_Fermeture_base::Loi_Fermeture_base() <loi-fermeture-base-public-loi-fermeture-base-loi-fermeture-base>`
[Loi_Fermeture_base::Loi_Fermeture_base()](#loi-fermeture-base-public-loi-fermeture-base-loi-fermeture-base)

mettre_a_jour#

Definition
void Loi_Fermeture_base::mettre_a_jour(double temps)
Brief description

Cette methode est appelee par le probleme apres mettre_a_jour() des equations et du milieu.

Detailed description

Elle doit mettre a jour tous les champs qu’elle gere en fonction des autres champs du probleme.

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 Loi_Fermeture_base::mettre_a_jour(double temps) <loi-fermeture-base-public-void-loi-fermeture-base-mettre-a-jour-double-temps>`
[void Loi_Fermeture_base::mettre_a_jour(double temps)](#loi-fermeture-base-public-void-loi-fermeture-base-mettre-a-jour-double-temps)

nommer#

Definition
void Loi_Fermeture_base::nommer(const Nom &nom) override
Brief description

Donne un nom a l’ Objet_U Methode virtuelle 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:`void Loi_Fermeture_base::nommer(const Nom &nom) override <loi-fermeture-base-public-void-loi-fermeture-base-nommer-const-nom-ref-nom-override>`
[void Loi_Fermeture_base::nommer(const Nom &nom) override](#loi-fermeture-base-public-void-loi-fermeture-base-nommer-const-nom-ref-nom-override)

preparer_calcul#

Definition
void Loi_Fermeture_base::preparer_calcul()
Brief description

Cette methode est appelee par le probleme apres preparer_calcul() des equations et du milieu.

Detailed description

Elle doit mettre a jour tous les champs qu’elle gere en fonction des autres champs du probleme.

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 Loi_Fermeture_base::preparer_calcul() <loi-fermeture-base-public-void-loi-fermeture-base-preparer-calcul>`
[void Loi_Fermeture_base::preparer_calcul()](#loi-fermeture-base-public-void-loi-fermeture-base-preparer-calcul)

set_param#

Definition
void Loi_Fermeture_base::set_param(Param &param)
Brief description

Cette methode est appelee par le readOn de la classe.

Detailed description

Elle doit etre reimplementee dans les classes derivees pour ajouter dans “param” les differents parametres a lire dans le jeu de donnees et appeler la methode de l’ancetre. Dans la classe de base: aucun parametre.

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 Loi_Fermeture_base::set_param(Param &param) <loi-fermeture-base-public-void-loi-fermeture-base-set-param-param-ref-param>`
[void Loi_Fermeture_base::set_param(Param &param)](#loi-fermeture-base-public-void-loi-fermeture-base-set-param-param-ref-param)

~Loi_Fermeture_base#

Definition
Loi_Fermeture_base::~Loi_Fermeture_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:`Loi_Fermeture_base::~Loi_Fermeture_base() override <loi-fermeture-base-public-loi-fermeture-base-dtor-loi-fermeture-base-override>`
[Loi_Fermeture_base::~Loi_Fermeture_base() override](#loi-fermeture-base-public-loi-fermeture-base-dtor-loi-fermeture-base-override)

info#

Definition
const Type_info * Loi_Fermeture_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 * Loi_Fermeture_base::info() <loi-fermeture-base-public-static-const-type-info-ptr-loi-fermeture-base-info>`
[const Type_info * Loi_Fermeture_base::info()](#loi-fermeture-base-public-static-const-type-info-ptr-loi-fermeture-base-info)

self_cast#

Definition
const Loi_Fermeture_base & Loi_Fermeture_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 Loi_Fermeture_base & Loi_Fermeture_base::self_cast(const Objet_U &) <loi-fermeture-base-public-static-const-loi-fermeture-base-ref-loi-fermeture-base-self-cast-const-objet-u-ref>`
[const Loi_Fermeture_base & Loi_Fermeture_base::self_cast(const Objet_U &)](#loi-fermeture-base-public-static-const-loi-fermeture-base-ref-loi-fermeture-base-self-cast-const-objet-u-ref)

self_cast#

Definition
Loi_Fermeture_base & Loi_Fermeture_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:`Loi_Fermeture_base & Loi_Fermeture_base::self_cast(Objet_U &) <loi-fermeture-base-public-static-loi-fermeture-base-ref-loi-fermeture-base-self-cast-objet-u-ref>`
[Loi_Fermeture_base & Loi_Fermeture_base::self_cast(Objet_U &)](#loi-fermeture-base-public-static-loi-fermeture-base-ref-loi-fermeture-base-self-cast-objet-u-ref)

mon_probleme#

Definition
const Probleme_base & Loi_Fermeture_base::mon_probleme() const
Brief description

Renvoie le probleme (j’ai cree cette methode pour ne pas donner acces au probleme en ecriture par la REF)

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:`const Probleme_base & Loi_Fermeture_base::mon_probleme() const <loi-fermeture-base-protected-const-probleme-base-ref-loi-fermeture-base-mon-probleme-const>`
[const Probleme_base & Loi_Fermeture_base::mon_probleme() const](#loi-fermeture-base-protected-const-probleme-base-ref-loi-fermeture-base-mon-probleme-const)

printOn#

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

Pour l’instant, exit()

Detailed description

Reimplements:

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:`Sortie & Loi_Fermeture_base::printOn(Sortie &x) const override <loi-fermeture-base-protected-sortie-ref-loi-fermeture-base-printon-sortie-ref-x-const-override>`
[Sortie & Loi_Fermeture_base::printOn(Sortie &x) const override](#loi-fermeture-base-protected-sortie-ref-loi-fermeture-base-printon-sortie-ref-x-const-override)

readOn#

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

Cette methode appelle la methode set_param() pour initialiser les parametres, puis lit les parametres.

Detailed description

Dans l’implementation des classes derivees on peut se contenter d’appeler la methode de la classe de base et verifier les parametres.

Reimplements:

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:`Entree & Loi_Fermeture_base::readOn(Entree &) override <loi-fermeture-base-protected-entree-ref-loi-fermeture-base-readon-entree-ref-override>`
[Entree & Loi_Fermeture_base::readOn(Entree &) override](#loi-fermeture-base-protected-entree-ref-loi-fermeture-base-readon-entree-ref-override)

Attributes Documentation#

info_obj (public)
const Type_info Loi_Fermeture_base::info_obj
champs_compris_ (protected)
Champs_compris Loi_Fermeture_base::champs_compris_
status_ (protected)
Status Loi_Fermeture_base::status_
mon_probleme_ (private)
TRUST_Ref<Probleme_base *> Loi_Fermeture_base::mon_probleme_
nom_ (private)
Nom Loi_Fermeture_base::nom_

Enums#

Loi_Fermeture_base::Status#

Location: trust-code/src/Kernel/Framework/Loi_Fermeture_base.h:69

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:`Loi\_Fermeture\_base::Status <enum-none-loi-fermeture-base-status>`
[Loi\_Fermeture\_base::Status](#enum-none-loi-fermeture-base-status)
  • INITIAL

  • PB_ASSOCIE

  • DISCRETISE

  • READON_FAIT

  • COMPLET