libMesh::DiagonalMatrix< T > 模板类 参考

对角矩阵类，其底层存储是一个向量 更多...

#include <diagonal_matrix.h>

类 libMesh::DiagonalMatrix< T > 继承关系图:

Public 成员函数
	DiagonalMatrix (const Parallel::Communicator &comm)
	构造函数；将矩阵初始化为空，没有任何结构，即矩阵根本无法使用。因此，此构造函数仅对是类成员的矩阵有用。 所有其他矩阵应在数据流中的某一点创建，此时所有必要的信息都是可用的。 更多...
virtual	~DiagonalMatrix ()=default
	由于此类不手动管理任何内存，所以析构函数可以安全地默认。 更多...
	DiagonalMatrix (DiagonalMatrix &&)=default
	unique pointers 可以移动但不能复制 更多...
DiagonalMatrix &	operator= (DiagonalMatrix &&)=default
DiagonalMatrix &	operator= (const NumericVector< T > &vec)
	将 vec 的内容复制到底层对角线存储中 更多...
DiagonalMatrix &	operator= (NumericVector< T > &&vec)
	将 vec 的内容移动到底层对角线存储中 更多...
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
	初始化矩阵的维度和结构 更多...
virtual void	init (ParallelType type=PARALLEL) override
	初始化并行矩阵 更多...
virtual void	init (const NumericVector< T > &other, const bool fast=false)
	使用 NumericVector other 初始化，例如复制 other 的存储分配。 该函数不复制向量条目。如果将 fast 设置为 false，则初始化的条目将显式清零，否则它们的值是不确定的。 更多...
virtual void	init (const DiagonalMatrix< T > &other, const bool fast=false)
	使用 DiagonalMatrix other 初始化，例如复制 other 底层 NumericVector 的存储分配。 该函数不复制向量条目。如果将 fast 设置为 false，则初始化的条目将显式清零，否则它们的值是不确定的。 更多...
virtual void	clear () override
	清除矩阵的所有内容，将其恢复到初始状态。 更多...
virtual void	zero () override
	将矩阵的所有元素置零。 更多...
virtual std::unique_ptr < SparseMatrix< T > >	zero_clone () const override
	创建当前矩阵的零副本，其结构和维度相同。 更多...
virtual std::unique_ptr < SparseMatrix< T > >	clone () const override
	克隆当前矩阵，返回一个新的矩阵，其结构和维度相同。 更多...
virtual void	close () override
	完成矩阵的初始化和结构设置，使其可以用于计算。 更多...
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 void	set (const numeric_index_type i, const numeric_index_type j, const T value) override
	设置矩阵中指定位置的元素值。 更多...
virtual void	add (const numeric_index_type i, const numeric_index_type j, const T value) override
	在矩阵中指定位置的元素上添加一个值。 更多...
virtual void	add_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) override
	将指定的 DenseMatrix dm 添加到矩阵中的指定行和列。 更多...
virtual void	add_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &dof_indices) override
	将指定的 DenseMatrix dm 添加到矩阵中的指定自由度索引。 更多...
virtual void	add (const T a, const SparseMatrix< T > &X) override
	用矩阵 X 中的值乘以标量 a 添加到当前矩阵中。 更多...
virtual T	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
	在输出流中打印矩阵的个性化信息。 更多...
virtual void	get_diagonal (NumericVector< T > &dest) const override
	获取对角矩阵的对角线元素，并将它们存储在指定的 NumericVector 对象中。 更多...
virtual void	get_transpose (SparseMatrix< T > &dest) const override
	获取当前矩阵的转置，并将其存储在指定的 SparseMatrix 对象中。 更多...
virtual void	zero_rows (std::vector< numeric_index_type > &rows, T val=0) override
	将指定行的所有元素置零。 更多...
const NumericVector< T > &	diagonal () const
	返回对底层数据存储 NumericVector 的常量引用。 更多...
virtual bool	initialized () const
void	attach_dof_map (const DofMap &dof_map)
	设置要使用的 DofMap 的指针。如果不使用单独的稀疏性模式， 则使用来自 DofMap 的模式。 更多...
void	attach_sparsity_pattern (const SparsityPattern::Build &sp)
	设置要使用的稀疏性模式的指针。在矩阵需要比系统中的大（或更小以提高效率）的模式， 或者在 DofMap 未计算系统稀疏性模式的情况下使用。 更多...
