#include <Field_base.h>

Inheritance diagram for Field_base:

Collaboration diagram for Field_base:

Public Member Functions
	Field_base ()
	Field_base (const Field_base &other)=default
void	nommer (const Nom &) override
	Gives a name to the field.
const Nom &	le_nom () const override
	Returns the name of the field.
const Noms &	get_synonyms () const
virtual void	add_synonymous (const Nom &nom)
virtual int	nb_comp () const
virtual void	fixer_nb_comp (int i)
	Sets the number of components of the field.
virtual int	nb_vect_comp () const
const Noms &	noms_compo () const
	Returns the array of names of the field components.
const Nom &	nom_compo (int) const
	Returns the name of the i-th component of the field.
const Nom &	nom_compo () const
	Returns the name of a scalar field.
virtual const Noms &	fixer_noms_compo (const Noms &)
	Sets the names of the field components.
virtual const Nom &	fixer_nom_compo (int, const Nom &)
	Sets the name of the i-th component of the field.
virtual const Nom &	fixer_nom_compo (const Nom &)
	Sets the name of a scalar field.
const Noms &	unites () const
	Returns the units of the field components.
const Nom &	unite () const
	Returns the unit of a scalar field whose all components have the same unit.
const Nom &	unite (int) const
	Returns the unit of the i-th component of the field.
virtual const Noms &	fixer_unites (const Noms &)
	Specifies the units of the field components.
virtual const Nom &	fixer_unite (const Nom &)
	Specifies the unit of a scalar field or whose all components have the same unit.
virtual const Nom &	fixer_unite (int i, const Nom &)
	Specifies the unit of the i-th component of the field Meaning: the index of the field component whose unit we want to specify.
virtual Nature_du_champ	nature_du_champ () const
virtual Nature_du_champ	fixer_nature_du_champ (Nature_du_champ nat)
	Sets the nature of a field: scalar, multiscalar, vectorial.
bool	is_basis_function () const
bool	is_quadrature () const
bool	is_vectorial () const
bool	is_scalar () const
int	order_field () const
	Returns the order of the basis functions.
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 int	reprendre (Entree &)
	Restores an Objet_U from an input stream. Virtual method to override.
virtual int	sauvegarder (Sortie &) const
	Saves an Objet_U to an output stream. Virtual method to override.
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	lire_motcle_non_standard (const Motcle &motlu, Entree &is)
	Reads non-simple-type parameters of an Objet_U from an input stream.
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 Attributes
Nom	nom_
Noms	noms_synonymes_
Noms	noms_compo_
Noms	unite_
int	nb_compo_
Nature_du_champ	nature_

Additional Inherited Members
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
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).
virtual void	set_param (Param &) const

Detailed Description

Definition at line 40 of file Field_base.h.

Constructor & Destructor Documentation

◆ Field_base() [1/2]

Field_base::Field_base ( )

Definition at line 22 of file Field_base.cpp.

◆ Field_base() [2/2]

Field_base::Field_base ( const Field_base & other )

default

Member Function Documentation

◆ add_synonymous()

virtual void Field_base::add_synonymous ( const Nom & nom )

inlinevirtual

Reimplemented in IJK_Field_vector< T, N >, IJK_Field_vector< double, 3 >, IJK_Field_vector< double, max_authorized_nb_of_groups_ >, and IJK_Field_vector< int, 3 >.

Definition at line 53 of file Field_base.h.

◆ fixer_nature_du_champ()

Nature_du_champ Field_base::fixer_nature_du_champ ( Nature_du_champ n )

virtual

Sets the nature of a field: scalar, multiscalar, vectorial.

The type (enum) Nature_du_champ is defined in Ch_base.h.

Parameters

(Nature_du_champ n) the nature to assign to the field

Reimplemented in Champ_front_Parametrique.

Definition at line 206 of file Field_base.cpp.

◆ fixer_nb_comp()

void Field_base::fixer_nb_comp ( int i )

