Matrice_Morse_Diag class - Represents a sparse symmetric matrix M stored in Morse format. More...

#include <Matrice_Morse_Diag.h>

Inheritance diagram for Matrice_Morse_Diag:

Collaboration diagram for Matrice_Morse_Diag:

Public Member Functions
	Matrice_Morse_Diag ()
void	dimensionne_diag (int n)
DoubleVect &	ajouter_multvect_ (const DoubleVect &x, DoubleVect &y) const override
	The purpose of this matrix is only to compute the diagonal.
DoubleVect &	ajouter_multvectT_ (const DoubleVect &, DoubleVect &) const override
	The purpose of this matrix is only to compute the diagonal.
DoubleTab &	ajouter_multTab_ (const DoubleTab &, DoubleTab &) const override
	The purpose of this matrix is only to compute the diagonal.
Public Member Functions inherited from Matrice_Morse_Sym
	Matrice_Morse_Sym (int n1=1, int n2=1)
	Matrice_Morse_Sym (int, int, const IntLists &, const DoubleLists &, const DoubleVect &)
	Constructor of a Matrice_Morse_Sym with n1 rows and capable of storing at most n2 non-zero elements.
	Matrice_Morse_Sym (const Matrice &)
	Matrice_Morse_Sym (const Matrice_Morse &)
	Copy constructor of a Matrice_Morse_Sym from a Matrice_Morse.
	Matrice_Morse_Sym (const Matrice_Morse_Sym &)
	Copy constructor of a Matrice_Morse_Sym from a Matrice_Morse.
Matrice_Morse_Sym &	operator= (const Matrice_Morse_Sym &)
	Assignment operator of a Matrice_Morse_Sym into a Matrice_Morse_Sym.
Matrice_Morse_Sym &	operator= (const Matrice_Morse &)
Matrice_Morse_Sym &	operator= (const Matrice &)
Matrice_Morse_Sym &	operator*= (double)
	DOES NOTHING: NOT IMPLEMENTED.
void	scale (const double x) override
void	get_stencil (Stencil &stencil) const override
void	get_symmetric_stencil (Stencil &stencil) const override
void	get_stencil_and_coefficients (Stencil &stencil, StencilCoeffs &coefficients) const override
void	get_symmetric_stencil_and_coefficients (Stencil &stencil, StencilCoeffs &coefficients) const override
Matrice_Morse_Sym	operator- () const
	Unary negation operator, returns the opposite of the matrix: -A.
DoubleTab &	ajouter_multTab_ (const DoubleTab &, DoubleTab &) const override
	Matrix-matrix multiply-accumulate operation (saxpy) where the matrix is represented by an array.
DoubleVect &	ajouter_multvect_ (const DoubleVect &, DoubleVect &) const override
	Matrix-vector multiply-accumulate operation (saxpy).
DoubleVect &	ajouter_multvectT_ (const DoubleVect &, DoubleVect &) const override
	Transposed-matrix-vector multiply-accumulate operation (saxpy).
virtual double	multvect_et_prodscal (const DoubleVect &, DoubleVect &) const
int	inverse (const DoubleVect &, DoubleVect &, double) const override
	Computes the solution of the linear system: A * solution = secmem.
int	inverse (const DoubleVect &, DoubleVect &, double, int) const override
Sortie &	imprimer_formatte (Sortie &s) const override
void	compacte (int elim_coeff_nul=0)
	Remove duplicates by sorting tab2.
void	renumerote () const
	Renumbers a matrix to reduce its bandwidth.
Matrice &	matrice_renumerotee ()
Matrice &	matrice_renumerotee () const
ArrOfInt &	permutation ()
ArrOfInt &	permutation_inverse ()
ArrOfInt &	permutation () const
ArrOfInt &	permutation_inverse () const
bool	check_symmetric_morse_matrix_structure () const
bool	check_sorted_symmetric_morse_matrix_structure () const
void	assert_check_symmetric_morse_matrix_structure () const
void	assert_check_sorted_symmetric_morse_matrix_structure () const
Public Member Functions inherited from Matrice_Morse
	Matrice_Morse ()
template<typename _SIZE_>
	Matrice_Morse (int n, _SIZE_ nnz)
	Constructor of a square Morse matrix of order n that can store at most nnz non-zero elements.
template<typename _SIZE_>
	Matrice_Morse (int n, int m, _SIZE_ nnz)
	Constructor of a Morse matrix with n rows and m columns that can store at most nnz non-zero elements.
	Matrice_Morse (const Matrice_Morse &)
	Copy constructor of a Matrice_Morse.
	Matrice_Morse (int, int, const IntLists &, const DoubleLists &, const DoubleVect &)
