class Champ_front_calc Derived class of Champ_front_var representing More...

#include <Champ_front_calc.h>

Inheritance diagram for Champ_front_calc:

Collaboration diagram for Champ_front_calc:

Public Member Functions
	Champ_front_calc ()
int	initialiser (double, const Champ_Inc_base &) override
	Initialization at the beginning of calculation.
void	associer_ch_inc_base (const Champ_Inc_base &)
	Associate the unknown field to the object.
Champ_front_base &	affecter_ (const Champ_front_base &ch) override
	Not implemented.
void	mettre_a_jour (double temps) override
	Time update of the field. We simply take the trace of the unknown field at the.
void	creer (const Nom &, const Nom &, const Motcle &)
	Create the Champ_front_calc object representing the trace of an unknown field on a boundary from names:
void	verifier (const Cond_lim_base &la_cl) const override
const Champ_Inc_base &	inconnue () const
	Returns the associated unknown field.
const Nom &	nom_bord_oppose () const
	Returns the name of the boundary on which the trace is computed.
const Equation_base &	equation () const
	Returns the equation associated with the unknown whose trace is taken.
const Milieu_base &	milieu () const
	Returns the medium associated with the equation carrying the unknown field whose trace is taken.
const Domaine_dis_base &	domaine_dis () const override
	Returns the discretized domain associated with the equation carrying the unknown field whose trace is taken.
const Domaine_Cl_dis_base &	domaine_Cl_dis () const
	Returns the domain of discretized boundary conditions carried by the equation carrying the unknown field.
const Frontiere_dis_base &	front_dis () const
	Returns the discretized boundary corresponding to the domain on which the trace is taken.
void	set_distant (int d)
Public Member Functions inherited from Champ_front_var_instationnaire
void	fixer_nb_valeurs_temporelles (int nb_cases) override
	Overrides Champ_front_base::fixer_nb_valeurs_temporelles.
int	initialiser (double temps, const Champ_Inc_base &inco) override
	Initializes the current time and Gpoint.
bool	has_valeurs_au_temps (double temps) const override
DoubleTab &	valeurs_au_temps (double temps) override
	Returns the values at the desired time.
const DoubleTab &	valeurs_au_temps (double temps) const override
	Returns the values at the desired time.
int	avancer (double temps) override
	Advances to the desired time.
int	reculer (double temps) override
	Goes back to the desired time.
virtual double	valeur_au_temps_et_au_point (double temps, int som, double x, double y, double z, int comp) const
virtual int	valeur_au_temps_et_au_point_disponible () const
Public Member Functions inherited from Champ_front_base
	Champ_front_base ()
virtual void	completer ()
virtual void	associer_fr_dis_base (const Frontiere_dis_base &)
	Associates a discretized boundary with the field.
virtual DoubleTab &	valeurs () override
	Returns the array of field values.
virtual const DoubleTab &	valeurs () const override
	Returns the array of field values at the default time.
virtual const Frontiere_dis_base &	frontiere_dis () const
	Returns the discretized boundary associated with the field.
virtual Frontiere_dis_base &	frontiere_dis ()
	Returns the discretized boundary associated with the field.
virtual void	calculer_coeffs_echange (double temps)
	DOES NOTHING, to override. This method can calculate and store useful data for the.
virtual void	valeurs_face (int, DoubleVect &) const
	Returns the vector of field values for the given face.
virtual double	get_temps_defaut () const
virtual void	set_temps_defaut (double temps)
virtual void	changer_temps_futur (double temps, int i)
	Changes the time value for the i-th temporal value after the present.
virtual bool	instationnaire () const
virtual void	set_instationnaire (bool flag)
virtual void	set_derivee_en_temps (DoubleTab &Gpoint)
virtual const DoubleTab &	derivee_en_temps () const
virtual void	calculer_derivee_en_temps (double t1, double t2)
	Computes the rate of change of the field between t1 and t2 and stores it in Gpoint_.
virtual DoubleTab &	valeurs (double temps)
virtual const DoubleTab &	valeurs (double temps) const
Public Member Functions inherited from Field_base
	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 ()
