TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Cond_lim_base Class Reference

class Cond_lim_base Base class for the hierarchy of classes that represent the different boundary conditions (Dirichlet, Neumann ...). More...

#include <Cond_lim_base.h>

Inheritance diagram for Cond_lim_base:
[legend]
Collaboration diagram for Cond_lim_base:
[legend]

Public Member Functions

virtual void completer ()
 DOES NOTHING must be overridden in derived classes.
virtual int initialiser (double temps)
 Initialization at the beginning of the calculation.
virtual void mettre_a_jour (double temps)
 Performs a time update of the boundary condition.
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_basefrontiere_dis ()
 Returns the discretized boundary to which the boundary conditions apply.
virtual const Frontiere_dis_basefrontiere_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_basedomaine_Cl_dis ()
 Returns the domain of discretized boundary conditions to which the object belongs.
const Domaine_Cl_dis_basedomaine_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_basechamp_front ()
const Champ_front_basechamp_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_eqn (const Equation_base &) 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 SortieprintOn (Sortie &) const
 Writes the object to an output stream. Virtual method to override.
virtual EntreereadOn (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 Nomle_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_infoget_info () const
 Returns type information for the Objet_U.
const Nomque_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 Interpreteinterprete () const
Interpreteinterprete ()
Public Member Functions inherited from Process
virtual ~Process ()

Protected Member Functions

 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_Uoperator= (const Objet_U &)
 Assignment operator: does nothing (the number and identifier are preserved).
virtual void set_param (Param &) const

Protected Attributes

std::vector< Motcleapp_domains
std::vector< Nomsupp_discs
int modifier_val_imp = 0

Additional Inherited Members

Static Public Member Functions inherited from Objet_U
static const Nomnom_du_cas ()
 Returns a constant reference to the case name. This method is static.
static Nomget_set_nom_du_cas ()
 Returns a non-constant reference to the case name (to allow modification). This method is static.
static const Type_infoinfo ()
 Returns type information for the Objet_U (static version).
static const Objet_Uself_cast (const Objet_U &)
 Method added for casting in Python.
static Objet_Uself_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 SortieJournal (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 Cond_lim_base Base class for the hierarchy of classes that represent the different boundary conditions (Dirichlet, Neumann ...).

A boundary condition object serves to define, for a given equation, the boundary conditions to apply on a boundary of a domain.
Each Cond_lim_base object contains a reference to the Domaine_Cl_dis_base object it is part of.
Each object also contains an OWN_PTR(Champ_front_base) object containing the values to impose on the boundary.
See also
Cond_lim Domaine_Cl_dis_base Frontiere_dis_base, Abstract class from which all objects representing boundary conditions must derive., Abstract method:, int compatible_avec_eqn(const Equation_base&) const

Definition at line 39 of file Cond_lim_base.h.

Member Function Documentation

◆ a_mettre_a_jour_ss_pas_dt()

int Cond_lim_base::a_mettre_a_jour_ss_pas_dt ( )
virtual

Indicates whether this boundary condition must be updated during sub-time steps of a time scheme such as RK.

By default it returns 0 to indicate that no update is necessary; it must be overloaded to return 1 if needed (example: Echange_impose_base)

Parameters
(doubletemps) the time step for update

Reimplemented in Echange_impose_base.

Definition at line 116 of file Cond_lim_base.cpp.

◆ associer_domaine_cl_dis_base()

void Cond_lim_base::associer_domaine_cl_dis_base ( const Domaine_Cl_dis_base & zcl)
virtual

Associates the Domaine_Cl_dis_base (domain of discretized boundary conditions) with the object.

This Domaine_Cl_dis_base stores (references) all the boundary conditions relative to a geometric domain.

Parameters
(Domaine_Cl_dis_base&zcl) a domain of discretized boundary conditions to which the Cond_lim_base object refers

Reimplemented in Courant_impose, Dirichlet_loi_paroi, Echange_global_impose_turbulent, and Frottement_impose_base.

Definition at line 170 of file Cond_lim_base.cpp.

◆ associer_fr_dis_base()

void Cond_lim_base::associer_fr_dis_base ( const Frontiere_dis_base & fr)
virtual

Associates the boundary with the object.

The Frontiere_dis_base object is in fact associated with the member OWN_PTR(Champ_front_base) of the Cond_lim_base object that represents the field of boundary conditions imposed on the boundary.

Parameters
(Frontiere_dis_base&fr) the boundary on which the boundary conditions are imposed

Reimplemented in Dirichlet_loi_paroi, Echange_global_impose_turbulent, Echange_impose_base, Echange_interne_impose, Frottement_impose_base, and Neumann_sortie_libre.

Definition at line 156 of file Cond_lim_base.cpp.

◆ avancer()

◆ calculer_coeffs_echange()

void Cond_lim_base::calculer_coeffs_echange ( double temps)
virtual

Computation of exchange coefficients for coupling via Champ_front_contact_VEF.

These computations are local to the problem and depend only on the unknown. They must therefore be done every time the unknown is modified. They are available externally and stored in the BCs. WEC: Champ_front_contact_VEF should disappear and this method with it!!!

Parameters
(doubletemps) the time step for update

Reimplemented in Dirichlet_loi_paroi, Echange_global_impose_turbulent, and Frottement_impose_base.

Definition at line 132 of file Cond_lim_base.cpp.

◆ champ_front() [1/3]

Champ_front_base & Cond_lim_base::champ_front ( )
inline

Definition at line 137 of file Cond_lim_base.h.

◆ champ_front() [2/3]

const Champ_front_base & Cond_lim_base::champ_front ( ) const
inline

Definition at line 142 of file Cond_lim_base.h.

◆ champ_front() [3/3]

void Cond_lim_base::champ_front ( int face,
DoubleVect & var ) const
virtual

Definition at line 218 of file Cond_lim_base.cpp.

◆ changer_temps_futur()

void Cond_lim_base::changer_temps_futur ( double temps,
int i )
virtual

◆ compatible_avec_discr()

int Cond_lim_base::compatible_avec_discr ( const Discretisation_base & discr) const
virtual

Returns 1 if the boundary condition is compatible with the discretization passed as parameter.

Parameters
(Discretisation_base&)the discretization with which we want to verify compatibility

Reimplemented in Echange_global_impose, and Echange_interne_global_parfait.

Definition at line 180 of file Cond_lim_base.cpp.

◆ compatible_avec_eqn()

◆ completer()

void Cond_lim_base::completer ( )
virtual

DOES NOTHING must be overridden in derived classes.

Reimplemented in Cond_lim_k_complique_transition_flux_nul_demi, Cond_lim_k_simple_flux_nul, Cond_lim_omega_demi, Cond_lim_omega_dix, Courant_impose, Dirichlet_loi_paroi, Dirichlet_paroi_defilante, Echange_contact_Correlation_VDF, Echange_contact_Correlation_VEF, Echange_contact_PolyMAC_CDO, Echange_contact_rayo_semi_transp_VDF, Echange_contact_rayo_transp_VDF, Echange_contact_VDF, Echange_contact_VDF_FT_Disc, Echange_contact_VDF_FT_Disc_solid, Echange_couplage_thermique, Echange_externe_impose_H, Echange_externe_impose_rayo_semi_transp, Echange_externe_impose_rayo_transp, Echange_global_impose, Echange_global_impose_rayo_semi_transp, Echange_interne_global_impose, Echange_interne_impose, Entree_fluide_temperature_imposee_H, Flux_radiatif_base, Frontiere_ouverte_rayo_semi_transp, Frontiere_ouverte_rayo_transp, Frontiere_ouverte_rho_u_impose, Frontiere_ouverte_temperature_imposee_rayo_semi_transp, Frontiere_ouverte_temperature_imposee_rayo_transp, Frottement_impose_base, Neumann_paroi_rayo_semi_transp_VDF, Neumann_paroi_rayo_semi_transp_VEF, Neumann_sortie_libre_Temp_H, Paroi_flux_impose_rayo_transp, Paroi_flux_impose_rayo_transp_VDF, Paroi_flux_impose_rayo_transp_VEF, Paroi_frottante_loi, Paroi_frottante_simple, Paroi_Knudsen_non_negligeable, Periodique, Robin_VEF, Sortie_libre_Gradient_Pression_impose, Sortie_libre_Gradient_Pression_libre_VEF, Sortie_libre_Gradient_Pression_libre_VEFPreP1B, Sortie_libre_pression_imposee, Sortie_libre_Pression_imposee_Orlansky, Sortie_libre_pression_imposee_QC, Sortie_libre_pression_moyenne_imposee, Sortie_libre_rho_variable, Temperature_imposee_paroi_H, Temperature_imposee_paroi_rayo_semi_transp, and Temperature_imposee_paroi_rayo_transp.

Definition at line 31 of file Cond_lim_base.cpp.

◆ domaine_Cl_dis() [1/2]

Domaine_Cl_dis_base & Cond_lim_base::domaine_Cl_dis ( )
inline

Returns the domain of discretized boundary conditions to which the object belongs.

Returns
(Domaine_Cl_dis_base&) the domain of discretized boundary conditions to which the object belongs

Definition at line 121 of file Cond_lim_base.h.

◆ domaine_Cl_dis() [2/2]

const Domaine_Cl_dis_base & Cond_lim_base::domaine_Cl_dis ( ) const
inline

Returns the domain of discretized boundary conditions to which the object belongs.

(const version)

Returns
(Domaine_Cl_dis_base&) the domain of discretized boundary conditions to which the object belongs

Definition at line 132 of file Cond_lim_base.h.

◆ err_pas_compatible() [1/2]

void Cond_lim_base::err_pas_compatible ( const Discretisation_base & discr) const
protected

This method is called when the boundary condition is not compatible with the discretization on which we try.

to apply it.

Parameters
(Discretisation_base&discr) the discretization with which the boundary condition is incompatible

Definition at line 212 of file Cond_lim_base.cpp.

◆ err_pas_compatible() [2/2]

void Cond_lim_base::err_pas_compatible ( const Equation_base & eqn) const
protected

This method is called when the boundary condition is not compatible with the equation on which we try.

to apply it.

Parameters
(Equation_base&eqn) the equation with which the boundary condition is incompatible

Definition at line 200 of file Cond_lim_base.cpp.

◆ fixer_nb_valeurs_temporelles()

void Cond_lim_base::fixer_nb_valeurs_temporelles ( int nb_cases)
virtual

Called by Conds_lim::completer. Calls cha_front_base::fixer_nb_valeurs_temporelles.

Reimplemented in Dirichlet_loi_paroi, Echange_global_impose_turbulent, Echange_impose_base, Echange_interne_impose, Frottement_impose_base, and Neumann_sortie_libre.

Definition at line 240 of file Cond_lim_base.cpp.

◆ frontiere_dis() [1/2]

Frontiere_dis_base & Cond_lim_base::frontiere_dis ( )
inlinevirtual

Returns the discretized boundary to which the boundary conditions apply.

Returns
(Frontiere_dis_base&) the discretized boundary to which the boundary conditions are associated

Reimplemented in Dirichlet_loi_paroi, Echange_global_impose_turbulent, and Frottement_impose_base.

Definition at line 101 of file Cond_lim_base.h.

◆ frontiere_dis() [2/2]

const Frontiere_dis_base & Cond_lim_base::frontiere_dis ( ) const
inlinevirtual

Returns the discretized boundary to which the boundary conditions apply.

(const version)

Returns
(Frontiere_dis_base&) the discretized boundary to which the boundary conditions are associated

Reimplemented in Dirichlet_loi_paroi, Echange_global_impose_turbulent, and Frottement_impose_base.

Definition at line 112 of file Cond_lim_base.h.

◆ initialiser()

◆ injecter_dans_champ_inc()

void Cond_lim_base::injecter_dans_champ_inc ( const Champ_Inc_base & ) const
virtual

Definition at line 223 of file Cond_lim_base.cpp.

◆ is_bc_rayo_milieu_transp()

◆ is_bc_rayo_semi_transp()

◆ mettre_a_jour()

◆ OBS_PTR()

Cond_lim_base::OBS_PTR ( Domaine_Cl_dis_base )
protected

◆ OWN_PTR()

Cond_lim_base::OWN_PTR ( Champ_front_base )
protected

◆ reculer()

int Cond_lim_base::reculer ( double temps)
virtual

◆ resetTime()

void Cond_lim_base::resetTime ( double time)
virtual

Definition at line 103 of file Cond_lim_base.cpp.

◆ set_modifier_val_imp()

void Cond_lim_base::set_modifier_val_imp ( int drap)
inline

Sets the modifier_val_imp flag to the given value: - if drap == 1: modifier_val_imp=1.

  • otherwise : modifier_val_imp=0 This flag allows the BC to know whether it should return the stored value as-is, or whether it should translate it for the calling object. It is up to the BC to then decide what translation to perform. See application in Temperature_imposee_paroi_H, where the BC returns the enthalpy by default (modifier_val_imp=1), or the temperature otherwise (case of the diffusion operator). The flag is set in equation.derivee_en_temps_inco according to the operator that will be called.
Parameters
(drap)value to assign to the flag

Definition at line 160 of file Cond_lim_base.h.

◆ set_temps_defaut()

void Cond_lim_base::set_temps_defaut ( double temps)
virtual

◆ verifie_ch_init_nb_comp()

void Cond_lim_base::verifie_ch_init_nb_comp ( ) const
virtual

Calls the verification of the field read through the equation for which the boundary condition is considered.

The method is overloaded in cases where the user must specify the boundary field.

Reimplemented in CL_Contrainte_Imposee, Courant_impose, Dirichlet, Dirichlet_loi_paroi, Echange_contact_PolyMAC_HFV, Echange_global_impose_rayo_semi_transp, Echange_global_impose_turbulent, Echange_interne_global_impose, Echange_interne_impose, Frottement_impose_base, Neumann_paroi, and Neumann_sortie_libre.

Definition at line 143 of file Cond_lim_base.cpp.

Member Data Documentation

◆ app_domains

std::vector<Motcle> Cond_lim_base::app_domains
protected

Definition at line 86 of file Cond_lim_base.h.

◆ modifier_val_imp

int Cond_lim_base::modifier_val_imp = 0
protected

Definition at line 94 of file Cond_lim_base.h.

◆ supp_discs

std::vector<Nom> Cond_lim_base::supp_discs
protected

Definition at line 87 of file Cond_lim_base.h.


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