#include <static_condensation.h>

Inheritance diagram for libMesh::StaticCondensation:

Classes
struct	MatrixData
	Data stored on a per-element basis used to compute element Schur complements and their applications to vectors. More...

Public Member Functions
	StaticCondensation (const MeshBase &mesh, System &system, const DofMap &full_dof_map, StaticCondensationDofMap &reduced_dof_map)

virtual	~StaticCondensation ()

virtual SparseMatrix< Number > &	operator= (const SparseMatrix< Number > &) override
	This looks like a copy assignment operator, but note that, unlike normal copy assignment operators, it is pure virtual.

virtual SolverPackage	solver_package () override

virtual void	init (const numeric_index_type m, const numeric_index_type n, const numeric_index_type m_l, const numeric_index_type n_l, const numeric_index_type nnz=30, const numeric_index_type noz=10, const numeric_index_type blocksize=1) override
	Initialize SparseMatrix with the specified sizes.

virtual void	init (const ParallelType type) override
	Initialize this matrix using the sparsity structure computed by `dof_map`.

virtual bool	initialized () const override

virtual void	clear () noexcept override
	clear() is called from the destructor, so it should not throw.

virtual void	zero () override
	Set all entries to 0.

virtual std::unique_ptr< SparseMatrix< Number > >	zero_clone () const override

virtual std::unique_ptr< SparseMatrix< Number > >	clone () const override

virtual void	close () override
	Calls the SparseMatrix's internal assembly routines, ensuring that the values are consistent across processors.

virtual numeric_index_type	m () const override

virtual numeric_index_type	n () const override

virtual numeric_index_type	row_start () const override

virtual numeric_index_type	row_stop () const override

virtual numeric_index_type	col_start () const override

virtual numeric_index_type	col_stop () const override

virtual void	set (const numeric_index_type i, const numeric_index_type j, const Number value) override
	Set the element (i,j) to `value`.

virtual void	add (const numeric_index_type i, const numeric_index_type j, const Number value) override
	Add `value` to the element (i,j).

virtual void	add_matrix (const DenseMatrix< Number > &dm, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) override
	Add the full matrix `dm` to the SparseMatrix.

virtual void	add_matrix (const DenseMatrix< Number > &dm, const std::vector< numeric_index_type > &dof_indices) override
	Same as `add_matrix`, but assumes the row and column maps are the same.

virtual void	add (const Number a, const SparseMatrix< Number > &X) override
	Compute \( A \leftarrow A + a*X \) for scalar `a`, matrix `X`.

virtual Number	operator() (const numeric_index_type i, const numeric_index_type j) const override

virtual Real	l1_norm () const override

virtual Real	linfty_norm () const override

virtual bool	closed () const override

virtual void	print_personal (std::ostream &os=libMesh::out) const override
	Print the contents of the matrix to the screen in a package-personalized style, if available.

virtual void	get_diagonal (NumericVector< Number > &dest) const override
	Copies the diagonal part of the matrix into `dest`.

virtual void	get_transpose (SparseMatrix< Number > &dest) const override
	Copies the transpose of the matrix into `dest`, which may be *this.

virtual void	get_row (numeric_index_type i, std::vector< numeric_index_type > &indices, std::vector< Number > &values) const override
	Get a row from the matrix.

void	init ()
	Size the element matrices.

void	setup ()
	A no-op to be consistent with shimming from the `StaticCondenstionPreconditioner`.

void	apply (const NumericVector< Number > &full_rhs, NumericVector< Number > &full_sol)
	Perform our three stages, `forward_elimination()`, a `solve()` on the condensed system, and finally a `backwards_substitution()`

const SparseMatrix< Number > &	get_condensed_mat () const

void	set_current_elem (const Elem &elem)
	Set the current element.

StaticCondensationPreconditioner &	get_preconditioner ()
	Get the preconditioning wrapper.

LinearSolver< Number > &	reduced_system_solver ()

virtual bool	require_sparsity_pattern () const override

void	uncondensed_dofs_only ()
	Sets whether this matrix represents uncondensed dofs only.

void	dont_condense_vars (const std::unordered_set< unsigned int > &vars)
	Add `vars` to the list of variables not to condense.

	StaticCondensation (const MeshBase &, const System &, const DofMap &full_dof_map, StaticCondensationDofMap &reduced_dof_map)

const std::unordered_set< unsigned int > &	uncondensed_vars () const

StaticCondensationPreconditioner &	get_preconditioner ()

virtual SparseMatrix< Number > &	operator= (const SparseMatrix< Number > &) override
	This looks like a copy assignment operator, but note that, unlike normal copy assignment operators, it is pure virtual.

virtual SolverPackage	solver_package () override

virtual void	init (const numeric_index_type, const numeric_index_type, const numeric_index_type, const numeric_index_type, const numeric_index_type=30, const numeric_index_type=10, const numeric_index_type=1) override
	Initialize SparseMatrix with the specified sizes.

virtual void	init (ParallelType) override
	Initialize this matrix using the sparsity structure computed by `dof_map`.

virtual void	clear () override
	clear() is called from the destructor, so it should not throw.

virtual void	zero () override
	Set all entries to 0.

virtual std::unique_ptr< SparseMatrix< Number > >	zero_clone () const override

virtual std::unique_ptr< SparseMatrix< Number > >	clone () const override

virtual void	close () override
	Calls the SparseMatrix's internal assembly routines, ensuring that the values are consistent across processors.

virtual numeric_index_type	m () const override

virtual numeric_index_type	n () const override

virtual numeric_index_type	row_start () const override

virtual numeric_index_type	row_stop () const override

virtual numeric_index_type	col_start () const override

virtual numeric_index_type	col_stop () const override

virtual void	set (const numeric_index_type, const numeric_index_type, const Number) override
	Set the element (i,j) to `value`.

virtual void	add (const numeric_index_type, const numeric_index_type, const Number) override
	Add `value` to the element (i,j).

virtual void	add_matrix (const DenseMatrix< Number > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &) override
	Add the full matrix `dm` to the SparseMatrix.

virtual void	add_matrix (const DenseMatrix< Number > &, const std::vector< numeric_index_type > &) override
	Same as `add_matrix`, but assumes the row and column maps are the same.

virtual void	add (const Number, const SparseMatrix< Number > &) override
	Compute \( A \leftarrow A + a*X \) for scalar `a`, matrix `X`.

virtual Number	operator() (const numeric_index_type, const numeric_index_type) const override

virtual Real	l1_norm () const override

virtual Real	linfty_norm () const override

virtual bool	closed () const override

virtual void	print_personal (std::ostream &=libMesh::out) const override
	Print the contents of the matrix to the screen in a package-personalized style, if available.

virtual void	get_diagonal (NumericVector< Number > &) const override
	Copies the diagonal part of the matrix into `dest`.

virtual void	get_transpose (SparseMatrix< Number > &) const override
	Copies the transpose of the matrix into `dest`, which may be *this.

virtual void	get_row (numeric_index_type, std::vector< numeric_index_type > &, std::vector< Number > &) const override
	Get a row from the matrix.

void	init ()

void	setup ()

void	apply (const NumericVector< Number > &, NumericVector< Number > &)

void	set_current_elem (const Elem &)

void	dont_condense_vars (const std::unordered_set< unsigned int > &)

Mat	mat ()

Mat	mat () const

void	set_destroy_mat_on_exit (bool destroy=true)
	If set to false, we don't delete the Mat on destruction and allow instead for `PETSc` to manage it.

void	swap (PetscMatrixBase< T > &)
	Swaps the internal data pointers of two PetscMatrices, no actual values are swapped.

void	set_context ()
	Set the context (ourself) for `_mat`.

virtual numeric_index_type	local_m () const final
	Get the number of rows owned by this process.

virtual numeric_index_type	local_n () const final
	Get the number of columns owned by this process.

void	attach_dof_map (const DofMap &dof_map)
	Set a pointer to the `DofMap` to use.

void	attach_sparsity_pattern (const SparsityPattern::Build &sp)
	Set a pointer to a sparsity pattern to use.

virtual bool	need_full_sparsity_pattern () const

virtual void	update_sparsity_pattern (const SparsityPattern::Graph &)
	Updates the matrix sparsity pattern.

virtual void	zero_rows (std::vector< numeric_index_type > &rows, T diag_value=0.0)
	Sets all row entries to 0 then puts `diag_value` in the diagonal entry.

virtual void	flush ()
	For PETSc matrix , this function is similar to close but without shrinking memory.

virtual void	set (const numeric_index_type i, const numeric_index_type j, const T value)=0
	Set the element (i,j) to `value`.

virtual void	add (const numeric_index_type i, const numeric_index_type j, const T value)=0
	Add `value` to the element (i,j).

virtual void	add (const T a, const SparseMatrix< T > &X)=0
	Compute \( A \leftarrow A + a*X \) for scalar `a`, matrix `X`.

virtual void	add_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols)=0
	Add the full matrix `dm` to the SparseMatrix.

virtual void	add_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &dof_indices)=0
	Same as `add_matrix`, but assumes the row and column maps are the same.

virtual void	add_block_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &brows, const std::vector< numeric_index_type > &bcols)
	Add the full matrix `dm` to the SparseMatrix.

virtual void	add_block_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &dof_indices)
	Same as `add_block_matrix()`, but assumes the row and column maps are the same.

virtual void	matrix_matrix_mult (SparseMatrix< T > &, SparseMatrix< T > &, bool)
	Compute Y = A*X for matrix `X`.

virtual void	add_sparse_matrix (const SparseMatrix< T > &, const std::map< numeric_index_type, numeric_index_type > &, const std::map< numeric_index_type, numeric_index_type > &, const T)
	Add `scalar` `spm` to the rows and cols of this matrix (A): A(rows[i], cols[j]) += scalar spm(i,j)

Real	l1_norm_diff (const SparseMatrix< T > &other_mat) const

virtual std::size_t	n_nonzeros () const

void	print (std::ostream &os=libMesh::out, const bool sparse=false) const
	Print the contents of the matrix to the screen in a uniform style, regardless of matrix/solver package being used.

void	print (const std::string &filename) const
	Print the contents of the matrix to a file, with a file format depending on the extension of `filename`.

void	print (std::ostream &os, const bool sparse) const

virtual void	print_coreform_hdf5 (const std::string &filename, const std::string &groupname="extraction") const
	Print the contents of the matrix to a file, with the HDF5 sparse matrix format used by CoreForm, putting CSR sparse matrix data in the group given by `groupname`.

virtual void	print_matlab (const std::string &="") const
	Print the contents of the matrix in Matlab's sparse matrix format.

virtual void	print_petsc_binary (const std::string &filename) const
	Write the contents of the matrix to a file in PETSc's binary sparse matrix format.

virtual void	print_petsc_hdf5 (const std::string &filename) const
	Write the contents of the matrix to a file in PETSc's HDF5 sparse matrix format.

virtual void	read (const std::string &filename)
	Read the contents of the matrix from a file, with the file format inferred from the extension of `filename`.

virtual void	read_coreform_hdf5 (const std::string &filename, const std::string &groupname="extraction")
	Read the contents of the matrix from a file, with the HDF5 sparse matrix format used by CoreForm, expecing sparse matrix data in the group given by `groupname`.

virtual void	read_matlab (const std::string &filename)
	Read the contents of the matrix from the Matlab-script sparse matrix format used by PETSc.

virtual void	read_petsc_binary (const std::string &filename)
	Read the contents of the matrix from a file in PETSc's binary sparse matrix format.

virtual void	read_petsc_hdf5 (const std::string &filename)
	Read the contents of the matrix from a file in PETSc's HDF5 sparse matrix format.

virtual void	create_submatrix (SparseMatrix< T > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const
	This function creates a matrix called "submatrix" which is defined by the row and column indices given in the "rows" and "cols" entries.

virtual void	create_submatrix_nosort (SparseMatrix< T > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &) const
	Similar to the above function, this function creates a `submatrix` which is defined by the indices given in the `rows` and `cols` vectors.

virtual void	reinit_submatrix (SparseMatrix< T > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const
	This function is similar to the one above, but it allows you to reuse the existing sparsity pattern of "submatrix" instead of reallocating it again.

void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const
	Multiplies the matrix by the NumericVector `arg` and stores the result in NumericVector `dest`.

void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const
	Multiplies the matrix by the NumericVector `arg` and adds the result to the NumericVector `dest`.

virtual void	get_diagonal (NumericVector< T > &dest) const =0
	Copies the diagonal part of the matrix into `dest`.

virtual void	get_transpose (SparseMatrix< T > &dest) const =0
	Copies the transpose of the matrix into `dest`, which may be *this.

virtual void	get_row (numeric_index_type i, std::vector< numeric_index_type > &indices, std::vector< T > &values) const =0
	Get a row from the matrix.

virtual void	scale (const T scale)
	Scales all elements of this matrix by `scale`.

virtual bool	supports_hash_table () const

void	use_hash_table (bool use_hash)
	Sets whether to use hash table assembly.

bool	use_hash_table () const

virtual void	restore_original_nonzero_pattern ()
	Reset the memory storage of the matrix.

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

void	attach_dof_map (const DofMap &dof_map)
	Set a pointer to the `DofMap` to use.

void	attach_sparsity_pattern (const SparsityPattern::Build &sp)
	Set a pointer to a sparsity pattern to use.

virtual bool	need_full_sparsity_pattern () const

virtual void	update_sparsity_pattern (const SparsityPattern::Graph &)
	Updates the matrix sparsity pattern.

virtual void	zero_rows (std::vector< numeric_index_type > &rows, Number diag_value=0.0)
	Sets all row entries to 0 then puts `diag_value` in the diagonal entry.

virtual void	flush ()
	For PETSc matrix , this function is similar to close but without shrinking memory.

virtual numeric_index_type	local_m () const
	Get the number of rows owned by this process.

virtual numeric_index_type	local_n () const
	Get the number of columns owned by this process.

virtual void	add_block_matrix (const DenseMatrix< Number > &dm, const std::vector< numeric_index_type > &brows, const std::vector< numeric_index_type > &bcols)
	Add the full matrix `dm` to the SparseMatrix.

virtual void	add_block_matrix (const DenseMatrix< Number > &dm, const std::vector< numeric_index_type > &dof_indices)
	Same as `add_block_matrix()`, but assumes the row and column maps are the same.

virtual void	matrix_matrix_mult (SparseMatrix< Number > &, SparseMatrix< Number > &, bool)
	Compute Y = A*X for matrix `X`.

virtual void	add_sparse_matrix (const SparseMatrix< Number > &, const std::map< numeric_index_type, numeric_index_type > &, const std::map< numeric_index_type, numeric_index_type > &, const Number)
	Add `scalar` `spm` to the rows and cols of this matrix (A): A(rows[i], cols[j]) += scalar spm(i,j)

Real	l1_norm_diff (const SparseMatrix< Number > &other_mat) const

virtual std::size_t	n_nonzeros () const

void	print (std::ostream &os=libMesh::out, const bool sparse=false) const
	Print the contents of the matrix to the screen in a uniform style, regardless of matrix/solver package being used.

void	print (const std::string &filename) const
	Print the contents of the matrix to a file, with a file format depending on the extension of `filename`.

virtual void	print_coreform_hdf5 (const std::string &filename, const std::string &groupname="extraction") const
	Print the contents of the matrix to a file, with the HDF5 sparse matrix format used by CoreForm, putting CSR sparse matrix data in the group given by `groupname`.

virtual void	print_matlab (const std::string &="") const
	Print the contents of the matrix in Matlab's sparse matrix format.

virtual void	print_petsc_binary (const std::string &filename) const
	Write the contents of the matrix to a file in PETSc's binary sparse matrix format.

virtual void	print_petsc_hdf5 (const std::string &filename) const
	Write the contents of the matrix to a file in PETSc's HDF5 sparse matrix format.

virtual void	read (const std::string &filename)
	Read the contents of the matrix from a file, with the file format inferred from the extension of `filename`.

virtual void	read_coreform_hdf5 (const std::string &filename, const std::string &groupname="extraction")
	Read the contents of the matrix from a file, with the HDF5 sparse matrix format used by CoreForm, expecing sparse matrix data in the group given by `groupname`.

virtual void	read_matlab (const std::string &filename)
	Read the contents of the matrix from the Matlab-script sparse matrix format used by PETSc.

virtual void	read_petsc_binary (const std::string &filename)
	Read the contents of the matrix from a file in PETSc's binary sparse matrix format.

virtual void	read_petsc_hdf5 (const std::string &filename)
	Read the contents of the matrix from a file in PETSc's HDF5 sparse matrix format.

virtual void	create_submatrix (SparseMatrix< Number > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const
	This function creates a matrix called "submatrix" which is defined by the row and column indices given in the "rows" and "cols" entries.

virtual void	create_submatrix_nosort (SparseMatrix< Number > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &) const
	Similar to the above function, this function creates a `submatrix` which is defined by the indices given in the `rows` and `cols` vectors.

virtual void	reinit_submatrix (SparseMatrix< Number > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const
	This function is similar to the one above, but it allows you to reuse the existing sparsity pattern of "submatrix" instead of reallocating it again.

void	vector_mult (NumericVector< Number > &dest, const NumericVector< Number > &arg) const
	Multiplies the matrix by the NumericVector `arg` and stores the result in NumericVector `dest`.

void	vector_mult_add (NumericVector< Number > &dest, const NumericVector< Number > &arg) const
	Multiplies the matrix by the NumericVector `arg` and adds the result to the NumericVector `dest`.

virtual void	scale (const Number scale)
	Scales all elements of this matrix by `scale`.

virtual bool	supports_hash_table () const

void	use_hash_table (bool use_hash)
	Sets whether to use hash table assembly.

bool	use_hash_table () const

virtual void	restore_original_nonzero_pattern ()
	Reset the memory storage of the matrix.

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static PetscMatrixBase< T > *	get_context (Mat mat, const TIMPI::Communicator &comm)

static std::unique_ptr< SparseMatrix< T > >	build (const Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package(), const MatrixBuildType matrix_build_type=MatrixBuildType::AUTOMATIC)
	Builds a `SparseMatrix<T>` using the linear solver package specified by `solver_package`.

static std::string	get_info ()
	Gets a string containing the reference information.

static void	print_info (std::ostream &out_stream=libMesh::out)
	Prints the reference information, by default to `libMesh::out`.

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects.

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info().

static void	disable_print_counter_info ()

static std::unique_ptr< SparseMatrix< Number > >	build (const Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package(), const MatrixBuildType matrix_build_type=MatrixBuildType::AUTOMATIC)
	Builds a `SparseMatrix<T>` using the linear solver package specified by `solver_package`.

static std::string	get_info ()
	Gets a string containing the reference information.

static void	print_info (std::ostream &out_stream=libMesh::out)
	Prints the reference information, by default to `libMesh::out`.

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects.

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info().

static void	disable_print_counter_info ()

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information.

typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information.

Protected Member Functions
virtual void	_get_submatrix (SparseMatrix< T > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &, const bool) const
	Protected implementation of the create_submatrix and reinit_submatrix routines.

void	increment_constructor_count (const std::string &name) noexcept
	Increments the construction counter.

void	increment_destructor_count (const std::string &name) noexcept
	Increments the destruction counter.

virtual void	_get_submatrix (SparseMatrix< Number > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &, const bool) const
	Protected implementation of the create_submatrix and reinit_submatrix routines.

void	increment_constructor_count (const std::string &name) noexcept
	Increments the construction counter.

void	increment_destructor_count (const std::string &name) noexcept
	Increments the destruction counter.

Protected Attributes
Mat	_mat
	PETSc matrix datatype to store values.

bool	_destroy_mat_on_exit
	This boolean value should only be set to `false` for the constructor which takes a PETSc Mat object.

DofMap const *	_dof_map
	The `DofMap` object associated with this object.

SparsityPattern::Build const *	_sp
	The `sparsity` pattern associated with this object.

bool	_is_initialized
	Flag indicating whether or not the matrix has been initialized.

bool	_use_hash_table
	Flag indicating whether the matrix is assembled using a hash table.

const Parallel::Communicator &	_communicator

DofMap const *	_dof_map
	The `DofMap` object associated with this object.

SparsityPattern::Build const *	_sp
	The `sparsity` pattern associated with this object.

bool	_is_initialized
	Flag indicating whether or not the matrix has been initialized.

bool	_use_hash_table
	Flag indicating whether the matrix is assembled using a hash table.

const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts
	Actually holds the data.

static Threads::atomic< unsigned int >	_n_objects
	The number of objects.

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting.

static bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called.

static Counts	_counts
	Actually holds the data.

static Threads::atomic< unsigned int >	_n_objects
	The number of objects.

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting.

static bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called.

Private Member Functions
void	forward_elimination (const NumericVector< Number > &full_rhs)
	Takes an incoming "full" RHS from the solver, where full means the union of uncondensed and condennsed dofs, and condenses it down into the condensed `_reduced_rhs` data member using element Schur complements.

void	backwards_substitution (const NumericVector< Number > &full_rhs, NumericVector< Number > &full_sol)
	After performing the solve with the `_reduced_rhs` and Schur complement matrix (`_reduced_sys_mat`) to determine the `_reduced_sol`, we use the uncondensed `full_rhs` along with the `_reduced_sol` to back substitute into the `full_sol`, which is the final output data of the static condensation preconditioner application.

Static Private Member Functions
static void	set_local_vectors (const NumericVector< Number > &global_vector, const std::vector< dof_id_type > &elem_dof_indices, std::vector< Number > &elem_dof_values_vec, EigenVector &elem_dof_values)
	Retrieves the degree of freedom values from `global_vector` corresponding to `elem_dof_indices`, filling both `elem_dof_values_vec` and `elem_dof_values`.

Private Attributes
std::unordered_map< dof_id_type, MatrixData >	_elem_to_matrix_data
	A map from element ID to Schur complement data.

const MeshBase &	_mesh

System &	_system

const DofMap &	_full_dof_map

StaticCondensationDofMap &	_reduced_dof_map

std::unique_ptr< SparseMatrix< Number > >	_reduced_sys_mat
	global sparse matrix for the uncondensed degrees of freedom

std::unique_ptr< NumericVector< Number > >	_reduced_sol
	solution for the uncondensed degrees of freedom

std::unique_ptr< NumericVector< Number > >	_reduced_rhs
	RHS corresponding to the uncondensed degrees of freedom.

std::unique_ptr< LinearSolver< Number > >	_reduced_solver
	The solver for the uncondensed degrees of freedom.

std::unique_ptr< NumericVector< Number > >	_ghosted_full_sol
	This is a ghosted representation of the full (uncondensed + condensed) solution. Note that.

dof_id_type	_current_elem_id
	The current element ID.

DenseMatrix< Number >	_size_one_mat
	Helper data member for adding individual matrix elements.

std::unique_ptr< StaticCondensationPreconditioner >	_scp
	Preconditioner object which will call back to us for the preconditioning action.

bool	_sc_is_initialized
	Whether our object has been initialized.

bool	_have_cached_values
	Whether we have cached values via add_XXX()

ParallelType	_parallel_type
	The parallel type to use for the reduced matrix.

bool	_uncondensed_dofs_only
	whether this matrix represents uncondensed dofs only.

const bool	_omit_constrained_dofs
	Whether to omit constrained degrees of freedom.

Detailed Description

Definition at line 66 of file static_condensation.h.

Member Typedef Documentation

◆ Counts [1/2]

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 119 of file reference_counter.h.

◆ Counts [2/2]

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 119 of file reference_counter.h.

Constructor & Destructor Documentation

◆ StaticCondensation() [1/2]

libMesh::StaticCondensation::StaticCondensation	(	const MeshBase &	mesh,
		System &	system,
		const DofMap &	full_dof_map,
		StaticCondensationDofMap &	reduced_dof_map
	)

Definition at line 39 of file static_condensation.C.

  : PetscMatrixShellMatrix<Number>(full_dof_map.comm()),
    _mesh(mesh),
    _system(system),
    _full_dof_map(full_dof_map),
    _reduced_dof_map(reduced_dof_map),
    _current_elem_id(DofObject::invalid_id),
    _sc_is_initialized(false),
    _have_cached_values(false),
    _parallel_type(INVALID_PARALLELIZATION),
    _uncondensed_dofs_only(false)
{
  _size_one_mat.resize(1, 1);
  _scp = std::make_unique<StaticCondensationPreconditioner>(*this);
}

References _scp, _size_one_mat, and libMesh::DenseMatrix< T >::resize().

◆ ~StaticCondensation()

libMesh::StaticCondensation::~StaticCondensation ( )

virtualdefault

◆ StaticCondensation() [2/2]

libMesh::StaticCondensation::StaticCondensation	(	const MeshBase &	,
		const System &	,
		const DofMap &	full_dof_map,
		StaticCondensationDofMap &	reduced_dof_map
	)

Definition at line 489 of file static_condensation.C.

  : SparseMatrix<Number>(full_dof_map.comm())
{
  libmesh_error_msg(
      "Static condensation requires configuring libMesh with PETSc and Eigen support");
}

Member Function Documentation

◆ _get_submatrix() [1/2]

virtual void libMesh::SparseMatrix< Number >::_get_submatrix	(	SparseMatrix< Number > &	,
		const std::vector< numeric_index_type > &	,
		const std::vector< numeric_index_type > &	,
		const bool
	)		const

inlineprotectedvirtualinherited

Protected implementation of the create_submatrix and reinit_submatrix routines.

Note: This function must be overridden in derived classes for it to work properly!

Definition at line 654 of file sparse_matrix.h.

  {
    libmesh_not_implemented();
  }

◆ _get_submatrix() [2/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::_get_submatrix	(	SparseMatrix< T > &	,
		const std::vector< numeric_index_type > &	,
		const std::vector< numeric_index_type > &	,
		const bool
	)		const

inlineprotectedvirtualinherited

Protected implementation of the create_submatrix and reinit_submatrix routines.

Note: This function must be overridden in derived classes for it to work properly!

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 654 of file sparse_matrix.h.

  {
    libmesh_not_implemented();
  }

Referenced by libMesh::SparseMatrix< T >::create_submatrix(), and libMesh::SparseMatrix< T >::reinit_submatrix().

◆ add() [1/6]

void libMesh::StaticCondensation::add	(	const Number	a,
		const SparseMatrix< Number > &	X
	)

overridevirtual

Compute \( A \leftarrow A + a*X \) for scalar a, matrix X.

Implements libMesh::SparseMatrix< Number >.

Definition at line 345 of file static_condensation.C.

{
  libmesh_not_implemented();
}

◆ add() [2/6]

virtual void libMesh::StaticCondensation::add	(	const Number	a,
		const SparseMatrix< Number > &	X
	)

inlineoverridevirtual

Compute \( A \leftarrow A + a*X \) for scalar a, matrix X.

Implements libMesh::SparseMatrix< Number >.

Definition at line 385 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ add() [3/6]

void libMesh::StaticCondensation::add	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const Number	value
	)

overridevirtual

Add value to the element (i,j).

Throws an error if the entry does not exist. Zero values can be "added" to non-existent entries.

Implements libMesh::SparseMatrix< Number >.

Definition at line 270 of file static_condensation.C.

{
  _size_one_mat(0, 0) = value;
  this->add_matrix(_size_one_mat, {i}, {j});
}

References _size_one_mat, add_matrix(), and value.

◆ add() [4/6]

template<typename T >

virtual void libMesh::SparseMatrix< T >::add	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const T	value
	)

pure virtualinherited

Add value to the element (i,j).

Throws an error if the entry does not exist. Zero values can be "added" to non-existent entries.

Implemented in libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::LumpedMassMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, libMesh::EpetraMatrix< T >, and libMesh::StaticCondensation.

Referenced by add_M_C_K_helmholtz(), libMesh::RBConstruction::add_scaled_Aq(), libMesh::TransientRBConstruction::add_scaled_mass_matrix(), assemble_shell(), libMesh::NewmarkSystem::compute_matrix(), libMesh::RBConstruction::compute_residual_dual_norm_slow(), AssembleOptimization::hessian(), libMesh::HDGProblem::jacobian(), libMesh::RBSCMConstruction::load_matrix_B(), LinearElasticityWithContact::residual_and_jacobian(), libMesh::ClawSystem::solve_conservation_law(), SystemsTest::testProjectMatrix1D(), SystemsTest::testProjectMatrix2D(), SystemsTest::testProjectMatrix3D(), libMesh::RBConstruction::truth_assembly(), and libMesh::TransientRBConstruction::truth_assembly().

◆ add() [5/6]

virtual void libMesh::StaticCondensation::add	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const Number	value
	)

inlineoverridevirtual

Add value to the element (i,j).

Throws an error if the entry does not exist. Zero values can be "added" to non-existent entries.

Implements libMesh::SparseMatrix< Number >.

Definition at line 370 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ add() [6/6]

template<typename T >

virtual void libMesh::SparseMatrix< T >::add	(	const T	a,
		const SparseMatrix< T > &	X
	)

pure virtualinherited

Compute \( A \leftarrow A + a*X \) for scalar a, matrix X.

Implemented in libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::LumpedMassMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, and libMesh::EpetraMatrix< T >.

◆ add_block_matrix() [1/4]

void libMesh::SparseMatrix< Number >::add_block_matrix	(	const DenseMatrix< Number > &	dm,
		const std::vector< numeric_index_type > &	brows,
		const std::vector< numeric_index_type > &	bcols
	)

virtualinherited

Add the full matrix dm to the SparseMatrix.

This is useful for adding an element matrix at assembly time. The matrix is assumed blocked, and brow, bcol correspond to the block row and column indices.

Definition at line 329 of file sparse_matrix.C.

{
  libmesh_assert_equal_to (dm.m() / brows.size(), dm.n() / bcols.size());
 
  const numeric_index_type blocksize = cast_int<numeric_index_type>
    (dm.m() / brows.size());
 
  libmesh_assert_equal_to (dm.m()%blocksize, 0);
  libmesh_assert_equal_to (dm.n()%blocksize, 0);
 
  std::vector<numeric_index_type> rows, cols;
 
  rows.reserve(blocksize*brows.size());
  cols.reserve(blocksize*bcols.size());
 
  for (auto & row : brows)
    {
      numeric_index_type i = row * blocksize;
 
      for (unsigned int v=0; v<blocksize; v++)
        rows.push_back(i++);
    }
 
  for (auto & col : bcols)
    {
      numeric_index_type j = col * blocksize;
 
      for (unsigned int v=0; v<blocksize; v++)
        cols.push_back(j++);
    }
 
  this->add_matrix (dm, rows, cols);
}

◆ add_block_matrix() [2/4]

virtual void libMesh::SparseMatrix< Number >::add_block_matrix	(	const DenseMatrix< Number > &	dm,
		const std::vector< numeric_index_type > &	dof_indices
	)

inlinevirtualinherited

Same as add_block_matrix(), but assumes the row and column maps are the same.

Thus the matrix dm must be square.

Definition at line 337 of file sparse_matrix.h.

339 { this->add_block_matrix (dm, dof_indices, dof_indices); }

libMesh::SparseMatrix< Number >::add_block_matrix

virtual void add_block_matrix(const DenseMatrix< Number > &dm, const std::vector< numeric_index_type > &brows, const std::vector< numeric_index_type > &bcols)

Add the full matrix dm to the SparseMatrix.

Definition sparse_matrix.C:119

◆ add_block_matrix() [3/4]

template<typename T >

void libMesh::SparseMatrix< T >::add_block_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	brows,
		const std::vector< numeric_index_type > &	bcols
	)

virtualinherited

Add the full matrix dm to the SparseMatrix.

This is useful for adding an element matrix at assembly time. The matrix is assumed blocked, and brow, bcol correspond to the block row and column indices.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 119 of file sparse_matrix.C.

{
  libmesh_assert_equal_to (dm.m() / brows.size(), dm.n() / bcols.size());
 
  const numeric_index_type blocksize = cast_int<numeric_index_type>
    (dm.m() / brows.size());
 
  libmesh_assert_equal_to (dm.m()%blocksize, 0);
  libmesh_assert_equal_to (dm.n()%blocksize, 0);
 
  std::vector<numeric_index_type> rows, cols;
 
  rows.reserve(blocksize*brows.size());
  cols.reserve(blocksize*bcols.size());
 
  for (auto & row : brows)
    {
      numeric_index_type i = row * blocksize;
 
      for (unsigned int v=0; v<blocksize; v++)
        rows.push_back(i++);
    }
 
  for (auto & col : bcols)
    {
      numeric_index_type j = col * blocksize;
 
      for (unsigned int v=0; v<blocksize; v++)
        cols.push_back(j++);
    }
 
  this->add_matrix (dm, rows, cols);
}

Referenced by libMesh::SparseMatrix< T >::add_block_matrix().

◆ add_block_matrix() [4/4]

template<typename T >

virtual void libMesh::SparseMatrix< T >::add_block_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	dof_indices
	)