virtual bool	need_full_sparsity_pattern () const
virtual void	update_sparsity_pattern (const SparsityPattern::Graph &)
	更新矩阵的稀疏性模式。当您的 SparseMatrix<T> 实现不需要此数据时， 只需不覆盖此方法。 更多...
virtual void	flush ()
	对于 PETSc 矩阵，此函数类似于 close，但不收缩内存。 当我们希望在 ADD_VALUES 和 INSERT_VALUES 之间切换时，这很有用。 在使用矩阵之前应该调用 close。 更多...
virtual numeric_index_type	local_m () const
	获取此进程拥有的行数。 更多...
virtual void	add_block_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &brows, const std::vector< numeric_index_type > &bcols)
	将完整矩阵 dm 添加到 SparseMatrix。这对于在装配时添加元素矩阵很有用。 矩阵被假定为块矩阵，brow、bcol 对应于*块*行和列索引。 更多...
virtual void	add_block_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &dof_indices)
	与 add_block_matrix() 相同，但假定行和列映射相同。 因此矩阵 dm 必须是方阵。 更多...
virtual void	matrix_matrix_mult (SparseMatrix< T > &, SparseMatrix< T > &, bool)
	计算 Y = A*X，其中 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)
	将 scalar* spm 添加到此矩阵的行和列中： A(rows[i], cols[j]) += scalar * spm(i,j) 更多...
void	print (std::ostream &os=libMesh::out, const bool sparse=false) const
	将矩阵的内容以统一的样式打印到屏幕上，而不考虑正在使用的矩阵/求解器包。 更多...
template<>
void	print (std::ostream &os, const bool sparse) const
virtual void	print_matlab (const std::string &="") const
	以 Matlab 的稀疏矩阵格式打印矩阵的内容。可选择将矩阵打印到名为 name 的文件中。 如果未指定 name ,则将其转储到屏幕上。 更多...
virtual void	create_submatrix (SparseMatrix< T > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const
	此函数创建一个名为 "submatrix" 的矩阵，其定义由 "rows" 和 "cols" 条目中的行和列索引给定。 目前，此操作仅对 PetscMatrix 类型定义。 注意：rows 和 cols 向量需要排序； 如果 rows 和 cols 向量未排序，则使用下面的 nosort 版本； rows 和 cols 仅包含由此处理器拥有的索引。 更多...
virtual void	create_submatrix_nosort (SparseMatrix< T > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &) const
	与上述函数类似，此函数创建由 rows 和 cols 向量中的索引定义的 submatrix。 注意：rows 和 cols 可以是无序的； 如果索引已排序，则对于效率更高的操作，请使用上面的函数； rows 和 cols 可以包含由其他处理器拥有的索引。 更多...
virtual void	reinit_submatrix (SparseMatrix< T > &submatrix, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols) const
	此函数与上述函数类似，但允许您重用 "submatrix" 的现有稀疏性模式，而不是再次分配它。 如果经常提取相同大小的子矩阵，这应该更有效。 更多...
void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const
	将矩阵乘以 NumericVector arg 并将结果存储在 NumericVector dest 中。 更多...
void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const
	将矩阵乘以 NumericVector arg ,并将结果添加到 NumericVector dest 中。 更多...
virtual void	get_row (numeric_index_type, std::vector< numeric_index_type > &, std::vector< T > &) const
	从矩阵获取一行。 更多...

静态 Public 成员函数
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)
	使用由 solver_package 指定的线性求解器包构建一个 SparseMatrix<T>。 更多...
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 类型
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information. 更多...

Protected 成员函数
virtual void	_get_submatrix (SparseMatrix< T > &, const std::vector< numeric_index_type > &, const std::vector< numeric_index_type > &, const bool) const
	创建子矩阵和 reinit_submatrix 例程的受保护实现。 更多...
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 属性
std::unique_ptr< NumericVector < T > >	_diagonal
	底层对角矩阵存储 更多...
DofMap const *	_dof_map
	与此对象关联的 DofMap 对象。可以查询其在处理器上的自由度计数。 更多...
SparsityPattern::Build const *	_sp
	与此对象关联的 sparsity pattern。在需要时， 应查询其入口计数（或使用 need_full_sparsity_pattern，模式）。 更多...
bool	_is_initialized
	标志，指示矩阵是否已初始化。 更多...

静态 Protected 属性
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. 更多...

详细描述