Public Member Functions inherited from Champ_Proto
virtual	~Champ_Proto ()
virtual DoubleTab &	futur (int i=1)
virtual const DoubleTab &	futur (int i=1) const
virtual DoubleTab &	passe (int i=1)
virtual const DoubleTab &	passe (int i=1) const
int	lire_dimension (Entree &, const Nom &)
	Verification of the field dimension Returns the dimension of the field.
int	lire_dimension (int dim, const Nom &le_nom_)
	Verification of the field dimension Returns the dimension of the field.
double	operator() (int i, int j) const =delete
double &	operator() (int i, int j)=delete
double	operator() (int i) const =delete
double &	operator() (int i)=delete

Protected Member Functions
	OBS_PTR (Champ_Inc_base) l_inconnue
Protected Member Functions inherited from Champ_front_base
	OBS_PTR (Frontiere_dis_base) la_frontiere_dis
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

Protected Attributes
Nom	nom_autre_bord_
Nom	nom_autre_pb_
Motcle	nom_inco_
bool	via_readon_ = false
int	distant_
Protected Attributes inherited from Champ_front_base
double	temps_defaut
Roue_ptr	les_valeurs
DoubleTab	Gpoint_
Protected Attributes inherited from Field_base
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

Detailed Description

class Champ_front_calc Derived class of Champ_front_var representing

boundary fields obtained by taking the trace
of an object of type OWN_PTR(Champ_Inc_base) (unknown field of an equation)

See also: Champ_front_var_instationnaire Champ_Inc

Definition at line 37 of file Champ_front_calc.h.

Constructor & Destructor Documentation

◆ Champ_front_calc()

Champ_front_calc::Champ_front_calc ( )

Definition at line 39 of file Champ_front_calc.cpp.

Member Function Documentation

◆ affecter_()

Champ_front_base & Champ_front_calc::affecter_ ( const Champ_front_base & ch )

overridevirtual

Not implemented.

Parameters

(Champ_front_base& ch)

Returns: (Champ_front_base&)

Reimplemented from Ch_front_var_instationnaire_dep.

Definition at line 148 of file Champ_front_calc.cpp.

◆ associer_ch_inc_base()

void Champ_front_calc::associer_ch_inc_base ( const Champ_Inc_base & inco )

Associate the unknown field to the object.

Parameters

(Champ_Inc_base& inco) the unknown field whose trace will be taken

Definition at line 137 of file Champ_front_calc.cpp.

◆ creer()

void Champ_front_calc::creer	(	const Nom &	nom_pb,
		const Nom &	nom_bord,
		const Motcle &	nom_inco )

Create the Champ_front_calc object representing the trace of an unknown field on a boundary from names:

    - of the problem carrying the unknown
    - of the concerned boundary
    - of the unknown

Parameters

(Nom&	nom_pb) the name of the problem to which the unknown whose trace we want belongs
(Nom&	nom) the name of the boundary on which the trace of the unknown is taken
(Motcle&	nom_inco) the name of the unknown whose trace we want

Exceptions

no	problem with the specified name
the	problem does not have a field with the specified name

Definition at line 72 of file Champ_front_calc.cpp.

◆ domaine_Cl_dis()

const Domaine_Cl_dis_base & Champ_front_calc::domaine_Cl_dis ( ) const

Returns the domain of discretized boundary conditions carried by the equation carrying the unknown field.

whose trace is taken

Returns: (Domaine_Cl_dis_base&) the domain of discretized boundary conditions carried by the equation carrying the unknown field whose trace is taken

Definition at line 236 of file Champ_front_calc.cpp.

◆ domaine_dis()

const Domaine_dis_base & Champ_front_calc::domaine_dis ( ) const

overridevirtual

Returns the discretized domain associated with the equation carrying the unknown field whose trace is taken.

Returns: (Domaine_dis_base&) the discretized domain associated with the equation carrying the unknown field whose trace is taken

Reimplemented from Champ_front_base.

Definition at line 225 of file Champ_front_calc.cpp.

◆ equation()

const Equation_base & Champ_front_calc::equation ( ) const

Returns the equation associated with the unknown whose trace is taken.

Returns: (Equation_base&) the equation associated with the unknown whose trace is taken

