TrioCFD 1.9.9_beta
TrioCFD documentation
Loading...
Searching...
No Matches
Champ_front_base Class Referenceabstract

class Champ_front_base Base class for the hierarchy of boundary fields. More...

#include <Champ_front_base.h>

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

Public Member Functions

 Champ_front_base ()
virtual void completer ()
virtual int initialiser (double temps, const Champ_Inc_base &inco)
 Initialization at the beginning of calculation.
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 bool has_valeurs_au_temps (double temps) const
virtual DoubleTab & valeurs_au_temps (double temps)=0
virtual const DoubleTab & valeurs_au_temps (double temps) const =0
virtual const Frontiere_dis_basefrontiere_dis () const
 Returns the discretized boundary associated with the field.
virtual Frontiere_dis_basefrontiere_dis ()
 Returns the discretized boundary associated with the field.
virtual const Domaine_dis_basedomaine_dis () const
virtual Champ_front_baseaffecter_ (const Champ_front_base &ch)=0
virtual void fixer_nb_valeurs_temporelles (int nb_cases)
 Called by Conds_lim::completer. By default does nothing.
virtual void mettre_a_jour (double temps)
 DOES NOTHING, to override.
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 void verifier (const Cond_lim_base &la_cl) const
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 int avancer (double temps)
 To implement in derived classes.
virtual int reculer (double temps)
 To implement in derived classes.
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 Nomle_nom () const override
 Returns the name of the field.
const Nomsget_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 Nomsnoms_compo () const
 Returns the array of names of the field components.
const Nomnom_compo (int) const
 Returns the name of the i-th component of the field.
const Nomnom_compo () const
 Returns the name of a scalar field.
virtual const Nomsfixer_noms_compo (const Noms &)
 Sets the names of the field components.
virtual const Nomfixer_nom_compo (int, const Nom &)
 Sets the name of the i-th component of the field.
virtual const Nomfixer_nom_compo (const Nom &)
 Sets the name of a scalar field.
const Nomsunites () const
 Returns the units of the field components.
const Nomunite () const
 Returns the unit of a scalar field whose all components have the same unit.
const Nomunite (int) const
 Returns the unit of the i-th component of the field.
virtual const Nomsfixer_unites (const Noms &)
 Specifies the units of the field components.
virtual const Nomfixer_unite (const Nom &)
 Specifies the unit of a scalar field or whose all components have the same unit.
