: class Champ_front_Parametrique More...

#include <Champ_front_Parametrique.h>

Inheritance diagram for Champ_front_Parametrique:

Collaboration diagram for Champ_front_Parametrique:

Public Member Functions
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.
DoubleTab &	valeurs_au_temps (double temps) override
const DoubleTab &	valeurs_au_temps (double temps) const override
const Frontiere_dis_base &	frontiere_dis () const override
	Returns the discretized boundary associated with the field.
Frontiere_dis_base &	frontiere_dis () override
	Returns the discretized boundary associated with the field.
const Domaine_dis_base &	domaine_dis () const override
Champ_front_base &	affecter_ (const Champ_front_base &ch) override
void	mettre_a_jour (double temps) override
	DOES NOTHING, to override.
void	calculer_coeffs_echange (double temps) override
	DOES NOTHING, to override. This method can calculate and store useful data for the.
void	valeurs_face (int i, DoubleVect &val) const override
	Returns the vector of field values for the given face.
void	verifier (const Cond_lim_base &la_cl) const override
double	get_temps_defaut () const override
void	set_temps_defaut (double temps) override
void	changer_temps_futur (double temps, int i) override
	Changes the time value for the i-th temporal value after the present.
int	avancer (double temps) override
	To implement in derived classes.
int	reculer (double temps) override
	To implement in derived classes.
void	fixer_nb_comp (int i) override
	Sets the number of components of the field.
int	nb_comp () const override
Nature_du_champ	nature_du_champ () const override
Nature_du_champ	fixer_nature_du_champ (Nature_du_champ nat) override
	Sets the nature of a field: scalar, multiscalar, vectorial.
void	associer_fr_dis_base (const Frontiere_dis_base &fr) override
	Associates a discretized boundary with the field.
int	initialiser (double temps, const Champ_Inc_base &inco) override
	Initialization at the beginning of calculation.
virtual void	completer () override
void	fixer_nb_valeurs_temporelles (int nb_cases) override
	Called by Conds_lim::completer. By default does nothing.
void	calculer_derivee_en_temps (double t1, double t2) override
	Computes the rate of change of the field between t1 and t2 and stores it in Gpoint_.
const DoubleTab &	derivee_en_temps () const override
bool	instationnaire () const override
std::string	newCompute () const
Champ_front_base &	champ ()
const Champ_front_base &	champ () const
virtual DoubleTab &	valeurs (double temps)
virtual const DoubleTab &	valeurs (double temps) const
Public Member Functions inherited from Champ_front_base
	Champ_front_base ()
virtual bool	has_valeurs_au_temps (double temps) const
virtual void	set_instationnaire (bool flag)
virtual void	set_derivee_en_temps (DoubleTab &Gpoint)
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_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.
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

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 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 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_

Detailed Description

: class Champ_front_Parametrique

Definition at line 28 of file Champ_front_Parametrique.h.

Member Function Documentation

◆ affecter_()

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

inlineoverridevirtual

Implements Champ_front_base.

Definition at line 42 of file Champ_front_Parametrique.h.

◆ associer_fr_dis_base()

void Champ_front_Parametrique::associer_fr_dis_base ( const Frontiere_dis_base & fr )

inlineoverridevirtual

Associates a discretized boundary with the field.

Parameters

(Frontiere_dis_base& fr) the discretized boundary to associate with the field

Reimplemented from Champ_front_base.

Definition at line 58 of file Champ_front_Parametrique.h.

◆ avancer()

int Champ_front_Parametrique::avancer ( double temps )

inlineoverridevirtual

To implement in derived classes.

Advances in time: the new current time will be the time passed as a parameter.

Returns: (int) 1 if OK, 0 otherwise

Reimplemented from Champ_front_base.

Definition at line 50 of file Champ_front_Parametrique.h.

◆ calculer_coeffs_echange()

void Champ_front_Parametrique::calculer_coeffs_echange ( double temps )

inlineoverridevirtual

DOES NOTHING, to override. This method can calculate and store useful data for the.

BC, and depending only on the unknown on which it acts this BC (not from outside). cf Champ_front_contact_VEF for example. It is called when the unknown is modified.

Parameters

(double)

Reimplemented from Champ_front_base.

Definition at line 44 of file Champ_front_Parametrique.h.

◆ calculer_derivee_en_temps()

void Champ_front_Parametrique::calculer_derivee_en_temps	(	double	t1,
		double	t2 )

overridevirtual

