class Source_Darcy_VDF_Face This class represents the Darcy term for flows in porous media. More...

#include <Source_Darcy_VDF_Face.h>

Inheritance diagram for Source_Darcy_VDF_Face:

Collaboration diagram for Source_Darcy_VDF_Face:

Public Member Functions
	Source_Darcy_VDF_Face ()
void	set_param (Param &param) const override
int	lire_motcle_non_standard (const Motcle &, Entree &) override
	Reads non-simple-type parameters of an Objet_U from an input stream.
void	associer_pb (const Probleme_base &) override
void	associer_domaines (const Domaine_dis_base &, const Domaine_Cl_dis_base &) override
void	mettre_a_jour (double temps) override
	DOES NOTHING - to override in derived classes.
Eval_Darcy_VDF_Face &	eval ()
Public Member Functions inherited from Terme_Source_VDF_base
	Terme_Source_VDF_base (const Iterateur_Source_base &iter_base)
void	completer () override
	Updates internal references of the Source_base object.
DoubleTab &	calculer (DoubleTab &resu) const override
void	dimensionner_blocs (matrices_t matrices, const tabs_t &semi_impl) const override
void	ajouter_blocs (matrices_t matrices, DoubleTab &secmem, const tabs_t &semi_impl) const override
int	has_interface_blocs () const override
Public Member Functions inherited from Source_base
virtual DoubleTab &	ajouter (DoubleTab &) const
virtual void	resetTime (double t)
	DOES NOTHING - to override in derived classes.
virtual void	dimensionner (Matrice_Morse &) const
	Sizing of the implicit matrix of source terms.
virtual void	dimensionner_bloc_vitesse (Matrice_Morse &) const
virtual void	contribuer_a_avec (const DoubleTab &, Matrice_Morse &) const
	contribution to the implicit matrix of source terms, by default no contribution
virtual void	contribuer_au_second_membre (DoubleTab &) const
	contribution to the right-hand side of source terms implicitly, by default error
virtual int	impr (Sortie &os) const
void	associer_domaines_public (const Domaine_dis_base &zdis, const Domaine_Cl_dis_base &zcldis)
virtual int	initialiser (double temps)
	Unlike the mettre_a_jour methods, the initializer methods of sources cannot depend on the outside.
virtual void	discretiser ()
virtual void	associer_champ_rho (const Champ_base &champ_rho)
	This method (or the method of the derived class) is called by Sources::associer_champ_rho for each source in the list.
virtual int	a_pour_Champ_Fonc (const Motcle &mot, OBS_PTR(Champ_base) &ch_ref) const
	If the source understands the keyword "mot", it fills the reference to ch_ref and returns 1, otherwise returns 0 (see Source_Translation for example).
virtual void	contribuer_jacobienne (Matrice_Bloc &, int) const
virtual int	reprendre (Entree &) override
	Restores an Objet_U from an input stream. Virtual method to override.
virtual int	sauvegarder (Sortie &) const override
	Saves an Objet_U to an output stream. Virtual method to override.
void	creer_champ (const Motcle &motlu) override
const Champ_base &	get_champ (const Motcle &nom) const override
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	ouvrir_fichier (SFichier &os, const Nom &, const int flag=1) const
	Opening/creation of a file for printing a source term. To override in derived classes.
void	set_fichier (const Nom &)
void	set_description (const Nom &nom)
void	set_col_names (const Noms &col_names)
const Nom	fichier () const
const Nom	description () const
DoubleVect &	bilan ()
DoubleVect &	bilan () const
Champs_compris &	champs_compris ()
const	LIST (OBS_PTR(Champ_Don_base)) &champs_don() const
Public Member Functions inherited from Champs_compris_interface
virtual	~Champs_compris_interface ()
virtual bool	has_champ (const Motcle &nom, OBS_PTR(Champ_base)&ref_champ) const =0
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 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.
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	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 ()

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
Protected Member Functions inherited from Terme_Source_VDF_base
	OWN_PTR (Iterateur_Source_base) iter_
Protected Member Functions inherited from Source_base
	LIST (OBS_PTR(Champ_Don_base)) champs_don_
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).
Protected Attributes inherited from Source_base
int	col_width_ = 0
Nom	out_
Nom	description_
Noms	col_names_
DoubleVect	bilan_
SFichier	Flux
Champs_compris	champs_compris_

Detailed Description

class Source_Darcy_VDF_Face This class represents the Darcy term for flows in porous media.

This term should normally be of "operator" type: for now it is coded as a source term and should therefore only be used with an explicit time scheme.

Definition at line 29 of file Source_Darcy_VDF_Face.h.

Constructor & Destructor Documentation

◆ Source_Darcy_VDF_Face()

Source_Darcy_VDF_Face::Source_Darcy_VDF_Face ( )

inline

Definition at line 33 of file Source_Darcy_VDF_Face.h.

Member Function Documentation

◆ associer_domaines()

void Source_Darcy_VDF_Face::associer_domaines	(	const Domaine_dis_base &	domaine_dis,
		const Domaine_Cl_dis_base &	domaine_cl_dis )

overridevirtual

Implements Source_base.

Definition at line 76 of file Source_Darcy_VDF_Face.cpp.

◆ associer_pb()

void Source_Darcy_VDF_Face::associer_pb ( const Probleme_base & pb )

overridevirtual

Implements Source_base.

Definition at line 84 of file Source_Darcy_VDF_Face.cpp.

◆ eval()

Eval_Darcy_VDF_Face & Source_Darcy_VDF_Face::eval ( )

inline

Definition at line 39 of file Source_Darcy_VDF_Face.h.

◆ lire_motcle_non_standard()

int Source_Darcy_VDF_Face::lire_motcle_non_standard	(	const Motcle &	motlu,
		Entree &	is )

overridevirtual

Reads non-simple-type parameters of an Objet_U from an input stream.

Parameters

motlu	The name of the keyword to read.
is	An input stream.

Returns: Negative value if the keyword is not understood, otherwise positive value.

Reimplemented from Objet_U.

Definition at line 53 of file Source_Darcy_VDF_Face.cpp.

◆ mettre_a_jour()

void Source_Darcy_VDF_Face::mettre_a_jour ( double temps )

inlineoverridevirtual

DOES NOTHING - to override in derived classes.

Time update of the source term.

Parameters

(double) the time step of the update

Reimplemented from Source_base.

Definition at line 38 of file Source_Darcy_VDF_Face.h.

◆ set_param()

void Source_Darcy_VDF_Face::set_param ( Param & param ) const

overridevirtual

Reimplemented from Objet_U.

Definition at line 47 of file Source_Darcy_VDF_Face.cpp.

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

/home/docs/trust-code/src/VDF/Sources/Sources_It_Eval/Source_Darcy_VDF_Face.h
/home/docs/trust-code/src/VDF/Sources/Sources_It_Eval/Source_Darcy_VDF_Face.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Source_Darcy_VDF_Face()

Member Function Documentation

◆ associer_domaines()

◆ associer_pb()

◆ eval()

◆ lire_motcle_non_standard()

◆ mettre_a_jour()

◆ set_param()