Sortie &	imprimer (Sortie &s) const override
Sortie &	imprimer_formatte (Sortie &s, int symetrie) const
Sortie &	imprimer_image (Sortie &s) const
Sortie &	imprimer_image (Sortie &s, int symetrie) const
void	WriteFileMTX (const Nom &) const
int	largeur_de_bande () const
	Computes the bandwidth of a Morse matrix.
void	remplir (const IntLists &, const DoubleLists &, const DoubleVect &)
void	remplir (const IntLists &, const DoubleLists &)
void	remplir (const int, const int, const int, const int, const Matrice_Morse &)
	Fill a Morse matrix from a smaller Morse matrix.
template<typename _SIZE_>
void	dimensionner (int n, _SIZE_ nnz)
	Size the matrix with n lines and n columns and nnz zero-values coefficients.
template<typename _SIZE_>
void	dimensionner (int n, int m, _SIZE_ nnz)
	Size the matrix with n lines, m columns with nnz zero-values coefficients.
void	dimensionner (const IntTab &)
	Resizes the sparse matrix, optionally adding new non-zero coefficients.
int	ordre () const override
	Returns the order of the matrix: - the number of rows if the matrix is square.
int	nb_lignes () const override
	Return local number of lines (=size on the current proc).
int	nb_colonnes () const override
	Return local number of columns (=size on the current proc).
auto	nb_coeff () const
void	set_nb_columns (const int)
void	set_symmetric (const int)
int	get_symmetric () const
auto &	get_set_tab1 ()
auto &	get_set_tab2 ()
auto &	get_set_coeff ()
const auto &	get_tab1 () const
const auto &	get_tab2 () const
const auto &	get_coeff () const
int	nb_vois (int i) const
void	clean () override
	Remplit la matrice avec des zeros.
double &	operator() (int i, int j)
double	operator() (int i, int j) const
double	coef (int i, int j) const
double &	coef (int i, int j)
Matrice_Morse &	operator= (const Matrice_Morse &)
	Assignment operator from one Matrice_Morse to another.
Matrice_Morse &	operator+= (const Matrice_Morse &)
	DOES NOTHING.
Matrice_Morse &	operator*= (double)
	Operator multiplying all elements of a matrix by a scalar.
void	get_stencil_and_coeff_ptrs (Stencil &stencil, std::vector< const double * > &coeff_ptr) const override
Matrice_Morse &	operator/= (double)
	Operator dividing all elements of a matrix by a scalar.
Matrice_Morse &	operator*= (const DoubleVect &)
	Matrix-vector multiplication operator: scales rows of the matrix by the corresponding.
Matrice_Morse	operator- () const
	Unary negation operator, returns the opposite of the matrix: - A. Calls operator*(double,const Matrice_Morse&).
Matrice_Morse &	affecte_prod (const Matrice_Morse &A, const Matrice_Morse &B)
	Assigns the product of 2 Morse matrices A and B to this object.
void	compacte (int elim_coeff_nul=0)
	Method to check/clean the Matrice_Morse matrix: -Suppress coefficient defined several times.
ArrOfDouble &	ajouter_multvect_ (const ArrOfDouble &, ArrOfDouble &, ArrOfInt &) const
ArrOfDouble &	ajouter_multvectT_ (const ArrOfDouble &, ArrOfDouble &, ArrOfInt &) const
virtual Matrice_Morse &	transpose (const Matrice_Morse &a)
	*this = transpose of a.
virtual Matrice_Morse &	diagmulmat (const DoubleVect &x)
virtual Matrice_Morse &	partie_sup (const Matrice_Morse &a)
void	unite ()
	Initialize to the identity matrix (modif MT).
void	construire_sous_bloc (int nl0, int nc0, int nl1, int nc1, Matrice_Morse &result) const
void	formeC ()
void	formeF ()
bool	has_same_morse_matrix_structure (const Matrice_Morse &) const
bool	check_morse_matrix_structure () const
bool	check_sorted_morse_matrix_structure () const
void	assert_check_morse_matrix_structure () const
void	assert_check_sorted_morse_matrix_structure () const
void	sort_stencil ()
bool &	constant_stencil () const
bool	is_sorted_stencil () const
bool	is_diagonal ()
void	set_tab1_int32 () const
const IntVect &	get_tab1_int32 () const
void	set_tab1 (const IntVect &tab1_int32)
Public Member Functions inherited from Matrice_Base
virtual DoubleVect &	ajouter_multvect (const DoubleVect &x, DoubleVect &r) const
	Matrix-vector multiply-accumulate operation (saxpy).