Computes the rate of change of the field between t1 and t2 and stores it in Gpoint_.

Reimplemented from Champ_front_base.

Definition at line 75 of file Champ_front_Parametrique.cpp.

◆ champ() [1/2]

Champ_front_base & Champ_front_Parametrique::champ ( )

inline

Definition at line 70 of file Champ_front_Parametrique.h.

◆ champ() [2/2]

const Champ_front_base & Champ_front_Parametrique::champ ( ) const

inline

Definition at line 71 of file Champ_front_Parametrique.h.

◆ changer_temps_futur()

void Champ_front_Parametrique::changer_temps_futur	(	double	temps,
		int	i )

inlineoverridevirtual

Changes the time value for the i-th temporal value after the present.

Reimplemented from Champ_front_base.

Definition at line 49 of file Champ_front_Parametrique.h.

◆ completer()

virtual void Champ_front_Parametrique::completer ( )

inlineoverridevirtual

Reimplemented from Champ_front_base.

Definition at line 60 of file Champ_front_Parametrique.h.

◆ derivee_en_temps()

const DoubleTab & Champ_front_Parametrique::derivee_en_temps ( ) const

overridevirtual

Reimplemented from Champ_front_base.

Definition at line 114 of file Champ_front_Parametrique.cpp.

◆ domaine_dis()

const Domaine_dis_base & Champ_front_Parametrique::domaine_dis ( ) const

inlineoverridevirtual

Reimplemented from Champ_front_base.

Definition at line 41 of file Champ_front_Parametrique.h.

◆ fixer_nature_du_champ()

Nature_du_champ Champ_front_Parametrique::fixer_nature_du_champ ( Nature_du_champ n )

inlineoverridevirtual

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 from Field_base.

Definition at line 55 of file Champ_front_Parametrique.h.

◆ fixer_nb_comp()

void Champ_front_Parametrique::fixer_nb_comp ( int i )

inlineoverridevirtual

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 from Field_base.

Definition at line 52 of file Champ_front_Parametrique.h.

◆ fixer_nb_valeurs_temporelles()

void Champ_front_Parametrique::fixer_nb_valeurs_temporelles ( int nb_cases )

inlineoverridevirtual

Called by Conds_lim::completer. By default does nothing.

To override in unsteady front fields.

Reimplemented from Champ_front_base.

Definition at line 61 of file Champ_front_Parametrique.h.

◆ frontiere_dis() [1/2]

const Frontiere_dis_base & Champ_front_Parametrique::frontiere_dis ( ) const

inlineoverridevirtual

Returns the discretized boundary associated with the field.

(const version)

Returns: (Frontiere_dis_base&) the discretized boundary associated with the field

Reimplemented from Champ_front_base.

Definition at line 39 of file Champ_front_Parametrique.h.

◆ frontiere_dis() [2/2]

Frontiere_dis_base & Champ_front_Parametrique::frontiere_dis ( )

inlineoverridevirtual

Returns the discretized boundary associated with the field.

Returns: (Frontiere_dis_base&) the discretized boundary associated with the field

Reimplemented from Champ_front_base.

Definition at line 40 of file Champ_front_Parametrique.h.

◆ get_temps_defaut()

double Champ_front_Parametrique::get_temps_defaut ( ) const

inlineoverridevirtual

Reimplemented from Champ_front_base.

Definition at line 47 of file Champ_front_Parametrique.h.

◆ initialiser()

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

inlineoverridevirtual

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 Champ_front_base.

Definition at line 59 of file Champ_front_Parametrique.h.

◆ instationnaire()

bool Champ_front_Parametrique::instationnaire ( ) const

inlineoverridevirtual

Reimplemented from Champ_front_base.

Definition at line 66 of file Champ_front_Parametrique.h.

◆ mettre_a_jour()

void Champ_front_Parametrique::mettre_a_jour ( double temps )

inlineoverridevirtual

DOES NOTHING, to override.

This method is called at the beginning of each time step or sub-time-step, it may possibly use data external to the equation. It is up to the algorithm to ensure that this data is relevant... Calculates the value of the boundary condition at the requested time.

Parameters

(double)

Reimplemented from Champ_front_base.

Definition at line 43 of file Champ_front_Parametrique.h.

◆ nature_du_champ()

Nature_du_champ Champ_front_Parametrique::nature_du_champ ( ) const

inlineoverridevirtual

Reimplemented from Field_base.

Definition at line 54 of file Champ_front_Parametrique.h.

