Special field class that encapsulates a reference to a volume field of TRUST of type Champ_base. More...

#include <Champ_Generique_refChamp.h>

Inheritance diagram for Champ_Generique_refChamp:

Collaboration diagram for Champ_Generique_refChamp:

Public Member Functions
void	initialize (const Champ_base &champ)
	Initialize the class with the given field.
void	set_param (Param &param) const override
	pb_champ : triggers the reading of the problem name (nom_pb_) to which the discrete field belongs and the name of that discrete field (nom_champ_)
int	lire_motcle_non_standard (const Motcle &, Entree &) override
	Reads non-simple-type parameters of an Objet_U from an input stream.
int	get_dimension () const override
	Returns the number of coordinates of each vertex of the domain.
void	get_property_names (Motcles &list) const override
	Returns the list of possible "queries" for the field.
const Noms	get_property (const Motcle &query) const override
	Returns the requested property.
Entity	get_localisation (const int index=-1) const override
	If the field is not a discrete field: exception Champ_Generique_erreur("INVALID") Otherwise, returns the localisation of the field for support "index".
const DoubleTab &	get_ref_values () const override
	Verifies that the field is indeed a discrete field and returns the value array.
void	get_copy_values (DoubleTab &) const override
	Creates a copy of the value array. See GenericField_base::get_copy_values().
void	get_xyz_values (const DoubleTab &coords, DoubleTab &values, ArrOfBit &validity_flag) const override
	call to Champ_base::valeur_aux()
const Domaine_Cl_dis_base &	get_ref_zcl_dis_base () const override
	Returns a ref to the discretized boundary conditions domain of the equation carrying the target field.
const DoubleTab &	get_ref_coordinates () const override
	Returns a reference to the array of coordinates of the vertices of the mesh supporting the field, if it exists.
void	get_copy_coordinates (DoubleTab &) const override
const IntTab &	get_ref_connectivity (Entity index1, Entity index2) const override
	Returns the connectivity array between the geometric entity index1 and entity index2.
void	get_copy_connectivity (Entity index1, Entity index2, IntTab &) const override
const Probleme_base &	get_ref_pb_base () const override
	Returns the problem that carries the target field.
void	reset () override
void	completer (const Postraitement_base &post) override
void	mettre_a_jour (double temps) override
	See Champ_Generique_base::mettre_a_jour If the field is a champ_inc in the equation, it must already have.
const Champ_base &	get_champ (OWN_PTR(Champ_base)&espace_stockage) const override
	See Champ_Generique_base::get_champ.
const Champ_base &	get_champ_without_evaluation (OWN_PTR(Champ_base)&espace_stockage) const override
virtual const Champ_base &	get_ref_champ_base () const
	Returns the underlying champ_base.
virtual void	set_ref_champ (const Champ_base &)
	Associates the field and determines its localisation.
double	get_time () const override
	Returns the time of the Champ_Generique_base.
const Motcle	get_directive_pour_discr () const override
	Returns the directive (champ_elem, champ_sommets, champ_face or pression) to launch the discretization of the storage space returned by get_champ().
void	set_nom_champ (const Motcle &)
void	nommer_source (const Postraitement_base &post)
int	get_info_type_post () const override
const Noms &	fixer_noms_compo (const Noms &noms) override
const Noms &	fixer_noms_synonyms (const Noms &noms) override
Public Member Functions inherited from Champ_Generique_base
virtual std::vector< YAML_data >	data_a_sauvegarder () const
int	sauvegarder (Sortie &os) const override
	Saves an Objet_U to an output stream. Virtual method to override.
int	reprendre (Entree &is) override
	Restores an Objet_U from an input stream. Virtual method to override.
virtual const Discretisation_base &	get_discretisation () const
	Returns the discretization associated with the problem.
void	nommer (const Nom &nom) override
	Assigns a name to the Objet_U. Virtual method to override.
virtual const Nom &	get_nom_post () const
virtual int	get_nb_localisations () const
virtual const Domaine &	get_ref_domain () const
	Returns a ref to the domain on which the storage space will be evaluated.
virtual void	get_copy_domain (Domaine &) const
	Creates a copy of the domain on which the storage space will be evaluated.
virtual const Domaine_dis_base &	get_ref_domaine_dis_base () const
	Returns a ref to the discretized domain on which the storage space will be evaluated.
