class Domaine_Cl_dis_base Domaine_Cl_dis_base objects represent discretized boundary conditions More...

#include <Domaine_Cl_dis_base.h>

Inheritance diagram for Domaine_Cl_dis_base:

Collaboration diagram for Domaine_Cl_dis_base:

Public Member Functions
void	nommer (const Nom &nom) override
	Assigns a name to the Objet_U. Virtual method to override.
const Cond_lim &	les_conditions_limites (int) const
	Returns the i-th boundary condition.
Cond_lim &	les_conditions_limites (int)
	Returns the i-th boundary condition.
Conds_lim &	les_conditions_limites ()
	Returns the array of boundary conditions.
const Conds_lim &	les_conditions_limites () const
	Returns the array of boundary conditions.
int	nb_cond_lim () const
	Returns the number of boundary conditions.
virtual void	mettre_a_jour (double temps)
	Performs a time update of all boundary conditions.
virtual void	mettre_a_jour_ss_pas_dt (double temps)
	Performs a time update for sub-time-steps of a time scheme (e.g. in RungeKutta).
void	resetTime (double time)
void	completer ()
	Calls Cond_lim_base::completer() on each boundary condition.
int	contient_Cl (const Nom &)
	Returns 1 if the object contains a boundary condition with the specified Name.
Domaine_dis_base &	domaine_dis ()
	Returns a reference to the discretized domain associated with the boundary conditions.
const Domaine_dis_base &	domaine_dis () const
	Returns a reference to the discretized domain associated with the boundary conditions.
Domaine &	domaine ()
const Domaine &	domaine () const
virtual void	associer (const Domaine_dis_base &ddb)
virtual int	calculer_coeffs_echange (double temps)
	Computes the exchange coefficients for thermally coupled problems.
virtual void	imposer_cond_lim (Champ_Inc_base &, double)=0
int	nb_faces_Cl () const
virtual const Cond_lim &	la_cl_de_la_face (int num_face) const
	Given a boundary face index in the Domaine_VF, returns the boundary condition to which this face.
const Cond_lim_base &	condition_limite_de_la_face_reelle (int face_globale, int &face_locale) const
	Returns the boundary condition associated with a given real face.
const Cond_lim_base &	condition_limite_de_la_face_virtuelle (int face_globale, int &face_locale) const
	Returns the boundary condition associated with a given virtual face.
const Cond_lim_base &	condition_limite_de_la_frontiere (Nom frontiere) const
	Returns the boundary condition associated with a boundary of the given name.
Cond_lim_base &	condition_limite_de_la_frontiere (Nom frontiere)
	Returns the boundary condition associated with a boundary of the given name.
void	changer_temps_futur (double temps, int i)
	Changes the i-th future time of all BCs.
void	calculer_derivee_en_temps (double t1, double t2)
	Computes the growth rate of unsteady BCs between t1 and t2.
void	set_temps_defaut (double temps)
	Changes the i-th future time of all BCs.
int	avancer (double temps)
	Rotates the wheel of all BCs up to the given time.
int	reculer (double temps)
	Rotates the wheel of all BCs back to the given time.
virtual int	initialiser (double temps)
	Initializes the BCs. Unlike the update methods, the.
const Nom &	le_nom () const override
	Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
virtual void	associer_inconnue (const Champ_Inc_base &)
virtual const Champ_Inc_base &	inconnue () const
virtual Champ_Inc_base &	inconnue ()
Public Member Functions inherited from MorEqn
void	associer_eqn (const Equation_base &)
	Associates an equation with the object.
virtual void	calculer_pour_post (Champ_base &espace_stockage, const Nom &option, int comp) const
virtual Motcle	get_localisation_pour_post (const Nom &option) const
const Equation_base &	equation () const
	Returns the reference to the equation pointed to by MorEqn::mon_equation.
Equation_base &	equation ()
	Returns the reference to the equation pointed to by MorEqn::mon_equation.
int	mon_equation_non_nul () const
virtual void	check_multiphase_compatibility () const
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 Member Functions
	OBS_PTR (Champ_Inc_base) mon_inconnue
virtual void	completer (const Domaine_dis_base &)=0
Protected Member Functions inherited from MorEqn
	OBS_PTR (Equation_base) mon_equation
virtual	~MorEqn ()
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_
Conds_lim	les_conditions_limites_

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 Domaine_Cl_dis_base Domaine_Cl_dis_base objects represent discretized boundary conditions

