class Periodique This class represents a periodic boundary condition. More...

#include <Periodique.h>

Inheritance diagram for Periodique:

Collaboration diagram for Periodique:

Public Member Functions
void	mettre_a_jour (double temps) override
	Performs a time update of the boundary condition.
int	face_associee (int i) const
const ArrOfInt &	face_associee () const
double	distance () const
const ArrOfDouble &	direction_perio () const
int	direction_periodicite () const
int	est_periodique_selon_un_axe () const
Public Member Functions inherited from Cond_lim_base
virtual int	initialiser (double temps)
	Initialization at the beginning of the calculation.
virtual void	resetTime (double time)
virtual void	calculer_coeffs_echange (double temps)
	Computation of exchange coefficients for coupling via Champ_front_contact_VEF.
virtual void	verifie_ch_init_nb_comp () const
	Calls the verification of the field read through the equation for which the boundary condition is considered.
virtual Frontiere_dis_base &	frontiere_dis ()
	Returns the discretized boundary to which the boundary conditions apply.
virtual const Frontiere_dis_base &	frontiere_dis () const
	Returns the discretized boundary to which the boundary conditions apply.
virtual void	associer_fr_dis_base (const Frontiere_dis_base &)
	Associates the boundary with the object.
Domaine_Cl_dis_base &	domaine_Cl_dis ()
	Returns the domain of discretized boundary conditions to which the object belongs.
const Domaine_Cl_dis_base &	domaine_Cl_dis () const
	Returns the domain of discretized boundary conditions to which the object belongs.
virtual void	associer_domaine_cl_dis_base (const Domaine_Cl_dis_base &)
	Associates the Domaine_Cl_dis_base (domain of discretized boundary conditions) with the object.
Champ_front_base &	champ_front ()
const Champ_front_base &	champ_front () const
virtual void	set_temps_defaut (double temps)
	Changes the i-th future time of the BC.
virtual void	fixer_nb_valeurs_temporelles (int nb_cases)
	Called by Conds_lim::completer. Calls cha_front_base::fixer_nb_valeurs_temporelles.
virtual void	champ_front (int, DoubleVect &) const
virtual int	compatible_avec_discr (const Discretisation_base &) const
	Returns 1 if the boundary condition is compatible with the discretization passed as parameter.
virtual void	injecter_dans_champ_inc (const Champ_Inc_base &) const
virtual int	a_mettre_a_jour_ss_pas_dt ()
	Indicates whether this boundary condition must be updated during sub-time steps of a time scheme such as RK.
void	set_modifier_val_imp (int)
	Sets the modifier_val_imp flag to the given value: - if drap == 1: modifier_val_imp=1.
virtual void	changer_temps_futur (double temps, int i)
	Changes the i-th future time of the BC.
virtual int	avancer (double temps)
	Rotates the wheel of the BC.
virtual int	reculer (double temps)
	Rotates the wheel of the BC.
virtual bool	is_bc_rayo_milieu_transp (Cond_lim_rayo_milieu_transp *&la_cl_rayo)
virtual bool	is_bc_rayo_semi_transp (Cond_lim_rayo_semi_transp *&la_cl_rayo)
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.
virtual void	nommer (const Nom &)
	Assigns a name to the Objet_U. Virtual method to override.
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
int	compatible_avec_eqn (const Equation_base &) const override
void	completer () override
	DOES NOTHING must be overridden in derived classes.
Protected Member Functions inherited from Cond_lim_base
	OWN_PTR (Champ_front_base) le_champ_front
	OBS_PTR (Domaine_Cl_dis_base) mon_dom_cl_dis
void	err_pas_compatible (const Equation_base &) const
	This method is called when the boundary condition is not compatible with the equation on which we try.
void	err_pas_compatible (const Discretisation_base &) const
	This method is called when the boundary condition is not compatible with the discretization on which we try.
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
ArrOfInt	face_front_associee_
ArrOfDouble	direction_perio_
double	distance_ = -500.
int	direction_xyz_ = -100
Protected Attributes inherited from Cond_lim_base
std::vector< Motcle >	app_domains
std::vector< Nom >	supp_discs
int	modifier_val_imp = 0

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 Periodique This class represents a periodic boundary condition.

Periodicity can be specified in X, Y or Z.
All faces of the boundary associated with this condition must
have the same orientation.

See also: Cond_lim_base, All faces of the boundary associated with this condition must have the same orientation

Definition at line 30 of file Periodique.h.

Member Function Documentation

◆ compatible_avec_eqn()

int Periodique::compatible_avec_eqn ( const Equation_base & ) const

inlineoverrideprotectedvirtual

Reimplemented from Cond_lim_base.

Definition at line 50 of file Periodique.h.

◆ completer()

void Periodique::completer ( )

overrideprotectedvirtual

DOES NOTHING must be overridden in derived classes.

Reimplemented from Cond_lim_base.

Definition at line 39 of file Periodique.cpp.

◆ direction_perio()

const ArrOfDouble & Periodique::direction_perio ( ) const

inline

Definition at line 38 of file Periodique.h.

◆ direction_periodicite()

int Periodique::direction_periodicite ( ) const

Definition at line 147 of file Periodique.cpp.

◆ distance()

double Periodique::distance ( ) const

inline

Definition at line 37 of file Periodique.h.

◆ est_periodique_selon_un_axe()

int Periodique::est_periodique_selon_un_axe ( ) const

inline

Definition at line 40 of file Periodique.h.

◆ face_associee() [1/2]

const ArrOfInt & Periodique::face_associee ( ) const

inline

Definition at line 36 of file Periodique.h.

◆ face_associee() [2/2]

int Periodique::face_associee ( int i ) const

inline

Definition at line 35 of file Periodique.h.

◆ mettre_a_jour()

void Periodique::mettre_a_jour ( double temps )

inlineoverridevirtual

Performs a time update of the boundary condition.

Parameters

(double temps) the time step for update

Reimplemented from Cond_lim_base.

Definition at line 34 of file Periodique.h.

Member Data Documentation

◆ direction_perio_

ArrOfDouble Periodique::direction_perio_

protected

Definition at line 46 of file Periodique.h.

◆ direction_xyz_

int Periodique::direction_xyz_ = -100

protected

Definition at line 49 of file Periodique.h.

◆ distance_

double Periodique::distance_ = -500.

protected

Definition at line 47 of file Periodique.h.

◆ face_front_associee_

ArrOfInt Periodique::face_front_associee_

protected

Definition at line 45 of file Periodique.h.

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

/home/docs/trust-code/src/Kernel/Geometrie/Periodique.h
/home/docs/trust-code/src/Kernel/Geometrie/Periodique.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ compatible_avec_eqn()

◆ completer()

◆ direction_perio()

◆ direction_periodicite()

◆ distance()

◆ est_periodique_selon_un_axe()

◆ face_associee() [1/2]

◆ face_associee() [2/2]

◆ mettre_a_jour()

Member Data Documentation

◆ direction_perio_

◆ direction_xyz_

◆ distance_

◆ face_front_associee_