inlinevirtualinherited

Same as add_block_matrix(), but assumes the row and column maps are the same.

Thus the matrix dm must be square.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 337 of file sparse_matrix.h.

339 { this->add_block_matrix (dm, dof_indices, dof_indices); }

References libMesh::SparseMatrix< T >::add_block_matrix().

◆ add_matrix() [1/6]

virtual void libMesh::StaticCondensation::add_matrix	(	const DenseMatrix< Number > &	dm,
		const std::vector< numeric_index_type > &	dof_indices
	)

inlineoverridevirtual

Same as add_matrix, but assumes the row and column maps are the same.

Thus the matrix dm must be square.

Implements libMesh::SparseMatrix< Number >.

Definition at line 380 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ add_matrix() [2/6]

virtual void libMesh::StaticCondensation::add_matrix	(	const DenseMatrix< Number > &	dm,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)

inlineoverridevirtual

Add the full matrix dm to the SparseMatrix.

This is useful for adding an element matrix at assembly time.

Implements libMesh::SparseMatrix< Number >.

Definition at line 374 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ add_matrix() [3/6]

void libMesh::StaticCondensation::add_matrix	(	const DenseMatrix< Number > &	dm,
		const std::vector< numeric_index_type > &	dof_indices
	)

overridevirtual

Same as add_matrix, but assumes the row and column maps are the same.

Thus the matrix dm must be square.

Implements libMesh::SparseMatrix< Number >.

Definition at line 339 of file static_condensation.C.

{
  this->add_matrix(dm, dof_indices, dof_indices);
}

References add_matrix().

◆ add_matrix() [4/6]

void libMesh::StaticCondensation::add_matrix	(	const DenseMatrix< Number > &	dm,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)

overridevirtual

Add the full matrix dm to the SparseMatrix.

This is useful for adding an element matrix at assembly time.

Implements libMesh::SparseMatrix< Number >.

Definition at line 278 of file static_condensation.C.

{
  if (rows.empty() || cols.empty())
    return;
 
  libmesh_assert(_current_elem_id != DofObject::invalid_id);
  auto & matrix_data = libmesh_map_find(_elem_to_matrix_data, _current_elem_id);
  const auto & dof_data = libmesh_map_find(_reduced_dof_map._elem_to_dof_data, _current_elem_id);
  EigenMatrix * mat;
 
  auto info_from_index = [&dof_data](const auto global_index) {
    auto index_it = dof_data.condensed_global_to_local_map.find(global_index);
    const bool index_is_condensed = index_it != dof_data.condensed_global_to_local_map.end();
    if (!index_is_condensed)
      {
        index_it = dof_data.uncondensed_global_to_local_map.find(global_index);
        if (index_it == dof_data.uncondensed_global_to_local_map.end())
          libmesh_error_msg("Failed to find the global index "
                            << global_index
                            << " in our current element's degree of freedom information. One way "
                               "this can happen is when using a discontinuous Galerkin method, "
                               "adding element matrices to both + and - sides of a face");
      }
    else
      // We found the dof in the condensed container. Let's assert that it's not also in the
      // uncondensed container
      libmesh_assert(dof_data.uncondensed_global_to_local_map.find(global_index) ==
                     dof_data.uncondensed_global_to_local_map.end());
 
    return std::make_pair(index_is_condensed, index_it->second);
  };
 
  for (const auto i : make_range(dm.m()))
    for (const auto j : make_range(dm.n()))
      {
        const auto global_i = rows[i];
        const auto global_j = cols[j];
        const auto [i_is_condensed, local_i] = info_from_index(global_i);
        const auto [j_is_condensed, local_j] = info_from_index(global_j);
        if (i_is_condensed)
          {
            if (j_is_condensed)
              mat = &matrix_data.Acc;
            else
              mat = &matrix_data.Acu;
          }
        else
          {
            if (j_is_condensed)
              mat = &matrix_data.Auc;
            else
              mat = &matrix_data.Auu;
          }
        (*mat)(local_i, local_j) += dm(i, j);
      }
 
  _have_cached_values = true;
}

References _current_elem_id, libMesh::StaticCondensationDofMap::_elem_to_dof_data, _elem_to_matrix_data, _have_cached_values, _reduced_dof_map, libMesh::DofObject::invalid_id, libMesh::libmesh_assert(), libMesh::DenseMatrixBase< T >::m(), libMesh::make_range(), libMesh::PetscMatrixBase< T >::mat(), and libMesh::DenseMatrixBase< T >::n().

Referenced by add(), and add_matrix().

◆ add_matrix() [5/6]

template<typename T >

virtual void libMesh::SparseMatrix< T >::add_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	dof_indices
	)

pure virtualinherited

Same as add_matrix, but assumes the row and column maps are the same.

Thus the matrix dm must be square.

Implemented in libMesh::StaticCondensation, libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, and libMesh::EpetraMatrix< T >.

◆ add_matrix() [6/6]

template<typename T >

virtual void libMesh::SparseMatrix< T >::add_matrix	(	const DenseMatrix< T > &	dm,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)

pure virtualinherited

Add the full matrix dm to the SparseMatrix.

This is useful for adding an element matrix at assembly time.

Implemented in libMesh::StaticCondensation, libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, and libMesh::EpetraMatrix< T >.

Referenced by libMesh::HDGProblem::add_matrix(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), LinearElasticity::assemble(), assemble(), assemble(), assemble_1D(), AssembleOptimization::assemble_A_and_F(), assemble_biharmonic(), assemble_divgrad(), assemble_elasticity(), assemble_ellipticdg(), assemble_func(), assemble_graddiv(), assemble_helmholtz(), assemble_laplace(), assemble_mass(), assemble_matrices(), assemble_matrix_and_rhs(), assemble_poisson(), assemble_poisson(), assemble_poisson(), assemble_SchroedingerEquation(), assemble_shell(), assemble_shell(), assemble_stokes(), assemble_temperature_jump(), assemble_wave(), assemble_wave(), assembly_with_dg_fem_context(), compute_jacobian(), fe_assembly(), periodic_bc_test_poisson(), LinearElasticityWithContact::residual_and_jacobian(), Biharmonic::JR::residual_and_jacobian(), and OverlappingCouplingGhostingTest::run_sparsity_pattern_test().

◆ add_sparse_matrix() [1/2]

virtual void libMesh::SparseMatrix< Number >::add_sparse_matrix	(	const SparseMatrix< Number > &	,
		const std::map< numeric_index_type, numeric_index_type > &	,
		const std::map< numeric_index_type, numeric_index_type > &	,
		const Number
	)

inlinevirtualinherited

Add scalar* spm to the rows and cols of this matrix (A): A(rows[i], cols[j]) += scalar * spm(i,j)

Definition at line 356 of file sparse_matrix.h.

360 { libmesh_not_implemented(); }