template<typename T>
class libMesh::DiagonalMatrix< T >

对角矩阵类，其底层存储是一个向量

作者

Alexander D. Lindsay

日期

2019

在文件 diagonal_matrix.h 第 42 行定义.

成员类型定义说明

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.

在文件 reference_counter.h 第 119 行定义.

构造及析构函数说明

template<typename T >

libMesh::DiagonalMatrix< T >::DiagonalMatrix ( const Parallel::Communicator &  comm )

explicit

构造函数；将矩阵初始化为空，没有任何结构，即矩阵根本无法使用。因此，此构造函数仅对是类成员的矩阵有用。 所有其他矩阵应在数据流中的某一点创建，此时所有必要的信息都是可用的。

在使用之前，您必须使用 init(...) 初始化矩阵。

参数

comm	通信器对象，用于在并行环境中进行通信。

在文件 diagonal_matrix.C 第 33 行定义.

参考 libMesh::DiagonalMatrix< T >::_diagonal , 以及 libMesh::NumericVector< T >::build().

                                                                      : SparseMatrix<T>(comm_in)
{
  _diagonal = NumericVector<T>::build(comm_in);
}

template<typename T>

virtual libMesh::DiagonalMatrix< T >::~DiagonalMatrix ( )

virtualdefault

由于此类不手动管理任何内存，所以析构函数可以安全地默认。

template<typename T>

libMesh::DiagonalMatrix< T >::DiagonalMatrix ( DiagonalMatrix< T > &&  )

default

unique pointers 可以移动但不能复制

成员函数说明

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

创建子矩阵和 reinit_submatrix 例程的受保护实现。

注解

派生类必须在此函数中覆盖，以使其正常工作！

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 483 行定义.

参考自 libMesh::SparseMatrix< T >::create_submatrix() , 以及 libMesh::SparseMatrix< T >::reinit_submatrix().

  {
    libmesh_not_implemented();
  }

template<typename T >

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

overridevirtual

在矩阵中指定位置的元素上添加一个值。

参数

i	行索引。
j	列索引。
value	要添加的值。

实现了 libMesh::SparseMatrix< T >.

被 libMesh::LumpedMassMatrix< T > 重载.

在文件 diagonal_matrix.C 第 190 行定义.

{
  if (i == j)
    _diagonal->add(i, value);
}

template<typename T >

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

overridevirtual

用矩阵 X 中的值乘以标量 a 添加到当前矩阵中。

参数

a	标量乘法因子。
X	要添加到当前矩阵的 SparseMatrix 对象。

实现了 libMesh::SparseMatrix< T >.

被 libMesh::LumpedMassMatrix< T > 重载.

在文件 diagonal_matrix.C 第 225 行定义.

参考 libMesh::SparseMatrix< T >::get_diagonal().

{
  auto x_diagonal = _diagonal->zero_clone();
  X.get_diagonal(*x_diagonal);
  _diagonal->add(a, *x_diagonal);
}

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

将完整矩阵 dm 添加到 SparseMatrix。这对于在装配时添加元素矩阵很有用。 矩阵被假定为块矩阵，brow、bcol 对应于*块*行和列索引。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.C 第 77 行定义.

参考 libMesh::DenseMatrixBase< T >::m() , 以及 libMesh::DenseMatrixBase< T >::n().

参考自 libMesh::SparseMatrix< T >::add_block_matrix().

{
  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);
}

template<typename T>

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

inlinevirtualinherited

与 add_block_matrix() 相同，但假定行和列映射相同。 因此矩阵 dm 必须是方阵。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 278 行定义.

参考 libMesh::SparseMatrix< T >::add_block_matrix().

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

template<typename T >

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

overridevirtual

将指定的 DenseMatrix dm 添加到矩阵中的指定行和列。

参数

dm	要添加的 DenseMatrix 对象。
rows	要添加到的行索引列表。
cols	要添加到的列索引列表。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 198 行定义.

参考 libMesh::DenseMatrixBase< T >::m() , 以及 libMesh::DenseMatrixBase< T >::n().

{
  auto m = dm.m();
  auto n = dm.n();

  for (decltype(m) i = 0; i < m; ++i)
    for (decltype(n) j = 0; j < n; ++j)
    {
      auto global_i = rows[i];
      auto global_j = cols[j];
      if (global_i == global_j)
        _diagonal->add(global_i, dm(i, j));
    }
}

template<typename T >

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

