Abstract base class for the DG mass matrix operator. More...

#include <Masse_DG_base.h>

Inheritance diagram for Masse_DG_base:

Collaboration diagram for Masse_DG_base:

Public Member Functions
void	associer_domaine_dis_base (const Domaine_dis_base &) override
void	associer_domaine_cl_dis_base (const Domaine_Cl_dis_base &) override
void	appliquer_coef (DoubleVect &coef) const
	Multiplies the mass coefficient vector element-wise by an optional temporal field.
int	has_interface_blocs () const override
void	dimensionner_blocs (matrices_t matrices, const tabs_t &semi_impl) const override
	Builds the sparsity pattern of the mass matrix block.
void	ajouter_blocs (matrices_t matrices, DoubleTab &secmem, double dt, const tabs_t &semi_impl, int resoudre_en_increments) const override
	Assembles the mass matrix contribution (M/dt) into the matrix and right-hand side.
Public Member Functions inherited from Solveur_Masse_base
virtual DoubleTab &	appliquer (DoubleTab &) const
	Returns appliquer_impl(x/temporal_coefficient) if a temporal coefficient is set, otherwise returns appliquer_impl(x).
virtual void	mettre_a_jour (double temps)
	DOES NOTHING - to override in derived classes.
virtual void	resetTime (double temps)
	DOES NOTHING - to override in derived classes.
virtual void	assembler ()
	DOES NOTHING.
virtual Matrice_Base &	ajouter_masse (double dt, Matrice_Base &matrice, int penalisation=1) const
virtual DoubleTab &	ajouter_masse (double dt, DoubleTab &x, const DoubleTab &y, int penalisation=1, bool use_old_volumes=false) const
virtual Matrice_Base &	ajouter_masse_dt_local (DoubleVect &dt_locaux, Matrice_Base &matrice, int penalisation=1) const
virtual DoubleTab &	ajouter_masse_dt_local (DoubleVect &dt_locaux, DoubleTab &x, const DoubleTab &y, int penalisation=1) const
virtual void	get_masse_dt_local (DoubleVect &m_dt_locaux, DoubleVect &dt_locaux, int penalisation=1)
virtual void	get_masse_divide_by_local_dt (DoubleVect &m_dt_locaux, DoubleVect &dt_locaux, int penalisation=1)
virtual DoubleTab &	corriger_solution (DoubleTab &x, const DoubleTab &y, int incr=0) const
void	set_name_of_coefficient_temporel (const Nom &)
	Allows choosing the name of the temporal coefficient to use for apply.
int	has_coefficient_temporel () const
const Nom &	get_name_of_coefficient_temporel () const
virtual DoubleTab &	appliquer_impl (DoubleTab &x) const =0
virtual void	dimensionner (Matrice_Morse &matrix) const
virtual void	completer ()
virtual void	preparer_calcul ()
void	set_penalisation_flag (int pen)
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 ()
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

Protected Member Functions
	OBS_PTR (Domaine_DG) le_dom_dg_
	OBS_PTR (Domaine_Cl_DG) le_dom_Cl_dg_
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 Member Functions inherited from MorEqn
	OBS_PTR (Equation_base) mon_equation
virtual	~MorEqn ()

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 Attributes inherited from Solveur_Masse_base
Nom	name_of_coefficient_temporel_
int	has_coefficient_temporel_
int	penalisation_flag_

Detailed Description

Abstract base class for the DG mass matrix operator.

This class assembles and applies the element-wise L2 mass matrix arising in the DG time discretization. The mass term appears in the implicit time scheme as: (M/dt) * u^{n+1} = (M/dt) * u^n + RHS

Two assembly strategies are supported depending on whether the basis is orthonormalized via Gram-Schmidt (gram_schmidt flag on Domaine_DG):

Orthonormal basis (gram_schmidt == true): The mass matrix is diagonal, with entries equal to the element volume (since the basis is L2-normalized by volume). The sparsity pattern is therefore purely diagonal (nb_bfunc entries per element per spatial dimension).
Non-orthonormal basis (gram_schmidt == false): The mass matrix is a dense nb_bfunc x nb_bfunc block per element, assembled by numerical quadrature as M_ij = integral of phi_i * phi_j. The sparsity pattern is a full local block.

An optional temporal coefficient (e.g., density or porosity) can be applied element-wise via appliquer_coef(), which multiplies the mass entries by a field retrieved by name from the equation (name_of_coefficient_temporel_).

Derived classes must implement appliquer_impl(), which applies M^{-1} to a right-hand side vector (used for explicit time stepping or lumped-mass inversion).

See also: Masse_DG_Elem, Solveur_Masse_base

Definition at line 53 of file Masse_DG_base.h.

Member Function Documentation

◆ ajouter_blocs()

void Masse_DG_base::ajouter_blocs	(	matrices_t	matrices,
		DoubleTab &	secmem,
		double	dt,
		const tabs_t &	semi_impl,
		int	resoudre_en_increments ) const