virtual

Sets the number of components of the field.

The field is vectorial if it has the same dimension as the space.

Parameters

(int	i) the number of components of the field

Reimplemented in Champ_front_Parametrique.

Definition at line 50 of file Field_base.cpp.

◆ fixer_nom_compo() [1/2]

const Nom & Field_base::fixer_nom_compo ( const Nom & nom )

virtual

Sets the name of a scalar field.

Parameters

(Nom& nom) the name to give to the field (scalar)

Returns: (Nom&) the name of the scalar field

Exceptions

the	field is not scalar

Definition at line 119 of file Field_base.cpp.

◆ fixer_nom_compo() [2/2]

const Nom & Field_base::fixer_nom_compo	(	int	i,
		const Nom &	nom )

virtual

Sets the name of the i-th component of the field.

Parameters

(int	i) the index of the field component whose name we want to specify
(Nom&	nom) the name to give to the i-th component of the field

Returns: (Nom&) the name of i-th component of the field

Exceptions

invalid field component index

Definition at line 89 of file Field_base.cpp.

◆ fixer_noms_compo()

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

virtual

Sets the names of the field components.

Parameters

(Noms& noms) the array of names to give to the field components

Returns: (Noms&) the array of names of the field components

Definition at line 65 of file Field_base.cpp.

◆ fixer_unite() [1/2]

const Nom & Field_base::fixer_unite ( const Nom & nom )

virtual

Specifies the unit of a scalar field or whose all components have the same unit.

Parameters

(Nom& nom) the unit to specify

Returns: (Nom&) the unit of the field

Reimplemented in Champ_Input_P0_Composite, and Champ_Morceaux.

Definition at line 184 of file Field_base.cpp.

◆ fixer_unite() [2/2]

const Nom & Field_base::fixer_unite	(	int	i,
		const Nom &	nom )

virtual

Specifies the unit of the i-th component of the field Meaning: the index of the field component whose unit we want to specify.

Parameters

(Nom& nom) the type of unit to specify

Returns: (Nom&) the type of unit of the i-th component of the field

Reimplemented in Champ_Input_P0_Composite, and Champ_Morceaux.

Definition at line 163 of file Field_base.cpp.

◆ fixer_unites()

const Noms & Field_base::fixer_unites ( const Noms & noms )

virtual

Specifies the units of the field components.

These units are specified through an array of Nom and can be different for each component of the field.

Parameters

(Noms& noms) the names of the units of the field components

Definition at line 142 of file Field_base.cpp.

◆ get_synonyms()

const Noms & Field_base::get_synonyms ( ) const

inline

Definition at line 52 of file Field_base.h.

◆ is_basis_function()

bool Field_base::is_basis_function ( ) const

inline

Definition at line 80 of file Field_base.h.

◆ is_quadrature()

bool Field_base::is_quadrature ( ) const

inline

Definition at line 81 of file Field_base.h.

◆ is_scalar()

bool Field_base::is_scalar ( ) const

inline

Definition at line 86 of file Field_base.h.

◆ is_vectorial()

bool Field_base::is_vectorial ( ) const

inline

Definition at line 82 of file Field_base.h.

◆ le_nom()

const Nom & Field_base::le_nom ( ) const

overridevirtual

Returns the name of the field.

Reimplemented from Objet_U.

Definition at line 30 of file Field_base.cpp.

◆ nature_du_champ()

virtual Nature_du_champ Field_base::nature_du_champ ( ) const

inlinevirtual

Reimplemented in Champ_front_Parametrique.

Definition at line 77 of file Field_base.h.

◆ nb_comp()

virtual int Field_base::nb_comp ( ) const

inlinevirtual

Reimplemented in Champ_front_Parametrique.

Definition at line 56 of file Field_base.h.

◆ nb_vect_comp()

int Field_base::nb_vect_comp ( ) const

virtual

Definition at line 234 of file Field_base.cpp.