. Domaine_Cl_dis_base is a piece of equation so it
inherits from MorEqn, it is through this inheritance that each
Domaine_Cl_dis_base object contains a reference to the equation to which it
refers. The discretized boundary conditions represent the
boundary conditions of the discretized domain associated with the equation
referenced by Domaine_Cl_dis_base.
Domaine_Cl_dis_base has a member representing the boundary conditions.

See also: MorEqn Conds_lim Cond_lim_base, Abstract class., Abstract methods:, void completer(const Domaine_dis_base& ), void imposer_cond_lim(Champ_Inc_base& )

Definition at line 36 of file Domaine_Cl_dis_base.h.

Member Function Documentation

◆ associer()

virtual void Domaine_Cl_dis_base::associer ( const Domaine_dis_base & ddb )

inlinevirtual

Reimplemented in Domaine_Cl_VDF, and Domaine_Cl_VEF.

Definition at line 60 of file Domaine_Cl_dis_base.h.

◆ associer_inconnue()

void Domaine_Cl_dis_base::associer_inconnue ( const Champ_Inc_base & inco )

virtual

Definition at line 483 of file Domaine_Cl_dis_base.cpp.

◆ avancer()

int Domaine_Cl_dis_base::avancer ( double temps )

Rotates the wheel of all BCs up to the given time.

Definition at line 204 of file Domaine_Cl_dis_base.cpp.

◆ calculer_coeffs_echange()

int Domaine_Cl_dis_base::calculer_coeffs_echange ( double temps )

virtual

Computes the exchange coefficients for thermally coupled problems.

Returns: (int) always returns 1

Definition at line 272 of file Domaine_Cl_dis_base.cpp.

◆ calculer_derivee_en_temps()

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

Computes the growth rate of unsteady BCs between t1 and t2.

Definition at line 370 of file Domaine_Cl_dis_base.cpp.

◆ changer_temps_futur()

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

Changes the i-th future time of all BCs.

Definition at line 186 of file Domaine_Cl_dis_base.cpp.

◆ completer() [1/2]

void Domaine_Cl_dis_base::completer ( )

Calls Cond_lim_base::completer() on each boundary condition.

Definition at line 281 of file Domaine_Cl_dis_base.cpp.

◆ completer() [2/2]

virtual void Domaine_Cl_dis_base::completer ( const Domaine_dis_base & )

protectedpure virtual

Implemented in Domaine_Cl_Coloc, Domaine_Cl_DG, Domaine_Cl_EF, Domaine_Cl_PolyMAC_family, Domaine_Cl_VDF, and Domaine_Cl_VEF.

◆ condition_limite_de_la_face_reelle()

const Cond_lim_base & Domaine_Cl_dis_base::condition_limite_de_la_face_reelle	(	int	face_globale,
		int &	face_locale ) const

Returns the boundary condition associated with a given real face.

Stores in face_locale the face number within the boundary. Triggers an error if the face does not have a BC.

Definition at line 293 of file Domaine_Cl_dis_base.cpp.

◆ condition_limite_de_la_face_virtuelle()

const Cond_lim_base & Domaine_Cl_dis_base::condition_limite_de_la_face_virtuelle	(	int	face_globale,
		int &	face_locale ) const

Returns the boundary condition associated with a given virtual face.

Stores in face_locale the face number within the boundary. Triggers an error if the face does not have a BC.

Definition at line 314 of file Domaine_Cl_dis_base.cpp.

◆ condition_limite_de_la_frontiere() [1/2]

Cond_lim_base & Domaine_Cl_dis_base::condition_limite_de_la_frontiere ( Nom frontiere )

Returns the boundary condition associated with a boundary of the given name.

Triggers an error if no boundary has this name.

Definition at line 336 of file Domaine_Cl_dis_base.cpp.

◆ condition_limite_de_la_frontiere() [2/2]

const Cond_lim_base & Domaine_Cl_dis_base::condition_limite_de_la_frontiere ( Nom frontiere ) const

Returns the boundary condition associated with a boundary of the given name.

Triggers an error if no boundary has this name.

Definition at line 354 of file Domaine_Cl_dis_base.cpp.

◆ contient_Cl()

int Domaine_Cl_dis_base::contient_Cl ( const Nom & type )

Returns 1 if the object contains a boundary condition with the specified Name.

Returns 0 otherwise.

Parameters

