Force_ph

Force_ph#

#include <Force_ph.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:`Force\_ph <class-force-ph>`

[Force\_ph](#class-force-ph)

Detailed description#

Inherits from#

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

Complete Member Function Documentation#

cheat_function#

Definition
void Force_ph::cheat_function()
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:`void Force_ph::cheat_function() <force-ph-public-void-force-ph-cheat-function>`

[void Force_ph::cheat_function()](#force-ph-public-void-force-ph-cheat-function)

compute_energie#

Definition
void Force_ph::compute_energie()
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:`void Force_ph::compute_energie() <force-ph-public-void-force-ph-compute-energie>`

[void Force_ph::compute_energie()](#force-ph-public-void-force-ph-compute-energie)

duplique#

Definition
int Force_ph::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 Force_ph::duplique() const override <force-ph-public-int-force-ph-duplique-const-override>`

[int Force_ph::duplique() const override](#force-ph-public-int-force-ph-duplique-const-override)

Force_ph#

Definition
Force_ph::Force_ph()
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:`Force_ph::Force_ph() <force-ph-public-force-ph-force-ph>`

[Force_ph::Force_ph()](#force-ph-public-force-ph-force-ph)

from_spect_to_phys2#

Definition
void Force_ph::from_spect_to_phys2(const std::vector< double > &coeff_force)
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:`void Force_ph::from_spect_to_phys2(const std::vector< double > &coeff_force) <force-ph-public-void-force-ph-from-spect-to-phys2-const-std-vector-double-ref-coeff-force>`

[void Force_ph::from_spect_to_phys2(const std::vector< double > &coeff_force)](#force-ph-public-void-force-ph-from-spect-to-phys2-const-std-vector-double-ref-coeff-force)

from_spect_to_phys_bis#

Definition
void Force_ph::from_spect_to_phys_bis(const std::vector< std::vector< std::vector< double > > > &coeff_force)
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:`void Force_ph::from_spect_to_phys_bis(const std::vector< std::vector< std::vector< double > > > &coeff_force) <force-ph-public-void-force-ph-from-spect-to-phys-bis-const-std-vector-std-vector-std-vector-double-ref-coeff-force>`

[void Force_ph::from_spect_to_phys_bis(const std::vector< std::vector< std::vector< double > > > &coeff_force)](#force-ph-public-void-force-ph-from-spect-to-phys-bis-const-std-vector-std-vector-std-vector-double-ref-coeff-force)

from_spect_to_phys_opti2#

Definition
void Force_ph::from_spect_to_phys_opti2(ArrOfDouble &coeff_force)
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 Force_ph::from_spect_to_phys_opti2(ArrOfDouble &coeff_force) <force-ph-public-void-force-ph-from-spect-to-phys-opti2-arrofdouble-ref-coeff-force>`

[void Force_ph::from_spect_to_phys_opti2(ArrOfDouble &coeff_force)](#force-ph-public-void-force-ph-from-spect-to-phys-opti2-arrofdouble-ref-coeff-force)

from_spect_to_phys_opti2_advection#

Definition
void Force_ph::from_spect_to_phys_opti2_advection(ArrOfDouble &coeff_force, const ArrOfDouble &advection_length)
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 Force_ph::from_spect_to_phys_opti2_advection(ArrOfDouble &coeff_force, const ArrOfDouble &advection_length) <force-ph-public-void-force-ph-from-spect-to-phys-opti2-advection-arrofdouble-ref-coeff-force-const-arrofdouble-ref-advection-length>`

[void Force_ph::from_spect_to_phys_opti2_advection(ArrOfDouble &coeff_force, const ArrOfDouble &advection_length)](#force-ph-public-void-force-ph-from-spect-to-phys-opti2-advection-arrofdouble-ref-coeff-force-const-arrofdouble-ref-advection-length)

gbz_gather#

Definition
void Force_ph::gbz_gather(IJK_Field_vector3_double force_)
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:`void Force_ph::gbz_gather(IJK_Field_vector3_double force_) <force-ph-public-void-force-ph-gbz-gather-ijk-field-vector3-double-force>`

[void Force_ph::gbz_gather(IJK_Field_vector3_double force_)](#force-ph-public-void-force-ph-gbz-gather-ijk-field-vector3-double-force)

get_energie#

Definition
double Force_ph::get_energie()
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:`double Force_ph::get_energie() <force-ph-public-double-force-ph-get-energie>`

[double Force_ph::get_energie()](#force-ph-public-double-force-ph-get-energie)

get_force_attribute#

Definition
IJK_Field_vector3_double Force_ph::get_force_attribute()
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:`IJK_Field_vector3_double Force_ph::get_force_attribute() <force-ph-public-ijk-field-vector3-double-force-ph-get-force-attribute>`

[IJK_Field_vector3_double Force_ph::get_force_attribute()](#force-ph-public-ijk-field-vector3-double-force-ph-get-force-attribute)

get_force_attribute2#

Definition
IJK_Field_vector3_double & Force_ph::get_force_attribute2()
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:`IJK_Field_vector3_double & Force_ph::get_force_attribute2() <force-ph-public-ijk-field-vector3-double-ref-force-ph-get-force-attribute2>`

[IJK_Field_vector3_double & Force_ph::get_force_attribute2()](#force-ph-public-ijk-field-vector3-double-ref-force-ph-get-force-attribute2)

get_info#

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

[const Type_info * Force_ph::get_info() const override](#force-ph-public-const-type-info-ptr-force-ph-get-info-const-override)

initialise#

Definition
void Force_ph::initialise(int nproc_tot, int ni, int nj, int nk, int nl, int nm, int nn, double Lx, double Ly, double Lz, double Ox, double Oy, double Oz, int momin, int momax, double kmin, double kmax, std::string nom_fichier, const Domaine_IJK &splitting, int a_i_offset, int a_j_offset, int a_k_offset)
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 Force_ph::initialise(int nproc_tot, int ni, int nj, int nk, int nl, int nm, int nn, double Lx, double Ly, double Lz, double Ox, double Oy, double Oz, int momin, int momax, double kmin, double kmax, std::string nom_fichier, const Domaine_IJK &splitting, int a_i_offset, int a_j_offset, int a_k_offset) <force-ph-public-void-force-ph-initialise-int-nproc-tot-int-ni-int-nj-int-nk-int-nl-int-nm-int-nn-double-lx-double-ly-double-lz-double-ox-double-oy-double-oz-int-momin-int-momax-double-kmin-double-kmax-std-string-nom-fichier-const-domaine-ijk-ref-splitting-int-a-i-offset-int-a-j-offset-int-a-k-offset>`

[void Force_ph::initialise(int nproc_tot, int ni, int nj, int nk, int nl, int nm, int nn, double Lx, double Ly, double Lz, double Ox, double Oy, double Oz, int momin, int momax, double kmin, double kmax, std::string nom_fichier, const Domaine_IJK &splitting, int a_i_offset, int a_j_offset, int a_k_offset)](#force-ph-public-void-force-ph-initialise-int-nproc-tot-int-ni-int-nj-int-nk-int-nl-int-nm-int-nn-double-lx-double-ly-double-lz-double-ox-double-oy-double-oz-int-momin-int-momax-double-kmin-double-kmax-std-string-nom-fichier-const-domaine-ijk-ref-splitting-int-a-i-offset-int-a-j-offset-int-a-k-offset)

set_zero#

Definition
void Force_ph::set_zero()
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:`void Force_ph::set_zero() <force-ph-public-void-force-ph-set-zero>`

[void Force_ph::set_zero()](#force-ph-public-void-force-ph-set-zero)

taille_memoire#

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

[unsigned Force_ph::taille_memoire() const override](#force-ph-public-unsigned-force-ph-taille-memoire-const-override)

write#

Definition
void Force_ph::write(std::string nom_fichier_sortie, double t)
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:`void Force_ph::write(std::string nom_fichier_sortie, double t) <force-ph-public-void-force-ph-write-std-string-nom-fichier-sortie-double-t>`

[void Force_ph::write(std::string nom_fichier_sortie, double t)](#force-ph-public-void-force-ph-write-std-string-nom-fichier-sortie-double-t)

write_offset_index_position#

Definition
void Force_ph::write_offset_index_position(const Domaine_IJK &my_splitting)
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 Force_ph::write_offset_index_position(const Domaine_IJK &my_splitting) <force-ph-public-void-force-ph-write-offset-index-position-const-domaine-ijk-ref-my-splitting>`

[void Force_ph::write_offset_index_position(const Domaine_IJK &my_splitting)](#force-ph-public-void-force-ph-write-offset-index-position-const-domaine-ijk-ref-my-splitting)

write_separate#

Definition
void Force_ph::write_separate(std::string nom_fichier_sortie, double t)
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:`void Force_ph::write_separate(std::string nom_fichier_sortie, double t) <force-ph-public-void-force-ph-write-separate-std-string-nom-fichier-sortie-double-t>`

[void Force_ph::write_separate(std::string nom_fichier_sortie, double t)](#force-ph-public-void-force-ph-write-separate-std-string-nom-fichier-sortie-double-t)

~Force_ph#

Definition
Force_ph::~Force_ph()
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:`Force_ph::~Force_ph() <force-ph-public-force-ph-dtor-force-ph>`

[Force_ph::~Force_ph()](#force-ph-public-force-ph-dtor-force-ph)

cree_instance#

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

[Objet_U * Force_ph::cree_instance()](#force-ph-public-static-objet-u-ptr-force-ph-cree-instance)

info#

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

[const Type_info * Force_ph::info()](#force-ph-public-static-const-type-info-ptr-force-ph-info)

self_cast#

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

[const Force_ph & Force_ph::self_cast(const Objet_U &)](#force-ph-public-static-const-force-ph-ref-force-ph-self-cast-const-objet-u-ref)

self_cast#

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

[Force_ph & Force_ph::self_cast(Objet_U &)](#force-ph-public-static-force-ph-ref-force-ph-self-cast-objet-u-ref)

printOn#

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

[Sortie & Force_ph::printOn(Sortie &x) const override](#force-ph-protected-sortie-ref-force-ph-printon-sortie-ref-x-const-override)

readOn#

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

[Entree & Force_ph::readOn(Entree &) override](#force-ph-protected-entree-ref-force-ph-readon-entree-ref-override)

Attributes Documentation#

info_obj (public)
const Type_info Force_ph::info_obj
energie (private)
double Force_ph::energie = 0.
force (private)
std::vector<std::vector<std:: vector <double>>> Force_ph::force
force_ (private)
IJK_Field_vector3_double Force_ph::force_
i_offset (private)
int Force_ph::i_offset = 0
j_offset (private)
int Force_ph::j_offset = 0
k_offset (private)
int Force_ph::k_offset = 0
kmax (private)
double Force_ph::kmax = 0.
kmin (private)
double Force_ph::kmin = 0.
Lx (private)
double Force_ph::Lx = 0.
Ly (private)
double Force_ph::Ly = 0.
Lz (private)
double Force_ph::Lz = 0.
momax (private)
int Force_ph::momax = 0
momin (private)
int Force_ph::momin = 0
n_ijk (private)
int Force_ph::n_ijk = 0
n_lmn (private)
int Force_ph::n_lmn = 0
ni (private)
int Force_ph::ni = 0
nj (private)
int Force_ph::nj = 0
nk (private)
int Force_ph::nk = 0
nl (private)
int Force_ph::nl = 0
nm (private)
int Force_ph::nm = 0
nn (private)
int Force_ph::nn = 0
nproc_i (private)
int Force_ph::nproc_i = 0
nproc_j (private)
int Force_ph::nproc_j = 0
nproc_k (private)
int Force_ph::nproc_k = 0
nproc_tot (private)
int Force_ph::nproc_tot = 0
Ox (private)
double Force_ph::Ox = 0.
Oy (private)
double Force_ph::Oy = 0.
Oz (private)
double Force_ph::Oz = 0.
Contents