overridevirtual

将指定的 DenseMatrix dm 添加到矩阵中的指定自由度索引。

参数

dm	要添加的 DenseMatrix 对象。
dof_indices	要添加到的自由度索引列表。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 217 行定义.

参考 libMesh::DenseMatrixBase< T >::diagonal().

{
  _diagonal->add_vector(dm.diagonal(), dof_indices);
}

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

将 scalar* spm 添加到此矩阵的行和列中： A(rows[i], cols[j]) += scalar * spm(i,j)

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 297 行定义.

  { libmesh_not_implemented(); }

template<typename T >

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

inherited

设置要使用的 DofMap 的指针。如果不使用单独的稀疏性模式， 则使用来自 DofMap 的模式。

dof_map 的生命周期必须超过 this 的生命周期。

在文件 sparse_matrix.C 第 58 行定义.

参考 libMesh::DofMap::get_sparsity_pattern().

参考自 libMesh::DofMap::update_sparsity_pattern().

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

template<typename T >

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

inherited

设置要使用的稀疏性模式的指针。在矩阵需要比系统中的大（或更小以提高效率）的模式， 或者在 DofMap 未计算系统稀疏性模式的情况下使用。

sp 的生命周期必须超过 this 的生命周期。

在文件 sparse_matrix.C 第 68 行定义.

参考自 libMesh::DofMap::update_sparsity_pattern().

{
  _sp = &sp;
}

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

使用由 solver_package 指定的线性求解器包构建一个 SparseMatrix<T>。

在文件 sparse_matrix.C 第 151 行定义.

参考 libMesh::EIGEN_SOLVERS, libMesh::LASPACK_SOLVERS, libMesh::libmesh_ignore() , 以及 libMesh::TRILINOS_SOLVERS.

参考自 libMesh::DofMap::process_mesh_constraint_rows().

{
  // 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);
    }
}

template<typename T >

void libMesh::DiagonalMatrix< T >::clear ( )

overridevirtual

清除矩阵的所有内容，将其恢复到初始状态。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 99 行定义.

{
  _diagonal->clear();
}

template<typename T >

std::unique_ptr< SparseMatrix< T > > libMesh::DiagonalMatrix< T >::clone ( ) const

overridevirtual

克隆当前矩阵，返回一个新的矩阵，其结构和维度相同。

实现了 libMesh::SparseMatrix< T >.

被 libMesh::LumpedMassMatrix< T > 重载.

在文件 diagonal_matrix.C 第 129 行定义.

{
  // Make empty copy with matching comm
  auto mat_copy = std::make_unique<DiagonalMatrix<T>>(this->comm());

  // Make copy of our diagonal
  auto diag_copy = _diagonal->clone();

  // Swap diag_copy with diagonal in mat_copy
  *mat_copy = std::move(*diag_copy);

  // Work around an issue on older compilers.  We are able to simply
  // "return mat_copy;" on newer compilers
  return std::unique_ptr<SparseMatrix<T>>(mat_copy.release());
}

template<typename T >

void libMesh::DiagonalMatrix< T >::close ( )

overridevirtual

完成矩阵的初始化和结构设置，使其可以用于计算。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 147 行定义.

{
  _diagonal->close();
}

template<typename T >

bool libMesh::DiagonalMatrix< T >::closed ( ) const

overridevirtual

返回矩阵是否已关闭，即是否已完成初始化并可以用于计算。

返回

如果矩阵已关闭，则为 true；否则为 false。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 258 行定义.

{
  return _diagonal->closed();
}

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

此函数创建一个名为 "submatrix" 的矩阵，其定义由 "rows" 和 "cols" 条目中的行和列索引给定。 目前，此操作仅对 PetscMatrix 类型定义。 注意：rows 和 cols 向量需要排序； 如果 rows 和 cols 向量未排序，则使用下面的 nosort 版本； rows 和 cols 仅包含由此处理器拥有的索引。

在文件 sparse_matrix.h 第 388 行定义.

参考 libMesh::SparseMatrix< T >::_get_submatrix().

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

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

与上述函数类似，此函数创建由 rows 和 cols 向量中的索引定义的 submatrix。 注意：rows 和 cols 可以是无序的； 如果索引已排序，则对于效率更高的操作，请使用上面的函数； rows 和 cols 可以包含由其他处理器拥有的索引。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 404 行定义.

  {
    libmesh_not_implemented();
  }