virtual const Nomfixer_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 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 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 ()
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 (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_Uoperator= (const Objet_U &)
 Assignment operator: does nothing (the number and identifier are preserved).
virtual void set_param (Param &) const

Protected Attributes

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 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 Champ_front_base Base class for the hierarchy of boundary fields.

A Champ_front_base object defines a field on the boundary of a domain. A Champ_front_base type object will be associated with each boundary condition. Champ_front_base derives from Champ_Proto, in order to have an interface conforming to all fields, and to inherit common operations on Fields. The two main methods are initialiser and mettre_a_jour. These are the only two that can modify the field values. The initialiser method is called once at the beginning of the calculation. It must not depend on data external to the equation carrying the BC (indeed, nothing guarantees that this data is initialized). On the other hand, the values of the unknown on which the BC depends can be useful for initialization => the unknown is passed as a parameter in read-only mode. The mettre_a_jour method is called at the beginning of each time step or sub-time-step, it can use data external to the equation. It is the responsibility of the algorithm to ensure that this data is relevant... In the case of stationary fields, the mettre_a_jour method has nothing to do and the values are filled once and for all by the initialiser method. In the case of unsteady fields, there are several values in time and each can be updated. Champ_front_base are divided into:

The values are stored in a wheel of DoubleTab. If the field is uniform in space, the DoubleTabs are dimensioned to 1. If it is stationary, the wheel has only one temporal value and the time assigned to it is meaningless. If it is unsteady, the temporal values are those of the unknown of the equation to which the field refers.

See also
Champ_Proto Frontiere_dis_base, Abstract class, Abstract method:, Champ_front_base& affecter_(const Champ_front_base& ch)

Definition at line 75 of file Champ_front_base.h.

Constructor & Destructor Documentation

◆ Champ_front_base()

Champ_front_base::Champ_front_base ( )

Definition at line 23 of file Champ_front_base.cpp.

Member Function Documentation

◆ affecter_()

◆ associer_fr_dis_base()

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

Associates a discretized boundary with the field.

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

Reimplemented in Champ_front_Parametrique, and Champ_front_xyz_debit.

Definition at line 56 of file Champ_front_base.cpp.

◆ avancer()

int Champ_front_base::avancer ( double temps)
virtual

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 in Ch_front_var_stationnaire, Champ_Front_Composite, Champ_front_instationnaire_base, Champ_front_Parametrique, Champ_front_uniforme, Champ_front_var_instationnaire, Champ_front_vide, and Champ_front_xyz_debit.

Definition at line 136 of file Champ_front_base.cpp.

◆ calculer_coeffs_echange()

void Champ_front_base::calculer_coeffs_echange ( double temps)
virtual

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 in Champ_front_contact_rayo_transp_VEF, Champ_front_contact_VEF, and Champ_front_Parametrique.

Definition at line 93 of file Champ_front_base.cpp.

◆ calculer_derivee_en_temps()

void Champ_front_base::calculer_derivee_en_temps ( double t1,
double t2 )
virtual

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

Reimplemented in Champ_front_Parametrique.

Definition at line 168 of file Champ_front_base.cpp.

◆ changer_temps_futur()

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

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

Reimplemented in Ch_front_var_stationnaire, Champ_Front_Composite, Champ_front_Parametrique, Champ_front_uniforme, Champ_front_vide, and Champ_front_xyz_debit.

Definition at line 160 of file Champ_front_base.cpp.

◆ completer()

virtual void Champ_front_base::completer ( )
inlinevirtual

Reimplemented in Champ_front_calc_interne, and Champ_front_Parametrique.

Definition at line 80 of file Champ_front_base.h.

◆ derivee_en_temps()

virtual const DoubleTab & Champ_front_base::derivee_en_temps ( ) const
inlinevirtual

Reimplemented in Champ_front_Parametrique.

Definition at line 106 of file Champ_front_base.h.

◆ domaine_dis()

const Domaine_dis_base & Champ_front_base::domaine_dis ( ) const
virtual

Reimplemented in Champ_front_calc, Champ_front_contact_VEF, and Champ_front_Parametrique.

Definition at line 123 of file Champ_front_base.cpp.

◆ fixer_nb_valeurs_temporelles()

void Champ_front_base::fixer_nb_valeurs_temporelles ( int nb_cases)
virtual

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

To override in unsteady front fields.

Reimplemented in Champ_front_instationnaire_base, Champ_front_Parametrique, Champ_front_var_instationnaire, and Champ_front_xyz_debit.

Definition at line 81 of file Champ_front_base.cpp.

◆ frontiere_dis() [1/2]

Frontiere_dis_base & Champ_front_base::frontiere_dis ( )
inlinevirtual

Returns the discretized boundary associated with the field.

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

Reimplemented in Champ_front_Parametrique.

Definition at line 137 of file Champ_front_base.h.

◆ frontiere_dis() [2/2]

const Frontiere_dis_base & Champ_front_base::frontiere_dis ( ) const
inlinevirtual

Returns the discretized boundary associated with the field.

(const version)

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

Reimplemented in Champ_front_Parametrique.

Definition at line 127 of file Champ_front_base.h.

◆ get_temps_defaut()

virtual double Champ_front_base::get_temps_defaut ( ) const
inlinevirtual

Reimplemented in Champ_front_Parametrique.

Definition at line 98 of file Champ_front_base.h.

◆ has_valeurs_au_temps()

virtual bool Champ_front_base::has_valeurs_au_temps ( double temps) const
inlinevirtual

◆ initialiser()

◆ instationnaire()

virtual bool Champ_front_base::instationnaire ( ) const
inlinevirtual

Reimplemented in Champ_front_Parametrique.

Definition at line 103 of file Champ_front_base.h.

◆ mettre_a_jour()

void Champ_front_base::mettre_a_jour ( double temps)
virtual

◆ OBS_PTR()

Champ_front_base::OBS_PTR ( Frontiere_dis_base )
protected

◆ reculer()

int Champ_front_base::reculer ( double temps)
virtual

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 in Ch_front_var_stationnaire, Champ_Front_Composite, Champ_front_instationnaire_base, Champ_front_Parametrique, Champ_front_uniforme, Champ_front_var_instationnaire, Champ_front_vide, and Champ_front_xyz_debit.

Definition at line 150 of file Champ_front_base.cpp.

◆ set_derivee_en_temps()

virtual void Champ_front_base::set_derivee_en_temps ( DoubleTab & Gpoint)
inlinevirtual

Definition at line 105 of file Champ_front_base.h.

◆ set_instationnaire()

virtual void Champ_front_base::set_instationnaire ( bool flag)
inlinevirtual

Definition at line 104 of file Champ_front_base.h.

◆ set_temps_defaut()

virtual void Champ_front_base::set_temps_defaut ( double temps)
inlinevirtual

Reimplemented in Champ_front_Parametrique, and Champ_front_xyz_debit.

Definition at line 99 of file Champ_front_base.h.

◆ valeurs() [1/4]

const DoubleTab & Champ_front_base::valeurs ( ) const
inlineoverridevirtual

Returns the array of field values at the default time.

(const version)

Returns
(DoubleTab&) the array of field values

Implements Champ_Proto.

Reimplemented in Champ_front_Parametrique.

Definition at line 159 of file Champ_front_base.h.

◆ valeurs() [2/4]

DoubleTab & Champ_front_base::valeurs ( )
inlineoverridevirtual

Returns the array of field values.

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

Implements Champ_Proto.

Reimplemented in Champ_front_Parametrique.

Definition at line 147 of file Champ_front_base.h.

◆ valeurs() [3/4]

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

Reimplemented from Champ_Proto.

Reimplemented in Champ_front_Parametrique.

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

Reimplemented in Champ_front_Parametrique.

Definition at line 45 of file Champ_Proto.h.

◆ valeurs_au_temps() [1/2]

virtual const DoubleTab & Champ_front_base::valeurs_au_temps ( double temps) const
pure virtual

◆ valeurs_au_temps() [2/2]

virtual DoubleTab & Champ_front_base::valeurs_au_temps ( double temps)
pure virtual

◆ valeurs_face()

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

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 in Champ_Front_Composite, Champ_front_instationnaire_base, Champ_front_Parametrique, Champ_front_uniforme, and Champ_front_vide.

Definition at line 106 of file Champ_front_base.cpp.

◆ verifier()

void Champ_front_base::verifier ( const Cond_lim_base & la_cl) const
inlinevirtual

Reimplemented in Champ_front_calc, and Champ_front_Parametrique.

Definition at line 165 of file Champ_front_base.h.

Member Data Documentation

◆ Gpoint_

DoubleTab Champ_front_base::Gpoint_
protected

Definition at line 115 of file Champ_front_base.h.

◆ les_valeurs

Roue_ptr Champ_front_base::les_valeurs
protected

Definition at line 114 of file Champ_front_base.h.

◆ temps_defaut

double Champ_front_base::temps_defaut
protected

Definition at line 110 of file Champ_front_base.h.


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