overridevirtual

Assembles the mass matrix contribution (M/dt) into the matrix and right-hand side.

Computes and accumulates the term (M/dt) * u into the global system, where M is the L2 mass matrix and dt is the time step. The assembly strategy depends on whether the basis is orthonormalized:

Orthonormal basis (gram_schmidt == true): The mass matrix is diagonal with entries coef[e] * volume[e]. For each DOF: mat(dof, dof) += coef[e] * volume[e] / dt secmem(e, dof) += coef[e] * volume[e] * (u^n - delta * u^{n+1}) / dt where delta = resoudre_en_increments (1 if solving for the increment, 0 otherwise).
Non-orthonormal basis, order 0: reduces to a single scalar per element (one DOF), equivalent to the cell-average finite volume mass term.
Non-orthonormal basis, order > 0: the full local mass matrix M_ij is assembled by Gaussian quadrature (Ern, Finite Elements II, 2021, p.71): M_ij = integral of phi_i * phi_j accumulated as mat(i,j) += coef[e] * M_ij / dt and the corresponding RHS term.

The temporal coefficient (e.g., density) is applied via appliquer_coef() before the loop, and the medium porosity is used as the base coefficient array.

Parameters

matrices	Map of matrix name → Matrice_Morse pointer to accumulate into.
secmem	Right-hand side to accumulate into.
dt	Current time step size.
semi_impl	Map of semi-implicit field values; if the unknown is present, its values are used as u^n instead of the stored past values.
resoudre_en_increments	If 1, the system is solved for the increment (u^{n+1} - u^n); the current solution is subtracted from the RHS accordingly.

Reimplemented from Solveur_Masse_base.

Definition at line 182 of file Masse_DG_base.cpp.

◆ appliquer_coef()

void Masse_DG_base::appliquer_coef ( DoubleVect & coef ) const

Multiplies the mass coefficient vector element-wise by an optional temporal field.

If a temporal coefficient has been registered (has_coefficient_temporel_ == true), the field named name_of_coefficient_temporel_ is retrieved from the equation and its values are applied to coef via tab_multiply_any_shape(). Three field types are handled:

Champ_Inc_base: uses the first part of the field's values (ConstDoubleTab_parts[0]).
Champ_Fonc_base: uses the field's values directly.
Champ_Don_base: evaluates the field at the unknown's node coordinates. If no temporal coefficient is registered, coef is left unchanged.

Parameters

coef	The coefficient vector to scale in-place (typically initialized to 1).

Definition at line 50 of file Masse_DG_base.cpp.

◆ associer_domaine_cl_dis_base()

void Masse_DG_base::associer_domaine_cl_dis_base ( const Domaine_Cl_dis_base & le_dom_Cl_dis_base )

overridevirtual

Implements Solveur_Masse_base.

Definition at line 32 of file Masse_DG_base.cpp.

◆ associer_domaine_dis_base()

void Masse_DG_base::associer_domaine_dis_base ( const Domaine_dis_base & le_dom_dis_base )

overridevirtual

Implements Solveur_Masse_base.

Definition at line 27 of file Masse_DG_base.cpp.

◆ dimensionner_blocs()

void Masse_DG_base::dimensionner_blocs	(	matrices_t	matrices,
		const tabs_t &	semi_impl ) const

overridevirtual

Builds the sparsity pattern of the mass matrix block.

The pattern depends on whether the basis is orthonormalized:

Orthonormal basis: purely diagonal — one non-zero per DOF (indice(k,0) == indice(k,1) for every k).
Non-orthonormal basis: full local block — every pair (i,j) within the same element and same spatial component is coupled.

The number of spatial components (dim) is set to Objet_U::dimension for velocity unknowns and 1 for all other fields (scalar).

Parameters

matrices	Map of matrix name → Matrice_Morse pointer to be sized.
semi_impl	Unused here; kept for interface compatibility.

Reimplemented from Solveur_Masse_base.

Definition at line 96 of file Masse_DG_base.cpp.

◆ has_interface_blocs()

int Masse_DG_base::has_interface_blocs ( ) const

inlineoverridevirtual

Reimplemented from Solveur_Masse_base.

Definition at line 62 of file Masse_DG_base.h.

◆ OBS_PTR() [1/2]

Masse_DG_base::OBS_PTR ( Domaine_Cl_DG )

protected

◆ OBS_PTR() [2/2]

Masse_DG_base::OBS_PTR ( Domaine_DG )

protected

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

/home/docs/trust-code/src/DG/Solveurs/Masse_DG_base.h
/home/docs/trust-code/src/DG/Solveurs/Masse_DG_base.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ajouter_blocs()

◆ appliquer_coef()

◆ associer_domaine_cl_dis_base()

◆ associer_domaine_dis_base()

◆ dimensionner_blocs()

◆ has_interface_blocs()

◆ OBS_PTR() [1/2]

◆ OBS_PTR() [2/2]