virtual const Champ_base &	get_champ (OWN_PTR(Champ_base) &espace_stockage) const =0
virtual const Champ_Generique_base &	get_champ_post (const Motcle &nom) const
virtual bool	has_champ_post (const Motcle &nom) const
virtual int	comprend_champ_post (const Motcle &identifiant) const
void	fixer_identifiant_appel (const Nom &identifiant)
Public Member Functions inherited from Objet_U
	~Objet_U () override
	Destructor. Removes the object from the list of objects registered in "memory".
int	numero () const
	Returns the index of the object in Memoire::data.
virtual int	duplique () const =0
virtual Sortie &	printOn (Sortie &) const
	Writes the object to an output stream. Virtual method to override.
virtual Entree &	readOn (Entree &)
	Reads an Objet_U from an input stream. Virtual method to override.
virtual unsigned	taille_memoire () const =0
virtual int	est_egal_a (const Objet_U &) const
	Returns 1 if x and *this are the same instance (same memory address).
virtual const Nom &	le_nom () const
	Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
int	get_object_id () const
	Returns the unique identifier of the object (object_id_).
virtual const Type_info *	get_info () const
	Returns type information for the Objet_U.
const Nom &	que_suis_je () const
	Returns the string identifying the class.
const char *	le_type () const
	Returns the type name of the Objet_U.
virtual int	change_num (const int *const)
	Changes the internal number of the Objet_U.
virtual int	associer_ (Objet_U &)
	Associates the Objet_U with another Objet_U. Virtual method to override.
const Interprete &	interprete () const
Interprete &	interprete ()
Public Member Functions inherited from Process
virtual	~Process ()

Protected Member Functions
	OBS_PTR (Champ_base) ref_champ_
	OWN_PTR (Champ_base) ptr_champ_
Protected Member Functions inherited from Champ_Generique_base
	OBS_PTR (Probleme_base) ref_pb_
Protected Member Functions inherited from Objet_U
	Objet_U ()
	Default constructor: assigns a unique identifier to the object (object_id_) and registers the object in "memory" by giving it a num_obj number.
	Objet_U (const Objet_U &)
	Copy constructor.
const Objet_U &	operator= (const Objet_U &)
	Assignment operator: does nothing (the number and identifier are preserved).

Protected Attributes
Noms	compo_
Noms	syno_
Motcle	localisation_
Nom	nom_champ_
Protected Attributes inherited from Champ_Generique_base
Nom	nom_post_
Nom	identifiant_appel_
Nom	nom_pb_

Additional Inherited Members
Static Public Member Functions inherited from Champ_Generique_base
static int	composante (const Nom &nom_test, const Nom &nom, const Noms &composantes, const Noms &synonyms)
Static Public Member Functions inherited from Objet_U
static const Nom &	nom_du_cas ()
	Returns a constant reference to the case name. This method is static.
static Nom &	get_set_nom_du_cas ()
	Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_info *	info ()
	Returns type information for the Objet_U (static version).
static const Objet_U &	self_cast (const Objet_U &)
	Method added for casting in Python.
static Objet_U &	self_cast (Objet_U &)
Static Public Member Functions inherited from Process
static int	me ()
	Returns the rank of the local processor in the current communication group. See Comm_Group::rank() and PE_Groups::current_group().
static int	nproc ()
	Returns the number of processors in the current group. See Comm_Group::nproc() and PE_Groups::current_group().
static bool	is_parallel ()
static void	exit (int exit_code=-1)
	Exit routine for TRUST within a Kokkos region.
static double	mp_sum (double)
	Computes the sum of x over all processors in the current group.
static float	mp_sum (float)
static trustIdType	mp_sum (trustIdType)
	Computes the sum of x over all processors in the current group.
static double	mp_max (double)
static double	mp_min (double)
static int	mp_max (int)
	Returns the maximum value of x across all processors in the current group.
static int	mp_min (int)
	Returns the minimum value of x across all processors in the current group.
static double	mp_sum_as_double (int v)
static trustIdType	mppartial_sum (trustIdType i)
	Computes the partial sum of x over processors 0 to me()-1 (returns 0 on processor 0).
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2)
	C++14 compatible mp_sum_for_each: combine multiple mp_sum calls into one collective operation Usage: mp_sum_for_each(a, b); mp_sum_for_each(a, b, c); mp_sum_for_each(a, b, c, d); mp_sum_for_each(a, b, c, d, e); All arguments must be of the same type (double or int) and are modified in place. Supports 2-5 parameters.
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void	mp_sum_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2)
	C++14 compatible mp_max_for_each: combine multiple mp_max calls into one collective operation.
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void	mp_max_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2)
	C++14 compatible mp_min_for_each: combine multiple mp_min calls into one collective operation.
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2, T &arg3)
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4)
template<typename T>
static void	mp_min_for_each (T &arg1, T &arg2, T &arg3, T &arg4, T &arg5)
template<typename _TYPE_>
static void	mp_sum_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void	mp_max_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
template<typename _TYPE_>
static void	mp_min_for_each_item (TRUSTArray< _TYPE_ > &x, int n=-1)
static bool	mp_and (bool)
	Computes the logical AND of b across all processors in the current group.