(Nom& type) the name of the boundary condition to search for

Returns: (int) 1 if the boundary condition with the specified name was found, 0 otherwise.

Definition at line 151 of file Domaine_Cl_dis_base.cpp.

◆ domaine() [1/2]

Domaine & Domaine_Cl_dis_base::domaine ( )

Definition at line 435 of file Domaine_Cl_dis_base.cpp.

◆ domaine() [2/2]

const Domaine & Domaine_Cl_dis_base::domaine ( ) const

Definition at line 439 of file Domaine_Cl_dis_base.cpp.

◆ domaine_dis() [1/2]

Domaine_dis_base & Domaine_Cl_dis_base::domaine_dis ( )

Returns a reference to the discretized domain associated with the boundary conditions.

This Domaine_dis is associated through the associated equation and not directly with the Domaine_Cl_dis_base object.

Returns: (Domaine_dis_base&) the discretized domain associated with the equation associated with the boundary conditions.

Definition at line 165 of file Domaine_Cl_dis_base.cpp.

◆ domaine_dis() [2/2]

const Domaine_dis_base & Domaine_Cl_dis_base::domaine_dis ( ) const

Returns a reference to the discretized domain associated with the boundary conditions.

This Domaine_dis is associated through the associated equation and not directly with the Domaine_Cl_dis_base object. (const version)

Returns: (Domaine_dis_base&) the discretized domain associated with the equation associated with the boundary conditions.

Definition at line 178 of file Domaine_Cl_dis_base.cpp.

◆ imposer_cond_lim()

virtual void Domaine_Cl_dis_base::imposer_cond_lim	(	Champ_Inc_base &	,
		double	)

pure virtual

Implemented in Domaine_Cl_Coloc, Domaine_Cl_DG, Domaine_Cl_EF, Domaine_Cl_PolyMAC_family, Domaine_Cl_VDF, and Domaine_Cl_VEF.

◆ inconnue() [1/2]

Champ_Inc_base & Domaine_Cl_dis_base::inconnue ( )

virtual

Definition at line 493 of file Domaine_Cl_dis_base.cpp.

◆ inconnue() [2/2]

const Champ_Inc_base & Domaine_Cl_dis_base::inconnue ( ) const

virtual

Definition at line 488 of file Domaine_Cl_dis_base.cpp.

◆ initialiser()

int Domaine_Cl_dis_base::initialiser ( double temps )

virtual

Initializes the BCs. Unlike the update methods, the.

initialize methods of BCs cannot depend on the outside (it may not be initialized itself)

Returns: (int) 1 if OK, 0 otherwise

Reimplemented in Domaine_Cl_DG, Domaine_Cl_EF, Domaine_Cl_PolyMAC_family, and Domaine_Cl_VEF.

Definition at line 263 of file Domaine_Cl_dis_base.cpp.

◆ la_cl_de_la_face()

const Cond_lim & Domaine_Cl_dis_base::la_cl_de_la_face ( int num_face ) const

virtual

Given a boundary face index in the Domaine_VF, returns the boundary condition to which this face.

belongs, for 0 <= num_face < nb_faces_Cl().

Reimplemented in Domaine_Cl_VDF.

Definition at line 449 of file Domaine_Cl_dis_base.cpp.

◆ le_nom()

const Nom & Domaine_Cl_dis_base::le_nom ( ) const

inlineoverridevirtual

Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.

Returns: The name of the Objet_U.

Reimplemented from Objet_U.

Definition at line 93 of file Domaine_Cl_dis_base.h.

◆ les_conditions_limites() [1/4]

Conds_lim & Domaine_Cl_dis_base::les_conditions_limites ( )

Returns the array of boundary conditions.

Returns: (Conds_lim&) the array of boundary conditions

Definition at line 405 of file Domaine_Cl_dis_base.cpp.

◆ les_conditions_limites() [2/4]

const Conds_lim & Domaine_Cl_dis_base::les_conditions_limites ( ) const

Returns the array of boundary conditions.

(const version)

Returns: (Conds_lim&) the array of boundary conditions

Definition at line 416 of file Domaine_Cl_dis_base.cpp.

◆ les_conditions_limites() [3/4]

Cond_lim & Domaine_Cl_dis_base::les_conditions_limites ( int i )

Returns the i-th boundary condition.

Parameters

(int	i) the rank of the i-th boundary condition

Returns: (Cond_lim&) the i-th boundary condition