template<typename T >

const NumericVector< T > & libMesh::DiagonalMatrix< T >::diagonal

(

)

const

返回对底层数据存储 NumericVector 的常量引用。

返回

对底层数据存储 NumericVector 的常量引用。

在文件 diagonal_matrix.C 第 299 行定义.

参考自 libMesh::DiagonalMatrix< T >::init().

{
  return *_diagonal;
}

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

在文件 reference_counter.C 第 100 行定义.

参考 libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = false;
  return;
}

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

在文件 reference_counter.C 第 94 行定义.

参考 libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = true;
  return;
}

template<typename T>

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

inlinevirtualinherited

对于 PETSc 矩阵，此函数类似于 close，但不收缩内存。 当我们希望在 ADD_VALUES 和 INSERT_VALUES 之间切换时，这很有用。 在使用矩阵之前应该调用 close。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 202 行定义.

参考 libMesh::SparseMatrix< T >::close().

{ close(); }

template<typename T >

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

overridevirtual

获取对角矩阵的对角线元素，并将它们存储在指定的 NumericVector 对象中。

参数

dest	存储对角元素的 NumericVector 对象。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 272 行定义.

{
  dest = *_diagonal;
}

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

staticinherited

Gets a string containing the reference information.

在文件 reference_counter.C 第 47 行定义.

参考 libMesh::ReferenceCounter::_counts.

参考自 libMesh::ReferenceCounter::print_info().

{
#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
}

template<typename T>

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

inlinevirtualinherited

从矩阵获取一行。

参数

i	要获取的矩阵行
indices	将填充为与（可能）非零值对应的列索引的容器
values	包含列值的容器

注解

此函数检索矩阵的一行，并将提供的容器填充为列索引和值。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 469 行定义.

  {
    libmesh_not_implemented();
  }

template<typename T >

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

overridevirtual

获取当前矩阵的转置，并将其存储在指定的 SparseMatrix 对象中。

参数

dest	存储转置矩阵的 SparseMatrix 对象。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 279 行定义.

{
  auto diagonal_dest = dynamic_cast<DiagonalMatrix<T> *>(&dest);
  if (diagonal_dest)
    *diagonal_dest = *_diagonal;
  else
    libmesh_error_msg("DenseMatrix<T>::get_transpose currently only accepts another DenseMatrix<T> "
                      "as its argument");
}

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.

在文件 reference_counter.h 第 183 行定义.

参考 libMesh::err.

参考自 libMesh::ReferenceCountedObject< SparseMatrix< T > >::ReferenceCountedObject().

{
  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();
  }
}

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.

在文件 reference_counter.h 第 207 行定义.

参考 libMesh::err.

参考自 libMesh::ReferenceCountedObject< SparseMatrix< T > >::~ReferenceCountedObject().

{
  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();
  }
}

template<typename T >

void libMesh::DiagonalMatrix< T >::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  )

overridevirtual

初始化矩阵的维度和结构

参数

m	矩阵的总行数。
n	矩阵的总列数。
m_l	矩阵的本地行数（在并行环境中使用）。
n_l	矩阵的本地列数（在并行环境中使用）。
nnz	矩阵的非零元素的估计数量。
noz	矩阵的零元素的估计数量。
blocksize	矩阵的块大小。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 60 行定义.

{
  _diagonal->init(m, m_l);
}

template<typename T >

void libMesh::DiagonalMatrix< T >::init ( ParallelType  type = PARALLEL )

overridevirtual

初始化并行矩阵

参数

type	并行类型（默认为 PARALLEL）。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 73 行定义.

{
  libmesh_assert(this->_dof_map);

  _diagonal->init(this->_dof_map->n_dofs(),
                  this->_dof_map->n_dofs_on_processor(this->processor_id()),
                  /*fast=*/false,
                  type);
}

template<typename T >

void libMesh::DiagonalMatrix< T >::init ( const NumericVector< T > &  other, const bool  fast = false  )

virtual

使用 NumericVector other 初始化，例如复制 other 的存储分配。 该函数不复制向量条目。如果将 fast 设置为 false，则初始化的条目将显式清零，否则它们的值是不确定的。

参数

other	要初始化的 NumericVector 对象。
fast	如果设置为 false，将初始化的条目显式清零；否则，它们的值是不确定的。

在文件 diagonal_matrix.C 第 85 行定义.

{
  _diagonal->init(other, fast);
}