static bool	mp_or (bool)
static int	check_int_overflow (trustIdType)
static int	je_suis_maitre ()
	Returns 1 if on the master processor of the current group (i.e. me() == 0), 0 otherwise.
static KOKKOS_INLINE_FUNCTION void	Kokkos_exit (const char *)
	Exit routine for TRUST within a Kokkos region.
static int	node_master ()
	Returns 1 if on the NUMA node master processor, 0 otherwise.
static void	exit (const Nom &message, int exit_code=-1)
static bool	is_sequential ()
static void	barrier ()
	Synchronizes all processors in the current group (waits until all processors have reached the barrier).
static void	abort ()
	Abort routine for TRUST on a fatal error.
static Sortie &	Journal (int message_level=0)
	Returns a static Sortie object used as an event journal.
static double	ram_processeur ()
static void	imprimer_ram_totale (int all_process=0)
static bool	force_single_file (const int ranks, const Nom &filename)
Static Public Attributes inherited from Objet_U
static double	precision_geom = 1e-10
static constexpr bool	HAS_POINTER = false
static int	dimension =0
static int	format_precision_geom =11
static int	axi =0
static int	bidim_axi =0
static int	DEACTIVATE_SIGINT_CATCH =0
static Type_info	info_obj
static bool	disable_TU =false
	Flag to disable or not the writing of the .TU files.
static bool	stat_per_proc_perf_log =false
	Flag to enable the writing of the statistics detailed per processor in _csv.TU file.
Static Public Attributes inherited from Process
static int	exception_sur_exit =0
static int	multiple_files =5120
Static Protected Member Functions inherited from Champ_Generique_base
static void	assert_parallel (int)

Detailed Description

Special field class that encapsulates a reference to a volume field of TRUST of type Champ_base.

The class does not manage the memory of Champ_base.

Definition at line 34 of file Champ_Generique_refChamp.h.

Member Function Documentation

◆ completer()

void Champ_Generique_refChamp::completer ( const Postraitement_base & post )

overridevirtual

Implements Champ_Generique_base.

Definition at line 391 of file Champ_Generique_refChamp.cpp.

◆ fixer_noms_compo()

const Noms & Champ_Generique_refChamp::fixer_noms_compo ( const Noms & noms )

overridevirtual

Reimplemented from Champ_Generique_base.

Definition at line 557 of file Champ_Generique_refChamp.cpp.

◆ fixer_noms_synonyms()

const Noms & Champ_Generique_refChamp::fixer_noms_synonyms ( const Noms & noms )

overridevirtual

Reimplemented from Champ_Generique_base.

Definition at line 553 of file Champ_Generique_refChamp.cpp.

◆ get_champ()

const Champ_base & Champ_Generique_refChamp::get_champ ( OWN_PTR(Champ_base)& espace_stockage ) const

override

See Champ_Generique_base::get_champ.

Here, the storage space is not used, the field already exists

Definition at line 412 of file Champ_Generique_refChamp.cpp.

◆ get_champ_without_evaluation()

const Champ_base & Champ_Generique_refChamp::get_champ_without_evaluation ( OWN_PTR(Champ_base)& espace_stockage ) const

overridevirtual

Implements Champ_Generique_base.

Definition at line 419 of file Champ_Generique_refChamp.cpp.

◆ get_copy_connectivity()

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

overridevirtual

Reimplemented from Champ_Generique_base.

Definition at line 358 of file Champ_Generique_refChamp.cpp.

◆ get_copy_coordinates()

void Champ_Generique_refChamp::get_copy_coordinates ( DoubleTab & coordinates ) const

overridevirtual

Reimplemented from Champ_Generique_base.

Definition at line 303 of file Champ_Generique_refChamp.cpp.

◆ get_copy_values()

void Champ_Generique_refChamp::get_copy_values ( DoubleTab & values ) const

overridevirtual

Creates a copy of the value array. See GenericField_base::get_copy_values().

Reimplemented from Champ_Generique_base.

Definition at line 267 of file Champ_Generique_refChamp.cpp.

◆ get_dimension()

