Schema_Phase_field

Schema_Phase_field#

#include <Schema_Phase_field.h>
Brief description

classe Schema_Phase_field

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:`Schema\_Phase\_field <class-schema-phase-field>`

[Schema\_Phase\_field](#class-schema-phase-field)

Detailed description#

Inherits from#

Inheritance graph#

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

../../../../../_images/classSchema__Phase__field__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

associer_pb#

Definition
void Schema_Phase_field::associer_pb(const Probleme_base &) 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:`void Schema_Phase_field::associer_pb(const Probleme_base &) override <schema-phase-field-public-void-schema-phase-field-associer-pb-const-probleme-base-ref-override>`

[void Schema_Phase_field::associer_pb(const Probleme_base &) override](#schema-phase-field-public-void-schema-phase-field-associer-pb-const-probleme-base-ref-override)

changer_temps_courant#

Definition
void Schema_Phase_field::changer_temps_courant(const double) override
Brief description

Appel a l’objet sous - jacent Change le temps courant.

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:`void Schema_Phase_field::changer_temps_courant(const double) override <schema-phase-field-public-void-schema-phase-field-changer-temps-courant-const-double-override>`

[void Schema_Phase_field::changer_temps_courant(const double) override](#schema-phase-field-public-void-schema-phase-field-changer-temps-courant-const-double-override)

completer#

Definition
void Schema_Phase_field::completer() override
Brief description

Complete les attributs de sch2.

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:`void Schema_Phase_field::completer() override <schema-phase-field-public-void-schema-phase-field-completer-override>`

[void Schema_Phase_field::completer() override](#schema-phase-field-public-void-schema-phase-field-completer-override)

corriger_dt_calcule#

Definition
bool Schema_Phase_field::corriger_dt_calcule(double &) const override
Brief description

Corrige le pas de temps dt_min < = dt < = dt_max.

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 Schema_Phase_field::corriger_dt_calcule(double &) const override <schema-phase-field-public-bool-schema-phase-field-corriger-dt-calcule-double-ref-const-override>`

[bool Schema_Phase_field::corriger_dt_calcule(double &) const override](#schema-phase-field-public-bool-schema-phase-field-corriger-dt-calcule-double-ref-const-override)

deuxieme_dt#

Definition
int Schema_Phase_field::deuxieme_dt(Convection_Diffusion_Phase_field &eq_c)
Brief description

Effectue le deuxieme demi - pas de temps sur l’equation de type Convection_Diffusion_Phase_field .

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 Schema_Phase_field::deuxieme_dt(Convection_Diffusion_Phase_field &eq_c) <schema-phase-field-public-int-schema-phase-field-deuxieme-dt-convection-diffusion-phase-field-ref-eq-c>`

[int Schema_Phase_field::deuxieme_dt(Convection_Diffusion_Phase_field &eq_c)](#schema-phase-field-public-int-schema-phase-field-deuxieme-dt-convection-diffusion-phase-field-ref-eq-c)

duplique#

Definition
int Schema_Phase_field::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 Schema_Phase_field::duplique() const override <schema-phase-field-public-int-schema-phase-field-duplique-const-override>`

[int Schema_Phase_field::duplique() const override](#schema-phase-field-public-int-schema-phase-field-duplique-const-override)

faire_un_pas_de_temps_C_D_Phase_field#

Definition
int Schema_Phase_field::faire_un_pas_de_temps_C_D_Phase_field(Convection_Diffusion_Phase_field &)
Brief description

Effectue un pas de temps sur l’equation de type Convection_Diffusion_Phase_field .

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 Schema_Phase_field::faire_un_pas_de_temps_C_D_Phase_field(Convection_Diffusion_Phase_field &) <schema-phase-field-public-int-schema-phase-field-faire-un-pas-de-temps-c-d-phase-field-convection-diffusion-phase-field-ref>`

[int Schema_Phase_field::faire_un_pas_de_temps_C_D_Phase_field(Convection_Diffusion_Phase_field &)](#schema-phase-field-public-int-schema-phase-field-faire-un-pas-de-temps-c-d-phase-field-convection-diffusion-phase-field-ref)

faire_un_pas_de_temps_eqn_base#

Definition
int Schema_Phase_field::faire_un_pas_de_temps_eqn_base(Equation_base &) override
Brief description

Effectue un pas de temps sur l’equation passee en parametre.

Detailed description

Le pas de temps effectue n’est pas standard si l’equation est de type Convection_Diffusion_Phase_field

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:`int Schema_Phase_field::faire_un_pas_de_temps_eqn_base(Equation_base &) override <schema-phase-field-public-int-schema-phase-field-faire-un-pas-de-temps-eqn-base-equation-base-ref-override>`

[int Schema_Phase_field::faire_un_pas_de_temps_eqn_base(Equation_base &) override](#schema-phase-field-public-int-schema-phase-field-faire-un-pas-de-temps-eqn-base-equation-base-ref-override)

get_info#

Definition
const Type_info * Schema_Phase_field::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 * Schema_Phase_field::get_info() const override <schema-phase-field-public-const-type-info-ptr-schema-phase-field-get-info-const-override>`

[const Type_info * Schema_Phase_field::get_info() const override](#schema-phase-field-public-const-type-info-ptr-schema-phase-field-get-info-const-override)

imprimer#

Definition
void Schema_Phase_field::imprimer(Sortie &) const override
Brief description

Appel a l’objet sous - jacent Imprime le schema en temp sur un flot de sortie (si il y a lieu).

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:`void Schema_Phase_field::imprimer(Sortie &) const override <schema-phase-field-public-void-schema-phase-field-imprimer-sortie-ref-const-override>`

[void Schema_Phase_field::imprimer(Sortie &) const override](#schema-phase-field-public-void-schema-phase-field-imprimer-sortie-ref-const-override)

initialize#

Definition
void Schema_Phase_field::initialize() 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:`void Schema_Phase_field::initialize() override <schema-phase-field-public-void-schema-phase-field-initialize-override>`

[void Schema_Phase_field::initialize() override](#schema-phase-field-public-void-schema-phase-field-initialize-override)

initTimeStep#

Definition
bool Schema_Phase_field::initTimeStep(double dt) 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 Schema_Phase_field::initTimeStep(double dt) override <schema-phase-field-public-bool-schema-phase-field-inittimestep-double-dt-override>`

[bool Schema_Phase_field::initTimeStep(double dt) override](#schema-phase-field-public-bool-schema-phase-field-inittimestep-double-dt-override)

iterateTimeStep#

Definition
bool Schema_Phase_field::iterateTimeStep(bool &converged) override
Brief description

faire_un_pas_de_temps_pb_base avec NS = equation(0) et CH = equation(1) Sert a calculer l’equation de Cahn - Hilliard en premier puis Navier - Stokes, en appelant

Detailed description

equation(1) d’abord puis equation(0) pour obtenir les couplages voulus. (dans le cas nb_eqn = 2)

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 Schema_Phase_field::iterateTimeStep(bool &converged) override <schema-phase-field-public-bool-schema-phase-field-iteratetimestep-bool-ref-converged-override>`

[bool Schema_Phase_field::iterateTimeStep(bool &converged) override](#schema-phase-field-public-bool-schema-phase-field-iteratetimestep-bool-ref-converged-override)

lire_motcle_non_standard#

Definition
int Schema_Phase_field::lire_motcle_non_standard(const Motcle &, Entree &) override
Brief description

Lecture du nombre d’iterations pour l’etape de relaxation du Schema_Phase_field .

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 Schema_Phase_field::lire_motcle_non_standard(const Motcle &, Entree &) override <schema-phase-field-public-int-schema-phase-field-lire-motcle-non-standard-const-motcle-ref-entree-ref-override>`

[int Schema_Phase_field::lire_motcle_non_standard(const Motcle &, Entree &) override](#schema-phase-field-public-int-schema-phase-field-lire-motcle-non-standard-const-motcle-ref-entree-ref-override)

mettre_a_jour#

Definition
int Schema_Phase_field::mettre_a_jour() override
Brief description

Mise a jour du temps courant (t + = dt) et du nombre de pas de temps effectue (nb_pas_dt_ + + ).

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 Schema_Phase_field::mettre_a_jour() override <schema-phase-field-public-int-schema-phase-field-mettre-a-jour-override>`

[int Schema_Phase_field::mettre_a_jour() override](#schema-phase-field-public-int-schema-phase-field-mettre-a-jour-override)

nb_valeurs_futures#

Definition
int Schema_Phase_field::nb_valeurs_futures() const override
Brief description

Renvoie le nombre de valeurs temporelles futures.

Detailed description

Ici : la valeur commune aux deux schemas utilises.

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 Schema_Phase_field::nb_valeurs_futures() const override <schema-phase-field-public-int-schema-phase-field-nb-valeurs-futures-const-override>`

[int Schema_Phase_field::nb_valeurs_futures() const override](#schema-phase-field-public-int-schema-phase-field-nb-valeurs-futures-const-override)

nb_valeurs_temporelles#

Definition
int Schema_Phase_field::nb_valeurs_temporelles() const override
Brief description

Renvoie le nombre de valeurs temporelles a conserver.

Detailed description

Ici : le max des deux schemas utilises.

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 Schema_Phase_field::nb_valeurs_temporelles() const override <schema-phase-field-public-int-schema-phase-field-nb-valeurs-temporelles-const-override>`

[int Schema_Phase_field::nb_valeurs_temporelles() const override](#schema-phase-field-public-int-schema-phase-field-nb-valeurs-temporelles-const-override)

premier_dt#

Definition
int Schema_Phase_field::premier_dt(Convection_Diffusion_Phase_field &eq_c)
Brief description

Effectue le premier demi - pas de temps1 sur l’equation de type Convection_Diffusion_Phase_field .

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 Schema_Phase_field::premier_dt(Convection_Diffusion_Phase_field &eq_c) <schema-phase-field-public-int-schema-phase-field-premier-dt-convection-diffusion-phase-field-ref-eq-c>`

[int Schema_Phase_field::premier_dt(Convection_Diffusion_Phase_field &eq_c)](#schema-phase-field-public-int-schema-phase-field-premier-dt-convection-diffusion-phase-field-ref-eq-c)

Schema_Phase_field#

Definition
Schema_Phase_field::Schema_Phase_field()
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:`Schema_Phase_field::Schema_Phase_field() <schema-phase-field-public-schema-phase-field-schema-phase-field>`

[Schema_Phase_field::Schema_Phase_field()](#schema-phase-field-public-schema-phase-field-schema-phase-field)

set_param#

Definition
void Schema_Phase_field::set_param(Param &titi) 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:`void Schema_Phase_field::set_param(Param &titi) override <schema-phase-field-public-void-schema-phase-field-set-param-param-ref-titi-override>`

[void Schema_Phase_field::set_param(Param &titi) override](#schema-phase-field-public-void-schema-phase-field-set-param-param-ref-titi-override)

stop#

Definition
int Schema_Phase_field::stop() const override
Brief description

Appel a l’objet sous - jacent Renvoie 1 si il y lieu de stopper le calcul pour differente raisons:

Detailed description

  • le temps final est atteint - le nombre de pas de temps maximum est depasse-l’etat stationnaire est atteint - indicateur d’arret fichier Renvoie 0 sinon

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 Schema_Phase_field::stop() const override <schema-phase-field-public-int-schema-phase-field-stop-const-override>`

[int Schema_Phase_field::stop() const override](#schema-phase-field-public-int-schema-phase-field-stop-const-override)

taille_memoire#

Definition
unsigned Schema_Phase_field::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 Schema_Phase_field::taille_memoire() const override <schema-phase-field-public-unsigned-schema-phase-field-taille-memoire-const-override>`

[unsigned Schema_Phase_field::taille_memoire() const override](#schema-phase-field-public-unsigned-schema-phase-field-taille-memoire-const-override)

temps_defaut#

Definition
double Schema_Phase_field::temps_defaut() const override
Brief description

Renvoie le le temps le temps que doivent rendre les champs a l’appel de valeurs()

Detailed description

Ici : la valeur commune aux deux schemas utilises.

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:`double Schema_Phase_field::temps_defaut() const override <schema-phase-field-public-double-schema-phase-field-temps-defaut-const-override>`

[double Schema_Phase_field::temps_defaut() const override](#schema-phase-field-public-double-schema-phase-field-temps-defaut-const-override)

temps_futur#

Definition
double Schema_Phase_field::temps_futur(int i) const override
Brief description

Renvoie le le temps a la i - eme valeur future.

Detailed description

Ici : la valeur commune aux deux schemas utilises.

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:`double Schema_Phase_field::temps_futur(int i) const override <schema-phase-field-public-double-schema-phase-field-temps-futur-int-i-const-override>`

[double Schema_Phase_field::temps_futur(int i) const override](#schema-phase-field-public-double-schema-phase-field-temps-futur-int-i-const-override)

valeur_temps_intermediaire#

Definition
const DoubleTab & Schema_Phase_field::valeur_temps_intermediaire() const
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 DoubleTab & Schema_Phase_field::valeur_temps_intermediaire() const <schema-phase-field-public-const-doubletab-ref-schema-phase-field-valeur-temps-intermediaire-const>`

[const DoubleTab & Schema_Phase_field::valeur_temps_intermediaire() const](#schema-phase-field-public-const-doubletab-ref-schema-phase-field-valeur-temps-intermediaire-const)

~Schema_Phase_field#

Definition
Schema_Phase_field::~Schema_Phase_field()
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:`Schema_Phase_field::~Schema_Phase_field() <schema-phase-field-public-schema-phase-field-dtor-schema-phase-field>`

[Schema_Phase_field::~Schema_Phase_field()](#schema-phase-field-public-schema-phase-field-dtor-schema-phase-field)

cree_instance#

Definition
Objet_U * Schema_Phase_field::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 * Schema_Phase_field::cree_instance() <schema-phase-field-public-static-objet-u-ptr-schema-phase-field-cree-instance>`

[Objet_U * Schema_Phase_field::cree_instance()](#schema-phase-field-public-static-objet-u-ptr-schema-phase-field-cree-instance)

info#

Definition
const Type_info * Schema_Phase_field::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 * Schema_Phase_field::info() <schema-phase-field-public-static-const-type-info-ptr-schema-phase-field-info>`

[const Type_info * Schema_Phase_field::info()](#schema-phase-field-public-static-const-type-info-ptr-schema-phase-field-info)

self_cast#

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

[const Schema_Phase_field & Schema_Phase_field::self_cast(const Objet_U &)](#schema-phase-field-public-static-const-schema-phase-field-ref-schema-phase-field-self-cast-const-objet-u-ref)

self_cast#

Definition
Schema_Phase_field & Schema_Phase_field::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:`Schema_Phase_field & Schema_Phase_field::self_cast(Objet_U &) <schema-phase-field-public-static-schema-phase-field-ref-schema-phase-field-self-cast-objet-u-ref>`

[Schema_Phase_field & Schema_Phase_field::self_cast(Objet_U &)](#schema-phase-field-public-static-schema-phase-field-ref-schema-phase-field-self-cast-objet-u-ref)

printOn#

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

Simple appel a: Schema_Temps_base::printOn(Sortie& ) Ecrit le schema en temps sur un flot de sortie.

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 & Schema_Phase_field::printOn(Sortie &x) const override <schema-phase-field-protected-sortie-ref-schema-phase-field-printon-sortie-ref-x-const-override>`

[Sortie & Schema_Phase_field::printOn(Sortie &x) const override](#schema-phase-field-protected-sortie-ref-schema-phase-field-printon-sortie-ref-x-const-override)

readOn#

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

Lit le schema en temps a partir d’un flot d’entree.

Detailed description

Simple appel a: Schema_Temps_base::readOn(Entree& )

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 & Schema_Phase_field::readOn(Entree &) override <schema-phase-field-protected-entree-ref-schema-phase-field-readon-entree-ref-override>`

[Entree & Schema_Phase_field::readOn(Entree &) override](#schema-phase-field-protected-entree-ref-schema-phase-field-readon-entree-ref-override)

Attributes Documentation#

info_obj (public)
const Type_info Schema_Phase_field::info_obj
nb_iterations_relax_ (protected)
int Schema_Phase_field::nb_iterations_relax_
sch2 (protected)
TRUST_Deriv<Schema_Temps_base> Schema_Phase_field::sch2
sch3 (protected)
TRUST_Deriv<Schema_Temps_base> Schema_Phase_field::sch3
Contents