template<typename T >

void libMesh::DiagonalMatrix< T >::init ( const DiagonalMatrix< T > &  other, const bool  fast = false  )

virtual

使用 DiagonalMatrix other 初始化，例如复制 other 底层 NumericVector 的存储分配。 该函数不复制向量条目。如果将 fast 设置为 false，则初始化的条目将显式清零，否则它们的值是不确定的。

参数

other	要初始化的 DiagonalMatrix 对象。
fast	如果设置为 false，将初始化的条目显式清零；否则，它们的值是不确定的。

在文件 diagonal_matrix.C 第 92 行定义.

参考 libMesh::DiagonalMatrix< T >::diagonal().

{
  init(other.diagonal(), fast);
}

template<typename T>

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

inlinevirtualinherited

返回

如果矩阵已初始化，则为 true，否则为 false。

在文件 sparse_matrix.h 第 102 行定义.

参考 libMesh::SparseMatrix< T >::_is_initialized.

参考自 libMesh::PetscMatrix< T >::_get_submatrix().

{ return _is_initialized; }

template<typename T >

Real libMesh::DiagonalMatrix< T >::l1_norm ( ) const

overridevirtual

计算矩阵的 范数。

返回

矩阵的 范数。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 244 行定义.

{
  return _diagonal->l1_norm();
}

template<typename T >

Real libMesh::DiagonalMatrix< T >::linfty_norm ( ) const

overridevirtual

计算矩阵的 范数。

返回

矩阵的 范数。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 251 行定义.

{
  return _diagonal->linfty_norm();
}

template<typename T>

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

inlinevirtualinherited

获取此进程拥有的行数。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 212 行定义.

参考 libMesh::SparseMatrix< T >::row_start() , 以及 libMesh::SparseMatrix< T >::row_stop().

{ return row_stop() - row_start(); }

template<typename T >

numeric_index_type libMesh::DiagonalMatrix< T >::m ( ) const

overridevirtual

返回矩阵的总行数。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 154 行定义.

{
  return _diagonal->size();
}

template<typename T>

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

inlinevirtualinherited

计算 Y = A*X，其中 X 为矩阵。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 290 行定义.

  { libmesh_not_implemented(); }

template<typename T >

numeric_index_type libMesh::DiagonalMatrix< T >::n ( ) const

overridevirtual

返回矩阵的总列数。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 161 行定义.

{
  return _diagonal->size();
}

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

inlinestaticinherited

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

在文件 reference_counter.h 第 85 行定义.

参考 libMesh::ReferenceCounter::_n_objects.

参考自 libMesh::LibMeshInit::~LibMeshInit().

  { return _n_objects; }

template<typename T>

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

inlinevirtualinherited

返回

如果此稀疏矩阵格式需要提供稀疏矩阵的图形，则为 true。

这对于 LaspackMatrix 是 true，但对于 PetscMatrix 是 false。 在不需要完整图形的情况下，我们可以有效地近似它以提供对稀疏矩阵所需大小的良好估计。

被 libMesh::EpetraMatrix< T > , 以及 libMesh::LaspackMatrix< T > 重载.

在文件 sparse_matrix.h 第 126 行定义.

参考自 libMesh::DofMap::attach_matrix() , 以及 libMesh::DofMap::update_sparsity_pattern().

  { return false; }

template<typename T >

T libMesh::DiagonalMatrix< T >::operator() ( const numeric_index_type  i, const numeric_index_type  j  ) const

overridevirtual

返回矩阵中指定位置的元素值。

参数

i	行索引。
j	列索引。

返回

矩阵中指定位置的元素值。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 234 行定义.

{
  if (i == j)
    return (*_diagonal)(i);
  else
    return 0;
}

template<typename T>

DiagonalMatrix& libMesh::DiagonalMatrix< T >::operator= ( DiagonalMatrix< T > &&  )

default

template<typename T >

DiagonalMatrix< T > & libMesh::DiagonalMatrix< T >::operator=

(

const NumericVector< T > &

vec

)

将 vec 的内容复制到底层对角线存储中

参数

vec	要复制的 NumericVector 对象。

返回

对 *this 的引用。

在文件 diagonal_matrix.C 第 40 行定义.

{
  *_diagonal = vec;
  return *this;
}

template<typename T >

DiagonalMatrix< T > & libMesh::DiagonalMatrix< T >::operator=