◆ nom_compo() [1/2]

const Nom & Field_base::nom_compo ( ) const

Returns the name of a scalar field.

Definition at line 130 of file Field_base.cpp.

◆ nom_compo() [2/2]

const Nom & Field_base::nom_compo ( int i ) const

Returns the name of the i-th component of the field.

Parameters

(int	i) the index of the field component whose name we want to specify

Returns: (Nom& nom) the name of i-th component of the field

Exceptions

invalid field component index

Definition at line 101 of file Field_base.cpp.

◆ nommer()

void Field_base::nommer ( const Nom & name )

overridevirtual

Gives a name to the field.

Parameters

(Nom& name) the name to give to the field

Reimplemented from Objet_U.

Reimplemented in IJK_Field_vector< T, N >, IJK_Field_vector< double, 3 >, IJK_Field_vector< double, max_authorized_nb_of_groups_ >, and IJK_Field_vector< int, 3 >.

Definition at line 39 of file Field_base.cpp.

◆ noms_compo()

const Noms & Field_base::noms_compo ( ) const

Returns the array of names of the field components.

Definition at line 77 of file Field_base.cpp.

◆ order_field()

int Field_base::order_field ( ) const

Returns the order of the basis functions.

Definition at line 214 of file Field_base.cpp.

◆ unite() [1/2]

const Nom & Field_base::unite ( ) const

Returns the unit of a scalar field whose all components have the same unit.

Returns: (Nom&) the (common) unit of the field components

Definition at line 194 of file Field_base.cpp.

◆ unite() [2/2]

const Nom & Field_base::unite ( int i ) const

Returns the unit of the i-th component of the field.

Parameters

(int	i) the index of the field component whose unit we want to know

Returns: (Nom&) the unit of the i-th component of the field

Definition at line 174 of file Field_base.cpp.

◆ unites()

const Noms & Field_base::unites ( ) const

Returns the units of the field components.

Returns: (Noms&) the names of the units of the field components

Definition at line 153 of file Field_base.cpp.

Member Data Documentation

◆ nature_

Nature_du_champ Field_base::nature_

protected

Definition at line 96 of file Field_base.h.

◆ nb_compo_

int Field_base::nb_compo_

protected

Definition at line 95 of file Field_base.h.

◆ nom_

Nom Field_base::nom_

protected

Definition at line 93 of file Field_base.h.

◆ noms_compo_

Noms Field_base::noms_compo_

protected

Definition at line 94 of file Field_base.h.

◆ noms_synonymes_

Noms Field_base::noms_synonymes_

protected

Definition at line 94 of file Field_base.h.

◆ unite_

Noms Field_base::unite_

protected

Definition at line 94 of file Field_base.h.

The documentation for this class was generated from the following files:

/home/docs/trust-code/src/Kernel/Framework/Field_base.h
/home/docs/trust-code/src/Kernel/Framework/Field_base.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Field_base() [1/2]

◆ Field_base() [2/2]

Member Function Documentation

◆ add_synonymous()

◆ fixer_nature_du_champ()

◆ fixer_nb_comp()

◆ fixer_nom_compo() [1/2]

◆ fixer_nom_compo() [2/2]

◆ fixer_noms_compo()

◆ fixer_unite() [1/2]

◆ fixer_unite() [2/2]

◆ fixer_unites()

◆ get_synonyms()

◆ is_basis_function()

◆ is_quadrature()

◆ is_scalar()

◆ is_vectorial()

◆ le_nom()

◆ nature_du_champ()

◆ nb_comp()

◆ nb_vect_comp()

◆ nom_compo() [1/2]

◆ nom_compo() [2/2]

◆ nommer()

◆ noms_compo()

◆ order_field()

◆ unite() [1/2]

◆ unite() [2/2]

◆ unites()

Member Data Documentation

◆ nature_

◆ nb_compo_

◆ nom_

◆ noms_compo_

◆ noms_synonymes_

◆ unite_