◆ add_sparse_matrix() [2/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::add_sparse_matrix	(	const SparseMatrix< T > &	,
		const std::map< numeric_index_type, numeric_index_type > &	,
		const std::map< numeric_index_type, numeric_index_type > &	,
		const T
	)

inlinevirtualinherited

Add scalar* spm to the rows and cols of this matrix (A): A(rows[i], cols[j]) += scalar * spm(i,j)

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 356 of file sparse_matrix.h.

360 { libmesh_not_implemented(); }

◆ apply() [1/2]

void libMesh::StaticCondensation::apply	(	const NumericVector< Number > &	,
		NumericVector< Number > &
	)

inline

Definition at line 410 of file static_condensation.h.

410{ libmesh_not_implemented(); }

◆ apply() [2/2]

void libMesh::StaticCondensation::apply	(	const NumericVector< Number > &	full_rhs,
		NumericVector< Number > &	full_sol
	)

Perform our three stages, forward_elimination(), a solve() on the condensed system, and finally a backwards_substitution()

Definition at line 457 of file static_condensation.C.

{
  forward_elimination(full_rhs);
  // Apparently PETSc will send us the yvec without zeroing it ahead of time. This can be a poor
  // initial guess for the Krylov solve as well as lead to bewildered users who expect their initial
  // residual norm to equal the norm of the RHS
  full_parallel_sol.zero();
  _reduced_sol = full_parallel_sol.get_subvector(_reduced_dof_map._local_uncondensed_dofs);
  _reduced_solver->solve(*_reduced_sys_mat, *_reduced_sol, *_reduced_rhs, 1e-5, 300);
  // Must restore to the full solution because during backwards substitution we will need to be able
  // to read ghosted dofs and we don't support ghosting of subvectors
  full_parallel_sol.restore_subvector(std::move(_reduced_sol),
                                      _reduced_dof_map._local_uncondensed_dofs);
  *_ghosted_full_sol = full_parallel_sol;
  backwards_substitution(full_rhs, full_parallel_sol);
}

References _ghosted_full_sol, libMesh::StaticCondensationDofMap::_local_uncondensed_dofs, _reduced_dof_map, _reduced_rhs, _reduced_sol, _reduced_solver, _reduced_sys_mat, backwards_substitution(), forward_elimination(), libMesh::NumericVector< T >::get_subvector(), libMesh::NumericVector< T >::restore_subvector(), and libMesh::NumericVector< T >::zero().

Referenced by libMesh::StaticCondensationPreconditioner::apply().

◆ attach_dof_map() [1/2]

template<typename T >

void libMesh::SparseMatrix< T >::attach_dof_map ( const DofMap & dof_map )

inherited

Set a pointer to the DofMap to use.

If a separate sparsity pattern is not being used, use the one from the DofMap.

The lifetime of dof_map must exceed the lifetime of this.

Definition at line 100 of file sparse_matrix.C.

{
  _dof_map = &dof_map;
  if (!_sp)
    _sp = dof_map.get_sparsity_pattern();
}

References libMesh::DofMap::get_sparsity_pattern().

Referenced by libMesh::Problem_Interface::computeJacobian(), DMlibMeshJacobian(), and libMesh::DofMap::update_sparsity_pattern().

◆ attach_dof_map() [2/2]

void libMesh::SparseMatrix< Number >::attach_dof_map ( const DofMap & dof_map )

inherited

Set a pointer to the DofMap to use.

If a separate sparsity pattern is not being used, use the one from the DofMap.

The lifetime of dof_map must exceed the lifetime of this.

Definition at line 141 of file sparse_matrix.C.

{
  _dof_map = &dof_map;
  if (!_sp)
    _sp = dof_map.get_sparsity_pattern();
}

◆ attach_sparsity_pattern() [1/2]

void libMesh::SparseMatrix< Number >::attach_sparsity_pattern ( const SparsityPattern::Build & sp )

inherited

Set a pointer to a sparsity pattern to use.

Useful in cases where a matrix requires a wider (or for efficiency narrower) pattern than most matrices in the system, or in cases where no system sparsity pattern is being calculated by the DofMap.

The lifetime of sp must exceed the lifetime of this.

Definition at line 151 of file sparse_matrix.C.

{
  _sp = &sp;
}

◆ attach_sparsity_pattern() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::attach_sparsity_pattern ( const SparsityPattern::Build & sp )

inherited

Set a pointer to a sparsity pattern to use.

Useful in cases where a matrix requires a wider (or for efficiency narrower) pattern than most matrices in the system, or in cases where no system sparsity pattern is being calculated by the DofMap.

The lifetime of sp must exceed the lifetime of this.

Definition at line 110 of file sparse_matrix.C.

{
  _sp = &sp;
}

Referenced by libMesh::DofMap::update_sparsity_pattern().

◆ backwards_substitution()

void libMesh::StaticCondensation::backwards_substitution	(	const NumericVector< Number > &	full_rhs,
		NumericVector< Number > &	full_sol
	)

private

After performing the solve with the _reduced_rhs and Schur complement matrix (_reduced_sys_mat) to determine the _reduced_sol, we use the uncondensed full_rhs along with the _reduced_sol to back substitute into the full_sol, which is the final output data of the static condensation preconditioner application.

Definition at line 419 of file static_condensation.C.

{
  std::vector<dof_id_type> elem_condensed_dofs, elem_uncondensed_dofs;
  std::vector<Number> elem_condensed_rhs_vec, elem_uncondensed_sol_vec;
  EigenVector elem_condensed_rhs, elem_uncondensed_sol, elem_condensed_sol;
 
  for (auto elem : _mesh.active_local_element_ptr_range())
    {
      auto & matrix_data = libmesh_map_find(_elem_to_matrix_data, elem->id());
      const auto & dof_data = libmesh_map_find(_reduced_dof_map._elem_to_dof_data, elem->id());
      elem_condensed_dofs.resize(dof_data.condensed_global_to_local_map.size());
      elem_uncondensed_dofs.resize(dof_data.uncondensed_global_to_local_map.size());
      for (const auto & [global_dof, local_dof] : dof_data.condensed_global_to_local_map)
        {
          libmesh_assert(local_dof < elem_condensed_dofs.size());
          elem_condensed_dofs[local_dof] = global_dof;
        }
      for (const auto & [global_dof, local_dof] : dof_data.uncondensed_global_to_local_map)
        {
          libmesh_assert(local_dof < elem_uncondensed_dofs.size());
          elem_uncondensed_dofs[local_dof] = global_dof;
        }
 
      set_local_vectors(full_rhs, elem_condensed_dofs, elem_condensed_rhs_vec, elem_condensed_rhs);
      set_local_vectors(*_ghosted_full_sol,
                        elem_uncondensed_dofs,
                        elem_uncondensed_sol_vec,
                        elem_uncondensed_sol);
 
      elem_condensed_sol =
          matrix_data.AccFactor.solve(elem_condensed_rhs - matrix_data.Acu * elem_uncondensed_sol);
      full_sol.insert(elem_condensed_sol.data(), elem_condensed_dofs);
    }
 
  full_sol.close();
}

References libMesh::StaticCondensationDofMap::_elem_to_dof_data, _elem_to_matrix_data, _ghosted_full_sol, _mesh, _reduced_dof_map, libMesh::NumericVector< T >::close(), libMesh::NumericVector< T >::insert(), libMesh::libmesh_assert(), and set_local_vectors().

Referenced by apply().

◆ build() [1/2]

template<typename T >

std::unique_ptr< SparseMatrix< T > > libMesh::SparseMatrix< T >::build	(	const Parallel::Communicator &	comm,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`,
		const MatrixBuildType	matrix_build_type = `MatrixBuildType::AUTOMATIC`
	)

staticinherited

Builds a SparseMatrix<T> using the linear solver package specified by solver_package.

Definition at line 193 of file sparse_matrix.C.

{
  // Avoid unused parameter warnings when no solver packages are enabled.
  libmesh_ignore(comm);
 
  if (matrix_build_type == MatrixBuildType::DIAGONAL)
    return std::make_unique<DiagonalMatrix<T>>(comm);
 
  // Build the appropriate vector
  switch (solver_package)
    {
 
#ifdef LIBMESH_HAVE_LASPACK
    case LASPACK_SOLVERS:
      return std::make_unique<LaspackMatrix<T>>(comm);
#endif
 
 
#ifdef LIBMESH_HAVE_PETSC
    case PETSC_SOLVERS:
      return std::make_unique<PetscMatrix<T>>(comm);
#endif
 
 
#ifdef LIBMESH_TRILINOS_HAVE_EPETRA
    case TRILINOS_SOLVERS:
      return std::make_unique<EpetraMatrix<T>>(comm);
#endif
 
 
#ifdef LIBMESH_HAVE_EIGEN
    case EIGEN_SOLVERS:
      return std::make_unique<EigenSparseMatrix<T>>(comm);
#endif
 
    default:
      libmesh_error_msg("ERROR:  Unrecognized solver package: " << solver_package);
    }
}

References libMesh::DIAGONAL, libMesh::EIGEN_SOLVERS, libMesh::LASPACK_SOLVERS, libMesh::libmesh_ignore(), libMesh::PETSC_SOLVERS, and libMesh::TRILINOS_SOLVERS.

Referenced by libMesh::CondensedEigenSystem::add_matrices(), libMesh::System::add_matrix(), libMesh::RBConstruction::allocate_data_structures(), libMesh::TransientRBConstruction::allocate_data_structures(), libMesh::CondensedEigenSystem::copy_super_to_sub(), init(), main(), libMesh::DofMap::process_mesh_constraint_rows(), ConstraintOperatorTest::test1DCoarseningNewNodes(), ConstraintOperatorTest::test1DCoarseningOperator(), ConstraintOperatorTest::testCoreform(), ConnectedComponentsTest::testEdge(), SystemsTest::testProjectMatrix1D(), SystemsTest::testProjectMatrix2D(), and SystemsTest::testProjectMatrix3D().

◆ build() [2/2]

std::unique_ptr< SparseMatrix< Number > > libMesh::SparseMatrix< Number >::build	(	const Parallel::Communicator &	comm,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`,
		const MatrixBuildType	matrix_build_type = `MatrixBuildType::AUTOMATIC`
	)

staticinherited

Builds a SparseMatrix<T> using the linear solver package specified by solver_package.

Definition at line 123 of file sparse_matrix.C.

{
  // Avoid unused parameter warnings when no solver packages are enabled.
  libmesh_ignore(comm);
 
  if (matrix_build_type == MatrixBuildType::DIAGONAL)
    return std::make_unique<DiagonalMatrix<T>>(comm);
 
  // Build the appropriate vector
  switch (solver_package)
    {
 
#ifdef LIBMESH_HAVE_LASPACK
    case LASPACK_SOLVERS:
      return std::make_unique<LaspackMatrix<T>>(comm);
#endif
 
 
#ifdef LIBMESH_HAVE_PETSC
    case PETSC_SOLVERS:
      return std::make_unique<PetscMatrix<T>>(comm);
#endif
 
 
#ifdef LIBMESH_TRILINOS_HAVE_EPETRA
    case TRILINOS_SOLVERS:
      return std::make_unique<EpetraMatrix<T>>(comm);
#endif
 
 
#ifdef LIBMESH_HAVE_EIGEN
    case EIGEN_SOLVERS:
      return std::make_unique<EigenSparseMatrix<T>>(comm);
#endif
 
    default:
      libmesh_error_msg("ERROR:  Unrecognized solver package: " << solver_package);
    }
}

◆ clear() [1/2]

void libMesh::StaticCondensation::clear ( )

overridevirtualnoexcept

clear() is called from the destructor, so it should not throw.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 75 of file static_condensation.C.

{
  PetscMatrixShellMatrix<Number>::clear();
 
  _elem_to_matrix_data.clear();
  _reduced_sys_mat.reset();
  _reduced_sol.reset();
  _reduced_rhs.reset();
  _reduced_solver.reset();
  _current_elem_id = DofObject::invalid_id;
  _have_cached_values = false;
  _sc_is_initialized = false;
}

References _current_elem_id, _elem_to_matrix_data, _have_cached_values, _reduced_rhs, _reduced_sol, _reduced_solver, _reduced_sys_mat, _sc_is_initialized, libMesh::PetscMatrixBase< T >::clear(), and libMesh::DofObject::invalid_id.

Referenced by libMesh::StaticCondensationPreconditioner::clear().

◆ clear() [2/2]

virtual void libMesh::StaticCondensation::clear ( )

inlineoverridevirtual

clear() is called from the destructor, so it should not throw.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 349 of file static_condensation.h.

349{ libmesh_not_implemented(); }

◆ clone() [1/2]

std::unique_ptr< SparseMatrix< Number > > libMesh::StaticCondensation::clone ( ) const

overridevirtual

Returns: A smart pointer to a copy of this matrix.

Note: This must be overridden in the derived classes.

Implements libMesh::SparseMatrix< T >.

Definition at line 70 of file static_condensation.C.

{
  libmesh_not_implemented();
}

◆ clone() [2/2]

virtual std::unique_ptr< SparseMatrix< Number > > libMesh::StaticCondensation::clone ( ) const

inlineoverridevirtual

Returns: A smart pointer to a copy of this matrix.

Note: This must be overridden in the derived classes.

Implements libMesh::SparseMatrix< T >.

Definition at line 355 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ close() [1/2]

void libMesh::StaticCondensation::close ( )

overridevirtual

Calls the SparseMatrix's internal assembly routines, ensuring that the values are consistent across processors.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 185 of file static_condensation.C.

{
  _communicator.max(_have_cached_values);
  if (!_have_cached_values)
    {
      bool closed = _reduced_sys_mat->closed();
      // closed is not collective
      _communicator.min(closed);
      if (!closed)
        _reduced_sys_mat->close();
      return;
    }
 
  DenseMatrix<Number> shim;
  std::vector<dof_id_type> reduced_space_indices;
  for (auto & [elem_id, matrix_data] : _elem_to_matrix_data)
    {
      const auto & dof_data = libmesh_map_find(_reduced_dof_map._elem_to_dof_data, elem_id);
      reduced_space_indices.clear();
 
      // The result matrix is either a Schur complement or it's simply the result of summing element
      // matrices of the uncondensed degrees of freedom
      EigenMatrix result = matrix_data.Auu;
      if (!_uncondensed_dofs_only)
        {
          matrix_data.AccFactor = matrix_data.Acc.partialPivLu();
          result -= matrix_data.Auc * matrix_data.AccFactor.solve(matrix_data.Acu);
        }
      shim.resize(result.rows(), result.cols());
      for (const auto i : make_range(result.rows()))
        for (const auto j : make_range(result.cols()))
          shim(i, j) = result(i, j);
      for (const auto & var_reduced_space_indices : dof_data.reduced_space_indices)
        reduced_space_indices.insert(reduced_space_indices.end(),
                                     var_reduced_space_indices.begin(),
                                     var_reduced_space_indices.end());
      _reduced_sys_mat->add_matrix(shim, reduced_space_indices);
    }
 
  _reduced_sys_mat->close();
 
  _have_cached_values = false;
}

References libMesh::ParallelObject::_communicator, libMesh::StaticCondensationDofMap::_elem_to_dof_data, _elem_to_matrix_data, _have_cached_values, _reduced_dof_map, _reduced_sys_mat, _uncondensed_dofs_only, closed(), libMesh::make_range(), libMesh::Parallel::Communicator::max(), libMesh::Parallel::Communicator::min(), and libMesh::DenseMatrix< T >::resize().

◆ close() [2/2]

virtual void libMesh::StaticCondensation::close ( )

inlineoverridevirtual

Calls the SparseMatrix's internal assembly routines, ensuring that the values are consistent across processors.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 359 of file static_condensation.h.

359{ libmesh_not_implemented(); }

◆ closed() [1/2]

bool libMesh::StaticCondensation::closed ( ) const

overridevirtual

Returns: true if the matrix has been assembled.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 229 of file static_condensation.C.

{
  return _reduced_sys_mat->closed() && !_have_cached_values;
}

References _have_cached_values, and _reduced_sys_mat.

Referenced by close(), and setup().

◆ closed() [2/2]

virtual bool libMesh::StaticCondensation::closed ( ) const

inlineoverridevirtual

Returns: true if the matrix has been assembled.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 395 of file static_condensation.h.

395{ libmesh_not_implemented(); }

◆ col_start() [1/2]

virtual numeric_index_type libMesh::StaticCondensation::col_start ( ) const

inlineoverridevirtual

Returns: The index of the first matrix column owned by this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 113 of file static_condensation.h.

113{ return this->row_start(); }

libMesh::StaticCondensation::row_start

virtual numeric_index_type row_start() const override

Definition static_condensation.C:251

References row_start().

◆ col_start() [2/2]

virtual numeric_index_type libMesh::StaticCondensation::col_start ( ) const

inlineoverridevirtual

Returns: The index of the first matrix column owned by this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 364 of file static_condensation.h.

364{ libmesh_not_implemented(); }

◆ col_stop() [1/2]

virtual numeric_index_type libMesh::StaticCondensation::col_stop ( ) const

inlineoverridevirtual

Returns: The index of the last matrix column (+1) owned by this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 115 of file static_condensation.h.

115{ return this->row_stop(); }

libMesh::StaticCondensation::row_stop

virtual numeric_index_type row_stop() const override

Definition static_condensation.C:253

References row_stop().

◆ col_stop() [2/2]

virtual numeric_index_type libMesh::StaticCondensation::col_stop ( ) const

inlineoverridevirtual

Returns: The index of the last matrix column (+1) owned by this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 365 of file static_condensation.h.

365{ libmesh_not_implemented(); }

◆ comm() [1/2]

const Parallel::Communicator & libMesh::ParallelObject::comm ( ) const

inlineinherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 97 of file parallel_object.h.

98 { return _communicator; }

References libMesh::ParallelObject::_communicator.

◆ comm() [2/2]

const Parallel::Communicator & libMesh::ParallelObject::comm ( ) const

inlineinherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 97 of file parallel_object.h.

98 { return _communicator; }

References libMesh::ParallelObject::_communicator.

◆ create_submatrix() [1/2]

virtual void libMesh::SparseMatrix< Number >::create_submatrix	(	SparseMatrix< Number > &	submatrix,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)		const

inlinevirtualinherited

This function creates a matrix called "submatrix" which is defined by the row and column indices given in the "rows" and "cols" entries.

Currently this operation is only defined for the PetscMatrixBase subclasses. Note: The rows and cols vectors need to be sorted; Use the nosort version below if rows and cols vectors are not sorted; The rows and cols only contain indices that are owned by this processor.

Definition at line 534 of file sparse_matrix.h.

  {
    this->_get_submatrix(submatrix,
                         rows,
                         cols,
                         false); // false means DO NOT REUSE submatrix
  }

◆ create_submatrix() [2/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::create_submatrix	(	SparseMatrix< T > &	submatrix,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)		const

inlinevirtualinherited

This function creates a matrix called "submatrix" which is defined by the row and column indices given in the "rows" and "cols" entries.

Currently this operation is only defined for the PetscMatrixBase subclasses. Note: The rows and cols vectors need to be sorted; Use the nosort version below if rows and cols vectors are not sorted; The rows and cols only contain indices that are owned by this processor.

Definition at line 534 of file sparse_matrix.h.

  {
    this->_get_submatrix(submatrix,
                         rows,
                         cols,
                         false); // false means DO NOT REUSE submatrix
  }

References libMesh::SparseMatrix< T >::_get_submatrix().

Referenced by libMesh::CondensedEigenSystem::copy_super_to_sub(), libMesh::libmesh_petsc_DMCreateInterpolation(), and libMesh::CondensedEigenSystem::solve().

◆ create_submatrix_nosort() [1/2]

virtual void libMesh::SparseMatrix< Number >::create_submatrix_nosort	(	SparseMatrix< Number > &	,
		const std::vector< numeric_index_type > &	,
		const std::vector< numeric_index_type > &
	)		const

inlinevirtualinherited

Similar to the above function, this function creates a submatrix which is defined by the indices given in the rows and cols vectors.

Note: Both rows and cols can be unsorted; Use the above function for better efficiency if your indices are sorted; rows and cols can contain indices that are owned by other processors.

Definition at line 552 of file sparse_matrix.h.

  {
    libmesh_not_implemented();
  }

◆ create_submatrix_nosort() [2/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::create_submatrix_nosort	(	SparseMatrix< T > &	,
		const std::vector< numeric_index_type > &	,
		const std::vector< numeric_index_type > &
	)		const

inlinevirtualinherited

Similar to the above function, this function creates a submatrix which is defined by the indices given in the rows and cols vectors.

Note: Both rows and cols can be unsorted; Use the above function for better efficiency if your indices are sorted; rows and cols can contain indices that are owned by other processors.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 552 of file sparse_matrix.h.

  {
    libmesh_not_implemented();
  }

◆ disable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

◆ disable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

◆ dont_condense_vars() [1/2]

void libMesh::StaticCondensation::dont_condense_vars ( const std::unordered_set< unsigned int > & )

inline

Definition at line 413 of file static_condensation.h.

413{}

◆ dont_condense_vars() [2/2]

void libMesh::StaticCondensation::dont_condense_vars ( const std::unordered_set< unsigned int > & vars )

Add vars to the list of variables not to condense.

This can be useful when some variable's equation is discretized with a DG method or if including the variable in the condensed block diagonal would result in it being singular

Definition at line 477 of file static_condensation.C.

{
  _reduced_dof_map.dont_condense_vars(vars);
}

References _reduced_dof_map, and libMesh::StaticCondensationDofMap::dont_condense_vars().

Referenced by main().

◆ enable_print_counter_info() [1/2]

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info().

Enabled by default.

Definition at line 94 of file reference_counter.C.

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ enable_print_counter_info() [2/2]

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info().

Enabled by default.

Definition at line 94 of file reference_counter.C.

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ flush() [1/2]

virtual void libMesh::SparseMatrix< Number >::flush ( )

inlinevirtualinherited

For PETSc matrix , this function is similar to close but without shrinking memory.

This is useful when we want to switch between ADD_VALUES and INSERT_VALUES. close should be called before using the matrix.

Definition at line 244 of file sparse_matrix.h.

244{ close(); }

libMesh::SparseMatrix< Number >::close

virtual void close()=0

Calls the SparseMatrix's internal assembly routines, ensuring that the values are consistent across p...

◆ flush() [2/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::flush ( )

inlinevirtualinherited

For PETSc matrix , this function is similar to close but without shrinking memory.

This is useful when we want to switch between ADD_VALUES and INSERT_VALUES. close should be called before using the matrix.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 244 of file sparse_matrix.h.

244{ close(); }

References libMesh::SparseMatrix< T >::close().

◆ forward_elimination()

void libMesh::StaticCondensation::forward_elimination ( const NumericVector< Number > & full_rhs )

private

Takes an incoming "full" RHS from the solver, where full means the union of uncondensed and condennsed dofs, and condenses it down into the condensed _reduced_rhs data member using element Schur complements.

Definition at line 383 of file static_condensation.C.

{
  std::vector<dof_id_type> elem_condensed_dofs;
  std::vector<Number> elem_condensed_rhs_vec;
  EigenVector elem_condensed_rhs, elem_uncondensed_rhs;
 
  full_rhs.create_subvector(
      *_reduced_rhs, _reduced_dof_map._local_uncondensed_dofs, /*all_global_entries=*/false);
 
  std::vector<dof_id_type> reduced_space_indices;
  for (auto elem : _mesh.active_local_element_ptr_range())
    {
      auto & matrix_data = libmesh_map_find(_elem_to_matrix_data, elem->id());
      reduced_space_indices.clear();
      const auto & dof_data = libmesh_map_find(_reduced_dof_map._elem_to_dof_data, elem->id());
      for (const auto & var_reduced_space_indices : dof_data.reduced_space_indices)
        reduced_space_indices.insert(reduced_space_indices.end(),
                                     var_reduced_space_indices.begin(),
                                     var_reduced_space_indices.end());
      elem_condensed_dofs.resize(dof_data.condensed_global_to_local_map.size());
      for (const auto & [global_dof, local_dof] : dof_data.condensed_global_to_local_map)
        {
          libmesh_assert(local_dof < elem_condensed_dofs.size());
          elem_condensed_dofs[local_dof] = global_dof;
        }
 
      set_local_vectors(full_rhs, elem_condensed_dofs, elem_condensed_rhs_vec, elem_condensed_rhs);
      elem_uncondensed_rhs = -matrix_data.Auc * matrix_data.AccFactor.solve(elem_condensed_rhs);
 
      libmesh_assert(cast_int<std::size_t>(elem_uncondensed_rhs.size()) ==
                     reduced_space_indices.size());
      _reduced_rhs->add_vector(elem_uncondensed_rhs.data(), reduced_space_indices);
    }
  _reduced_rhs->close();
}

References libMesh::StaticCondensationDofMap::_elem_to_dof_data, _elem_to_matrix_data, libMesh::StaticCondensationDofMap::_local_uncondensed_dofs, _mesh, _reduced_dof_map, _reduced_rhs, libMesh::NumericVector< T >::create_subvector(), libMesh::libmesh_assert(), and set_local_vectors().

Referenced by apply().

◆ get_condensed_mat()

const SparseMatrix< Number > & libMesh::StaticCondensation::get_condensed_mat ( ) const

inline

Definition at line 296 of file static_condensation.h.

{
  libmesh_assert(_reduced_sys_mat);
  return *_reduced_sys_mat;
}

References _reduced_sys_mat, and libMesh::libmesh_assert().

◆ get_context()

template<typename T >

PetscMatrixBase< T > * libMesh::PetscMatrixBase< T >::get_context	(	Mat	mat,
		const TIMPI::Communicator &	comm
	)

staticinherited

Returns: The context for mat if it exists, else a nullptr

Definition at line 116 of file petsc_matrix_base.C.

{
  void * ctx;
  PetscContainer container;
  LibmeshPetscCall2(comm, PetscObjectQuery((PetscObject)mat, "PetscMatrixCtx", (PetscObject *)&container));
  if (!container)
    return nullptr;
 
  LibmeshPetscCall2(comm, PetscContainerGetPointer(container, &ctx));
  libmesh_assert(ctx);
  return static_cast<PetscMatrixBase<T> *>(ctx);
}

References libMesh::ctx, and libMesh::libmesh_assert().

Referenced by DMlibMeshJacobian(), and form_matrixA().

◆ get_diagonal() [1/3]

virtual void libMesh::StaticCondensation::get_diagonal ( NumericVector< Number > & dest ) const

inlineoverridevirtual

Copies the diagonal part of the matrix into dest.

Implements libMesh::SparseMatrix< Number >.

Definition at line 400 of file static_condensation.h.

400{ libmesh_not_implemented(); }

◆ get_diagonal() [2/3]

void libMesh::StaticCondensation::get_diagonal ( NumericVector< Number > & dest ) const

overridevirtual

Copies the diagonal part of the matrix into dest.

Implements libMesh::SparseMatrix< Number >.

Definition at line 361 of file static_condensation.C.

361{ libmesh_not_implemented(); }

◆ get_diagonal() [3/3]

template<typename T >

virtual void libMesh::SparseMatrix< T >::get_diagonal ( NumericVector< T > & dest ) const

pure virtualinherited

Copies the diagonal part of the matrix into dest.

Implemented in libMesh::StaticCondensation, libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, and libMesh::EpetraMatrix< T >.

Referenced by libMesh::DiagonalMatrix< T >::add(), and libMesh::LumpedMassMatrix< T >::add().

◆ get_info() [1/2]

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
  std::ostringstream oss;
 
  oss << '\n'
      << " ---------------------------------------------------------------------------- \n"
      << "| Reference count information                                                |\n"
      << " ---------------------------------------------------------------------------- \n";
 
  for (const auto & [name, cd] : _counts)
    oss << "| " << name << " reference count information:\n"
        << "|  Creations:    " << cd.first    << '\n'
        << "|  Destructions: " << cd.second << '\n';
 
  oss << " ---------------------------------------------------------------------------- \n";
 
  return oss.str();
 
#else
 
  return "";
 
#endif
}

References libMesh::ReferenceCounter::_counts.

Referenced by libMesh::ReferenceCounter::print_info().

◆ get_info() [2/2]

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
  std::ostringstream oss;
 
  oss << '\n'
      << " ---------------------------------------------------------------------------- \n"
      << "| Reference count information                                                |\n"
      << " ---------------------------------------------------------------------------- \n";
 
  for (const auto & [name, cd] : _counts)
    oss << "| " << name << " reference count information:\n"
        << "|  Creations:    " << cd.first    << '\n'
        << "|  Destructions: " << cd.second << '\n';
 
  oss << " ---------------------------------------------------------------------------- \n";
 
  return oss.str();
 
#else
 
  return "";
 
#endif
}

References libMesh::ReferenceCounter::_counts.

Referenced by libMesh::ReferenceCounter::print_info().

◆ get_preconditioner() [1/2]

StaticCondensationPreconditioner & libMesh::StaticCondensation::get_preconditioner ( )

inline

Get the preconditioning wrapper.

Definition at line 181 of file static_condensation.h.

181{ return *_scp; }

References _scp.

Referenced by libMesh::ImplicitSystem::setup_static_condensation_preconditioner().

◆ get_preconditioner() [2/2]

StaticCondensationPreconditioner & libMesh::StaticCondensation::get_preconditioner ( )

inline

Definition at line 332 of file static_condensation.h.

332{ libmesh_not_implemented(); }

◆ get_row() [1/3]

void libMesh::StaticCondensation::get_row	(	numeric_index_type	i,
		std::vector< numeric_index_type > &	indices,
		std::vector< Number > &	values
	)		const

overridevirtual

Get a row from the matrix.

Parameters

i	The matrix row to get
indices	A container that will be filled with the column indices corresponding to (possibly) non-zero values
values	A container holding the column values

Implements libMesh::SparseMatrix< Number >.

Definition at line 365 of file static_condensation.C.

{
  libmesh_not_implemented();
}

◆ get_row() [2/3]

template<typename T >

virtual void libMesh::SparseMatrix< T >::get_row	(	numeric_index_type	i,
		std::vector< numeric_index_type > &	indices,
		std::vector< T > &	values
	)		const

pure virtualinherited

Get a row from the matrix.

Parameters

i	The matrix row to get
indices	A container that will be filled with the column indices corresponding to (possibly) non-zero values
values	A container holding the column values

Implemented in libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, libMesh::EpetraMatrix< T >, and libMesh::StaticCondensation.

Referenced by libMesh::MeshBase::copy_constraint_rows().

◆ get_row() [3/3]

virtual void libMesh::StaticCondensation::get_row	(	numeric_index_type	i,
		std::vector< numeric_index_type > &	indices,
		std::vector< Number > &	values
	)		const

inlineoverridevirtual

Get a row from the matrix.

Parameters

i	The matrix row to get
indices	A container that will be filled with the column indices corresponding to (possibly) non-zero values
values	A container holding the column values

Implements libMesh::SparseMatrix< Number >.

Definition at line 402 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ get_transpose() [1/3]

virtual void libMesh::StaticCondensation::get_transpose ( SparseMatrix< Number > & dest ) const

inlineoverridevirtual

Copies the transpose of the matrix into dest, which may be *this.

Implements libMesh::SparseMatrix< Number >.

Definition at line 401 of file static_condensation.h.

401{ libmesh_not_implemented(); }

◆ get_transpose() [2/3]

void libMesh::StaticCondensation::get_transpose ( SparseMatrix< Number > & dest ) const

overridevirtual

Copies the transpose of the matrix into dest, which may be *this.

Implements libMesh::SparseMatrix< Number >.

Definition at line 363 of file static_condensation.C.

363{ libmesh_not_implemented(); }

◆ get_transpose() [3/3]

template<typename T >

virtual void libMesh::SparseMatrix< T >::get_transpose ( SparseMatrix< T > & dest ) const

pure virtualinherited

Copies the transpose of the matrix into dest, which may be *this.

Implemented in libMesh::StaticCondensation, libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, and libMesh::EpetraMatrix< T >.

Referenced by libMesh::EigenSparseLinearSolver< T >::adjoint_solve(), ConstraintOperatorTest::testCoreform(), and libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

◆ increment_constructor_count() [1/2]

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectednoexceptinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 183 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.first++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_constructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

◆ increment_constructor_count() [2/2]

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectednoexceptinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 183 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.first++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_constructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

◆ increment_destructor_count() [1/2]

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectednoexceptinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 207 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.second++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_destructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::~ReferenceCountedObject().

◆ increment_destructor_count() [2/2]

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectednoexceptinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 207 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.second++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_destructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::~ReferenceCountedObject().

◆ init() [1/6]

void libMesh::StaticCondensation::init ( )

Size the element matrices.

Definition at line 120 of file static_condensation.C.

{
  if (this->initialized())
    return;
 
  libmesh_assert(_reduced_dof_map.initialized());
 
  // This API is public, so it can be called without going through the other init overloads which
  // would give us an indication of what kind of parallel type the user wants. If we've gotten no
  // indication so far, we will default to parallel
  if (_parallel_type == INVALID_PARALLELIZATION)
    _parallel_type = PARALLEL;
  libmesh_assert(_parallel_type != SERIAL);
 
  for (const auto & [elem_id, dof_data] : _reduced_dof_map._elem_to_dof_data)
    {
      auto & matrix_data = _elem_to_matrix_data[elem_id];
 
      const auto condensed_dof_size = dof_data.condensed_global_to_local_map.size();
      const auto uncondensed_dof_size = dof_data.uncondensed_global_to_local_map.size();
 
      matrix_data.Acc.setZero(condensed_dof_size, condensed_dof_size);
      matrix_data.Acu.setZero(condensed_dof_size, uncondensed_dof_size);
      matrix_data.Auc.setZero(uncondensed_dof_size, condensed_dof_size);
      matrix_data.Auu.setZero(uncondensed_dof_size, uncondensed_dof_size);
    }
 
  //
  // Build the reduced system data
  //
  const auto n = _reduced_dof_map.n_dofs();
  const auto n_local =
      (_parallel_type == SERIAL) ? _reduced_dof_map.n_dofs() : _reduced_dof_map.n_local_dofs();
  _reduced_solver = LinearSolver<Number>::build(this->comm());
  _reduced_solver->init((_system.name() + "_condensed_").c_str());
  _reduced_rhs = NumericVector<Number>::build(this->comm());
  // Init the RHS vector so we can conveniently get processor row offsets
  _reduced_rhs->init(n, n_local);
 
  // Initialize the reduced system matrix
  _sp = _reduced_dof_map._reduced_sp.get();
  _reduced_sys_mat = SparseMatrix<Number>::build(this->comm());
  if (auto * const petsc_mat = dynamic_cast<PetscMatrix<Number> *>(_reduced_sys_mat.get()))
    {
      // Optimization for PETSc. This is critical for problems in which there are SCALAR dofs that
      // introduce dense rows to avoid allocating a dense matrix
      petsc_mat->init(
          n, n, n_local, n_local, _reduced_dof_map._reduced_nnz, _reduced_dof_map._reduced_noz);
    }
  else
    {
      const auto & nnz = _sp->get_n_nz();
      const auto & noz = _sp->get_n_oz();
      const auto nz = nnz.empty() ? dof_id_type(0) : *std::max_element(nnz.begin(), nnz.end());
      const auto oz = noz.empty() ? dof_id_type(0) : *std::max_element(noz.begin(), noz.end());
      _reduced_sys_mat->init(n, n, n_local, n_local, nz, oz);
    }
 
  // Build ghosted full solution vector. Note that this is, in general, *not equal* to the system
  // solution, e.g. this may correspond to the solution for the Newton *update*
  _ghosted_full_sol = _system.current_local_solution->clone();
 
  _sc_is_initialized = true;
}

References libMesh::StaticCondensationDofMap::_elem_to_dof_data, _elem_to_matrix_data, _ghosted_full_sol, _parallel_type, _reduced_dof_map, libMesh::StaticCondensationDofMap::_reduced_nnz, libMesh::StaticCondensationDofMap::_reduced_noz, _reduced_rhs, _reduced_solver, libMesh::StaticCondensationDofMap::_reduced_sp, _reduced_sys_mat, _sc_is_initialized, libMesh::SparseMatrix< Number >::_sp, _system, libMesh::LinearSolver< T >::build(), libMesh::SparseMatrix< T >::build(), libMesh::NumericVector< T >::build(), libMesh::ParallelObject::comm(), libMesh::System::current_local_solution, libMesh::SparsityPattern::Build::get_n_nz(), libMesh::SparsityPattern::Build::get_n_oz(), libMesh::StaticCondensationDofMap::initialized(), initialized(), libMesh::INVALID_PARALLELIZATION, libMesh::libmesh_assert(), n(), libMesh::DofMapBase::n_dofs(), libMesh::DofMapBase::n_local_dofs(), libMesh::System::name(), libMesh::PARALLEL, and libMesh::SERIAL.

Referenced by init(), and init().

◆ init() [2/6]

void libMesh::StaticCondensation::init ( )

inline

Definition at line 408 of file static_condensation.h.

408{ libmesh_not_implemented(); }

◆ init() [3/6]

void libMesh::StaticCondensation::init	(	const numeric_index_type	m,
		const numeric_index_type	n,
		const numeric_index_type	m_l,
		const numeric_index_type	n_l,
		const numeric_index_type	= `30`,
		const numeric_index_type	= `10`,
		const numeric_index_type	blocksize = `1`
	)

overridevirtual

Initialize SparseMatrix with the specified sizes.

Parameters

m	The global number of rows.
n	The global number of columns.
m_l	The local number of rows.
n_l	The local number of columns.
nnz	The number of on-diagonal nonzeros per row (defaults to 30).
noz	The number of off-diagonal nonzeros per row (defaults to 10).
blocksize	Optional value indicating dense coupled blocks for systems with multiple variables all of the same type.

Reimplemented from libMesh::PetscMatrixShellMatrix< Number >.

Definition at line 89 of file static_condensation.C.

{
  if (!this->initialized())
    {
      PetscMatrixShellMatrix<Number>::init(m, n, m_l, n_l, nnz, noz, blocksize);
      _parallel_type = ((m == m_l) && (this->n_processors() > 1)) ? SERIAL : PARALLEL;
      this->init();
    }
}

References _parallel_type, init(), libMesh::PetscMatrixShellMatrix< T >::init(), initialized(), m(), n(), libMesh::ParallelObject::n_processors(), libMesh::PARALLEL, and libMesh::SERIAL.

Referenced by libMesh::StaticCondensationPreconditioner::init().

◆ init() [4/6]

virtual void libMesh::StaticCondensation::init	(	const numeric_index_type	m,
		const numeric_index_type	n,
		const numeric_index_type	m_l,
		const numeric_index_type	n_l,
		const numeric_index_type	= `30`,
		const numeric_index_type	= `10`,
		const numeric_index_type	blocksize = `1`
	)

inlineoverridevirtual

Initialize SparseMatrix with the specified sizes.

Parameters

m	The global number of rows.
n	The global number of columns.
m_l	The local number of rows.
n_l	The local number of columns.
nnz	The number of on-diagonal nonzeros per row (defaults to 30).
noz	The number of off-diagonal nonzeros per row (defaults to 10).
blocksize	Optional value indicating dense coupled blocks for systems with multiple variables all of the same type.

Reimplemented from libMesh::PetscMatrixShellMatrix< Number >.

Definition at line 338 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ init() [5/6]

void libMesh::StaticCondensation::init ( const ParallelType )

overridevirtual

Initialize this matrix using the sparsity structure computed by dof_map.

Parameters

type	The serial/parallel/ghosted type of the matrix

Reimplemented from libMesh::PetscMatrixShellMatrix< Number >.

Definition at line 105 of file static_condensation.C.

{
  if (!this->initialized())
    {
      PetscMatrixShellMatrix<Number>::init(type);
      _parallel_type = type;
      this->init();
    }
}

References _parallel_type, init(), libMesh::PetscMatrixShellMatrix< T >::init(), and initialized().

◆ init() [6/6]

virtual void libMesh::StaticCondensation::init ( ParallelType )

inlineoverridevirtual

Initialize this matrix using the sparsity structure computed by dof_map.

Parameters

type	The serial/parallel/ghosted type of the matrix

Reimplemented from libMesh::PetscMatrixShellMatrix< Number >.

Definition at line 348 of file static_condensation.h.

348{ libmesh_not_implemented(); }

◆ initialized()

bool libMesh::StaticCondensation::initialized ( ) const

overridevirtual

Returns: true if the matrix has been initialized, false otherwise.

Reimplemented from libMesh::SparseMatrix< T >.

Definition at line 115 of file static_condensation.C.

{
  return PetscMatrixShellMatrix<Number>::initialized() && _sc_is_initialized;
}

References _sc_is_initialized, and libMesh::SparseMatrix< T >::initialized().

Referenced by init(), init(), init(), and libMesh::StaticCondensationPreconditioner::initialized().

◆ l1_norm() [1/2]

Real libMesh::StaticCondensation::l1_norm ( ) const

overridevirtual

Returns: The \( \ell_1 \)-norm of the matrix, that is the max column sum: \( |M|_1 = \max_{j} \sum_{i} |M_{ij}| \)

This is the natural matrix norm that is compatible with the \( \ell_1 \)-norm for vectors, i.e. \( |Mv|_1 \leq |M|_1 |v|_1 \). (cf. Haemmerlin-Hoffmann : Numerische Mathematik)

Implements libMesh::SparseMatrix< T >.

Definition at line 355 of file static_condensation.C.

355{ libmesh_not_implemented(); }

◆ l1_norm() [2/2]

virtual Real libMesh::StaticCondensation::l1_norm ( ) const

inlineoverridevirtual

Returns: The \( \ell_1 \)-norm of the matrix, that is the max column sum: \( |M|_1 = \max_{j} \sum_{i} |M_{ij}| \)

This is the natural matrix norm that is compatible with the \( \ell_1 \)-norm for vectors, i.e. \( |Mv|_1 \leq |M|_1 |v|_1 \). (cf. Haemmerlin-Hoffmann : Numerische Mathematik)

Implements libMesh::SparseMatrix< T >.

Definition at line 393 of file static_condensation.h.

393{ libmesh_not_implemented(); }

◆ l1_norm_diff() [1/2]

Real libMesh::SparseMatrix< Number >::l1_norm_diff ( const SparseMatrix< Number > & other_mat ) const

inherited

Returns: The l1_norm() of the difference of this and other_mat

Definition at line 396 of file sparse_matrix.C.

{
  auto diff_mat = this->clone();
  diff_mat->add(-1.0, other_mat);
  return diff_mat->l1_norm();
}

◆ l1_norm_diff() [2/2]

template<typename T >

Real libMesh::SparseMatrix< T >::l1_norm_diff ( const SparseMatrix< T > & other_mat ) const

inherited

Returns: The l1_norm() of the difference of this and other_mat

Definition at line 1362 of file sparse_matrix.C.

{
  auto diff_mat = this->clone();
  diff_mat->add(-1.0, other_mat);
  return diff_mat->l1_norm();
}

Referenced by libMesh::l1_norm_diff().

◆ linfty_norm() [1/2]

Real libMesh::StaticCondensation::linfty_norm ( ) const

overridevirtual

Returns: The \( \ell_{\infty} \)-norm of the matrix, that is the max row sum:

\( |M|_{\infty} = \max_{i} \sum_{j} |M_{ij}| \)

This is the natural matrix norm that is compatible to the \( \ell_{\infty} \)-norm of vectors, i.e. \( |Mv|_{\infty} \leq |M|_{\infty} |v|_{\infty} \). (cf. Haemmerlin-Hoffmann : Numerische Mathematik)

Implements libMesh::SparseMatrix< T >.

Definition at line 357 of file static_condensation.C.

357{ libmesh_not_implemented(); }

◆ linfty_norm() [2/2]

virtual Real libMesh::StaticCondensation::linfty_norm ( ) const

inlineoverridevirtual

Returns: The \( \ell_{\infty} \)-norm of the matrix, that is the max row sum:

\( |M|_{\infty} = \max_{i} \sum_{j} |M_{ij}| \)

This is the natural matrix norm that is compatible to the \( \ell_{\infty} \)-norm of vectors, i.e. \( |Mv|_{\infty} \leq |M|_{\infty} |v|_{\infty} \). (cf. Haemmerlin-Hoffmann : Numerische Mathematik)

Implements libMesh::SparseMatrix< T >.

Definition at line 394 of file static_condensation.h.

394{ libmesh_not_implemented(); }

◆ local_m() [1/2]

virtual numeric_index_type libMesh::SparseMatrix< Number >::local_m ( ) const

inlinevirtualinherited

Get the number of rows owned by this process.

Definition at line 254 of file sparse_matrix.h.

254{ return row_stop() - row_start(); }

libMesh::SparseMatrix< Number >::row_stop

virtual numeric_index_type row_stop() const=0

libMesh::SparseMatrix< Number >::row_start

virtual numeric_index_type row_start() const=0

◆ local_m() [2/2]

template<typename T >

numeric_index_type libMesh::PetscMatrixBase< T >::local_m ( ) const

finalvirtualinherited

Get the number of rows owned by this process.

Reimplemented from libMesh::SparseMatrix< T >.

Definition at line 142 of file petsc_matrix_base.C.

{
  libmesh_assert (this->initialized());
 
  PetscInt m = 0;
 
  LibmeshPetscCall(MatGetLocalSize (this->_mat, &m, NULL));
 
  return static_cast<numeric_index_type>(m);
}

References libMesh::initialized(), and libMesh::libmesh_assert().

◆ local_n() [1/2]

virtual numeric_index_type libMesh::SparseMatrix< Number >::local_n ( ) const

inlinevirtualinherited

Get the number of columns owned by this process.

Definition at line 259 of file sparse_matrix.h.

259{ return col_stop() - col_start(); }

libMesh::SparseMatrix< Number >::col_stop

virtual numeric_index_type col_stop() const=0

libMesh::SparseMatrix< Number >::col_start

virtual numeric_index_type col_start() const=0

◆ local_n() [2/2]

template<typename T >

numeric_index_type libMesh::PetscMatrixBase< T >::local_n ( ) const

finalvirtualinherited

Get the number of columns owned by this process.

Reimplemented from libMesh::SparseMatrix< T >.

Definition at line 166 of file petsc_matrix_base.C.

{
  libmesh_assert (this->initialized());
 
  PetscInt n = 0;
 
  LibmeshPetscCall(MatGetLocalSize (this->_mat, NULL, &n));
 
  return static_cast<numeric_index_type>(n);
}

◆ m() [1/2]

numeric_index_type libMesh::StaticCondensation::m ( ) const

overridevirtual

Returns: The row-dimension of the matrix.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 249 of file static_condensation.C.

249{ return _full_dof_map.n_dofs(); }

libMesh::DofMap::n_dofs

dof_id_type n_dofs(const unsigned int vn) const

Definition dof_map.h:776

References _full_dof_map, and libMesh::DofMap::n_dofs().

Referenced by init(), and n().

◆ m() [2/2]

virtual numeric_index_type libMesh::StaticCondensation::m ( ) const

inlineoverridevirtual

Returns: The row-dimension of the matrix.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 360 of file static_condensation.h.

360{ libmesh_not_implemented(); }

◆ mat() [1/2]

template<typename T >

Mat libMesh::PetscMatrixBase< T >::mat ( )

inlineinherited

Returns: The raw PETSc matrix pointer.

Note: This is generally not required in user-level code.; Don't do anything crazy like calling MatDestroy() on it, or very bad things will likely happen!

Definition at line 120 of file petsc_matrix_base.h.

120{ libmesh_assert (_mat); return _mat; }

References libMesh::PetscMatrixBase< T >::_mat, and libMesh::libmesh_assert().

Referenced by libMesh::__libmesh_petsc_diff_solver_jacobian(), libMesh::PetscLinearSolver< Number >::_petsc_shell_matrix_get_diagonal(), add_matrix(), libMesh::PetscLinearSolver< T >::init(), libMesh::libmesh_petsc_DMCreateInterpolation(), libMesh::libmesh_petsc_DMCreateRestriction(), libMesh::PetscPreconditioner< T >::set_hypre_ads_data(), libMesh::PetscPreconditioner< T >::set_hypre_ams_data(), libMesh::PetscDiffSolver::solve(), libMesh::TaoOptimizationSolver< T >::solve(), and libMesh::PetscNonlinearSolver< T >::solve().

◆ mat() [2/2]

template<typename T >

Mat libMesh::PetscMatrixBase< T >::mat ( ) const

inlineinherited

Definition at line 121 of file petsc_matrix_base.h.

121{ libmesh_assert(_mat); return _mat; }

References libMesh::PetscMatrixBase< T >::_mat, and libMesh::libmesh_assert().

◆ matrix_matrix_mult() [1/2]

virtual void libMesh::SparseMatrix< Number >::matrix_matrix_mult	(	SparseMatrix< Number > &	,
		SparseMatrix< Number > &	,
		bool
	)

inlinevirtualinherited

Compute Y = A*X for matrix X.

Definition at line 349 of file sparse_matrix.h.

350 { libmesh_not_implemented(); }

◆ matrix_matrix_mult() [2/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::matrix_matrix_mult	(	SparseMatrix< T > &	,
		SparseMatrix< T > &	,
		bool
	)

inlinevirtualinherited

Compute Y = A*X for matrix X.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 349 of file sparse_matrix.h.

350 { libmesh_not_implemented(); }

◆ n() [1/2]

virtual numeric_index_type libMesh::StaticCondensation::n ( ) const

inlineoverridevirtual

Returns: The column-dimension of the matrix.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 107 of file static_condensation.h.

107{ return this->m(); }

References m().

Referenced by init(), and init().

◆ n() [2/2]

virtual numeric_index_type libMesh::StaticCondensation::n ( ) const

inlineoverridevirtual

Returns: The column-dimension of the matrix.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 361 of file static_condensation.h.

361{ libmesh_not_implemented(); }

◆ n_nonzeros() [1/2]

std::size_t libMesh::SparseMatrix< Number >::n_nonzeros ( ) const

virtualinherited

Returns: the global number of non-zero entries in the matrix sparsity pattern

Definition at line 407 of file sparse_matrix.C.

{
  if (!_sp)
    return 0;
  return _sp->n_nonzeros();
}

◆ n_nonzeros() [2/2]

template<typename T >

std::size_t libMesh::SparseMatrix< T >::n_nonzeros ( ) const

virtualinherited

Returns: the global number of non-zero entries in the matrix sparsity pattern

Definition at line 266 of file sparse_matrix.C.

{
  if (!_sp)
    return 0;
  return _sp->n_nonzeros();
}

◆ n_objects() [1/2]

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 85 of file reference_counter.h.

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition reference_counter.h:132

References libMesh::ReferenceCounter::_n_objects.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ n_objects() [2/2]

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 85 of file reference_counter.h.

86 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ n_processors() [1/2]

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 103 of file parallel_object.h.

  {
    processor_id_type returnval =
      cast_int<processor_id_type>(_communicator.size());
    libmesh_assert(returnval); // We never have an empty comm
    return returnval;
  }

References libMesh::ParallelObject::_communicator, libMesh::libmesh_assert(), and libMesh::Parallel::Communicator::size().

◆ n_processors() [2/2]

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 103 of file parallel_object.h.

  {
    processor_id_type returnval =
      cast_int<processor_id_type>(_communicator.size());
    libmesh_assert(returnval); // We never have an empty comm
    return returnval;
  }

References libMesh::ParallelObject::_communicator, libMesh::libmesh_assert(), and libMesh::Parallel::Communicator::size().

◆ need_full_sparsity_pattern() [1/2]

template<typename T >

virtual bool libMesh::SparseMatrix< T >::need_full_sparsity_pattern ( ) const

inlinevirtualinherited

Returns: true if this sparse matrix format needs to be fed the graph of the sparse matrix.

This is true for LaspackMatrix, but not PetscMatrixBase subclasses. In the case where the full graph is not required, we can efficiently approximate it to provide a good estimate of the required size of the sparse matrix.

Reimplemented in libMesh::LaspackMatrix< T >, and libMesh::EpetraMatrix< T >.

Definition at line 162 of file sparse_matrix.h.

163 { return false; }

Referenced by libMesh::DofMap::attach_matrix(), and libMesh::DofMap::update_sparsity_pattern().

◆ need_full_sparsity_pattern() [2/2]

virtual bool libMesh::SparseMatrix< Number >::need_full_sparsity_pattern ( ) const

inlinevirtualinherited

Returns: true if this sparse matrix format needs to be fed the graph of the sparse matrix.

This is true for LaspackMatrix, but not PetscMatrixBase subclasses. In the case where the full graph is not required, we can efficiently approximate it to provide a good estimate of the required size of the sparse matrix.

Definition at line 162 of file sparse_matrix.h.

163 { return false; }

◆ operator()() [1/2]

Number libMesh::StaticCondensation::operator()	(	const numeric_index_type	i,
		const numeric_index_type	j
	)		const

overridevirtual

Returns: A copy of matrix entry (i,j).

Note: This may be an expensive operation, and you should always be careful where you call this function.

Implements libMesh::SparseMatrix< T >.

Definition at line 350 of file static_condensation.C.

{
  libmesh_not_implemented();
}

◆ operator()() [2/2]

virtual Number libMesh::StaticCondensation::operator()	(	const numeric_index_type	i,
		const numeric_index_type	j
	)		const

inlineoverridevirtual

Returns: A copy of matrix entry (i,j).

Note: This may be an expensive operation, and you should always be careful where you call this function.

Implements libMesh::SparseMatrix< T >.

Definition at line 389 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ operator=() [1/2]

SparseMatrix< Number > & libMesh::StaticCondensation::operator= ( const SparseMatrix< Number > & )

overridevirtual

This looks like a copy assignment operator, but note that, unlike normal copy assignment operators, it is pure virtual.

This function should be overridden in derived classes so that they can be copied correctly via references to the base class. This design usually isn't a good idea in general, but in this context it works because we usually don't have a mix of different kinds of SparseMatrix active in the library at a single time.

Returns: A reference to *this as the base type.

Reimplemented from libMesh::SparseMatrix< Number >.

Definition at line 60 of file static_condensation.C.

{
  libmesh_not_implemented();
}

◆ operator=() [2/2]

virtual SparseMatrix< Number > & libMesh::StaticCondensation::operator= ( const SparseMatrix< Number > & )

inlineoverridevirtual

This looks like a copy assignment operator, but note that, unlike normal copy assignment operators, it is pure virtual.

This function should be overridden in derived classes so that they can be copied correctly via references to the base class. This design usually isn't a good idea in general, but in this context it works because we usually don't have a mix of different kinds of SparseMatrix active in the library at a single time.

Returns: A reference to *this as the base type.

Reimplemented from libMesh::PetscMatrixShellMatrix< Number >.

Definition at line 333 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ print() [1/5]

template<typename T >

void libMesh::SparseMatrix< T >::print ( const std::string & filename ) const

inherited

Print the contents of the matrix to a file, with a file format depending on the extension of filename.

Definition at line 754 of file sparse_matrix.C.

{
  {
    std::ofstream outstr (filename.c_str());
    libmesh_error_msg_if
      (!outstr.good(), "ERROR: cannot write to file:\n\t" <<
       filename);
  }
 
  std::string_view basename = Utility::basename_of(filename);
 
  const bool gzipped_file = Utility::ends_with(filename, ".gz");
 
  if (gzipped_file)
    basename.remove_suffix(3);
 
  if (Utility::ends_with(basename, ".matlab") ||
      Utility::ends_with(basename, ".m"))
    this->print_matlab(filename);
  else if (Utility::ends_with(basename, ".petsc64"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 8
      libmesh_error_msg("Cannot load 64-bit PETSc matrix file " <<
                        filename << " with non-64-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->print_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".petsc32"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 4
      libmesh_error_msg("Cannot load 32-bit PETSc matrix file " <<
                        filename << " with non-32-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->print_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".h5"))
    {
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped HDF5 matrices are not currently supported");
      this->print_coreform_hdf5(filename);
    }
  else
    libmesh_error_msg(" ERROR: Unrecognized matrix file extension on: "
                      << basename
                      << "\n   I understand the following:\n\n"
                      << "     *.h5        -- CoreForm HDF5 sparse matrix format\n"
                      << "     *.matlab    -- Matlab sparse matrix format\n"
                      << "     *.matlab.gz -- Matlab sparse matrix format, gzipped\n"
                      << "     *.m         -- Matlab sparse matrix format\n"
                      << "     *.m.gz      -- Matlab sparse matrix format, gzipped\n"
                      << "     *.petsc32   -- PETSc binary format, 32-bit\n"
                      << "     *.petsc64   -- PETSc binary format, 64-bit\n"
                     );
}

References libMesh::Utility::basename_of(), and libMesh::Utility::ends_with().

◆ print() [2/5]

void libMesh::SparseMatrix< Number >::print ( const std::string & filename ) const

inherited

Print the contents of the matrix to a file, with a file format depending on the extension of filename.

Definition at line 454 of file sparse_matrix.C.

{
  {
    std::ofstream outstr (filename.c_str());
    libmesh_error_msg_if
      (!outstr.good(), "ERROR: cannot write to file:\n\t" <<
       filename);
  }
 
  std::string_view basename = Utility::basename_of(filename);
 
  const bool gzipped_file = Utility::ends_with(filename, ".gz");
 
  if (gzipped_file)
    basename.remove_suffix(3);
 
  if (Utility::ends_with(basename, ".matlab") ||
      Utility::ends_with(basename, ".m"))
    this->print_matlab(filename);
  else if (Utility::ends_with(basename, ".petsc64"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 8
      libmesh_error_msg("Cannot load 64-bit PETSc matrix file " <<
                        filename << " with non-64-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->print_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".petsc32"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 4
      libmesh_error_msg("Cannot load 32-bit PETSc matrix file " <<
                        filename << " with non-32-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->print_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".h5"))
    {
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped HDF5 matrices are not currently supported");
      this->print_coreform_hdf5(filename);
    }
  else
    libmesh_error_msg(" ERROR: Unrecognized matrix file extension on: "
                      << basename
                      << "\n   I understand the following:\n\n"
                      << "     *.h5        -- CoreForm HDF5 sparse matrix format\n"
                      << "     *.matlab    -- Matlab sparse matrix format\n"
                      << "     *.matlab.gz -- Matlab sparse matrix format, gzipped\n"
                      << "     *.m         -- Matlab sparse matrix format\n"
                      << "     *.m.gz      -- Matlab sparse matrix format, gzipped\n"
                      << "     *.petsc32   -- PETSc binary format, 32-bit\n"
                      << "     *.petsc64   -- PETSc binary format, 64-bit\n"
                     );
}

◆ print() [3/5]

void libMesh::SparseMatrix< Complex >::print	(	std::ostream &	os,
		const bool	sparse
	)		const

inherited

Definition at line 159 of file sparse_matrix.C.

{
  // std::complex<>::operator<<() is defined, but use this form
 
  if (sparse)
    {
      libmesh_not_implemented();
    }
 
  os << "Real part:" << std::endl;
  for (auto i : make_range(this->m()))
    {
      for (auto j : make_range(this->n()))
        os << std::setw(8) << (*this)(i,j).real() << " ";
      os << std::endl;
    }
 
  os << std::endl << "Imaginary part:" << std::endl;
  for (auto i : make_range(this->m()))
    {
      for (auto j : make_range(this->n()))
        os << std::setw(8) << (*this)(i,j).imag() << " ";
      os << std::endl;
    }
}

References libMesh::make_range().

◆ print() [4/5]

template<typename T >

void libMesh::SparseMatrix< T >::print	(	std::ostream &	os = `libMesh::out`,
		const bool	sparse = `false`
	)		const

inherited

Print the contents of the matrix to the screen in a uniform style, regardless of matrix/solver package being used.

Definition at line 275 of file sparse_matrix.C.

{
  parallel_object_only();
 
  libmesh_assert (this->initialized());
 
  const numeric_index_type first_dof = this->row_start(),
                           end_dof   = this->row_stop();
 
  // We'll print the matrix from processor 0 to make sure
  // it's serialized properly
  if (this->processor_id() == 0)
    {
      libmesh_assert_equal_to (first_dof, 0);
      for (numeric_index_type i : make_range(end_dof))
        {
          if (sparse)
            {
              for (auto j : make_range(this->n()))
                {
                  T c = (*this)(i,j);
                  if (c != static_cast<T>(0.0))
                    {
                      os << i << " " << j << " " << c << std::endl;
                    }
                }
            }
          else
            {
              for (auto j : make_range(this->n()))
                os << (*this)(i,j) << " ";
              os << std::endl;
            }
        }
 
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
      numeric_index_type currenti = end_dof;
      for (auto p : IntRange<processor_id_type>(1, this->n_processors()))
        {
          this->comm().receive(p, ibuf);
          this->comm().receive(p, jbuf);
          this->comm().receive(p, cbuf);
          libmesh_assert_equal_to (ibuf.size(), jbuf.size());
          libmesh_assert_equal_to (ibuf.size(), cbuf.size());
 
          if (ibuf.empty())
            continue;
          libmesh_assert_greater_equal (ibuf.front(), currenti);
          libmesh_assert_greater_equal (ibuf.back(), ibuf.front());
 
          std::size_t currentb = 0;
          for (;currenti <= ibuf.back(); ++currenti)
            {
              if (sparse)
                {
                  for (numeric_index_type j=0; j<this->n(); j++)
                    {
                      if (currentb < ibuf.size() &&
                          ibuf[currentb] == currenti &&
                          jbuf[currentb] == j)
                        {
                          os << currenti << " " << j << " " << cbuf[currentb] << std::endl;
                          currentb++;
                        }
                    }
                }
              else
                {
                  for (auto j : make_range(this->n()))
                    {
                      if (currentb < ibuf.size() &&
                          ibuf[currentb] == currenti &&
                          jbuf[currentb] == j)
                        {
                          os << cbuf[currentb] << " ";
                          currentb++;
                        }
                      else
                        os << static_cast<T>(0.0) << " ";
                    }
                  os << std::endl;
                }
            }
        }
      if (!sparse)
        {
          for (; currenti != this->m(); ++currenti)
            {
              for (numeric_index_type j=0; j<this->n(); j++)
                os << static_cast<T>(0.0) << " ";
              os << std::endl;
            }
        }
    }
  else
    {
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
 
      // We'll assume each processor has access to entire
      // matrix rows, so (*this)(i,j) is valid if i is a local index.
      for (numeric_index_type i : make_range(first_dof, end_dof))
        {
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                {
                  ibuf.push_back(i);
                  jbuf.push_back(j);
                  cbuf.push_back(c);
                }
            }
        }
      this->comm().send(0,ibuf);
      this->comm().send(0,jbuf);
      this->comm().send(0,cbuf);
    }
}

References libMesh::initialized(), libMesh::libmesh_assert(), and libMesh::make_range().

Referenced by libMesh::EigenSparseMatrix< T >::print_personal(), and libMesh::LaspackMatrix< T >::print_personal().

◆ print() [5/5]

void libMesh::SparseMatrix< Number >::print	(	std::ostream &	os = `libMesh::out`,
		const bool	sparse = `false`
	)		const

inherited

Print the contents of the matrix to the screen in a uniform style, regardless of matrix/solver package being used.

Definition at line 413 of file sparse_matrix.C.

{
  parallel_object_only();
 
  libmesh_assert (this->initialized());
 
  const numeric_index_type first_dof = this->row_start(),
                           end_dof   = this->row_stop();
 
  // We'll print the matrix from processor 0 to make sure
  // it's serialized properly
  if (this->processor_id() == 0)
    {
      libmesh_assert_equal_to (first_dof, 0);
      for (numeric_index_type i : make_range(end_dof))
        {
          if (sparse)
            {
              for (auto j : make_range(this->n()))
                {
                  T c = (*this)(i,j);
                  if (c != static_cast<T>(0.0))
                    {
                      os << i << " " << j << " " << c << std::endl;
                    }
                }
            }
          else
            {
              for (auto j : make_range(this->n()))
                os << (*this)(i,j) << " ";
              os << std::endl;
            }
        }
 
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
      numeric_index_type currenti = end_dof;
      for (auto p : IntRange<processor_id_type>(1, this->n_processors()))
        {
          this->comm().receive(p, ibuf);
          this->comm().receive(p, jbuf);
          this->comm().receive(p, cbuf);
          libmesh_assert_equal_to (ibuf.size(), jbuf.size());
          libmesh_assert_equal_to (ibuf.size(), cbuf.size());
 
          if (ibuf.empty())
            continue;
          libmesh_assert_greater_equal (ibuf.front(), currenti);
          libmesh_assert_greater_equal (ibuf.back(), ibuf.front());
 
          std::size_t currentb = 0;
          for (;currenti <= ibuf.back(); ++currenti)
            {
              if (sparse)
                {
                  for (numeric_index_type j=0; j<this->n(); j++)
                    {
                      if (currentb < ibuf.size() &&
                          ibuf[currentb] == currenti &&
                          jbuf[currentb] == j)
                        {
                          os << currenti << " " << j << " " << cbuf[currentb] << std::endl;
                          currentb++;
                        }
                    }
                }
              else
                {
                  for (auto j : make_range(this->n()))
                    {
                      if (currentb < ibuf.size() &&
                          ibuf[currentb] == currenti &&
                          jbuf[currentb] == j)
                        {
                          os << cbuf[currentb] << " ";
                          currentb++;
                        }
                      else
                        os << static_cast<T>(0.0) << " ";
                    }
                  os << std::endl;
                }
            }
        }
      if (!sparse)
        {
          for (; currenti != this->m(); ++currenti)
            {
              for (numeric_index_type j=0; j<this->n(); j++)
                os << static_cast<T>(0.0) << " ";
              os << std::endl;
            }
        }
    }
  else
    {
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
 
      // We'll assume each processor has access to entire
      // matrix rows, so (*this)(i,j) is valid if i is a local index.
      for (numeric_index_type i : make_range(first_dof, end_dof))
        {
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                {
                  ibuf.push_back(i);
                  jbuf.push_back(j);
                  cbuf.push_back(c);
                }
            }
        }
      this->comm().send(0,ibuf);
      this->comm().send(0,jbuf);
      this->comm().send(0,cbuf);
    }
}

◆ print_coreform_hdf5() [1/2]

template<typename T >

void libMesh::SparseMatrix< T >::print_coreform_hdf5	(	const std::string &	filename,
		const std::string &	groupname = `"extraction"`
	)		const

virtualinherited

Print the contents of the matrix to a file, with the HDF5 sparse matrix format used by CoreForm, putting CSR sparse matrix data in the group given by groupname.

Definition at line 521 of file sparse_matrix.C.

{
#if defined(LIBMESH_USE_COMPLEX_NUMBERS) || !defined(LIBMESH_HAVE_HDF5)
  // TODO: HDF5 version 2.0.0 and later adds native support for
  // complex numbers with the H5T_NATIVE_DOUBLE_COMPLEX type [0], so
  // we could consider supporting T==std::complex<Real> in the future.
  // [0]: https://forum.hdfgroup.org/t/coming-in-the-next-hdf5-release-native-support-for-complex-number-datatypes/13543
  libmesh_ignore(filename, groupname);
  libmesh_error_msg("ERROR: need HDF5 support to handle .h5 files!!!");
#else
  LOG_SCOPE("print_coreform_hdf5()", "SparseMatrix");
 
  // In this implementation, we copy the SparseMatrix entries into a
  // std::vector<double>, so this won't work for any Number type for
  // which sizeof(Number) > sizeof(double).
  if constexpr (sizeof(T) > sizeof(double))
    libmesh_not_implemented();
 
  const numeric_index_type first_dof = this->row_start(),
                           end_dof   = this->row_stop();
 
  std::vector<std::size_t> cols, row_offsets;
  std::vector<double> vals;
 
  if (this->processor_id() == 0)
    row_offsets.push_back(0);
 
  for (numeric_index_type i : make_range(first_dof, end_dof))
    {
      for (auto j : make_range(this->n()))
        {
          T c = (*this)(i,j);
          if (c != static_cast<T>(0.0))
            {
              cols.push_back(j);
              vals.push_back(c);
            }
        }
      // This is a *local* row offset; proc 0 may need to adjust later
      row_offsets.push_back(cols.size());
    }
 
  if (this->processor_id() == 0)
    {
      const hid_t file = H5Fcreate(filename.c_str(), H5F_ACC_TRUNC,
                                   H5P_DEFAULT, H5P_DEFAULT);
      if (file == H5I_INVALID_HID)
        libmesh_file_error(filename);
 
      const hid_t group =
        H5Gcreate2(file, groupname.c_str(), H5P_DEFAULT, H5P_DEFAULT,
                   H5P_DEFAULT);
      check_open(filename, group, groupname);
 
      auto write_size_attribute = [&filename, &group]
        (const std::string & attribute_name, unsigned long long writeval)
      {
        const hid_t fspace = H5Screate(H5S_SCALAR);
        check_hdf5(filename, fspace, attribute_name + " fspace");
 
        const hid_t attr = H5Acreate2(group, attribute_name.c_str(),
                                      H5T_STD_I64LE, fspace,
                                      H5P_DEFAULT, H5P_DEFAULT);
        check_hdf5(filename, attr, attribute_name);
 
        // HDF5 is supposed to handle both upscaling and endianness
        // conversions here
        const herr_t errval = H5Awrite(attr, H5T_NATIVE_ULLONG, &writeval);
        check_hdf5(filename, errval, attribute_name + " write");
 
        H5Aclose(attr);
        H5Sclose(fspace);
      };
 
      write_size_attribute("num_cols", this->n());
      write_size_attribute("num_rows", this->m());
 
      auto write_vector = [&filename, &group]
        (const std::string & dataname, auto hdf5_file_type,
         auto hdf5_native_type, auto & datavec)
      {
        const hsize_t len[1] = {cast_int<hsize_t>(datavec.size())};
 
        const hid_t space = H5Screate_simple(1, len, nullptr);
        check_hdf5(filename, space, dataname + " space");
 
        const hid_t data =
          H5Dcreate2(group, dataname.c_str(), hdf5_file_type, space,
                     H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);
        check_hdf5(filename, data, dataname + " data");
 
        const hid_t errval =
          H5Dwrite(data, hdf5_native_type, H5S_ALL, H5S_ALL,
                   H5P_DEFAULT, datavec.data());
        check_hdf5(filename, errval, dataname + " write");
 
        H5Dclose(data);
        H5Sclose(space);
      };
 
      std::vector<std::size_t> vals_sizes, first_dofs;
      this->comm().gather(0, vals.size(), vals_sizes);
      this->comm().gather(0, cast_int<std::size_t>(first_dof), first_dofs);
      first_dofs.push_back(this->m());
 
      this->comm().allgather(cols);
      this->comm().allgather(vals);
      this->comm().allgather(row_offsets);
 
      libmesh_assert_equal_to(vals.size(),
                              cols.size());
      libmesh_assert_equal_to(vals.size(),
                              std::accumulate(vals_sizes.begin(),
                                              vals_sizes.end(),
                                              std::size_t(0)));
 
      std::size_t extra_offset = 0;
      for (auto p : make_range(processor_id_type(1), this->n_processors()))
        {
          extra_offset += vals_sizes[p-1];
          for (auto i : make_range(first_dofs[p]+1, first_dofs[p+1]+1))
            row_offsets[i] += extra_offset;
        }
 
      write_vector("cols", H5T_STD_U64LE, H5T_NATIVE_ULLONG, cols);
      write_vector("row_offsets", H5T_STD_U64LE, H5T_NATIVE_ULLONG, row_offsets);
      write_vector("vals", H5T_IEEE_F64LE, H5T_NATIVE_DOUBLE, vals);
 
      H5Gclose(group);
      H5Fclose(file);
    }
  else
    {
      std::vector<std::size_t> dummy;
      this->comm().gather(0, vals.size(), dummy);
      this->comm().gather(0, cast_int<std::size_t>(first_dof), dummy);
      this->comm().allgather(cols);
      this->comm().allgather(vals);
      this->comm().allgather(row_offsets);
    }
#endif // LIBMESH_HAVE_HDF5
}

◆ print_coreform_hdf5() [2/2]

void libMesh::SparseMatrix< Number >::print_coreform_hdf5	(	const std::string &	filename,
		const std::string &	groupname = `"extraction"`
	)		const

virtualinherited

Print the contents of the matrix to a file, with the HDF5 sparse matrix format used by CoreForm, putting CSR sparse matrix data in the group given by groupname.

Definition at line 461 of file sparse_matrix.C.

{
#if defined(LIBMESH_USE_COMPLEX_NUMBERS) || !defined(LIBMESH_HAVE_HDF5)
  // TODO: HDF5 version 2.0.0 and later adds native support for
  // complex numbers with the H5T_NATIVE_DOUBLE_COMPLEX type [0], so
  // we could consider supporting T==std::complex<Real> in the future.
  // [0]: https://forum.hdfgroup.org/t/coming-in-the-next-hdf5-release-native-support-for-complex-number-datatypes/13543
  libmesh_ignore(filename, groupname);
  libmesh_error_msg("ERROR: need HDF5 support to handle .h5 files!!!");
#else
  LOG_SCOPE("print_coreform_hdf5()", "SparseMatrix");
 
  // In this implementation, we copy the SparseMatrix entries into a
  // std::vector<double>, so this won't work for any Number type for
  // which sizeof(Number) > sizeof(double).
  if constexpr (sizeof(T) > sizeof(double))
    libmesh_not_implemented();
 
  const numeric_index_type first_dof = this->row_start(),
                           end_dof   = this->row_stop();
 
  std::vector<std::size_t> cols, row_offsets;
  std::vector<double> vals;
 
  if (this->processor_id() == 0)
    row_offsets.push_back(0);
 
  for (numeric_index_type i : make_range(first_dof, end_dof))
    {
      for (auto j : make_range(this->n()))
        {
          T c = (*this)(i,j);
          if (c != static_cast<T>(0.0))
            {
              cols.push_back(j);
              vals.push_back(c);
            }
        }
      // This is a *local* row offset; proc 0 may need to adjust later
      row_offsets.push_back(cols.size());
    }
 
  if (this->processor_id() == 0)
    {
      const hid_t file = H5Fcreate(filename.c_str(), H5F_ACC_TRUNC,
                                   H5P_DEFAULT, H5P_DEFAULT);
      if (file == H5I_INVALID_HID)
        libmesh_file_error(filename);
 
      const hid_t group =
        H5Gcreate2(file, groupname.c_str(), H5P_DEFAULT, H5P_DEFAULT,
                   H5P_DEFAULT);
      check_open(filename, group, groupname);
 
      auto write_size_attribute = [&filename, &group]
        (const std::string & attribute_name, unsigned long long writeval)
      {
        const hid_t fspace = H5Screate(H5S_SCALAR);
        check_hdf5(filename, fspace, attribute_name + " fspace");
 
        const hid_t attr = H5Acreate2(group, attribute_name.c_str(),
                                      H5T_STD_I64LE, fspace,
                                      H5P_DEFAULT, H5P_DEFAULT);
        check_hdf5(filename, attr, attribute_name);
 
        // HDF5 is supposed to handle both upscaling and endianness
        // conversions here
        const herr_t errval = H5Awrite(attr, H5T_NATIVE_ULLONG, &writeval);
        check_hdf5(filename, errval, attribute_name + " write");
 
        H5Aclose(attr);
        H5Sclose(fspace);
      };
 
      write_size_attribute("num_cols", this->n());
      write_size_attribute("num_rows", this->m());
 
      auto write_vector = [&filename, &group]
        (const std::string & dataname, auto hdf5_file_type,
         auto hdf5_native_type, auto & datavec)
      {
        const hsize_t len[1] = {cast_int<hsize_t>(datavec.size())};
 
        const hid_t space = H5Screate_simple(1, len, nullptr);
        check_hdf5(filename, space, dataname + " space");
 
        const hid_t data =
          H5Dcreate2(group, dataname.c_str(), hdf5_file_type, space,
                     H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);
        check_hdf5(filename, data, dataname + " data");
 
        const hid_t errval =
          H5Dwrite(data, hdf5_native_type, H5S_ALL, H5S_ALL,
                   H5P_DEFAULT, datavec.data());
        check_hdf5(filename, errval, dataname + " write");
 
        H5Dclose(data);
        H5Sclose(space);
      };
 
      std::vector<std::size_t> vals_sizes, first_dofs;
      this->comm().gather(0, vals.size(), vals_sizes);
      this->comm().gather(0, cast_int<std::size_t>(first_dof), first_dofs);
      first_dofs.push_back(this->m());
 
      this->comm().allgather(cols);
      this->comm().allgather(vals);
      this->comm().allgather(row_offsets);
 
      libmesh_assert_equal_to(vals.size(),
                              cols.size());
      libmesh_assert_equal_to(vals.size(),
                              std::accumulate(vals_sizes.begin(),
                                              vals_sizes.end(),
                                              std::size_t(0)));
 
      std::size_t extra_offset = 0;
      for (auto p : make_range(processor_id_type(1), this->n_processors()))
        {
          extra_offset += vals_sizes[p-1];
          for (auto i : make_range(first_dofs[p]+1, first_dofs[p+1]+1))
            row_offsets[i] += extra_offset;
        }
 
      write_vector("cols", H5T_STD_U64LE, H5T_NATIVE_ULLONG, cols);
      write_vector("row_offsets", H5T_STD_U64LE, H5T_NATIVE_ULLONG, row_offsets);
      write_vector("vals", H5T_IEEE_F64LE, H5T_NATIVE_DOUBLE, vals);
 
      H5Gclose(group);
      H5Fclose(file);
    }
  else
    {
      std::vector<std::size_t> dummy;
      this->comm().gather(0, vals.size(), dummy);
      this->comm().gather(0, cast_int<std::size_t>(first_dof), dummy);
      this->comm().allgather(cols);
      this->comm().allgather(vals);
      this->comm().allgather(row_offsets);
    }
#endif // LIBMESH_HAVE_HDF5
}

◆ print_info() [1/2]

void libMesh::ReferenceCounter::print_info ( std::ostream & out_stream = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 81 of file reference_counter.C.

{
  if (_enable_print_counter)
    out_stream << ReferenceCounter::get_info();
}

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ print_info() [2/2]

void libMesh::ReferenceCounter::print_info ( std::ostream & out_stream = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 81 of file reference_counter.C.

{
  if (_enable_print_counter)
    out_stream << ReferenceCounter::get_info();
}

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ print_matlab() [1/2]

void libMesh::SparseMatrix< Number >::print_matlab ( const std::string & name = "" ) const

virtualinherited

Print the contents of the matrix in Matlab's sparse matrix format.

Optionally prints the matrix to the file named name. If name is not specified it is dumped to the screen.

Definition at line 469 of file sparse_matrix.C.

{
  parallel_object_only();
 
  libmesh_assert (this->initialized());
 
  const numeric_index_type first_dof = this->row_start(),
                           end_dof   = this->row_stop();
 
  // We'll print the matrix from processor 0 to make sure
  // it's serialized properly
  if (this->processor_id() == 0)
    {
      std::unique_ptr<std::ofstream> file;
 
      if (name != "")
        file = std::make_unique<std::ofstream>(name.c_str());
 
      std::ostream & os = (name == "") ? libMesh::out : *file;
 
      std::size_t sparsity_nonzeros = this->n_nonzeros();
 
      std::size_t real_nonzeros = 0;
 
      libmesh_assert_equal_to(first_dof, 0);
      for (numeric_index_type i : make_range(end_dof))
        {
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                ++real_nonzeros;
            }
        }
 
 
      for (auto p : IntRange<processor_id_type>(1, this->n_processors()))
        {
          std::size_t nonzeros_on_p = 0;
          this->comm().receive(p, nonzeros_on_p);
          real_nonzeros += nonzeros_on_p;
        }
 
      if (sparsity_nonzeros &&
          sparsity_nonzeros != real_nonzeros)
        libmesh_warning(sparsity_nonzeros <<
                        " nonzeros allocated, but " <<
                        real_nonzeros << " used.");
 
      // We probably want to be more consistent than that, if our
      // sparsity is overallocated.
 
      // Print a header similar to PETSc's mat_view ascii_matlab
      os << "%Mat Object: () " << this->n_processors() << " MPI processes\n"
         << "%  type: " << (this->n_processors() > 1 ? "mpi" : "seq") << "aij\n"
         << "% Size = " << this->m() << ' ' << this->n() << '\n'
         << "% Nonzeros = " << real_nonzeros << '\n'
         << "zzz = zeros(" << real_nonzeros << ",3);\n"
         << "zzz = [\n";
 
      for (numeric_index_type i : make_range(end_dof))
        {
          // FIXME - we need a base class way to iterate over a
          // SparseMatrix row.
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                {
                  // Convert from 0-based to 1-based indexing
                  os << (i+1) << ' ' << (j+1) << "  " << c << '\n';
                }
            }
        }
 
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
      for (auto p : IntRange<processor_id_type>(1, this->n_processors()))
        {
          this->comm().receive(p, ibuf);
          this->comm().receive(p, jbuf);
          this->comm().receive(p, cbuf);
          libmesh_assert_equal_to (ibuf.size(), jbuf.size());
          libmesh_assert_equal_to (ibuf.size(), cbuf.size());
 
          for (auto n : index_range(ibuf))
            os << ibuf[n] << ' ' << jbuf[n] << "  " << cbuf[n] << '\n';
        }
 
      os << "];\n" << "Mat_sparse = spconvert(zzz);" << std::endl;
    }
  else
    {
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
      std::size_t my_nonzeros = 0;
 
      // We'll assume each processor has access to entire
      // matrix rows, so (*this)(i,j) is valid if i is a local index.
      for (numeric_index_type i : make_range(first_dof, end_dof))
        {
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                {
                  ibuf.push_back(i);
                  jbuf.push_back(j);
                  cbuf.push_back(c);
                  ++my_nonzeros;
                }
            }
        }
      this->comm().send(0,my_nonzeros);
      this->comm().send(0,ibuf);
      this->comm().send(0,jbuf);
      this->comm().send(0,cbuf);
    }
}

◆ print_matlab() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::print_matlab ( const std::string & name = "" ) const

virtualinherited

Print the contents of the matrix in Matlab's sparse matrix format.

Optionally prints the matrix to the file named name. If name is not specified it is dumped to the screen.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 398 of file sparse_matrix.C.

{
  parallel_object_only();
 
  libmesh_assert (this->initialized());
 
  const numeric_index_type first_dof = this->row_start(),
                           end_dof   = this->row_stop();
 
  // We'll print the matrix from processor 0 to make sure
  // it's serialized properly
  if (this->processor_id() == 0)
    {
      std::unique_ptr<std::ofstream> file;
 
      if (name != "")
        file = std::make_unique<std::ofstream>(name.c_str());
 
      std::ostream & os = (name == "") ? libMesh::out : *file;
 
      std::size_t sparsity_nonzeros = this->n_nonzeros();
 
      std::size_t real_nonzeros = 0;
 
      libmesh_assert_equal_to(first_dof, 0);
      for (numeric_index_type i : make_range(end_dof))
        {
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                ++real_nonzeros;
            }
        }
 
 
      for (auto p : IntRange<processor_id_type>(1, this->n_processors()))
        {
          std::size_t nonzeros_on_p = 0;
          this->comm().receive(p, nonzeros_on_p);
          real_nonzeros += nonzeros_on_p;
        }
 
      if (sparsity_nonzeros &&
          sparsity_nonzeros != real_nonzeros)
        libmesh_warning(sparsity_nonzeros <<
                        " nonzeros allocated, but " <<
                        real_nonzeros << " used.");
 
      // We probably want to be more consistent than that, if our
      // sparsity is overallocated.
 
      // Print a header similar to PETSc's mat_view ascii_matlab
      os << "%Mat Object: () " << this->n_processors() << " MPI processes\n"
         << "%  type: " << (this->n_processors() > 1 ? "mpi" : "seq") << "aij\n"
         << "% Size = " << this->m() << ' ' << this->n() << '\n'
         << "% Nonzeros = " << real_nonzeros << '\n'
         << "zzz = zeros(" << real_nonzeros << ",3);\n"
         << "zzz = [\n";
 
      for (numeric_index_type i : make_range(end_dof))
        {
          // FIXME - we need a base class way to iterate over a
          // SparseMatrix row.
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                {
                  // Convert from 0-based to 1-based indexing
                  os << (i+1) << ' ' << (j+1) << "  " << c << '\n';
                }
            }
        }
 
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
      for (auto p : IntRange<processor_id_type>(1, this->n_processors()))
        {
          this->comm().receive(p, ibuf);
          this->comm().receive(p, jbuf);
          this->comm().receive(p, cbuf);
          libmesh_assert_equal_to (ibuf.size(), jbuf.size());
          libmesh_assert_equal_to (ibuf.size(), cbuf.size());
 
          for (auto n : index_range(ibuf))
            os << ibuf[n] << ' ' << jbuf[n] << "  " << cbuf[n] << '\n';
        }
 
      os << "];\n" << "Mat_sparse = spconvert(zzz);" << std::endl;
    }
  else
    {
      std::vector<numeric_index_type> ibuf, jbuf;
      std::vector<T> cbuf;
      std::size_t my_nonzeros = 0;
 
      // We'll assume each processor has access to entire
      // matrix rows, so (*this)(i,j) is valid if i is a local index.
      for (numeric_index_type i : make_range(first_dof, end_dof))
        {
          for (auto j : make_range(this->n()))
            {
              T c = (*this)(i,j);
              if (c != static_cast<T>(0.0))
                {
                  ibuf.push_back(i);
                  jbuf.push_back(j);
                  cbuf.push_back(c);
                  ++my_nonzeros;
                }
            }
        }
      this->comm().send(0,my_nonzeros);
      this->comm().send(0,ibuf);
      this->comm().send(0,jbuf);
      this->comm().send(0,cbuf);
    }
}

References libMesh::initialized(), and libMesh::libmesh_assert().

◆ print_personal() [1/2]

virtual void libMesh::StaticCondensation::print_personal ( std::ostream & os = libMesh::out ) const

inlineoverridevirtual

Print the contents of the matrix to the screen in a package-personalized style, if available.

Implements libMesh::SparseMatrix< T >.

Definition at line 396 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ print_personal() [2/2]

void libMesh::StaticCondensation::print_personal ( std::ostream & os = libMesh::out ) const

overridevirtual

Print the contents of the matrix to the screen in a package-personalized style, if available.

Implements libMesh::SparseMatrix< T >.

Definition at line 359 of file static_condensation.C.

359{ libmesh_not_implemented(); }

◆ print_petsc_binary() [1/2]

void libMesh::SparseMatrix< Number >::print_petsc_binary ( const std::string & filename ) const

virtualinherited

Write the contents of the matrix to a file in PETSc's binary sparse matrix format.

Definition at line 475 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot write PETSc binary-format files from non-PETSc matrices");
}

◆ print_petsc_binary() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::print_petsc_binary ( const std::string & filename ) const

virtualinherited

Write the contents of the matrix to a file in PETSc's binary sparse matrix format.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 668 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot write PETSc binary-format files from non-PETSc matrices");
}

◆ print_petsc_hdf5() [1/2]

void libMesh::SparseMatrix< Number >::print_petsc_hdf5 ( const std::string & filename ) const

virtualinherited

Write the contents of the matrix to a file in PETSc's HDF5 sparse matrix format.

Definition at line 481 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot write PETSc HDF5-format files from non-PETSc matrices");
}

◆ print_petsc_hdf5() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::print_petsc_hdf5 ( const std::string & filename ) const

virtualinherited

Write the contents of the matrix to a file in PETSc's HDF5 sparse matrix format.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 677 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot write PETSc HDF5-format files from non-PETSc matrices");
}

◆ processor_id() [1/2]

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 114 of file parallel_object.h.

115 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

◆ processor_id() [2/2]

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 114 of file parallel_object.h.

115 { return cast_int<processor_id_type>(_communicator.rank()); }

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

◆ read() [1/2]

void libMesh::SparseMatrix< Number >::read ( const std::string & filename )

virtualinherited

Read the contents of the matrix from a file, with the file format inferred from the extension of filename.

Definition at line 487 of file sparse_matrix.C.

{
  {
    std::ifstream in (filename.c_str());
    libmesh_error_msg_if
      (!in.good(), "ERROR: cannot read file:\n\t" <<
       filename);
  }
 
  std::string_view basename = Utility::basename_of(filename);
 
  const bool gzipped_file = Utility::ends_with(filename, ".gz");
 
  if (gzipped_file)
    basename.remove_suffix(3);
 
  if (Utility::ends_with(basename, ".matlab") ||
      Utility::ends_with(basename, ".m"))
    this->read_matlab(filename);
  else if (Utility::ends_with(basename, ".petsc64"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 8
      libmesh_error_msg("Cannot load 64-bit PETSc matrix file " <<
                        filename << " with non-64-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->read_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".petsc32"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 4
      libmesh_error_msg("Cannot load 32-bit PETSc matrix file " <<
                        filename << " with non-32-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->read_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".h5"))
    {
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped HDF5 matrices are not currently supported");
      this->read_coreform_hdf5(filename);
    }
  else
    libmesh_error_msg(" ERROR: Unrecognized matrix file extension on: "
                      << basename
                      << "\n   I understand the following:\n\n"
                      << "     *.h5        -- CoreForm HDF5 sparse matrix format\n"
                      << "     *.matlab    -- Matlab sparse matrix format\n"
                      << "     *.matlab.gz -- Matlab sparse matrix format, gzipped\n"
                      << "     *.m         -- Matlab sparse matrix format\n"
                      << "     *.m.gz      -- Matlab sparse matrix format, gzipped\n"
                      << "     *.petsc32   -- PETSc binary format, 32-bit\n"
                      << "     *.petsc64   -- PETSc binary format, 64-bit\n"
                     );
}

◆ read() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::read ( const std::string & filename )

virtualinherited

Read the contents of the matrix from a file, with the file format inferred from the extension of filename.

Definition at line 686 of file sparse_matrix.C.

{
  {
    std::ifstream in (filename.c_str());
    libmesh_error_msg_if
      (!in.good(), "ERROR: cannot read file:\n\t" <<
       filename);
  }
 
  std::string_view basename = Utility::basename_of(filename);
 
  const bool gzipped_file = Utility::ends_with(filename, ".gz");
 
  if (gzipped_file)
    basename.remove_suffix(3);
 
  if (Utility::ends_with(basename, ".matlab") ||
      Utility::ends_with(basename, ".m"))
    this->read_matlab(filename);
  else if (Utility::ends_with(basename, ".petsc64"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 8
      libmesh_error_msg("Cannot load 64-bit PETSc matrix file " <<
                        filename << " with non-64-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->read_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".petsc32"))
    {
#ifndef LIBMESH_HAVE_PETSC
      libmesh_error_msg("Cannot load PETSc matrix file " <<
                        filename << " without PETSc-enabled libMesh.");
#elif LIBMESH_DOF_ID_BYTES != 4
      libmesh_error_msg("Cannot load 32-bit PETSc matrix file " <<
                        filename << " with non-32-bit libMesh.");
#endif
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped PETSc matrices are not currently supported");
      this->read_petsc_binary(filename);
    }
  else if (Utility::ends_with(basename, ".h5"))
    {
      if (gzipped_file)
        libmesh_not_implemented_msg("Gzipped HDF5 matrices are not currently supported");
      this->read_coreform_hdf5(filename);
    }
  else
    libmesh_error_msg(" ERROR: Unrecognized matrix file extension on: "
                      << basename
                      << "\n   I understand the following:\n\n"
                      << "     *.h5        -- CoreForm HDF5 sparse matrix format\n"
                      << "     *.matlab    -- Matlab sparse matrix format\n"
                      << "     *.matlab.gz -- Matlab sparse matrix format, gzipped\n"
                      << "     *.m         -- Matlab sparse matrix format\n"
                      << "     *.m.gz      -- Matlab sparse matrix format, gzipped\n"
                      << "     *.petsc32   -- PETSc binary format, 32-bit\n"
                      << "     *.petsc64   -- PETSc binary format, 64-bit\n"
                     );
}

References libMesh::Utility::basename_of(), and libMesh::Utility::ends_with().

◆ read_coreform_hdf5() [1/2]

template<typename T >

void libMesh::SparseMatrix< T >::read_coreform_hdf5	(	const std::string &	filename,
		const std::string &	groupname = `"extraction"`
	)

virtualinherited

Read the contents of the matrix from a file, with the HDF5 sparse matrix format used by CoreForm, expecing sparse matrix data in the group given by groupname.

This will be initialized with the sparsity from the file, linearly partitioned onto the number of processors available unless this matrix is pre-sized and pre-partitionsed.

Definition at line 822 of file sparse_matrix.C.

{
#ifndef LIBMESH_HAVE_HDF5
  libmesh_ignore(filename, groupname);
  libmesh_error_msg("ERROR: need HDF5 support to handle .h5 files!!!");
#else
  LOG_SCOPE("read_coreform_hdf5()", "SparseMatrix");
 
  std::size_t num_rows = 0, num_cols = 0;
 
  // These are only used on pid 0, but avoid "uninitialized" warnings
  hid_t group = H5I_INVALID_HID;
  hid_t file = H5I_INVALID_HID;
 
  if (this->processor_id() == 0)
    {
      file = H5Fopen(filename.c_str(), H5F_ACC_RDONLY, H5P_DEFAULT);
 
      if (file == H5I_INVALID_HID)
        libmesh_file_error(filename);
 
      group = H5Gopen(file, groupname.c_str(), H5P_DEFAULT);
      check_open(filename, group, groupname);
 
      auto read_size_attribute = [&filename, &group]
        (const std::string & attribute_name)
      {
        unsigned long long returnval = 0;
 
        const hid_t attr = H5Aopen(group, attribute_name.c_str(), H5P_DEFAULT);
        check_open(filename, attr, attribute_name);
 
        const hid_t attr_type = H5Aget_type(attr);
        check_hdf5(filename, attr_type, attribute_name + " type");
 
        // HDF5 will convert between the file's integer type and ours, but
        // we do expect an integer type.
        if (H5Tget_class(attr_type) != H5T_INTEGER)
          libmesh_error_msg("Non-integer type for " + attribute_name + " in " + filename);
 
        H5Tclose(attr_type);
 
        // HDF5 is supposed to handle both upscaling and endianness
        // conversions here
        const herr_t errval = H5Aread(attr, H5T_NATIVE_ULLONG, &returnval);
        check_hdf5(filename, errval, attribute_name + " read");
 
        H5Aclose(attr);
 
        return returnval;
      };
 
      num_cols = read_size_attribute("num_cols");
      num_rows = read_size_attribute("num_rows");
 
      this->comm().broadcast(num_cols);
      this->comm().broadcast(num_rows);
    }
  else
    {
      this->comm().broadcast(num_cols);
      this->comm().broadcast(num_rows);
    }
 
  numeric_index_type new_row_start, new_row_stop,
                     new_col_start, new_col_stop;
 
  // If we need to reinit, we need to determine which rows+columns
  // each processor is in charge of.
  std::vector<numeric_index_type> new_row_starts, new_row_stops,
                                  new_col_starts, new_col_stops;
 
  if (this->initialized() &&
      num_cols == this->n() &&
      num_rows == this->m())
    {
      new_row_start = this->row_start(),
      new_row_stop  = this->row_stop();
 
      new_col_start = this->col_start(),
      new_col_stop  = this->col_stop();
    }
  else
    {
      // Determine which rows/columns each processor will be in charge of
      new_row_start =     this->processor_id() * num_rows / this->n_processors(),
      new_row_stop  = (this->processor_id()+1) * num_rows / this->n_processors();
 
      new_col_start =     this->processor_id() * num_cols / this->n_processors(),
      new_col_stop  = (this->processor_id()+1) * num_cols / this->n_processors();
    }
 
  this->comm().gather(0, new_row_start, new_row_starts);
  this->comm().gather(0, new_row_stop, new_row_stops);
  this->comm().gather(0, new_col_start, new_col_starts);
  this->comm().gather(0, new_col_stop, new_col_stops);
 
  numeric_index_type on_diagonal_nonzeros = 0,
                     off_diagonal_nonzeros = 0;
 
  std::vector<std::size_t> cols, row_offsets;
  std::vector<double> vals;
 
  if (this->processor_id() == 0)
    {
      auto read_vector = [&filename, &group]
        (const std::string & dataname, auto hdf5_class,
         auto hdf5_type, auto & datavec)
      {
        const hid_t data = H5Dopen1(group, dataname.c_str());
        check_open(filename, data, dataname.c_str());
 
        const hid_t data_type = H5Dget_type(data);
        check_hdf5(filename, data_type, dataname + " type");
 
        // HDF5 will convert between the file's integer type and ours, but
        // we do expect an integer type.
        if (H5Tget_class(data_type) != hdf5_class)
          libmesh_error_msg("Unexpected type for " + dataname + " in " + filename);
 
        H5Tclose(data_type);
 
        const hid_t dataspace = H5Dget_space(data);
        check_hdf5(filename, dataspace, dataname + " space");
 
        int ndims = H5Sget_simple_extent_ndims(dataspace);
        if (ndims != 1)
          libmesh_error_msg("Non-vector space for " + dataname + " in " + filename);
 
        hsize_t len, maxlen;
        herr_t errval = H5Sget_simple_extent_dims(dataspace, &len, &maxlen);
        check_hdf5(filename, errval, dataname + " dims");
 
        datavec.resize(len);
 
        errval = H5Dread(data, hdf5_type, H5S_ALL, H5S_ALL, H5P_DEFAULT, datavec.data());
        check_hdf5(filename, errval, dataname + " read");
 
        H5Dclose(data);
      };
 
      read_vector("cols", H5T_INTEGER, H5T_NATIVE_ULLONG, cols);
      read_vector("row_offsets", H5T_INTEGER, H5T_NATIVE_ULLONG, row_offsets);
      read_vector("vals", H5T_FLOAT, H5T_NATIVE_DOUBLE, vals);
 
      if (cols.size() != vals.size())
        libmesh_error_msg("Inconsistent cols/vals sizes in " + filename);
 
      if (row_offsets.size() != num_rows + 1)
        libmesh_error_msg("Inconsistent row_offsets size in " + filename);
 
      // Data for the row we're working on
      numeric_index_type current_row = 0;
      processor_id_type current_proc = 0;
      numeric_index_type current_on_diagonal_nonzeros = 0;
      numeric_index_type current_off_diagonal_nonzeros = 0;
      if (row_offsets[0] != 0)
        libmesh_error_msg("Unexpected row_offsets[0] in " + filename);
 
      for (auto i : index_range(cols))
        {
          while (row_offsets[current_row+1] <= i)
            {
              ++current_row;
              if (row_offsets[current_row] < row_offsets[current_row-1])
                libmesh_error_msg("Non-monotonic row_offsets in " + filename);
              current_on_diagonal_nonzeros = 0;
              current_off_diagonal_nonzeros = 0;
            }
 
          while (current_row >= new_row_stops[current_proc])
            ++current_proc;
 
          // 0-based indexing in file
          if (cols[i] >= new_col_starts[current_proc] &&
              cols[i] < new_col_stops[current_proc])
            {
              ++current_on_diagonal_nonzeros;
              on_diagonal_nonzeros =
                std::max(on_diagonal_nonzeros,
                         current_on_diagonal_nonzeros);
            }
          else
            {
              ++current_off_diagonal_nonzeros;
              off_diagonal_nonzeros =
                std::max(off_diagonal_nonzeros,
                         current_off_diagonal_nonzeros);
            }
        }
    }
 
  this->comm().broadcast(on_diagonal_nonzeros);
  this->comm().broadcast(off_diagonal_nonzeros);
 
  this->init(num_rows, num_cols,
             new_row_stop-new_row_start,
             new_col_stop-new_col_start,
             on_diagonal_nonzeros,
             off_diagonal_nonzeros);
 
  // Set the matrix values last.
  if (this->processor_id() == 0)
    {
      numeric_index_type current_row = 0;
      for (auto i : index_range(cols))
        {
          while (row_offsets[current_row+1] <= i)
            {
              ++current_row;
              libmesh_assert_greater_equal (row_offsets[current_row],
                                            row_offsets[current_row-1]);
            }
          this->set(current_row, cols[i], vals[i]);
        }
 
      H5Gclose(group);
      H5Fclose(file);
    }
 
  this->close();
#endif // LIBMESH_HAVE_HDF5
}

References libMesh::index_range(), libMesh::initialized(), and libMesh::libmesh_ignore().

◆ read_coreform_hdf5() [2/2]

void libMesh::SparseMatrix< Number >::read_coreform_hdf5	(	const std::string &	filename,
		const std::string &	groupname = `"extraction"`
	)

virtualinherited

Read the contents of the matrix from a file, with the HDF5 sparse matrix format used by CoreForm, expecing sparse matrix data in the group given by groupname.

This will be initialized with the sparsity from the file, linearly partitioned onto the number of processors available unless this matrix is pre-sized and pre-partitionsed.

Definition at line 498 of file sparse_matrix.C.

{
#ifndef LIBMESH_HAVE_HDF5
  libmesh_ignore(filename, groupname);
  libmesh_error_msg("ERROR: need HDF5 support to handle .h5 files!!!");
#else
  LOG_SCOPE("read_coreform_hdf5()", "SparseMatrix");
 
  std::size_t num_rows = 0, num_cols = 0;
 
  // These are only used on pid 0, but avoid "uninitialized" warnings
  hid_t group = H5I_INVALID_HID;
  hid_t file = H5I_INVALID_HID;
 
  if (this->processor_id() == 0)
    {
      file = H5Fopen(filename.c_str(), H5F_ACC_RDONLY, H5P_DEFAULT);
 
      if (file == H5I_INVALID_HID)
        libmesh_file_error(filename);
 
      group = H5Gopen(file, groupname.c_str(), H5P_DEFAULT);
      check_open(filename, group, groupname);
 
      auto read_size_attribute = [&filename, &group]
        (const std::string & attribute_name)
      {
        unsigned long long returnval = 0;
 
        const hid_t attr = H5Aopen(group, attribute_name.c_str(), H5P_DEFAULT);
        check_open(filename, attr, attribute_name);
 
        const hid_t attr_type = H5Aget_type(attr);
        check_hdf5(filename, attr_type, attribute_name + " type");
 
        // HDF5 will convert between the file's integer type and ours, but
        // we do expect an integer type.
        if (H5Tget_class(attr_type) != H5T_INTEGER)
          libmesh_error_msg("Non-integer type for " + attribute_name + " in " + filename);
 
        H5Tclose(attr_type);
 
        // HDF5 is supposed to handle both upscaling and endianness
        // conversions here
        const herr_t errval = H5Aread(attr, H5T_NATIVE_ULLONG, &returnval);
        check_hdf5(filename, errval, attribute_name + " read");
 
        H5Aclose(attr);
 
        return returnval;
      };
 
      num_cols = read_size_attribute("num_cols");
      num_rows = read_size_attribute("num_rows");
 
      this->comm().broadcast(num_cols);
      this->comm().broadcast(num_rows);
    }
  else
    {
      this->comm().broadcast(num_cols);
      this->comm().broadcast(num_rows);
    }
 
  numeric_index_type new_row_start, new_row_stop,
                     new_col_start, new_col_stop;
 
  // If we need to reinit, we need to determine which rows+columns
  // each processor is in charge of.
  std::vector<numeric_index_type> new_row_starts, new_row_stops,
                                  new_col_starts, new_col_stops;
 
  if (this->initialized() &&
      num_cols == this->n() &&
      num_rows == this->m())
    {
      new_row_start = this->row_start(),
      new_row_stop  = this->row_stop();
 
      new_col_start = this->col_start(),
      new_col_stop  = this->col_stop();
    }
  else
    {
      // Determine which rows/columns each processor will be in charge of
      new_row_start =     this->processor_id() * num_rows / this->n_processors(),
      new_row_stop  = (this->processor_id()+1) * num_rows / this->n_processors();
 
      new_col_start =     this->processor_id() * num_cols / this->n_processors(),
      new_col_stop  = (this->processor_id()+1) * num_cols / this->n_processors();
    }
 
  this->comm().gather(0, new_row_start, new_row_starts);
  this->comm().gather(0, new_row_stop, new_row_stops);
  this->comm().gather(0, new_col_start, new_col_starts);
  this->comm().gather(0, new_col_stop, new_col_stops);
 
  numeric_index_type on_diagonal_nonzeros = 0,
                     off_diagonal_nonzeros = 0;
 
  std::vector<std::size_t> cols, row_offsets;
  std::vector<double> vals;
 
  if (this->processor_id() == 0)
    {
      auto read_vector = [&filename, &group]
        (const std::string & dataname, auto hdf5_class,
         auto hdf5_type, auto & datavec)
      {
        const hid_t data = H5Dopen1(group, dataname.c_str());
        check_open(filename, data, dataname.c_str());
 
        const hid_t data_type = H5Dget_type(data);
        check_hdf5(filename, data_type, dataname + " type");
 
        // HDF5 will convert between the file's integer type and ours, but
        // we do expect an integer type.
        if (H5Tget_class(data_type) != hdf5_class)
          libmesh_error_msg("Unexpected type for " + dataname + " in " + filename);
 
        H5Tclose(data_type);
 
        const hid_t dataspace = H5Dget_space(data);
        check_hdf5(filename, dataspace, dataname + " space");
 
        int ndims = H5Sget_simple_extent_ndims(dataspace);
        if (ndims != 1)
          libmesh_error_msg("Non-vector space for " + dataname + " in " + filename);
 
        hsize_t len, maxlen;
        herr_t errval = H5Sget_simple_extent_dims(dataspace, &len, &maxlen);
        check_hdf5(filename, errval, dataname + " dims");
 
        datavec.resize(len);
 
        errval = H5Dread(data, hdf5_type, H5S_ALL, H5S_ALL, H5P_DEFAULT, datavec.data());
        check_hdf5(filename, errval, dataname + " read");
 
        H5Dclose(data);
      };
 
      read_vector("cols", H5T_INTEGER, H5T_NATIVE_ULLONG, cols);
      read_vector("row_offsets", H5T_INTEGER, H5T_NATIVE_ULLONG, row_offsets);
      read_vector("vals", H5T_FLOAT, H5T_NATIVE_DOUBLE, vals);
 
      if (cols.size() != vals.size())
        libmesh_error_msg("Inconsistent cols/vals sizes in " + filename);
 
      if (row_offsets.size() != num_rows + 1)
        libmesh_error_msg("Inconsistent row_offsets size in " + filename);
 
      // Data for the row we're working on
      numeric_index_type current_row = 0;
      processor_id_type current_proc = 0;
      numeric_index_type current_on_diagonal_nonzeros = 0;
      numeric_index_type current_off_diagonal_nonzeros = 0;
      if (row_offsets[0] != 0)
        libmesh_error_msg("Unexpected row_offsets[0] in " + filename);
 
      for (auto i : index_range(cols))
        {
          while (row_offsets[current_row+1] <= i)
            {
              ++current_row;
              if (row_offsets[current_row] < row_offsets[current_row-1])
                libmesh_error_msg("Non-monotonic row_offsets in " + filename);
              current_on_diagonal_nonzeros = 0;
              current_off_diagonal_nonzeros = 0;
            }
 
          while (current_row >= new_row_stops[current_proc])
            ++current_proc;
 
          // 0-based indexing in file
          if (cols[i] >= new_col_starts[current_proc] &&
              cols[i] < new_col_stops[current_proc])
            {
              ++current_on_diagonal_nonzeros;
              on_diagonal_nonzeros =
                std::max(on_diagonal_nonzeros,
                         current_on_diagonal_nonzeros);
            }
          else
            {
              ++current_off_diagonal_nonzeros;
              off_diagonal_nonzeros =
                std::max(off_diagonal_nonzeros,
                         current_off_diagonal_nonzeros);
            }
        }
    }
 
  this->comm().broadcast(on_diagonal_nonzeros);
  this->comm().broadcast(off_diagonal_nonzeros);
 
  this->init(num_rows, num_cols,
             new_row_stop-new_row_start,
             new_col_stop-new_col_start,
             on_diagonal_nonzeros,
             off_diagonal_nonzeros);
 
  // Set the matrix values last.
  if (this->processor_id() == 0)
    {
      numeric_index_type current_row = 0;
      for (auto i : index_range(cols))
        {
          while (row_offsets[current_row+1] <= i)
            {
              ++current_row;
              libmesh_assert_greater_equal (row_offsets[current_row],
                                            row_offsets[current_row-1]);
            }
          this->set(current_row, cols[i], vals[i]);
        }
 
      H5Gclose(group);
      H5Fclose(file);
    }
 
  this->close();
#endif // LIBMESH_HAVE_HDF5
}

◆ read_matlab() [1/2]

void libMesh::SparseMatrix< Number >::read_matlab ( const std::string & filename )

virtualinherited

Read the contents of the matrix from the Matlab-script sparse matrix format used by PETSc.

If the size and sparsity of the matrix in filename appears consistent with the existing sparsity of this then the existing parallel decomposition and sparsity will be retained. If not, then this will be initialized with the sparsity from the file, linearly partitioned onto the number of processors available.

Definition at line 512 of file sparse_matrix.C.

{
  LOG_SCOPE("read_matlab()", "SparseMatrix");
 
#ifndef LIBMESH_HAVE_CXX11_REGEX
  libmesh_not_implemented();  // What is your compiler?!?  Email us!
  libmesh_ignore(filename);
#else
  parallel_object_only();
 
  const bool gzipped_file = Utility::ends_with(filename, ".gz");
 
  // The sizes we get from the file
  std::size_t m = 0,
              n = 0;
 
  // If we don't already have this size, we'll need to reinit, and
  // determine which rows+columns each processor is in charge of.
  std::vector<numeric_index_type> new_row_starts, new_row_stops,
                                  new_col_starts, new_col_stops;
 
  numeric_index_type new_row_start, new_row_stop,
                     new_col_start, new_col_stop;
 
  // We'll read through the file three times: once to get a reliable
  // value for the matrix size (so we can divvy it up among
  // processors), then again to get the sparsity to send to each
  // processor, then a final time to get the entries to send to each
  // processor.
  //
  // We'll use an istream here; it might be an ifstream if we're
  // opening a raw ASCII file or a gzstream if we're opening a
  // compressed one.
  std::unique_ptr<std::istream> file;
 
  // We'll need a temporary structure to cache matrix entries, because
  // we need to read through the whole file before we know the size
  // and sparsity structure with which we can init().
  //
  // Reading through the file three times via `seekg` doesn't work
  // with our gzstream wrapper, and seems to take three times as long
  // even with a plain ifstream.  What happened to disk caching!?
  std::vector<std::tuple<numeric_index_type, numeric_index_type, T>> entries;
 
  // First read through the file, saving size and entry data
  {
  // We'll read the matrix on processor 0 rather than try to juggle
  // parallel I/O.
  if (this->processor_id() == 0)
    {
      // We'll be using regular expressions to make ourselves slightly
      // more robust to formatting.
      const std::regex start_regex // assignment like "zzz = ["
        ("\\s*\\w+\\s*=\\s*\\[");
      const std::regex end_regex // end of assignment
        ("^[^%]*\\]");
 
      if (gzipped_file)
        {
#ifdef LIBMESH_HAVE_GZSTREAM
          auto inf = std::make_unique<igzstream>();
          libmesh_assert(inf);
          inf->open(filename.c_str(), std::ios::in);
          file = std::move(inf);
#else
          libmesh_error_msg("ERROR: need gzstream to handle .gz files!!!");
#endif
        }
      else
        {
          auto inf = std::make_unique<std::ifstream>();
          libmesh_assert(inf);
 
          std::string new_name = Utility::unzip_file(filename);
 
          inf->open(new_name.c_str(), std::ios::in);
          file = std::move(inf);
        }
 
      // If we have a matrix with all-zero trailing rows, the only
      // way to get the size is if it ended up in a comment
      const std::regex size_regex // comment like "% size = 8 8"
        ("%\\s*[Ss][Ii][Zz][Ee]\\s*=\\s*(\\d+)\\s+(\\d+)");
      const std::string whitespace = " \t";
 
      bool have_started = false;
      bool have_ended = false;
      std::size_t largest_i_seen = 0, largest_j_seen = 0;
 
      // Data for the row we're working on
      // Use 1-based indexing for current_row, as in the file
      std::size_t current_row = 1;
 
      for (std::string line; std::getline(*file, line);)
        {
          std::smatch sm;
 
          // First, try to match an entry.  This is the most common
          // case so we won't rely on slow std::regex for it.
          // stringstream is at least an improvement over that.
 
          // Look for row/col/val like "1 1 -2.0e-4"
 
          std::istringstream l(line);
 
          std::size_t i, j;
          T value;
 
          l >> i >> j >> value;
 
          if (!l.fail())
            {
              libmesh_error_msg_if
                (!have_started, "Confused by premature entries in matrix file " << filename);
 
              entries.emplace_back(cast_int<numeric_index_type>(i),
                                   cast_int<numeric_index_type>(j),
                                   value);
 
              libmesh_error_msg_if
                (!i || !j, "Expected 1-based indexing in matrix file "
                 << filename);
 
              current_row = std::max(current_row, i);
 
              libmesh_error_msg_if
                (i < current_row,
                 "Can't handle out-of-order entries in matrix file "
                 << filename);
 
              largest_i_seen = std::max(i, largest_i_seen);
              largest_j_seen = std::max(j, largest_j_seen);
            }
 
          else if (std::regex_search(line, sm, size_regex))
            {
              const std::string msize = sm[1];
              const std::string nsize = sm[2];
              m = std::stoull(msize);
              n = std::stoull(nsize);
            }
 
          else if (std::regex_search(line, start_regex))
            have_started = true;
 
          else if (std::regex_search(line, end_regex))
            {
              have_ended = true;
              break;
            }
        }
 
      libmesh_error_msg_if
        (!have_started, "Confused by missing assignment beginning in matrix file " << filename);
 
      libmesh_error_msg_if
        (!have_ended, "Confused by missing assignment ending in matrix file " << filename);
 
      libmesh_error_msg_if
        (m > largest_i_seen, "Confused by missing final row(s) in matrix file " << filename);
 
      libmesh_error_msg_if
        (m > 0 && m < largest_i_seen, "Confused by extra final row(s) in matrix file " << filename);
 
      if (!m)
        m = largest_i_seen;
 
      libmesh_error_msg_if
        (n > largest_j_seen, "Confused by missing final column(s) in matrix file " << filename);
 
      libmesh_error_msg_if
        (n > 0 && n < largest_j_seen, "Confused by extra final column(s) in matrix file " << filename);
 
      if (!n)
        n = largest_j_seen;
 
      this->comm().broadcast(m);
      this->comm().broadcast(n);
    }
  else
    {
      this->comm().broadcast(m);
      this->comm().broadcast(n);
    }
 
  if (this->initialized() &&
      m == this->m() &&
      n == this->n())
    {
      new_row_start = this->row_start(),
      new_row_stop  = this->row_stop();
 
      new_col_start = this->col_start(),
      new_col_stop  = this->col_stop();
    }
  else
    {
      // Determine which rows/columns each processor will be in charge of
      new_row_start =     this->processor_id() * m / this->n_processors(),
      new_row_stop  = (this->processor_id()+1) * m / this->n_processors();
 
      new_col_start =     this->processor_id() * n / this->n_processors(),
      new_col_stop  = (this->processor_id()+1) * n / this->n_processors();
    }
 
  this->comm().gather(0, new_row_start, new_row_starts);
  this->comm().gather(0, new_row_stop, new_row_stops);
  this->comm().gather(0, new_col_start, new_col_starts);
  this->comm().gather(0, new_col_stop, new_col_stops);
 
  } // Done reading entry data and broadcasting matrix size
 
  // Calculate the matrix sparsity and initialize it second
  {
  // Deduce the sparsity pattern, or at least the maximum number of
  // on- and off- diagonal non-zeros per row.
  numeric_index_type  on_diagonal_nonzeros =0,
                     off_diagonal_nonzeros =0;
 
  if (this->processor_id() == 0)
    {
      // Data for the row we're working on
      // Use 1-based indexing for current_row, as in the file
      numeric_index_type current_row = 1;
      processor_id_type current_proc = 0;
      numeric_index_type current_on_diagonal_nonzeros = 0;
      numeric_index_type current_off_diagonal_nonzeros = 0;
 
      for (auto [i, j, value] : entries)
        {
          if (i > current_row)
            {
              current_row = i;
              // +1 for 1-based indexing in file
              while (current_row >= (new_row_stops[current_proc]+1))
                ++current_proc;
              current_on_diagonal_nonzeros = 0;
              current_off_diagonal_nonzeros = 0;
            }
 
          // +1 for 1-based indexing in file
          if (j >= (new_col_starts[current_proc]+1) &&
              j < (new_col_stops[current_proc]+1))
            {
              ++current_on_diagonal_nonzeros;
              on_diagonal_nonzeros =
                std::max(on_diagonal_nonzeros,
                         current_on_diagonal_nonzeros);
            }
          else
            {
              ++current_off_diagonal_nonzeros;
              off_diagonal_nonzeros =
                std::max(off_diagonal_nonzeros,
                         current_off_diagonal_nonzeros);
            }
        }
    }
 
  this->comm().broadcast(on_diagonal_nonzeros);
  this->comm().broadcast(off_diagonal_nonzeros);
 
  this->init(m, n,
             new_row_stop-new_row_start,
             new_col_stop-new_col_start,
             on_diagonal_nonzeros,
             off_diagonal_nonzeros);
  }
 
  // Set the matrix values last.
  // Convert from 1-based to 0-based indexing
  if (this->processor_id() == 0)
    for (auto [i, j, value] : entries)
      this->set(i-1, j-1, value);
 
  this->close();
#endif
}

◆ read_matlab() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::read_matlab ( const std::string & filename )

virtualinherited

Read the contents of the matrix from the Matlab-script sparse matrix format used by PETSc.

If the size and sparsity of the matrix in filename appears consistent with the existing sparsity of this then the existing parallel decomposition and sparsity will be retained. If not, then this will be initialized with the sparsity from the file, linearly partitioned onto the number of processors available.

Definition at line 1050 of file sparse_matrix.C.

{
  LOG_SCOPE("read_matlab()", "SparseMatrix");
 
#ifndef LIBMESH_HAVE_CXX11_REGEX
  libmesh_not_implemented();  // What is your compiler?!?  Email us!
  libmesh_ignore(filename);
#else
  parallel_object_only();
 
  const bool gzipped_file = Utility::ends_with(filename, ".gz");
 
  // The sizes we get from the file
  std::size_t m = 0,
              n = 0;
 
  // If we don't already have this size, we'll need to reinit, and
  // determine which rows+columns each processor is in charge of.
  std::vector<numeric_index_type> new_row_starts, new_row_stops,
                                  new_col_starts, new_col_stops;
 
  numeric_index_type new_row_start, new_row_stop,
                     new_col_start, new_col_stop;
 
  // We'll read through the file three times: once to get a reliable
  // value for the matrix size (so we can divvy it up among
  // processors), then again to get the sparsity to send to each
  // processor, then a final time to get the entries to send to each
  // processor.
  //
  // We'll use an istream here; it might be an ifstream if we're
  // opening a raw ASCII file or a gzstream if we're opening a
  // compressed one.
  std::unique_ptr<std::istream> file;
 
  // We'll need a temporary structure to cache matrix entries, because
  // we need to read through the whole file before we know the size
  // and sparsity structure with which we can init().
  //
  // Reading through the file three times via `seekg` doesn't work
  // with our gzstream wrapper, and seems to take three times as long
  // even with a plain ifstream.  What happened to disk caching!?
  std::vector<std::tuple<numeric_index_type, numeric_index_type, T>> entries;
 
  // First read through the file, saving size and entry data
  {
  // We'll read the matrix on processor 0 rather than try to juggle
  // parallel I/O.
  if (this->processor_id() == 0)
    {
      // We'll be using regular expressions to make ourselves slightly
      // more robust to formatting.
      const std::regex start_regex // assignment like "zzz = ["
        ("\\s*\\w+\\s*=\\s*\\[");
      const std::regex end_regex // end of assignment
        ("^[^%]*\\]");
 
      if (gzipped_file)
        {
#ifdef LIBMESH_HAVE_GZSTREAM
          auto inf = std::make_unique<igzstream>();
          libmesh_assert(inf);
          inf->open(filename.c_str(), std::ios::in);
          file = std::move(inf);
#else
          libmesh_error_msg("ERROR: need gzstream to handle .gz files!!!");
#endif
        }
      else
        {
          auto inf = std::make_unique<std::ifstream>();
          libmesh_assert(inf);
 
          std::string new_name = Utility::unzip_file(filename);
 
          inf->open(new_name.c_str(), std::ios::in);
          file = std::move(inf);
        }
 
      // If we have a matrix with all-zero trailing rows, the only
      // way to get the size is if it ended up in a comment
      const std::regex size_regex // comment like "% size = 8 8"
        ("%\\s*[Ss][Ii][Zz][Ee]\\s*=\\s*(\\d+)\\s+(\\d+)");
      const std::string whitespace = " \t";
 
      bool have_started = false;
      bool have_ended = false;
      std::size_t largest_i_seen = 0, largest_j_seen = 0;
 
      // Data for the row we're working on
      // Use 1-based indexing for current_row, as in the file
      std::size_t current_row = 1;
 
      for (std::string line; std::getline(*file, line);)
        {
          std::smatch sm;
 
          // First, try to match an entry.  This is the most common
          // case so we won't rely on slow std::regex for it.
          // stringstream is at least an improvement over that.
 
          // Look for row/col/val like "1 1 -2.0e-4"
 
          std::istringstream l(line);
 
          std::size_t i, j;
          T value;
 
          l >> i >> j >> value;
 
          if (!l.fail())
            {
              libmesh_error_msg_if
                (!have_started, "Confused by premature entries in matrix file " << filename);
 
              entries.emplace_back(cast_int<numeric_index_type>(i),
                                   cast_int<numeric_index_type>(j),
                                   value);
 
              libmesh_error_msg_if
                (!i || !j, "Expected 1-based indexing in matrix file "
                 << filename);
 
              current_row = std::max(current_row, i);
 
              libmesh_error_msg_if
                (i < current_row,
                 "Can't handle out-of-order entries in matrix file "
                 << filename);
 
              largest_i_seen = std::max(i, largest_i_seen);
              largest_j_seen = std::max(j, largest_j_seen);
            }
 
          else if (std::regex_search(line, sm, size_regex))
            {
              const std::string msize = sm[1];
              const std::string nsize = sm[2];
              m = std::stoull(msize);
              n = std::stoull(nsize);
            }
 
          else if (std::regex_search(line, start_regex))
            have_started = true;
 
          else if (std::regex_search(line, end_regex))
            {
              have_ended = true;
              break;
            }
        }
 
      libmesh_error_msg_if
        (!have_started, "Confused by missing assignment beginning in matrix file " << filename);
 
      libmesh_error_msg_if
        (!have_ended, "Confused by missing assignment ending in matrix file " << filename);
 
      libmesh_error_msg_if
        (m > largest_i_seen, "Confused by missing final row(s) in matrix file " << filename);
 
      libmesh_error_msg_if
        (m > 0 && m < largest_i_seen, "Confused by extra final row(s) in matrix file " << filename);
 
      if (!m)
        m = largest_i_seen;
 
      libmesh_error_msg_if
        (n > largest_j_seen, "Confused by missing final column(s) in matrix file " << filename);
 
      libmesh_error_msg_if
        (n > 0 && n < largest_j_seen, "Confused by extra final column(s) in matrix file " << filename);
 
      if (!n)
        n = largest_j_seen;
 
      this->comm().broadcast(m);
      this->comm().broadcast(n);
    }
  else
    {
      this->comm().broadcast(m);
      this->comm().broadcast(n);
    }
 
  if (this->initialized() &&
      m == this->m() &&
      n == this->n())
    {
      new_row_start = this->row_start(),
      new_row_stop  = this->row_stop();
 
      new_col_start = this->col_start(),
      new_col_stop  = this->col_stop();
    }
  else
    {
      // Determine which rows/columns each processor will be in charge of
      new_row_start =     this->processor_id() * m / this->n_processors(),
      new_row_stop  = (this->processor_id()+1) * m / this->n_processors();
 
      new_col_start =     this->processor_id() * n / this->n_processors(),
      new_col_stop  = (this->processor_id()+1) * n / this->n_processors();
    }
 
  this->comm().gather(0, new_row_start, new_row_starts);
  this->comm().gather(0, new_row_stop, new_row_stops);
  this->comm().gather(0, new_col_start, new_col_starts);
  this->comm().gather(0, new_col_stop, new_col_stops);
 
  } // Done reading entry data and broadcasting matrix size
 
  // Calculate the matrix sparsity and initialize it second
  {
  // Deduce the sparsity pattern, or at least the maximum number of
  // on- and off- diagonal non-zeros per row.
  numeric_index_type  on_diagonal_nonzeros =0,
                     off_diagonal_nonzeros =0;
 
  if (this->processor_id() == 0)
    {
      // Data for the row we're working on
      // Use 1-based indexing for current_row, as in the file
      numeric_index_type current_row = 1;
      processor_id_type current_proc = 0;
      numeric_index_type current_on_diagonal_nonzeros = 0;
      numeric_index_type current_off_diagonal_nonzeros = 0;
 
      for (auto [i, j, value] : entries)
        {
          if (i > current_row)
            {
              current_row = i;
              // +1 for 1-based indexing in file
              while (current_row >= (new_row_stops[current_proc]+1))
                ++current_proc;
              current_on_diagonal_nonzeros = 0;
              current_off_diagonal_nonzeros = 0;
            }
 
          // +1 for 1-based indexing in file
          if (j >= (new_col_starts[current_proc]+1) &&
              j < (new_col_stops[current_proc]+1))
            {
              ++current_on_diagonal_nonzeros;
              on_diagonal_nonzeros =
                std::max(on_diagonal_nonzeros,
                         current_on_diagonal_nonzeros);
            }
          else
            {
              ++current_off_diagonal_nonzeros;
              off_diagonal_nonzeros =
                std::max(off_diagonal_nonzeros,
                         current_off_diagonal_nonzeros);
            }
        }
    }
 
  this->comm().broadcast(on_diagonal_nonzeros);
  this->comm().broadcast(off_diagonal_nonzeros);
 
  this->init(m, n,
             new_row_stop-new_row_start,
             new_col_stop-new_col_start,
             on_diagonal_nonzeros,
             off_diagonal_nonzeros);
  }
 
  // Set the matrix values last.
  // Convert from 1-based to 0-based indexing
  if (this->processor_id() == 0)
    for (auto [i, j, value] : entries)
      this->set(i-1, j-1, value);
 
  this->close();
#endif
}

References libMesh::Utility::ends_with(), libMesh::initialized(), libMesh::libmesh_assert(), libMesh::libmesh_ignore(), libMesh::Utility::unzip_file(), and value.

Referenced by ConstraintOperatorTest::test1DCoarseningNewNodes(), and ConstraintOperatorTest::testCoreform().

◆ read_petsc_binary() [1/2]

void libMesh::SparseMatrix< Number >::read_petsc_binary ( const std::string & filename )

virtualinherited

Read the contents of the matrix from a file in PETSc's binary sparse matrix format.

Definition at line 518 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot read PETSc binary-format files into non-PETSc matrices");
}

◆ read_petsc_binary() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::read_petsc_binary ( const std::string & filename )

virtualinherited

Read the contents of the matrix from a file in PETSc's binary sparse matrix format.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 1332 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot read PETSc binary-format files into non-PETSc matrices");
}

◆ read_petsc_hdf5() [1/2]

void libMesh::SparseMatrix< Number >::read_petsc_hdf5 ( const std::string & filename )

virtualinherited

Read the contents of the matrix from a file in PETSc's HDF5 sparse matrix format.

Definition at line 524 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot read PETSc HDF5-format files into non-PETSc matrices");
}

◆ read_petsc_hdf5() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::read_petsc_hdf5 ( const std::string & filename )

virtualinherited

Read the contents of the matrix from a file in PETSc's HDF5 sparse matrix format.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 1341 of file sparse_matrix.C.

{
  libmesh_not_implemented_msg
    ("libMesh cannot read PETSc HDF5-format files into non-PETSc matrices");
}

◆ reduced_system_solver()

LinearSolver< Number > & libMesh::StaticCondensation::reduced_system_solver ( )

inline

Returns: The reduced system linear solver

Definition at line 302 of file static_condensation.h.

{
  libmesh_assert_msg(_reduced_solver, "Reduced system solver not built yet");
  return *_reduced_solver;
}

References _reduced_solver.

◆ reinit_submatrix() [1/2]

virtual void libMesh::SparseMatrix< Number >::reinit_submatrix	(	SparseMatrix< Number > &	submatrix,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)		const

inlinevirtualinherited

This function is similar to the one above, but it allows you to reuse the existing sparsity pattern of "submatrix" instead of reallocating it again.

This should hopefully be more efficient if you are frequently extracting submatrices of the same size.

Definition at line 565 of file sparse_matrix.h.

  {
    this->_get_submatrix(submatrix,
                         rows,
                         cols,
                         true); // true means REUSE submatrix
  }

◆ reinit_submatrix() [2/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::reinit_submatrix	(	SparseMatrix< T > &	submatrix,
		const std::vector< numeric_index_type > &	rows,
		const std::vector< numeric_index_type > &	cols
	)		const

inlinevirtualinherited

This function is similar to the one above, but it allows you to reuse the existing sparsity pattern of "submatrix" instead of reallocating it again.

This should hopefully be more efficient if you are frequently extracting submatrices of the same size.

Definition at line 565 of file sparse_matrix.h.

  {
    this->_get_submatrix(submatrix,
                         rows,
                         cols,
                         true); // true means REUSE submatrix
  }

References libMesh::SparseMatrix< T >::_get_submatrix().

◆ require_sparsity_pattern()

virtual bool libMesh::StaticCondensation::require_sparsity_pattern ( ) const

inlineoverridevirtual

Returns: Whether this matrix needs the sparsity pattern computed by the DofMap

Reimplemented from libMesh::PetscMatrixShellMatrix< Number >.

Definition at line 188 of file static_condensation.h.

188{ return false; }

◆ restore_original_nonzero_pattern() [1/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::restore_original_nonzero_pattern ( )

inlinevirtualinherited

Reset the memory storage of the matrix.

Unlike clear(), this does not destroy the matrix but rather will reset the matrix to use the original preallocation or when using hash table matrix assembly (see use_hash_table()) will reset (clear) the hash table used for assembly. In the words of the MatResetPreallocation documentation in PETSc, 'current values in the matrix are lost in this call', so a user can expect to have back their original sparsity pattern in a zeroed state

Reimplemented in libMesh::DiagonalMatrix< T >, and libMesh::PetscMatrix< T >.

Definition at line 644 of file sparse_matrix.h.

644{ libmesh_not_implemented(); }

◆ restore_original_nonzero_pattern() [2/2]

virtual void libMesh::SparseMatrix< Number >::restore_original_nonzero_pattern ( )

inlinevirtualinherited

Reset the memory storage of the matrix.

Unlike clear(), this does not destroy the matrix but rather will reset the matrix to use the original preallocation or when using hash table matrix assembly (see use_hash_table()) will reset (clear) the hash table used for assembly. In the words of the MatResetPreallocation documentation in PETSc, 'current values in the matrix are lost in this call', so a user can expect to have back their original sparsity pattern in a zeroed state

Definition at line 644 of file sparse_matrix.h.

644{ libmesh_not_implemented(); }

◆ row_start() [1/2]

numeric_index_type libMesh::StaticCondensation::row_start ( ) const

overridevirtual

Returns: The index of the first matrix row stored on this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 251 of file static_condensation.C.

251{ return _full_dof_map.first_dof(); }

libMesh::DofMapBase::first_dof

dof_id_type first_dof(const processor_id_type proc) const

Definition dof_map_base.h:185

References _full_dof_map, and libMesh::DofMapBase::first_dof().

Referenced by col_start().

◆ row_start() [2/2]

virtual numeric_index_type libMesh::StaticCondensation::row_start ( ) const

inlineoverridevirtual

Returns: The index of the first matrix row stored on this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 362 of file static_condensation.h.

362{ libmesh_not_implemented(); }

◆ row_stop() [1/2]

numeric_index_type libMesh::StaticCondensation::row_stop ( ) const

overridevirtual

Returns: The index of the last matrix row (+1) stored on this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 253 of file static_condensation.C.

253{ return _full_dof_map.end_dof(); }

libMesh::DofMapBase::end_dof

dof_id_type end_dof(const processor_id_type proc) const

Definition dof_map_base.h:191

References _full_dof_map, and libMesh::DofMapBase::end_dof().

Referenced by col_stop().

◆ row_stop() [2/2]

virtual numeric_index_type libMesh::StaticCondensation::row_stop ( ) const

inlineoverridevirtual

Returns: The index of the last matrix row (+1) stored on this processor.

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 363 of file static_condensation.h.

363{ libmesh_not_implemented(); }

◆ scale() [1/2]

void libMesh::SparseMatrix< Number >::scale ( const Number scale )

virtualinherited

Scales all elements of this matrix by scale.

Definition at line 614 of file sparse_matrix.C.

{
  libmesh_assert(this->closed());
 
  for (const auto i : make_range(this->row_start(), this->row_stop()))
    for (const auto j : make_range(this->col_start(), this->col_stop()))
      this->set(i, j, (*this)(i, j) * scale);
}

◆ scale() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::scale ( const T scale )

virtualinherited

Scales all elements of this matrix by scale.

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 1350 of file sparse_matrix.C.

{
  libmesh_assert(this->closed());
 
  for (const auto i : make_range(this->row_start(), this->row_stop()))
    for (const auto j : make_range(this->col_start(), this->col_stop()))
      this->set(i, j, (*this)(i, j) * scale);
}

References libMesh::closed(), libMesh::libmesh_assert(), and libMesh::make_range().

◆ set() [1/3]

void libMesh::StaticCondensation::set	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const Number	value
	)

overridevirtual

Set the element (i,j) to value.

Throws an error if the entry does not exist. Zero values can be "stored" in non-existent fields.

Implements libMesh::SparseMatrix< Number >.

Definition at line 255 of file static_condensation.C.

{
  const auto reduced_i = _reduced_dof_map.get_reduced_from_global_constraint_dof(full_i);
  const auto reduced_j = _reduced_dof_map.get_reduced_from_global_constraint_dof(full_j);
  _reduced_sys_mat->set(reduced_i, reduced_j, val);
}

References _reduced_dof_map, _reduced_sys_mat, and libMesh::StaticCondensationDofMap::get_reduced_from_global_constraint_dof().

◆ set() [2/3]

template<typename T >

virtual void libMesh::SparseMatrix< T >::set	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const T	value
	)

pure virtualinherited

Set the element (i,j) to value.

Throws an error if the entry does not exist. Zero values can be "stored" in non-existent fields.

Implemented in libMesh::PetscMFFDMatrix< Number >, libMesh::StaticCondensation, libMesh::DiagonalMatrix< T >, libMesh::EigenSparseMatrix< T >, libMesh::LaspackMatrix< T >, libMesh::LumpedMassMatrix< T >, libMesh::PetscMatrix< T >, libMesh::PetscMFFDMatrix< T >, libMesh::EpetraMatrix< T >, and libMesh::StaticCondensation.

Referenced by AssembleOptimization::equality_constraints_jacobian(), AssembleOptimization::inequality_constraints_jacobian(), libMesh::MatrixFillAction< ValIn, ValOut >::insert(), libMesh::MatrixFillAction< ValIn, ValOut >::insert(), libMesh::System::projection_matrix(), ConstraintOperatorTest::test1DCoarseningOperator(), SystemsTest::testProjectMatrix1D(), SystemsTest::testProjectMatrix2D(), and SystemsTest::testProjectMatrix3D().

◆ set() [3/3]

virtual void libMesh::StaticCondensation::set	(	const numeric_index_type	i,
		const numeric_index_type	j,
		const Number	value
	)

inlineoverridevirtual

Set the element (i,j) to value.

Throws an error if the entry does not exist. Zero values can be "stored" in non-existent fields.

Implements libMesh::SparseMatrix< Number >.

Definition at line 366 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ set_context()

template<typename T >

void libMesh::PetscMatrixBase< T >::set_context ( )

inherited

Set the context (ourself) for _mat.

Definition at line 105 of file petsc_matrix_base.C.

{
  libmesh_assert(this->_mat);
  PetscContainer container;
  LibmeshPetscCall(PetscContainerCreate(this->comm().get(), &container));
  LibmeshPetscCall(PetscContainerSetPointer(container, this));
  LibmeshPetscCall(PetscObjectCompose((PetscObject)(Mat)this->_mat, "PetscMatrixCtx", (PetscObject)container));
  LibmeshPetscCall(PetscContainerDestroy(&container));
}

References libMesh::libmesh_assert().

Referenced by libMesh::PetscMatrixBase< T >::PetscMatrixBase().

◆ set_current_elem() [1/2]

void libMesh::StaticCondensation::set_current_elem ( const Elem & )

inline

Definition at line 412 of file static_condensation.h.

412{}

◆ set_current_elem() [2/2]

void libMesh::StaticCondensation::set_current_elem ( const Elem & elem )

Set the current element.

This enables fast lookups of local indices from global indices

Definition at line 264 of file static_condensation.C.

{
  libmesh_assert(!Threads::in_threads || libMesh::n_threads() == 1);
  _current_elem_id = elem.id();
}

References _current_elem_id, libMesh::DofObject::id(), libMesh::Threads::in_threads, libMesh::libmesh_assert(), and libMesh::n_threads().

Referenced by libMesh::HDGProblem::jacobian().

◆ set_destroy_mat_on_exit()

template<typename T >

void libMesh::PetscMatrixBase< T >::set_destroy_mat_on_exit ( bool destroy = true )

inherited

If set to false, we don't delete the Mat on destruction and allow instead for PETSc to manage it.

Definition at line 91 of file petsc_matrix_base.C.

{
  this->_destroy_mat_on_exit = destroy;
}

◆ set_local_vectors()

void libMesh::StaticCondensation::set_local_vectors	(	const NumericVector< Number > &	global_vector,
		const std::vector< dof_id_type > &	elem_dof_indices,
		std::vector< Number > &	elem_dof_values_vec,
		EigenVector &	elem_dof_values
	)

staticprivate

Retrieves the degree of freedom values from global_vector corresponding to elem_dof_indices, filling both elem_dof_values_vec and elem_dof_values.

Definition at line 372 of file static_condensation.C.

{
  global_vector.get(elem_dof_indices, elem_dof_values_vec);
  elem_dof_values.resize(elem_dof_indices.size());
  for (const auto i : index_range(elem_dof_indices))
    elem_dof_values(i) = elem_dof_values_vec[i];
}

References libMesh::NumericVector< T >::get(), and libMesh::index_range().

Referenced by backwards_substitution(), and forward_elimination().

◆ setup() [1/2]

void libMesh::StaticCondensation::setup ( )

A no-op to be consistent with shimming from the StaticCondenstionPreconditioner.

"setup" should take place at the end of matrix assembly, e.g. during a call to close()

Definition at line 247 of file static_condensation.C.

247{ libmesh_assert(this->closed()); }

References closed(), and libMesh::libmesh_assert().

Referenced by libMesh::StaticCondensationPreconditioner::setup().

◆ setup() [2/2]

void libMesh::StaticCondensation::setup ( )

inline

Definition at line 409 of file static_condensation.h.

409{ libmesh_not_implemented(); }

◆ solver_package() [1/2]

SolverPackage libMesh::StaticCondensation::solver_package ( )

overridevirtual

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 475 of file static_condensation.C.

475{ return libMesh::default_solver_package(); }

libMesh::default_solver_package

SolverPackage default_solver_package()

Definition libmesh.C:1064

References libMesh::default_solver_package().

◆ solver_package() [2/2]

virtual SolverPackage libMesh::StaticCondensation::solver_package ( )

inlineoverridevirtual

Reimplemented from libMesh::PetscMatrixBase< T >.

Definition at line 337 of file static_condensation.h.

337{ libmesh_not_implemented(); }

◆ supports_hash_table() [1/2]

virtual bool libMesh::SparseMatrix< Number >::supports_hash_table ( ) const

inlinevirtualinherited

Returns: Whether the matrix supports hash table assembly

Definition at line 619 of file sparse_matrix.h.

619{ return false; }

◆ supports_hash_table() [2/2]

template<typename T >

virtual bool libMesh::SparseMatrix< T >::supports_hash_table ( ) const

inlinevirtualinherited

Returns: Whether the matrix supports hash table assembly

Reimplemented in libMesh::PetscMatrix< T >.

Definition at line 619 of file sparse_matrix.h.

619{ return false; }

◆ swap()

template<typename T >

void libMesh::PetscMatrixBase< T >::swap ( PetscMatrixBase< T > & m_in )

inherited

Swaps the internal data pointers of two PetscMatrices, no actual values are swapped.

Definition at line 98 of file petsc_matrix_base.C.

{
  std::swap(_mat, m_in._mat);
  std::swap(_destroy_mat_on_exit, m_in._destroy_mat_on_exit);
}

References libMesh::PetscMatrixBase< T >::_destroy_mat_on_exit, and libMesh::PetscMatrixBase< T >::_mat.

Referenced by DMlibMeshJacobian().

◆ uncondensed_dofs_only()

void libMesh::StaticCondensation::uncondensed_dofs_only ( )

inline

Sets whether this matrix represents uncondensed dofs only.

In that case when building the Schur complement we won't attempt to invert zero element matrices corresponding to the condensed dofs

Definition at line 194 of file static_condensation.h.

194{ _uncondensed_dofs_only = true; }

References _uncondensed_dofs_only.

◆ uncondensed_vars()

const std::unordered_set< unsigned int > & libMesh::StaticCondensation::uncondensed_vars ( ) const

inline

Definition at line 331 of file static_condensation.h.

331{ libmesh_not_implemented(); }

◆ update_sparsity_pattern() [1/2]

template<typename T >

virtual void libMesh::SparseMatrix< T >::update_sparsity_pattern ( const SparsityPattern::Graph & )

inlinevirtualinherited

Updates the matrix sparsity pattern.

When your SparseMatrix<T> implementation does not need this data, simply do not override this method.

Reimplemented in libMesh::LaspackMatrix< T >, and libMesh::EpetraMatrix< T >.

Definition at line 175 of file sparse_matrix.h.

175{}

Referenced by libMesh::DofMap::update_sparsity_pattern().

◆ update_sparsity_pattern() [2/2]

virtual void libMesh::SparseMatrix< Number >::update_sparsity_pattern ( const SparsityPattern::Graph & )

inlinevirtualinherited

Updates the matrix sparsity pattern.

When your SparseMatrix<T> implementation does not need this data, simply do not override this method.

Definition at line 175 of file sparse_matrix.h.

175{}

◆ use_hash_table() [1/4]

template<typename T >

bool libMesh::SparseMatrix< T >::use_hash_table ( ) const

inlineinherited

Returns: Whether this matrix is using hash table assembly. Hash table or hash map assembly means storing maps from i-j locations in the matrix to values. Because it is a hash map as opposed to a contiguous array of data, no preallocation is required to use it

Definition at line 634 of file sparse_matrix.h.

634{ return _use_hash_table; }

libMesh::SparseMatrix::_use_hash_table

bool _use_hash_table

Flag indicating whether the matrix is assembled using a hash table.

Definition sparse_matrix.h:683

References libMesh::SparseMatrix< T >::_use_hash_table.

Referenced by libMesh::SparseMatrix< T >::require_sparsity_pattern().

◆ use_hash_table() [2/4]

bool libMesh::SparseMatrix< Number >::use_hash_table ( ) const

inlineinherited

Returns: Whether this matrix is using hash table assembly. Hash table or hash map assembly means storing maps from i-j locations in the matrix to values. Because it is a hash map as opposed to a contiguous array of data, no preallocation is required to use it

Definition at line 634 of file sparse_matrix.h.

634{ return _use_hash_table; }

◆ use_hash_table() [3/4]

void libMesh::SparseMatrix< Number >::use_hash_table ( bool use_hash )

inherited

Sets whether to use hash table assembly.

This will error if the passed-in value is true and the matrix type does not support hash tables. Hash table or hash map assembly means storing maps from i-j locations in the matrix to values. Because it is a hash map as opposed to a contiguous array of data, no preallocation is required to use it

Definition at line 627 of file sparse_matrix.h.

{
  libmesh_error_msg_if(use_hash && !this->supports_hash_table(),
                       "This matrix class does not support hash table assembly");
  this->_use_hash_table = use_hash;
}

◆ use_hash_table() [4/4]

template<typename T >

void libMesh::SparseMatrix< T >::use_hash_table ( bool use_hash )

inherited

Sets whether to use hash table assembly.

This will error if the passed-in value is true and the matrix type does not support hash tables. Hash table or hash map assembly means storing maps from i-j locations in the matrix to values. Because it is a hash map as opposed to a contiguous array of data, no preallocation is required to use it

Definition at line 692 of file sparse_matrix.h.

{
  libmesh_error_msg_if(use_hash && !this->supports_hash_table(),
                       "This matrix class does not support hash table assembly");
  this->_use_hash_table = use_hash;
}

Referenced by PetscMatrixTest::testPetscCopyFromHash().

◆ vector_mult() [1/2]

void libMesh::SparseMatrix< Number >::vector_mult	(	NumericVector< Number > &	dest,
		const NumericVector< Number > &	arg
	)		const

inherited

Multiplies the matrix by the NumericVector arg and stores the result in NumericVector dest.

Definition at line 579 of file sparse_matrix.C.

{
  dest.zero();
  this->vector_mult_add(dest,arg);
}

◆ vector_mult() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::vector_mult	(	NumericVector< T > &	dest,
		const NumericVector< T > &	arg
	)		const

inherited

Multiplies the matrix by the NumericVector arg and stores the result in NumericVector dest.

Definition at line 237 of file sparse_matrix.C.

{
  dest.zero();
  this->vector_mult_add(dest,arg);
}

References libMesh::NumericVector< T >::zero().

Referenced by libMesh::TransientRBConstruction::add_IC_to_RB_space(), libMesh::RBSCMConstruction::Aq_inner_product(), libMesh::AdvectionSystem::assemble_claw_rhs(), libMesh::RBSCMConstruction::B_inner_product(), libMesh::RBConstruction::compute_Fq_representor_innerprods(), libMesh::RBConstruction::compute_output_dual_innerprods(), libMesh::RBConstruction::compute_residual_dual_norm_slow(), libMesh::RBConstruction::enrich_RB_space(), libMesh::TransientRBConstruction::enrich_RB_space(), AssembleOptimization::gradient(), libMesh::TransientRBConstruction::mass_matrix_scaled_matvec(), AssembleOptimization::objective(), libMesh::RBConstruction::print_basis_function_orthogonality(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), libMesh::TransientRBConstruction::set_error_temporal_data(), libMesh::RBConstruction::train_reduced_basis_with_POD(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::RBConstruction::truth_solve(), libMesh::RBConstruction::update_RB_system_matrices(), libMesh::TransientRBConstruction::update_RB_system_matrices(), libMesh::TransientRBConstruction::update_residual_terms(), and libMesh::RBConstruction::update_residual_terms().

◆ vector_mult_add() [1/2]

void libMesh::SparseMatrix< Number >::vector_mult_add	(	NumericVector< Number > &	dest,
		const NumericVector< Number > &	arg
	)		const

inherited

Multiplies the matrix by the NumericVector arg and adds the result to the NumericVector dest.

Definition at line 586 of file sparse_matrix.C.

{
  /* This functionality is actually implemented in the \p
     NumericVector class.  */
  dest.add_vector(arg,*this);
}

◆ vector_mult_add() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::vector_mult_add	(	NumericVector< T > &	dest,
		const NumericVector< T > &	arg
	)		const

inherited

Multiplies the matrix by the NumericVector arg and adds the result to the NumericVector dest.

Definition at line 247 of file sparse_matrix.C.

{
  /* This functionality is actually implemented in the \p
     NumericVector class.  */
  dest.add_vector(arg,*this);
}

References libMesh::NumericVector< T >::add_vector().

Referenced by libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

◆ zero() [1/2]

void libMesh::StaticCondensation::zero ( )

overridevirtual

Set all entries to 0.

Implements libMesh::SparseMatrix< T >.

Definition at line 234 of file static_condensation.C.

{
  _reduced_sys_mat->zero();
  for (auto & [elem_id, matrix_data] : _elem_to_matrix_data)
    {
      libmesh_ignore(elem_id);
      matrix_data.Acc.setZero();
      matrix_data.Acu.setZero();
      matrix_data.Auc.setZero();
      matrix_data.Auu.setZero();
    }
}

References _elem_to_matrix_data, _reduced_sys_mat, and libMesh::libmesh_ignore().

Referenced by libMesh::StaticCondensationPreconditioner::zero().

◆ zero() [2/2]

virtual void libMesh::StaticCondensation::zero ( )

inlineoverridevirtual

Set all entries to 0.

Implements libMesh::SparseMatrix< T >.

Definition at line 350 of file static_condensation.h.

350{ libmesh_not_implemented(); }

◆ zero_clone() [1/2]

std::unique_ptr< SparseMatrix< Number > > libMesh::StaticCondensation::zero_clone ( ) const

overridevirtual

Returns: A smart pointer to a copy of this matrix with the same type, size, and partitioning, but with all zero entries.

Note: This must be overridden in the derived classes.

Implements libMesh::SparseMatrix< T >.

Definition at line 65 of file static_condensation.C.

{
  libmesh_not_implemented();
}

◆ zero_clone() [2/2]

virtual std::unique_ptr< SparseMatrix< Number > > libMesh::StaticCondensation::zero_clone ( ) const

inlineoverridevirtual

Returns: A smart pointer to a copy of this matrix with the same type, size, and partitioning, but with all zero entries.

Note: This must be overridden in the derived classes.

Implements libMesh::SparseMatrix< T >.

Definition at line 351 of file static_condensation.h.

  {
    libmesh_not_implemented();
  }

◆ zero_rows() [1/2]

void libMesh::SparseMatrix< Number >::zero_rows	(	std::vector< numeric_index_type > &	rows,
		Number	diag_value = `0.0`
	)

virtualinherited

Sets all row entries to 0 then puts diag_value in the diagonal entry.

Definition at line 231 of file sparse_matrix.C.

{
  /* This functionality isn't implemented or stubbed in every subclass yet */
  libmesh_not_implemented();
}

◆ zero_rows() [2/2]

template<typename T >

void libMesh::SparseMatrix< T >::zero_rows	(	std::vector< numeric_index_type > &	rows,
		T	diag_value = `0.0`
	)

virtualinherited

Sets all row entries to 0 then puts diag_value in the diagonal entry.

Reimplemented in libMesh::PetscMatrix< T >, and libMesh::DiagonalMatrix< T >.

Definition at line 258 of file sparse_matrix.C.

{
  /* This functionality isn't implemented or stubbed in every subclass yet */
  libmesh_not_implemented();
}

Member Data Documentation

◆ _communicator [1/2]

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 120 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), close(), libMesh::ParallelObject::comm(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), libMesh::ParallelObject::processor_id(), libMesh::BoundaryInfo::regenerate_id_sets(), libMesh::StaticCondensationDofMap::reinit(), and libMesh::BoundaryInfo::synchronize_global_id_set().

◆ _communicator [2/2]

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 120 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), close(), libMesh::ParallelObject::comm(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), libMesh::ParallelObject::processor_id(), libMesh::BoundaryInfo::regenerate_id_sets(), libMesh::StaticCondensationDofMap::reinit(), and libMesh::BoundaryInfo::synchronize_global_id_set().

◆ _counts [1/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info().

◆ _counts [2/2]

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info().

◆ _current_elem_id

dof_id_type libMesh::StaticCondensation::_current_elem_id

private

The current element ID.

This is one half of a key, along with the global index, that maps to a local index

Definition at line 273 of file static_condensation.h.

Referenced by add_matrix(), clear(), and set_current_elem().

◆ _destroy_mat_on_exit

template<typename T >

bool libMesh::PetscMatrixBase< T >::_destroy_mat_on_exit

protectedinherited

This boolean value should only be set to false for the constructor which takes a PETSc Mat object.

Definition at line 186 of file petsc_matrix_base.h.

Referenced by libMesh::PetscMatrixBase< T >::swap().

◆ _dof_map [1/2]

DofMap const* libMesh::SparseMatrix< Number >::_dof_map

protectedinherited

The DofMap object associated with this object.

May be queried for degree-of-freedom counts on processors.

Definition at line 666 of file sparse_matrix.h.

◆ _dof_map [2/2]

template<typename T >

DofMap const* libMesh::SparseMatrix< T >::_dof_map

protectedinherited

The DofMap object associated with this object.

May be queried for degree-of-freedom counts on processors.

Definition at line 666 of file sparse_matrix.h.

◆ _elem_to_matrix_data

std::unordered_map<dof_id_type, MatrixData> libMesh::StaticCondensation::_elem_to_matrix_data

private

A map from element ID to Schur complement data.

Definition at line 249 of file static_condensation.h.

Referenced by add_matrix(), backwards_substitution(), clear(), close(), forward_elimination(), init(), and zero().

◆ _enable_print_counter [1/2]

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 143 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _enable_print_counter [2/2]

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 143 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _full_dof_map

const DofMap& libMesh::StaticCondensation::_full_dof_map

private

Definition at line 253 of file static_condensation.h.

Referenced by m(), row_start(), and row_stop().

◆ _ghosted_full_sol

std::unique_ptr<NumericVector<Number> > libMesh::StaticCondensation::_ghosted_full_sol

private

This is a ghosted representation of the full (uncondensed + condensed) solution. Note that.

Definition at line 269 of file static_condensation.h.

Referenced by apply(), backwards_substitution(), and init().

◆ _have_cached_values

bool libMesh::StaticCondensation::_have_cached_values

private

Whether we have cached values via add_XXX()

Definition at line 285 of file static_condensation.h.

Referenced by add_matrix(), clear(), close(), and closed().

◆ _is_initialized [1/2]

bool libMesh::SparseMatrix< Number >::_is_initialized

protectedinherited

Flag indicating whether or not the matrix has been initialized.

Definition at line 678 of file sparse_matrix.h.

◆ _is_initialized [2/2]

template<typename T >

bool libMesh::SparseMatrix< T >::_is_initialized

protectedinherited

Flag indicating whether or not the matrix has been initialized.

Definition at line 678 of file sparse_matrix.h.

Referenced by libMesh::PetscMatrix< T >::_get_submatrix(), libMesh::PetscMatrix< T >::create_submatrix_nosort(), libMesh::EpetraMatrix< T >::EpetraMatrix(), libMesh::EigenSparseMatrix< T >::get_transpose(), libMesh::LaspackMatrix< T >::get_transpose(), libMesh::PetscMatrix< T >::get_transpose(), libMesh::SparseMatrix< T >::initialized(), and libMesh::PetscMatrixBase< T >::PetscMatrixBase().

◆ _mat

template<typename T >

Mat libMesh::PetscMatrixBase< T >::_mat

protectedinherited

PETSc matrix datatype to store values.

Definition at line 180 of file petsc_matrix_base.h.

Referenced by libMesh::PetscMatrix< T >::_get_submatrix(), libMesh::PetscMatrix< T >::add(), libMesh::PetscMatrix< T >::create_submatrix_nosort(), libMesh::PetscMatrix< T >::get_transpose(), libMesh::PetscMatrixBase< T >::mat(), libMesh::PetscMatrixBase< T >::mat(), libMesh::PetscMatrix< T >::matrix_matrix_mult(), libMesh::PetscMatrix< T >::operator=(), libMesh::PetscMatrixBase< T >::PetscMatrixBase(), and libMesh::PetscMatrixBase< T >::swap().

◆ _mesh

const MeshBase& libMesh::StaticCondensation::_mesh

private

Definition at line 251 of file static_condensation.h.

Referenced by backwards_substitution(), and forward_elimination().

◆ _mutex [1/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 of file reference_counter.h.

◆ _mutex [2/2]

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 of file reference_counter.h.

◆ _n_objects [1/2]

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 132 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _n_objects [2/2]

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 132 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _omit_constrained_dofs

const bool libMesh::PetscMatrixShellMatrix< Number >::_omit_constrained_dofs

privateinherited

Whether to omit constrained degrees of freedom.

Definition at line 67 of file petsc_matrix_shell_matrix.h.

◆ _parallel_type

ParallelType libMesh::StaticCondensation::_parallel_type

private

The parallel type to use for the reduced matrix.

Definition at line 288 of file static_condensation.h.

Referenced by init(), init(), and init().

◆ _reduced_dof_map

StaticCondensationDofMap& libMesh::StaticCondensation::_reduced_dof_map

private

Definition at line 254 of file static_condensation.h.

Referenced by add_matrix(), apply(), backwards_substitution(), close(), dont_condense_vars(), forward_elimination(), init(), and set().

◆ _reduced_rhs

std::unique_ptr<NumericVector<Number> > libMesh::StaticCondensation::_reduced_rhs

private

RHS corresponding to the uncondensed degrees of freedom.

This is constructed by applying the element Schur complements to an incoming RHS which contains both condensed and uncondensed degrees of freedom

Definition at line 263 of file static_condensation.h.

Referenced by apply(), clear(), forward_elimination(), and init().

◆ _reduced_sol

std::unique_ptr<NumericVector<Number> > libMesh::StaticCondensation::_reduced_sol

private

solution for the uncondensed degrees of freedom

Definition at line 259 of file static_condensation.h.

Referenced by apply(), and clear().

◆ _reduced_solver

std::unique_ptr<LinearSolver<Number> > libMesh::StaticCondensation::_reduced_solver

private

The solver for the uncondensed degrees of freedom.

Definition at line 265 of file static_condensation.h.

Referenced by apply(), clear(), init(), and reduced_system_solver().

◆ _reduced_sys_mat

std::unique_ptr<SparseMatrix<Number> > libMesh::StaticCondensation::_reduced_sys_mat

private

global sparse matrix for the uncondensed degrees of freedom

Definition at line 257 of file static_condensation.h.

Referenced by apply(), clear(), close(), closed(), get_condensed_mat(), init(), set(), and zero().

◆ _sc_is_initialized

bool libMesh::StaticCondensation::_sc_is_initialized

private

Whether our object has been initialized.

Definition at line 282 of file static_condensation.h.

Referenced by clear(), init(), and initialized().

◆ _scp

std::unique_ptr<StaticCondensationPreconditioner> libMesh::StaticCondensation::_scp

private

Preconditioner object which will call back to us for the preconditioning action.

Definition at line 279 of file static_condensation.h.

Referenced by get_preconditioner(), and StaticCondensation().

◆ _size_one_mat

DenseMatrix<Number> libMesh::StaticCondensation::_size_one_mat

private

Helper data member for adding individual matrix elements.

Definition at line 276 of file static_condensation.h.

Referenced by add(), and StaticCondensation().

◆ _sp [1/2]

SparsityPattern::Build const* libMesh::SparseMatrix< Number >::_sp

protectedinherited

The sparsity pattern associated with this object.

Should be queried for entry counts (or with need_full_sparsity_pattern, patterns) when needed.

Definition at line 673 of file sparse_matrix.h.

◆ _sp [2/2]

template<typename T >

SparsityPattern::Build const* libMesh::SparseMatrix< T >::_sp

protectedinherited

The sparsity pattern associated with this object.

Should be queried for entry counts (or with need_full_sparsity_pattern, patterns) when needed.

Definition at line 673 of file sparse_matrix.h.

◆ _system

System& libMesh::StaticCondensation::_system

private

Definition at line 252 of file static_condensation.h.

Referenced by init().

◆ _uncondensed_dofs_only

bool libMesh::StaticCondensation::_uncondensed_dofs_only

private

whether this matrix represents uncondensed dofs only.

In that case when building the Schur complement we won't attempt to invert zero element matrices corresponding to the condensed dofs

Definition at line 293 of file static_condensation.h.

Referenced by close(), and uncondensed_dofs_only().

◆ _use_hash_table [1/2]

bool libMesh::SparseMatrix< Number >::_use_hash_table

protectedinherited

Flag indicating whether the matrix is assembled using a hash table.

Definition at line 683 of file sparse_matrix.h.

◆ _use_hash_table [2/2]

template<typename T >

bool libMesh::SparseMatrix< T >::_use_hash_table

protectedinherited

Flag indicating whether the matrix is assembled using a hash table.

Definition at line 683 of file sparse_matrix.h.

Referenced by libMesh::SparseMatrix< T >::use_hash_table().

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

include/numerics/static_condensation.h
src/numerics/static_condensation.C

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Counts [1/2]

◆ Counts [2/2]

Constructor & Destructor Documentation

◆ StaticCondensation() [1/2]

◆ ~StaticCondensation()

◆ StaticCondensation() [2/2]

Member Function Documentation

◆ _get_submatrix() [1/2]

◆ _get_submatrix() [2/2]

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ add_block_matrix() [1/4]

◆ add_block_matrix() [2/4]

◆ add_block_matrix() [3/4]

◆ add_block_matrix() [4/4]

◆ add_matrix() [1/6]

◆ add_matrix() [2/6]

◆ add_matrix() [3/6]

◆ add_matrix() [4/6]

◆ add_matrix() [5/6]

◆ add_matrix() [6/6]

◆ add_sparse_matrix() [1/2]

◆ add_sparse_matrix() [2/2]

◆ apply() [1/2]

◆ apply() [2/2]

◆ attach_dof_map() [1/2]

◆ attach_dof_map() [2/2]

◆ attach_sparsity_pattern() [1/2]

◆ attach_sparsity_pattern() [2/2]

◆ backwards_substitution()

◆ build() [1/2]

◆ build() [2/2]

◆ clear() [1/2]

◆ clear() [2/2]

◆ clone() [1/2]

◆ clone() [2/2]

◆ close() [1/2]

◆ close() [2/2]

◆ closed() [1/2]

◆ closed() [2/2]

◆ col_start() [1/2]

◆ col_start() [2/2]

◆ col_stop() [1/2]

◆ col_stop() [2/2]

◆ comm() [1/2]

◆ comm() [2/2]

◆ create_submatrix() [1/2]

◆ create_submatrix() [2/2]

◆ create_submatrix_nosort() [1/2]

◆ create_submatrix_nosort() [2/2]

◆ disable_print_counter_info() [1/2]

◆ disable_print_counter_info() [2/2]

◆ dont_condense_vars() [1/2]

◆ dont_condense_vars() [2/2]

◆ enable_print_counter_info() [1/2]

◆ enable_print_counter_info() [2/2]

◆ flush() [1/2]

◆ flush() [2/2]

◆ forward_elimination()

◆ get_condensed_mat()

◆ get_context()

◆ get_diagonal() [1/3]

◆ get_diagonal() [2/3]

◆ get_diagonal() [3/3]