(

NumericVector< T > &&

vec

)

将 vec 的内容移动到底层对角线存储中

参数

vec	要移动的 NumericVector 对象。

返回

对 *this 的引用。

在文件 diagonal_matrix.C 第 48 行定义.

{
  // Don't get confused by the &&: vec is an lvalue reference; the && just
  // indicates that we are receiving an object that is safe to move from. Note
  // that we are not going to use std::move here because we do not have
  // (virtual) move assignment operations defined for NumericVector sub-classes
  _diagonal->swap(vec);
  return *this;
}

template<>

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

inherited

在文件 sparse_matrix.C 第 117 行定义.

参考 std::imag() , 以及 std::real().

{
  // 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;
    }
}

template<typename T >

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

inherited

将矩阵的内容以统一的样式打印到屏幕上，而不考虑正在使用的矩阵/求解器包。

在文件 sparse_matrix.C 第 225 行定义.

参考 libMesh::initialized().

参考自 libMesh::EigenSparseMatrix< T >::print_personal() , 以及 libMesh::LaspackMatrix< T >::print_personal().

{
  parallel_object_only();

  libmesh_assert (this->initialized());

  libmesh_error_msg_if(!this->_dof_map, "Error!  Trying to print a matrix with no dof_map set!");

  // We'll print the matrix from processor 0 to make sure
  // it's serialized properly
  if (this->processor_id() == 0)
    {
      libmesh_assert_equal_to (this->_dof_map->first_dof(), 0);
      for (numeric_index_type i=this->_dof_map->first_dof();
           i!=this->_dof_map->end_dof(); ++i)
        {
          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 = this->_dof_map->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=this->_dof_map->first_dof();
           i!=this->_dof_map->end_dof(); ++i)
        {
          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);
    }
}

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

staticinherited

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

在文件 reference_counter.C 第 81 行定义.

参考 libMesh::ReferenceCounter::_enable_print_counter , 以及 libMesh::ReferenceCounter::get_info().

参考自 libMesh::LibMeshInit::~LibMeshInit().

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

template<typename T>

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

inlinevirtualinherited

以 Matlab 的稀疏矩阵格式打印矩阵的内容。可选择将矩阵打印到名为 name 的文件中。 如果未指定 name ,则将其转储到屏幕上。

被 libMesh::PetscMatrix< T > 重载.

在文件 sparse_matrix.h 第 376 行定义.

  {
    libmesh_not_implemented();
  }

template<typename T >

void libMesh::DiagonalMatrix< T >::print_personal ( std::ostream &  os = libMesh::out ) const

overridevirtual

在输出流中打印矩阵的个性化信息。

参数

os	输出流（默认为 libMesh::out）。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 265 行定义.

{
  _diagonal->print(os);
}

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

此函数与上述函数类似，但允许您重用 "submatrix" 的现有稀疏性模式，而不是再次分配它。 如果经常提取相同大小的子矩阵，这应该更有效。

在文件 sparse_matrix.h 第 415 行定义.

参考 libMesh::SparseMatrix< T >::_get_submatrix().

  {
    this->_get_submatrix(submatrix,
                         rows,
                         cols,
                         true); // true 表示重用 submatrix
  }

template<typename T >

numeric_index_type libMesh::DiagonalMatrix< T >::row_start ( ) const

overridevirtual

返回矩阵在本地计算中的起始行号。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 168 行定义.

{
  return _diagonal->first_local_index();
}

template<typename T >

numeric_index_type libMesh::DiagonalMatrix< T >::row_stop ( ) const

overridevirtual

返回矩阵在本地计算中的结束行号。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 175 行定义.

{
  return _diagonal->last_local_index();
}

template<typename T >

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

overridevirtual

设置矩阵中指定位置的元素值。

参数

i	行索引。
j	列索引。
value	元素的值。

实现了 libMesh::SparseMatrix< T >.

被 libMesh::LumpedMassMatrix< T > 重载.

在文件 diagonal_matrix.C 第 182 行定义.

{
  if (i == j)
    _diagonal->set(i, value);
}

template<typename T>

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

inlinevirtualinherited

更新矩阵的稀疏性模式。当您的 SparseMatrix<T> 实现不需要此数据时， 只需不覆盖此方法。

被 libMesh::EpetraMatrix< T > , 以及 libMesh::LaspackMatrix< T > 重载.

在文件 sparse_matrix.h 第 133 行定义.