◆ nb_comp()

int Champ_front_Parametrique::nb_comp ( ) const

inlineoverridevirtual

Reimplemented from Field_base.

Definition at line 53 of file Champ_front_Parametrique.h.

◆ newCompute()

std::string Champ_front_Parametrique::newCompute ( ) const

Definition at line 56 of file Champ_front_Parametrique.cpp.

◆ reculer()

int Champ_front_Parametrique::reculer ( double temps )

inlineoverridevirtual

To implement in derived classes.

Rewinds in time: the new current time will be the time passed as a parameter.

Returns: (int) 1 if OK, 0 otherwise

Reimplemented from Champ_front_base.

Definition at line 51 of file Champ_front_Parametrique.h.

◆ set_temps_defaut()

void Champ_front_Parametrique::set_temps_defaut ( double temps )

inlineoverridevirtual

Reimplemented from Champ_front_base.

Definition at line 48 of file Champ_front_Parametrique.h.

◆ valeurs() [1/4]

virtual const DoubleTab & Champ_front_Parametrique::valeurs ( ) const

inlineoverridevirtual

Returns the array of field values at the default time.

(const version)

Returns: (DoubleTab&) the array of field values

Reimplemented from Champ_front_base.

Definition at line 36 of file Champ_front_Parametrique.h.

◆ valeurs() [2/4]

virtual DoubleTab & Champ_front_Parametrique::valeurs ( )

inlineoverridevirtual

Returns the array of field values.

Returns: (DoubleTab&) the array of field values at the default time.

Reimplemented from Champ_front_base.

Definition at line 35 of file Champ_front_Parametrique.h.

◆ valeurs() [3/4]

virtual DoubleTab & Champ_Proto::valeurs ( double temps )

inlinevirtual

Reimplemented from Champ_front_base.

Definition at line 44 of file Champ_Proto.h.

◆ valeurs() [4/4]

virtual const DoubleTab & Champ_Proto::valeurs ( double temps ) const

inlinevirtual

Reimplemented from Champ_front_base.

Definition at line 45 of file Champ_Proto.h.

◆ valeurs_au_temps() [1/2]

const DoubleTab & Champ_front_Parametrique::valeurs_au_temps ( double temps ) const

inlineoverridevirtual

Implements Champ_front_base.

Definition at line 38 of file Champ_front_Parametrique.h.

◆ valeurs_au_temps() [2/2]

DoubleTab & Champ_front_Parametrique::valeurs_au_temps ( double temps )

inlineoverridevirtual

Implements Champ_front_base.

Definition at line 37 of file Champ_front_Parametrique.h.

◆ valeurs_face()

void Champ_front_Parametrique::valeurs_face	(	int	num_face,
		DoubleVect &	val ) const

inlineoverridevirtual

Returns the vector of field values for the given face.

By default for func fields, we assume that the values array holds nb_faces * nb_compo_ values. Special case example: champ_front_uniforme::valeurs_face

Parameters

(num_face)	the index of a face on the boundary 0 <= num_face < frontiere_dis().frontiere().nb_faces()
(val)	Resize this array and fill it.

Reimplemented from Champ_front_base.

Definition at line 45 of file Champ_front_Parametrique.h.

◆ verifier()

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

inlineoverridevirtual

Reimplemented from Champ_front_base.

Definition at line 46 of file Champ_front_Parametrique.h.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ affecter_()

◆ associer_fr_dis_base()

◆ avancer()

◆ calculer_coeffs_echange()

◆ calculer_derivee_en_temps()

◆ champ() [1/2]

◆ champ() [2/2]

◆ changer_temps_futur()

◆ completer()

◆ derivee_en_temps()

◆ domaine_dis()

◆ fixer_nature_du_champ()

◆ fixer_nb_comp()

◆ fixer_nb_valeurs_temporelles()

◆ frontiere_dis() [1/2]

◆ frontiere_dis() [2/2]

◆ get_temps_defaut()

◆ initialiser()

◆ instationnaire()

◆ mettre_a_jour()

◆ nature_du_champ()

◆ nb_comp()

◆ newCompute()

◆ reculer()

◆ set_temps_defaut()

◆ valeurs() [1/4]

◆ valeurs() [2/4]

◆ valeurs() [3/4]

◆ valeurs() [4/4]

◆ valeurs_au_temps() [1/2]

◆ valeurs_au_temps() [2/2]

◆ valeurs_face()

◆ verifier()