: Base class of closure laws. More...

#include <Loi_Fermeture_base.h>

Inheritance diagram for Loi_Fermeture_base:

Collaboration diagram for Loi_Fermeture_base:

Public Member Functions
void	nommer (const Nom &nom) override
	Assigns a name to the Objet_U. Virtual method to override.
const Nom &	le_nom () const override
	Returns the name of the Objet_U. Virtual method to override: returns "neant" in this implementation.
void	creer_champ (const Motcle &motlu) override
const Champ_base &	get_champ (const Motcle &nom) const override
	This method returns the field named "nom" if it is understood by the class, otherwise calls the get_champ method of the ancestor.
bool	has_champ (const Motcle &nom, OBS_PTR(Champ_base)&ref_champ) const override
bool	has_champ (const Motcle &nom) const override
void	get_noms_champs_postraitables (Noms &nom, Option opt=NONE) const override
virtual void	associer_pb_base (const Probleme_base &)
	This method is the first called by the problem to construct the object when it is associated with the problem.
virtual void	discretiser (const Discretisation_base &)
	This method is called by the problem after the discretization of equations and medium and before.
virtual void	set_param (Param &param) const override
	This method is called by the readOn of the class.
virtual void	completer ()
	This method is called after reading all equations and closure laws (all fields and boundary conditions.
virtual void	preparer_calcul ()
	This method is called by the problem after preparer_calcul() of equations and medium.
virtual void	mettre_a_jour (double temps)
	This method is called by the problem after mettre_a_jour() of equations and medium.
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 Champs_compris_interface
virtual	~Champs_compris_interface ()

Protected Types
enum	Status { INITIAL , PB_ASSOCIE , DISCRETISE , READON_FAIT , COMPLET }

Protected Member Functions
const Probleme_base &	mon_probleme () const
	Returns the problem (this method was created to avoid giving write access to the problem via the REF).
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).

Protected Attributes
Champs_compris	champs_compris_
Status	status_

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

: Base class of closure laws.

This class calculates fields that can depend on several unknowns, physical quantities of the medium, etc. The fields of the class are made accessible to the entire problem through the get_champ() method and their update is triggered by the problem, after updating the medium and equations.

Definition at line 38 of file Loi_Fermeture_base.h.

Member Enumeration Documentation

◆ Status

enum Loi_Fermeture_base::Status

protected

Enumerator
INITIAL
PB_ASSOCIE
DISCRETISE
READON_FAIT
COMPLET

Definition at line 69 of file Loi_Fermeture_base.h.

Member Function Documentation

◆ associer_pb_base()

void Loi_Fermeture_base::associer_pb_base ( const Probleme_base & pb )

virtual

This method is the first called by the problem to construct the object when it is associated with the problem.

We check that it is not already associated.

Definition at line 36 of file Loi_Fermeture_base.cpp.

◆ completer()

void Loi_Fermeture_base::completer ( )

virtual

This method is called after reading all equations and closure laws (all fields and boundary conditions.

of the problem are available)

Definition at line 107 of file Loi_Fermeture_base.cpp.

◆ creer_champ()

void Loi_Fermeture_base::creer_champ ( const Motcle & motlu )

inlineoverridevirtual

Implements Champs_compris_interface.

Definition at line 52 of file Loi_Fermeture_base.h.

◆ discretiser()

void Loi_Fermeture_base::discretiser ( const Discretisation_base & )

virtual

This method is called by the problem after the discretization of equations and medium and before.

the call to readOn() for reading parameters. In derived classes it must at least discretize the fields that will be required in the readOn() of equations or other closure laws.

Reimplemented in Loi_Fermeture_Test.

Definition at line 59 of file Loi_Fermeture_base.cpp.

◆ get_champ()

const Champ_base & Loi_Fermeture_base::get_champ ( const Motcle & nom ) const

overridevirtual

This method returns the field named "nom" if it is understood by the class, otherwise calls the get_champ method of the ancestor.

In the base class, the Champ_compris_erreur exception is raised.

Implements Champs_compris_interface.

Definition at line 150 of file Loi_Fermeture_base.cpp.

◆ get_noms_champs_postraitables()

void Loi_Fermeture_base::get_noms_champs_postraitables	(	Noms &	nom,
		Option	opt = NONE ) const

overridevirtual

Implements Champs_compris_interface.

Definition at line 164 of file Loi_Fermeture_base.cpp.

◆ has_champ() [1/2]

bool Loi_Fermeture_base::has_champ ( const Motcle & nom ) const

overridevirtual

Implements Champs_compris_interface.

Definition at line 159 of file Loi_Fermeture_base.cpp.

◆ has_champ() [2/2]

bool Loi_Fermeture_base::has_champ	(	const Motcle &	nom,
		OBS_PTR(Champ_base)&	ref_champ ) const

overridevirtual

Implements Champs_compris_interface.

◆ le_nom()

const Nom & Loi_Fermeture_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 47 of file Loi_Fermeture_base.h.

◆ mettre_a_jour()

void Loi_Fermeture_base::mettre_a_jour ( double temps )

virtual

This method is called by the problem after mettre_a_jour() of equations and medium.

It must update all fields it manages based on the other fields of the problem.

Reimplemented in Loi_Fermeture_Test.

Definition at line 140 of file Loi_Fermeture_base.cpp.

◆ mon_probleme()

const Probleme_base & Loi_Fermeture_base::mon_probleme ( ) const

protected

Returns the problem (this method was created to avoid giving write access to the problem via the REF).

Definition at line 116 of file Loi_Fermeture_base.cpp.

◆ nommer()

void Loi_Fermeture_base::nommer ( const Nom & nom )

inlineoverridevirtual

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 43 of file Loi_Fermeture_base.h.

◆ preparer_calcul()

void Loi_Fermeture_base::preparer_calcul ( )

virtual

This method is called by the problem after preparer_calcul() of equations and medium.

It must update all fields it manages based on the other fields of the problem.

Definition at line 127 of file Loi_Fermeture_base.cpp.

◆ set_param()

void Loi_Fermeture_base::set_param ( Param & param ) const

overridevirtual

This method is called by the readOn of the class.

It must be overridden in derived classes to add to "param" the various parameters to be read from the dataset and call the ancestor method. In the base class: no parameters.

Reimplemented from Objet_U.

Reimplemented in Loi_Fermeture_Test.

Definition at line 98 of file Loi_Fermeture_base.cpp.

Member Data Documentation

◆ champs_compris_

Champs_compris Loi_Fermeture_base::champs_compris_

protected

Definition at line 67 of file Loi_Fermeture_base.h.

◆ status_

Status Loi_Fermeture_base::status_

protected

Definition at line 70 of file Loi_Fermeture_base.h.

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

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Status

Member Function Documentation

◆ associer_pb_base()

◆ completer()

◆ creer_champ()

◆ discretiser()

◆ get_champ()

◆ get_noms_champs_postraitables()

◆ has_champ() [1/2]

◆ has_champ() [2/2]

◆ le_nom()

◆ mettre_a_jour()

◆ mon_probleme()

◆ nommer()

◆ preparer_calcul()

◆ set_param()

Member Data Documentation

◆ champs_compris_

◆ status_