参考自 libMesh::DofMap::update_sparsity_pattern().

{}

template<typename T >

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

inherited

将矩阵乘以 NumericVector arg 并将结果存储在 NumericVector dest 中。

参数

dest	存储结果的目标 NumericVector。
arg	乘法的源 NumericVector。

注解

此函数将矩阵乘以 NumericVector arg 并将结果存储在 dest 中。

在文件 sparse_matrix.C 第 195 行定义.

参考 libMesh::NumericVector< T >::zero().

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

template<typename T >

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

inherited

将矩阵乘以 NumericVector arg ,并将结果添加到 NumericVector dest 中。

在文件 sparse_matrix.C 第 205 行定义.

参考 libMesh::NumericVector< T >::add_vector().

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

template<typename T >

void libMesh::DiagonalMatrix< T >::zero ( )

overridevirtual

将矩阵的所有元素置零。

实现了 libMesh::SparseMatrix< T >.

在文件 diagonal_matrix.C 第 106 行定义.

{
  _diagonal->zero();
}

template<typename T >

std::unique_ptr< SparseMatrix< T > > libMesh::DiagonalMatrix< T >::zero_clone ( ) const

overridevirtual

创建当前矩阵的零副本，其结构和维度相同。

实现了 libMesh::SparseMatrix< T >.

被 libMesh::LumpedMassMatrix< T > 重载.

在文件 diagonal_matrix.C 第 112 行定义.

{
  // Make empty copy with matching comm
  auto mat_copy = std::make_unique<DiagonalMatrix<T>>(this->comm());

  // Initialize copy with our same nonzero structure, and explicitly
  // zero values using fast == false.
  mat_copy->init(*this, /*fast=*/false);

  // Work around an issue on older compilers.  We are able to simply
  // "return mat_copy;" on newer compilers
  return std::unique_ptr<SparseMatrix<T>>(mat_copy.release());
}

template<typename T >

void libMesh::DiagonalMatrix< T >::zero_rows ( std::vector< numeric_index_type > &  rows, T  val = 0  )

overridevirtual

将指定行的所有元素置零。

参数

rows	要置零的行索引列表。
val	置零的值（默认为 0）。

重载 libMesh::SparseMatrix< T > .

在文件 diagonal_matrix.C 第 291 行定义.

{
  for (auto row : rows)
    _diagonal->set(row, val);
}

类成员变量说明

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

在文件 reference_counter.h 第 124 行定义.

参考自 libMesh::ReferenceCounter::get_info().

template<typename T>

std::unique_ptr<NumericVector<T> > libMesh::DiagonalMatrix< T >::_diagonal

protected

底层对角矩阵存储

在文件 diagonal_matrix.h 第 292 行定义.

参考自 libMesh::DiagonalMatrix< T >::DiagonalMatrix().

template<typename T>

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

protectedinherited

与此对象关联的 DofMap 对象。可以查询其在处理器上的自由度计数。

在文件 sparse_matrix.h 第 494 行定义.

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

在文件 reference_counter.h 第 143 行定义.

参考自 libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info() , 以及 libMesh::ReferenceCounter::print_info().

template<typename T>

bool libMesh::SparseMatrix< T >::_is_initialized

protectedinherited

标志，指示矩阵是否已初始化。

在文件 sparse_matrix.h 第 505 行定义.

参考自 libMesh::PetscMatrix< T >::_get_submatrix(), libMesh::PetscMatrix< T >::create_submatrix_nosort(), libMesh::EpetraMatrix< T >::EpetraMatrix(), libMesh::PetscMatrix< T >::get_transpose(), libMesh::SparseMatrix< T >::initialized() , 以及 libMesh::PetscMatrix< T >::PetscMatrix().

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

在文件 reference_counter.h 第 137 行定义.

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

staticprotectedinherited

The number of objects.

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

在文件 reference_counter.h 第 132 行定义.

参考自 libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter() , 以及 libMesh::ReferenceCounter::~ReferenceCounter().

template<typename T>

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

protectedinherited

与此对象关联的 sparsity pattern。在需要时， 应查询其入口计数（或使用 need_full_sparsity_pattern，模式）。

在文件 sparse_matrix.h 第 500 行定义.

---

该类的文档由以下文件生成:

• /home/lwz/libmesh/include/numerics/diagonal_matrix.h
• /home/lwz/libmesh/src/numerics/diagonal_matrix.C