Definition at line 396 of file Domaine_Cl_dis_base.cpp.

◆ les_conditions_limites() [4/4]

const Cond_lim & Domaine_Cl_dis_base::les_conditions_limites ( int i ) const

Returns the i-th boundary condition.

(const version)

Parameters

(int	i) the rank of the i-th boundary condition

Returns: (Cond_lim&) the i-th boundary condition

Definition at line 386 of file Domaine_Cl_dis_base.cpp.

◆ mettre_a_jour()

void Domaine_Cl_dis_base::mettre_a_jour ( double temps )

virtual

Performs a time update of all boundary conditions.

Parameters

(double temps) the time step for update

Definition at line 227 of file Domaine_Cl_dis_base.cpp.

◆ mettre_a_jour_ss_pas_dt()

void Domaine_Cl_dis_base::mettre_a_jour_ss_pas_dt ( double temps )

virtual

Performs a time update for sub-time-steps of a time scheme (e.g. in RungeKutta).

for all boundary conditions returning 1 through the method int Cond_Lim_base::a_mettre_a_jour_ss_pas_dt();

Parameters

(double temps) the time step for update

Definition at line 246 of file Domaine_Cl_dis_base.cpp.

◆ nb_cond_lim()

int Domaine_Cl_dis_base::nb_cond_lim ( ) const

Returns the number of boundary conditions.

Returns: (int) the number of boundary conditions

Definition at line 425 of file Domaine_Cl_dis_base.cpp.

◆ nb_faces_Cl()

int Domaine_Cl_dis_base::nb_faces_Cl ( ) const

Definition at line 430 of file Domaine_Cl_dis_base.cpp.

◆ nommer()

void Domaine_Cl_dis_base::nommer ( const Nom & nom )

overridevirtual

Assigns a name to the Objet_U. Virtual method to override.

Parameters

nom	The name to assign to the Objet_U.

Reimplemented from Objet_U.

Definition at line 478 of file Domaine_Cl_dis_base.cpp.

◆ OBS_PTR()

Domaine_Cl_dis_base::OBS_PTR ( Champ_Inc_base )

protected

◆ reculer()

int Domaine_Cl_dis_base::reculer ( double temps )

Rotates the wheel of all BCs back to the given time.

Definition at line 215 of file Domaine_Cl_dis_base.cpp.

◆ resetTime()

void Domaine_Cl_dis_base::resetTime ( double time )

Definition at line 234 of file Domaine_Cl_dis_base.cpp.

◆ set_temps_defaut()

void Domaine_Cl_dis_base::set_temps_defaut ( double temps )

Changes the i-th future time of all BCs.

Definition at line 195 of file Domaine_Cl_dis_base.cpp.

Member Data Documentation

◆ les_conditions_limites_

Conds_lim Domaine_Cl_dis_base::les_conditions_limites_

protected

Definition at line 88 of file Domaine_Cl_dis_base.h.

◆ nom_

Nom Domaine_Cl_dis_base::nom_

protected

Definition at line 87 of file Domaine_Cl_dis_base.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ associer()

◆ associer_inconnue()

◆ avancer()

◆ calculer_coeffs_echange()

◆ calculer_derivee_en_temps()

◆ changer_temps_futur()

◆ completer() [1/2]

◆ completer() [2/2]

◆ condition_limite_de_la_face_reelle()

◆ condition_limite_de_la_face_virtuelle()

◆ condition_limite_de_la_frontiere() [1/2]

◆ condition_limite_de_la_frontiere() [2/2]

◆ contient_Cl()

◆ domaine() [1/2]

◆ domaine() [2/2]

◆ domaine_dis() [1/2]

◆ domaine_dis() [2/2]

◆ imposer_cond_lim()

◆ inconnue() [1/2]

◆ inconnue() [2/2]

◆ initialiser()

◆ la_cl_de_la_face()

◆ le_nom()

◆ les_conditions_limites() [1/4]

◆ les_conditions_limites() [2/4]

◆ les_conditions_limites() [3/4]

◆ les_conditions_limites() [4/4]

◆ mettre_a_jour()

◆ mettre_a_jour_ss_pas_dt()

◆ nb_cond_lim()

◆ nb_faces_Cl()

◆ nommer()

◆ OBS_PTR()

◆ reculer()

◆ resetTime()

◆ set_temps_defaut()

Member Data Documentation

◆ les_conditions_limites_

◆ nom_