Definition at line 202 of file Champ_front_calc.cpp.

◆ front_dis()

const Frontiere_dis_base & Champ_front_calc::front_dis ( ) const

Returns the discretized boundary corresponding to the domain on which the trace is taken.

Returns: (Frontiere_dis_base&) discretized boundary corresponding to the domain on which the trace is taken

Exceptions

boundary with the specified name not found

Definition at line 246 of file Champ_front_calc.cpp.

◆ inconnue()

const Champ_Inc_base & Champ_front_calc::inconnue ( ) const

Returns the associated unknown field.

Returns: (Champ_Inc_base&) the associated unknown field

Definition at line 184 of file Champ_front_calc.cpp.

◆ initialiser()

int Champ_front_calc::initialiser	(	double	temps,
		const Champ_Inc_base &	inco )

overridevirtual

Initialization at the beginning of calculation.

Imperatively this method must not use data external to the equation (coupling). If mettre_a_jour does, then initializer must not call mettre_a_jour.

Returns: (0 in case of error, 1 otherwise.)

Reimplemented from Ch_front_var_instationnaire_dep.

Definition at line 101 of file Champ_front_calc.cpp.

◆ mettre_a_jour()

void Champ_front_calc::mettre_a_jour ( double temps )

overridevirtual

Time update of the field. We simply take the trace of the unknown field at the.

time step at which it is located. WEC: verify that we take the unknown at the correct time!

Reimplemented from Champ_front_base.

Reimplemented in Champ_front_calc_interne.

Definition at line 172 of file Champ_front_calc.cpp.

◆ milieu()

const Milieu_base & Champ_front_calc::milieu ( ) const

Returns the medium associated with the equation carrying the unknown field whose trace is taken.

Returns: (Milieu_base&) the medium associated with the equation carrying the unknown field whose trace is taken

Definition at line 216 of file Champ_front_calc.cpp.

◆ nom_bord_oppose()

const Nom & Champ_front_calc::nom_bord_oppose ( ) const

Returns the name of the boundary on which the trace is computed.

Returns: (Nom&) the name of the boundary on which the trace is computed

Definition at line 193 of file Champ_front_calc.cpp.

◆ OBS_PTR()

Champ_front_calc::OBS_PTR ( Champ_Inc_base )

protected

◆ set_distant()

void Champ_front_calc::set_distant ( int d )

inline

Definition at line 57 of file Champ_front_calc.h.

◆ verifier()

void Champ_front_calc::verifier ( const Cond_lim_base & la_cl ) const

overridevirtual

Reimplemented from Champ_front_base.

Definition at line 252 of file Champ_front_calc.cpp.

Member Data Documentation

◆ distant_

int Champ_front_calc::distant_

protected

Definition at line 64 of file Champ_front_calc.h.

◆ nom_autre_bord_

Nom Champ_front_calc::nom_autre_bord_

protected

Definition at line 61 of file Champ_front_calc.h.

◆ nom_autre_pb_

Nom Champ_front_calc::nom_autre_pb_

protected

Definition at line 61 of file Champ_front_calc.h.

◆ nom_inco_

Motcle Champ_front_calc::nom_inco_

protected

Definition at line 62 of file Champ_front_calc.h.

◆ via_readon_

bool Champ_front_calc::via_readon_ = false

protected

Definition at line 63 of file Champ_front_calc.h.

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

/home/docs/trust-code/src/Kernel/Champs/Champ_front_calc.h
/home/docs/trust-code/src/Kernel/Champs/Champ_front_calc.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Champ_front_calc()

Member Function Documentation

◆ affecter_()

◆ associer_ch_inc_base()

◆ creer()

◆ domaine_Cl_dis()

◆ domaine_dis()

◆ equation()

◆ front_dis()

◆ inconnue()

◆ initialiser()

◆ mettre_a_jour()

◆ milieu()

◆ nom_bord_oppose()

◆ OBS_PTR()

◆ set_distant()

◆ verifier()

Member Data Documentation

◆ distant_

◆ nom_autre_bord_

◆ nom_autre_pb_

◆ nom_inco_

◆ via_readon_