virtual DoubleVect &	ajouter_multvectT (const DoubleVect &x, DoubleVect &r) const
	Matrix-vector multiply-accumulate operation (saxpy).
virtual DoubleTab &	ajouter_multTab (const DoubleTab &, DoubleTab &r) const
	NOT IMPLEMENTED Matrix-matrix multiply-accumulate operation (saxpy).
virtual DoubleVect &	multvect_ (const DoubleVect &, DoubleVect &) const
virtual DoubleVect &	multvect (const DoubleVect &, DoubleVect &) const
	Multiplication of a vector by the matrix.
virtual DoubleVect &	multvectT_ (const DoubleVect &, DoubleVect &) const
virtual DoubleVect &	multvectT (const DoubleVect &, DoubleVect &) const
	Multiplication of a vector by the transposed matrix.
virtual DoubleTab &	multTab (const DoubleTab &, DoubleTab &r) const
	NOT IMPLEMENTED Multiplication of a matrix represented by an array by the matrix.
int	get_stencil_size () const
virtual void	build_stencil ()
void	set_stencil (const Stencil &stencil)
bool	is_stencil_up_to_date () 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.
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 Matrice_Sym
virtual	~Matrice_Sym ()
	Matrice_Sym ()
int	get_est_definie () const
void	set_est_definie (int)
void	unsymmetrize_stencil (const int nb_lines, const Stencil &symmetric_stencil, Stencil &stencil) const
void	unsymmetrize_stencil_and_coefficients (const int nb_lines, const Stencil &symmetric_stencil, const StencilCoeffs &symmetric_coefficients, Stencil &stencil, StencilCoeffs &coefficients) const

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)
Public Attributes inherited from Matrice_Morse
int	sorted_
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 Matrice_Morse
template<typename _TAB_T_, typename _VALUE_T_>
void	get_stencil_coeff_templ (Stencil &stencil, _TAB_T_ &coeffs_span) const
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 Attributes inherited from Matrice_Morse
IntVect	tab1_
IntVect	tab2_
DoubleVect	coeff_
int	morse_matrix_structure_has_changed_ =-1
int	m_
int	symetrique_
Protected Attributes inherited from Matrice_Base
bool	is_stencil_up_to_date_ = false
Stencil	stencil_

Detailed Description

Matrice_Morse_Diag class - Represents a sparse symmetric matrix M stored in Morse format.

Diagonal: only the upper triangular part of the matrix is stored. Important: All diagonal coefficients must be stored even if they are zero (TRUST assumption for several methods including multvect). This class derives from Matrice_Morse_Sym.

See also: Matrice_Morse Matrice_Diag

Definition at line 34 of file Matrice_Morse_Diag.h.

Constructor & Destructor Documentation

◆ Matrice_Morse_Diag()

Matrice_Morse_Diag::Matrice_Morse_Diag ( )

inline

Definition at line 40 of file Matrice_Morse_Diag.h.

Member Function Documentation

◆ ajouter_multTab_()

DoubleTab & Matrice_Morse_Diag::ajouter_multTab_	(	const DoubleTab &	x,
		DoubleTab &	y ) const

overridevirtual

The purpose of this matrix is only to compute the diagonal.

Reimplemented from Matrice_Morse.

Definition at line 62 of file Matrice_Morse_Diag.cpp.

◆ ajouter_multvect_()

DoubleVect & Matrice_Morse_Diag::ajouter_multvect_	(	const DoubleVect &	x,
		DoubleVect &	y ) const

overridevirtual

The purpose of this matrix is only to compute the diagonal.

Reimplemented from Matrice_Morse.

Definition at line 45 of file Matrice_Morse_Diag.cpp.

◆ ajouter_multvectT_()

DoubleVect & Matrice_Morse_Diag::ajouter_multvectT_	(	const DoubleVect &	x,
		DoubleVect &	y ) const

overridevirtual

The purpose of this matrix is only to compute the diagonal.

Reimplemented from Matrice_Morse.

Definition at line 53 of file Matrice_Morse_Diag.cpp.

◆ dimensionne_diag()

void Matrice_Morse_Diag::dimensionne_diag ( int n )

Definition at line 69 of file Matrice_Morse_Diag.cpp.

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

/home/docs/trust-code/src/Kernel/Math/Matrices/Matrice_Morse_Diag.h
/home/docs/trust-code/src/Kernel/Math/Matrices/Matrice_Morse_Diag.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Matrice_Morse_Diag()

Member Function Documentation

◆ ajouter_multTab_()

◆ ajouter_multvect_()

◆ ajouter_multvectT_()

◆ dimensionne_diag()