Champ_Generique_base

Champ_Generique_base#

#include <Champ_Generique_base.h>

class Champ_Generique_base

How to cite this class in this doc#

RST

:ref:`Champ\_Generique\_base <class-champ-generique-base>`

Markdown

[Champ\_Generique\_base](#class-champ-generique-base)

Detailed description#

Classe de base des champs generiques pour importation d un champ discret et actions elementaires sur ce champ (postraitement, etc) Attention: toutes les methodes sont PARALLELES, il faut les appeler simultanement sur tous les processeurs (get_domain() peut par exemple construire le domaine parallele avant de le renvoyer).

Inherits from#

public : Objet_U

Inherited by#

public : Champ_Gen_de_Champs_Gen
public : Champ_Generique_refChamp

List of Protected Methods#

printOn
readOn

List of Protected Static Methods#

assert_parallel

Complete Member Function Documentation#

Champ_Generique_base

Champ_Generique_base::Champ_Generique_base()

completer

virtual void Champ_Generique_base::completer(const Postraitement_base &post)=0

comprend_champ_post

int Champ_Generique_base::comprend_champ_post(const Motcle &identifiant) const

data_a_sauvegarder

virtual std::vector<YAML_data> Champ_Generique_base::data_a_sauvegarder() const

fixer_identifiant_appel

void Champ_Generique_base::fixer_identifiant_appel(const Nom &identifiant)

get_champ

virtual const Champ_base & Champ_Generique_base::get_champ(TRUST_Deriv< Champ_base > &espace_stockage) const =0

get_champ_post

const Champ_Generique_base & Champ_Generique_base::get_champ_post(const Motcle &nom) const

get_champ_without_evaluation

virtual const Champ_base & Champ_Generique_base::get_champ_without_evaluation(TRUST_Deriv< Champ_base > &espace_stockage) const =0

get_copy_connectivity

void Champ_Generique_base::get_copy_connectivity(Entity index1, Entity index2, IntTab &) const

get_copy_coordinates

void Champ_Generique_base::get_copy_coordinates(DoubleTab &) const

get_copy_domain

void Champ_Generique_base::get_copy_domain(Domaine &) const

Cree une copie du domaine sur lequel sera evalue l espace de stockage.

Par defaut le domaine associe au probleme.

get_copy_values

void Champ_Generique_base::get_copy_values(DoubleTab &) const

Remplit le tableau values avec les valeurs discretes du champ (cree une copie).

Exceptions:

get_dimension

int Champ_Generique_base::get_dimension() const

Renvoie la dimension de l’espace dans lequel le champ est defini.

Il s’agit du nombre de composantes des coordonnees qu’il faut fournir dans get_xyz_values. (par exemple, un champ defini sur une surface peut etre de dimension 3 si les coordonnees des sommets sont 3D, ou de dimension 2 s’il s’agit de coordonnees curvilignes le long de la surface)

get_directive_pour_discr

const Motcle Champ_Generique_base::get_directive_pour_discr() const

Renvoie la directive (champ_elem, champ_sommets, champ_face ou pression) pour lancer la discretisation de l espace de stockage rendu par get_champ()

get_discretisation

const Discretisation_base & Champ_Generique_base::get_discretisation() const

Renvoie la discretisation associee au probleme.

get_info

const Type_info * Champ_Generique_base::get_info() const override

Donne des informations sur le type de l’ Objet_U .

Reimplements:

get_info

get_info_type_post

virtual int Champ_Generique_base::get_info_type_post() const =0

get_localisation

Entity Champ_Generique_base::get_localisation(const int index=-1) const

Renvoie le type des entites geometriques sur auxquelles les valeurs discretes sont attachees (NODE pour un champ P1, FACE pour un champ P1NC, ELEMENT pour un.

champ P0, etc). Il est conseille d’utiliser la syntaxe get_localisation() sans parametre, sauf si on sait quoi faire pour les champs multi - supports.

get_nb_localisations

int Champ_Generique_base::get_nb_localisations() const

get_nom_post

const Nom & Champ_Generique_base::get_nom_post() const

get_property

const Noms Champ_Generique_base::get_property(const Motcle &query) const

Renvoie la propriete demandee.

Exemples: “DISCRETISATION” : type du champ discret (P0, P1, P1NC, etc…) “ELEMENT_TYPE” : type de l’element de plus grande dimension ({TRIANGLE}, {TETRAHEDRA}, {QUAD}, {HEXA}, etc) “DYNAMIC_MESH” : le maillage est - il dynamique ou pas ({STATIC}, {DYNAMIC}) “NAME” : nom du champ “COMPONENT_NAMES” : nom des composantes du champ ({K,EPSILON} ou {VITESSE_X,VITESSE_Y,VITESSE_Z}) “BOUNDARY_NAMES” : nom des bords “COORDINATES” : systeme de coordonnees des noeuds ({X}, {X,Y}, {X,Y,Z}, {R,THETA}, etc…) Exceptions:

get_property_names

void Champ_Generique_base::get_property_names(Motcles &list) const

Renvoie la liste des “query” possibles pour le champ.

get_ref_connectivity

const IntTab & Champ_Generique_base::get_ref_connectivity(Entity index1, Entity index2) const

Renvoie le tableau de connectivite entre l’entite geometrique index1 et l’entite index2.

Par exemple get_ref_connectivity(ELEM, NODE) = Domaine::mes_elems get_ref_connectivity(ELEM, FACE) = DomaineVF::elem_faces_ get_ref_connectivity(FACE, ELEM) = DomaineVF::face_voisins_ Le tableau a toujours deux dimensions : dimension(0) = nombre d’entites “index1” reelles dimension(1) = nombre d’entites “index2” connectees a chaque entite “index1” En parallele, le tableau est un tableau distribue avec items communs Exceptions:

get_ref_coordinates

const DoubleTab & Champ_Generique_base::get_ref_coordinates() const

Renvoie une reference au tableau des coordonnees des sommets du maillage support du champ, s’il existe.

Le tableau a toujours deux dimensions : dimension(0) = nombre de sommets reels dimension(1) = get_dimension() (dimension de l’espace dans lequel est defini le champ) En parallele, le tableau est un tableau distribue avec items communs. Exceptions:

get_ref_domain

const Domaine & Champ_Generique_base::get_ref_domain() const

Renvoie une ref au domaine sur lequel sera evalue l espace de stockage.

Par defaut le domaine associe au probleme.

get_ref_domaine_dis_base

const Domaine_dis_base & Champ_Generique_base::get_ref_domaine_dis_base() const

Renvoie une ref au domaine_discretisee du domaine sur lequel sera evalue l espace de stockage.

Par defaut le domaine associe au probleme.

get_ref_pb_base

const Probleme_base & Champ_Generique_base::get_ref_pb_base() const

Renvoie le probleme qui porte le champ cible.

get_ref_values

const DoubleTab & Champ_Generique_base::get_ref_values() const

Renvoie une reference au tableau de valeurs discretes s’il existe en memoire.

La reference est valide au moins jusqu’au prochain appel a une methode non const. Le maillage sur lequel ces valeurs sont definies est accessible par les methodes get_node_coordinates(), get_connectivity(), get_field_type(). Exceptions:

get_ref_zcl_dis_base

const Domaine_Cl_dis_base & Champ_Generique_base::get_ref_zcl_dis_base() const

Renvoie une ref au domaine_cl_discretisee de l equation portant le champ cible.

get_time

double Champ_Generique_base::get_time() const

Renvoie le temps du Champ_Generique_base .

get_xyz_values

void Champ_Generique_base::get_xyz_values(const DoubleTab &coords, DoubleTab &values, ArrOfBit &validity_flag) const

Calcule la valeur ponctuelle du champ aux coordonnees donnees dans coords et les met dans values.

validity_flag est rempli avec 1 si la valeur est valide (coordonnees a l’interieur du domaine), 0 sinon. Attention en parallele: Chaque processeur traite le tableau coords qui lui est fourni : on peut soit faire calculer le meme tableau a tout le monde: dans ce cas, validity_flag indique sur chaque processeur quelles valeurs chaque processeur a pu calculer, soit on sait par avance quelles coordonnees sont calculable par chaque processeur et on donne au processeur local uniquement des coordonnees qu’il possede. Si une meme coordonnee est demandee a plusieurs processeurs, on ne garantit pas que tous donnent le meme resultat. En general, un seul aura le validity_flag mis pour cette coordonnee. Exceptions:

has_champ_post

bool Champ_Generique_base::has_champ_post(const Motcle &nom) const

lire_motcle_non_standard

int Champ_Generique_base::lire_motcle_non_standard(const Motcle &, Entree &) override

Lecture des parametres de type non simple d’un objet_U a partir d’un flot d’entree.

Reimplements:

lire_motcle_non_standard

mettre_a_jour

virtual void Champ_Generique_base::mettre_a_jour(double temps)=0

nommer

void Champ_Generique_base::nommer(const Nom &nom) override

Donne un nom a l’ Objet_U Methode virtuelle a surcharger.

Reimplements:

nommer

reprendre

int Champ_Generique_base::reprendre(Entree &is) override

Reprise d’un Objet_U sur un flot d’entree Methode a surcharger.

Reimplements:

reprendre

reset

virtual void Champ_Generique_base::reset()=0

sauvegarder

int Champ_Generique_base::sauvegarder(Sortie &os) const override

Sauvegarde d’un Objet_U sur un flot de sortie Methode a surcharger.

Reimplements:

sauvegarder

set_param

virtual void Champ_Generique_base::set_param(Param &param)=0

~Champ_Generique_base

Champ_Generique_base::~Champ_Generique_base() override

composante

int Champ_Generique_base::composante(const Nom &nom_test, const Nom &nom, const Noms &composantes, const Noms &synonyms)

info

const Type_info * Champ_Generique_base::info()

self_cast

const Champ_Generique_base & Champ_Generique_base::self_cast(const Objet_U &)

self_cast

Champ_Generique_base & Champ_Generique_base::self_cast(Objet_U &)

printOn

Sortie & Champ_Generique_base::printOn(Sortie &x) const override

Ecriture de l’objet sur un flot de sortie Methode a surcharger.

Reimplements:

printOn

readOn

Entree & Champ_Generique_base::readOn(Entree &) override

Lecture d’un Objet_U sur un flot d’entree Methode a surcharger.

Reimplements:

readOn

assert_parallel

static void Champ_Generique_base::assert_parallel(int)

Attributes Documentation#

info_obj (public)

const Type_info Champ_Generique_base::info_obj

identifiant_appel_ (protected)

Nom Champ_Generique_base::identifiant_appel_

nom_pb_ (protected)

Nom Champ_Generique_base::nom_pb_

nom_post_ (protected)

Nom Champ_Generique_base::nom_post_

ref_pb_ (protected)

TRUST_Ref<Probleme_base *> Champ_Generique_base::ref_pb_

Champ_Generique_base

Contents

Champ_Generique_base#

How to cite this class in this doc#

Detailed description#

Inherits from#

Inherited by#

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

List of Protected Static Methods#

Complete Member Function Documentation#

Attributes Documentation#