int Champ_Generique_refChamp::get_dimension ( ) const

overridevirtual

Returns the number of coordinates of each vertex of the domain.

See GenericField_base::get_dimension()

Reimplemented from Champ_Generique_base.

Definition at line 109 of file Champ_Generique_refChamp.cpp.

◆ get_directive_pour_discr()

const Motcle Champ_Generique_refChamp::get_directive_pour_discr ( ) const

overridevirtual

Returns the directive (champ_elem, champ_sommets, champ_face or pression) to launch the discretization of the storage space returned by get_champ().

Reimplemented from Champ_Generique_base.

Definition at line 473 of file Champ_Generique_refChamp.cpp.

◆ get_info_type_post()

int Champ_Generique_refChamp::get_info_type_post ( ) const

overridevirtual

Implements Champ_Generique_base.

Definition at line 548 of file Champ_Generique_refChamp.cpp.

◆ get_localisation()

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

overridevirtual

If the field is not a discrete field: exception Champ_Generique_erreur("INVALID") Otherwise, returns the localisation of the field for support "index".

If index == -1 (default value), raises an exception if the field has multiple supports. Otherwise, raises an exception if the index exceeds the number of field localisations.

Reimplemented from Champ_Generique_base.

Definition at line 215 of file Champ_Generique_refChamp.cpp.

◆ get_property()

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

overridevirtual

Returns the requested property.

Examples: "DISCRETISATION" : type of discrete field (P0, P1, P1NC, etc...) "ELEMENT_TYPE" : type of element with the largest dimension ({TRIANGLE}, {TETRAHEDRA}, {QUAD}, {HEXA}, etc) "DYNAMIC_MESH" : is the mesh dynamic or not ({STATIC}, {DYNAMIC}) "NAME" : name of the field "COMPONENT_NAMES" : name of the field components ({K,EPSILON} or {VITESSE_X,VITESSE_Y,VITESSE_Z}) "BOUNDARY_NAMES" : name of the boundaries "COORDINATES" : coordinate system of the nodes ({X}, {X,Y}, {X,Y,Z}, {R,THETA}, etc...) Exceptions:

GenericFieldError::INVALID : query not understood

Reimplemented from Champ_Generique_base.

Definition at line 127 of file Champ_Generique_refChamp.cpp.

◆ get_property_names()

void Champ_Generique_refChamp::get_property_names ( Motcles & list ) const

overridevirtual

Returns the list of possible "queries" for the field.

Reimplemented from Champ_Generique_base.

Definition at line 118 of file Champ_Generique_refChamp.cpp.

◆ get_ref_champ_base()

const Champ_base & Champ_Generique_refChamp::get_ref_champ_base ( ) const

virtual

Returns the underlying champ_base.

Tests that the field has been properly associated. Eventually, this method will be removed from GenericField_base but remains here (to test if the field has been associated). Exceptions: Champ_Generique_erreur("NOT_INITIALIZED")

Definition at line 378 of file Champ_Generique_refChamp.cpp.

◆ get_ref_connectivity()

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

overridevirtual

Returns the connectivity array between the geometric entity index1 and entity index2.

For example get_ref_connectivity(ELEM, NODE) = Domaine::mes_elems get_ref_connectivity(ELEM, FACE) = DomaineVF::elem_faces_ get_ref_connectivity(FACE, ELEM) = DomaineVF::face_voisins_ The array always has two dimensions: dimension(0) = number of real entities "index1" dimension(1) = number of entities "index2" connected to each entity "index1" In parallel, the array is a distributed array with common items Exceptions:

GenericFieldError::INVALID : the array does not exist (analytical field ...)
GenericFieldError::NO_REF : values are not stored in memory, must use get_copy_connectivity();

Reimplemented from Champ_Generique_base.

Definition at line 309 of file Champ_Generique_refChamp.cpp.

◆ get_ref_coordinates()

const DoubleTab & Champ_Generique_refChamp::get_ref_coordinates ( ) const

overridevirtual

Returns a reference to the array of coordinates of the vertices of the mesh supporting the field, if it exists.

The array always has two dimensions: dimension(0) = number of real vertices dimension(1) = get_dimension() (dimension of the space in which the field is defined) In parallel, the array is a distributed array with common items. Exceptions:

GenericFieldError::INVALID : the array does not exist (analytical field ...)
GenericFieldError::NO_REF : values are not stored in memory, must use get_copy_coordinates();

Reimplemented from Champ_Generique_base.

Definition at line 297 of file Champ_Generique_refChamp.cpp.