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

此类提供了对Epetra数据结构的并行、稀疏矩阵的友好接口。所有重写的虚拟函数在sparse_matrix.h中都有文档。 更多...

#include <trilinos_epetra_matrix.h>

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

Public 类型
typedef T	value_type

Public 成员函数
	EpetraMatrix (const Parallel::Communicator &comm)
	构造函数; 初始化矩阵为空，没有任何结构。矩阵不可用。仅用于成员类的矩阵。 所有其他矩阵应在所有必要信息都可用的数据流的某个点创建。 更多...
	EpetraMatrix (Epetra_FECrsMatrix *m, const Parallel::Communicator &comm)
	构造函数。创建一个EpetraMatrix，假设您已经有一个有效的Epetra_FECrsMatrix对象。 在这种情况下，m不会在EpetraMatrix析构函数销毁时被销毁。这允许保留m的所有权在原始创建者手中， 并提供EpetraMatrix的附加功能。 更多...
	EpetraMatrix (EpetraMatrix &&)=delete
	禁用复制和移动构造函数，以及赋值运算符 更多...
	EpetraMatrix (const EpetraMatrix &)=delete
EpetraMatrix &	operator= (const EpetraMatrix &)=delete
EpetraMatrix &	operator= (EpetraMatrix &&)=delete
virtual	~EpetraMatrix ()
	析构函数 更多...
virtual bool	need_full_sparsity_pattern () const override
	EpetraMatrix需要完整的稀疏性模式。 更多...
virtual void	update_sparsity_pattern (const SparsityPattern::Graph &graph) override
	更新矩阵的稀疏性模式。这将告诉底层矩阵存储方案如何映射(i,j)元素。 更多...
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 parallelType=PARALLEL) override
	初始化矩阵并设置通信模式。 更多...
virtual void	clear () noexceptoverride
	清除矩阵。 更多...
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
	添加稀疏矩阵的元素值。 更多...
virtual void	add_matrix (const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &dof_indices) override
	添加稀疏矩阵的元素值。 更多...
virtual void	add (const T a, const SparseMatrix< T > &X) override
	计算A += a*X，其中a是标量，X是稀疏矩阵。 更多...
virtual T	operator() (const numeric_index_type i, const numeric_index_type j) const override
	获取矩阵元素值。 更多...
virtual Real	l1_norm () const override
	获取矩阵的L1范数。 更多...
virtual Real	linfty_norm () const override
	获取矩阵的L∞范数。 更多...
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
	获取矩阵的对角线元素。 更多...
virtual void	get_transpose (SparseMatrix< T > &dest) const override
	获取矩阵的转置。 更多...
void	swap (EpetraMatrix< T > &other)
	交换内部数据指针，不交换实际值。 更多...
Epetra_FECrsMatrix *	mat ()
	获取原始Epetra_FECrsMatrix指针。 更多...
const Epetra_FECrsMatrix *	mat () const
	获取原始Epetra_FECrsMatrix指针（const版本）。 更多...
virtual bool	initialized () const
void	attach_dof_map (const DofMap &dof_map)
	设置要使用的 DofMap 的指针。如果不使用单独的稀疏性模式， 则使用来自 DofMap 的模式。 更多...
void	attach_sparsity_pattern (const SparsityPattern::Build &sp)
	设置要使用的稀疏性模式的指针。在矩阵需要比系统中的大（或更小以提高效率）的模式， 或者在 DofMap 未计算系统稀疏性模式的情况下使用。 更多...
virtual void	zero_rows (std::vector< numeric_index_type > &rows, T diag_value=0.0)
	将所有行条目设置为 0，然后将 diag_value 放在对角线条目。 更多...
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 属性
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. 更多...

Private 属性
Epetra_FECrsMatrix *	_mat
	实际Epetra数据类型来保存矩阵条目。 更多...
Epetra_Map *	_map
	分布映射 更多...
Epetra_CrsGraph *	_graph
	稀疏性模式 更多...
bool	_destroy_mat_on_exit
	在接口函数中是否销毁_mat。 更多...
bool	_use_transpose
	手动跟踪是否手动进行了转置。 更多...

详细描述

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

此类提供了对Epetra数据结构的并行、稀疏矩阵的友好接口。所有重写的虚拟函数在sparse_matrix.h中都有文档。

作者

Benjamin S. Kirk

日期

2008

在文件 trilinos_epetra_matrix.h 第 61 行定义.

成员类型定义说明

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>

typedef T libMesh::EpetraMatrix< T >::value_type

在文件 trilinos_epetra_matrix.h 第 64 行定义.

构造及析构函数说明

template<typename T >

libMesh::EpetraMatrix< T >::EpetraMatrix

(

const Parallel::Communicator &

comm

)

构造函数; 初始化矩阵为空，没有任何结构。矩阵不可用。仅用于成员类的矩阵。 所有其他矩阵应在所有必要信息都可用的数据流的某个点创建。

参数

comm

通信器

在文件 trilinos_epetra_matrix.C 第 332 行定义.

                                                               :
  SparseMatrix<T>(comm),
  _destroy_mat_on_exit(true),
  _use_transpose(false)
{}

template<typename T >

libMesh::EpetraMatrix< T >::EpetraMatrix	(	Epetra_FECrsMatrix *	m,
		const Parallel::Communicator &	comm
	)

构造函数。创建一个EpetraMatrix，假设您已经有一个有效的Epetra_FECrsMatrix对象。 在这种情况下，m不会在EpetraMatrix析构函数销毁时被销毁。这允许保留m的所有权在原始创建者手中， 并提供EpetraMatrix的附加功能。

参数

m	指向现有Epetra_FECrsMatrix对象的指针
comm	通信器

在文件 trilinos_epetra_matrix.C 第 342 行定义.

参考 libMesh::SparseMatrix< T >::_is_initialized, libMesh::EpetraMatrix< T >::_mat , 以及 libMesh::EpetraMatrix< T >::m().

                                                                 :
  SparseMatrix<T>(comm),
  _destroy_mat_on_exit(false),
  _use_transpose(false) // dumb guess is the best we can do...
{
  this->_mat = m;
  this->_is_initialized = true;
}

template<typename T>

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

delete

禁用复制和移动构造函数，以及赋值运算符

template<typename T>

libMesh::EpetraMatrix< T >::EpetraMatrix ( const EpetraMatrix< T > &  )

delete

template<typename T >

libMesh::EpetraMatrix< T >::~EpetraMatrix ( )

virtual

析构函数

在文件 trilinos_epetra_matrix.C 第 356 行定义.

{
  this->clear();
}

成员函数说明

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::EpetraMatrix< T >::add ( const numeric_index_type  i, const numeric_index_type  j, const T  value  )

overridevirtual

添加矩阵元素值。

参数

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

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 437 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());

  int
    epetra_i = static_cast<int>(i),
    epetra_j = static_cast<int>(j);

  T epetra_value = value;

  _mat->SumIntoGlobalValues (epetra_i, 1, &epetra_value, &epetra_j);
}

template<typename T >

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

overridevirtual

计算A += a*X，其中a是标量，X是稀疏矩阵。

注意，不仅要使用init()分配适当的内存，还要在将非零值添加到X时明确将this的项归零。 a 标量

参数

X

稀疏矩阵

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 464 行定义.

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

{
#ifdef LIBMESH_TRILINOS_HAVE_EPETRAEXT
  libmesh_assert (this->initialized());

  // sanity check. but this cannot avoid
  // crash due to incompatible sparsity structure...
  libmesh_assert_equal_to (this->m(), X_in.m());
  libmesh_assert_equal_to (this->n(), X_in.n());

  const EpetraMatrix<T> * X =
    cast_ptr<const EpetraMatrix<T> *> (&X_in);

  EpetraExt::MatrixMatrix::Add (*X->_mat, false, a_in, *_mat, 1.);
#else
  libmesh_error_msg("ERROR: EpetraExt is required for EpetraMatrix::add()!");
#endif
}

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::EpetraMatrix< T >::add_matrix ( const DenseMatrix< T > &  dm, const std::vector< numeric_index_type > &  rows, const std::vector< numeric_index_type > &  cols  )

overridevirtual

添加稀疏矩阵的元素值。

参数

dm	稀疏矩阵
rows	要添加的行索引
cols	要添加的列索引

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 278 行定义.

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

{
  libmesh_assert (this->initialized());

  const numeric_index_type m = dm.m();
  const numeric_index_type n = dm.n();

  libmesh_assert_equal_to (rows.size(), m);
  libmesh_assert_equal_to (cols.size(), n);

  _mat->SumIntoGlobalValues(m, numeric_trilinos_cast(rows.data()),
                            n, numeric_trilinos_cast(cols.data()),
                            dm.get_values().data());
}

template<typename T >

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

overridevirtual

添加稀疏矩阵的元素值。

参数

dm	稀疏矩阵
dof_indices	要添加的行和列索引

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 455 行定义.

{
  this->add_matrix (dm, dof_indices, 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::EpetraMatrix< T >::clear ( )

overridevirtualnoexcept

清除矩阵。

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 240 行定义.

参考 libMesh::libMeshPrivateData::_is_initialized.

{
  // FIXME: clear() doesn't actually free the memory managed by this
  // class, so it probably leaks memory.
  // delete _mat;
  // delete _map;

  this->_is_initialized = false;
}

template<typename T >

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

overridevirtual

创建矩阵克隆。

返回

矩阵克隆的唯一指针

实现了 libMesh::SparseMatrix< T >.

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

{
  // We don't currently have a faster implementation than making a
  // zero clone and then filling in the values.
  auto mat_copy = this->zero_clone();
  mat_copy->add(1., *this);

  // 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::EpetraMatrix< T >::close ( )

overridevirtual

关闭矩阵，使其无法再次修改。

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 364 行定义.

{
  libmesh_assert(_mat);

  _mat->GlobalAssemble();
}

template<typename T >

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

overridevirtual

检查矩阵是否已关闭。

返回

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

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 522 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());
  libmesh_assert(this->_mat);

  return this->_mat->Filled();
}

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

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::EpetraMatrix< T >::get_diagonal ( NumericVector< T > &  dest ) const

overridevirtual

获取矩阵的对角线元素。

参数

dest	目标数值向量，包含对角线元素

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 301 行定义.

参考 libMesh::EpetraVector< T >::vec().

{
  // Convert vector to EpetraVector.
  EpetraVector<T> * epetra_dest = cast_ptr<EpetraVector<T> *>(&dest);

  // Call Epetra function.
  _mat->ExtractDiagonalCopy(*(epetra_dest->vec()));
}

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::EpetraMatrix< T >::get_transpose ( SparseMatrix< T > &  dest ) const

overridevirtual

获取矩阵的转置。

参数

dest	目标稀疏矩阵，包含矩阵的转置

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 313 行定义.

参考 libMesh::EpetraMatrix< T >::_mat , 以及 libMesh::EpetraMatrix< T >::_use_transpose.

{
  // Make sure the SparseMatrix passed in is really a EpetraMatrix
  EpetraMatrix<T> & epetra_dest = cast_ref<EpetraMatrix<T> &>(dest);

  // We currently only support calling get_transpose() with ourself
  // as the destination. Previously, this called the default copy
  // constructor which was not safe because this class manually
  // manages memory.
  if (&epetra_dest != this)
    libmesh_not_implemented();

  epetra_dest._use_transpose = !epetra_dest._use_transpose;
  epetra_dest._mat->SetUseTranspose(epetra_dest._use_transpose);
}

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>

virtual void libMesh::EpetraMatrix< 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 >.

template<typename T >

void libMesh::EpetraMatrix< T >::init ( ParallelType  parallelType = PARALLEL )

overridevirtual

初始化矩阵并设置通信模式。

参数

parallelType

并行类型

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 177 行定义.

参考 libMesh::libMeshPrivateData::_is_initialized , 以及 libMesh::initialized().

{
  libmesh_assert(this->_dof_map);

  {
    // Clear initialized matrices
    if (this->initialized())
      this->clear();

    this->_is_initialized = true;
  }


  _mat = new Epetra_FECrsMatrix (Copy, *_graph);
}

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::EpetraMatrix< T >::l1_norm ( ) const

overridevirtual

获取矩阵的L1范数。

返回

矩阵的L1范数

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 253 行定义.

参考 libMesh::initialized() , 以及 libMesh::Real.

{
  libmesh_assert (this->initialized());

  libmesh_assert(_mat);

  return static_cast<Real>(_mat->NormOne());
}

template<typename T >

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

overridevirtual

获取矩阵的L∞范数。

返回

矩阵的L∞范数

实现了 libMesh::SparseMatrix< T >.

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

参考 libMesh::initialized() , 以及 libMesh::Real.

{
  libmesh_assert (this->initialized());


  libmesh_assert(_mat);

  return static_cast<Real>(_mat->NormInf());
}

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::EpetraMatrix< T >::m ( ) const

overridevirtual

获取全局行数。

返回

全局行数

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 374 行定义.

参考 libMesh::initialized().

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

{
  libmesh_assert (this->initialized());

  return static_cast<numeric_index_type>(_mat->NumGlobalRows());
}

template<typename T>

Epetra_FECrsMatrix* libMesh::EpetraMatrix< T >::mat ( )

inline

获取原始Epetra_FECrsMatrix指针。

返回

原始Epetra_FECrsMatrix指针

注解

通常不需要在用户级别代码中使用此函数。

不要尝试删除指针或执行其他不安全的操作！

在文件 trilinos_epetra_matrix.h 第 315 行定义.

参考 libMesh::EpetraMatrix< T >::_mat.

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

{ libmesh_assert(_mat); return _mat; }

template<typename T>

const Epetra_FECrsMatrix* libMesh::EpetraMatrix< T >::mat ( ) const

inline

获取原始Epetra_FECrsMatrix指针（const版本）。

返回

原始Epetra_FECrsMatrix指针（const版本）

注解

通常不需要在用户级别代码中使用此函数。

不要尝试删除指针或执行其他不安全的操作！

在文件 trilinos_epetra_matrix.h 第 325 行定义.

参考 libMesh::EpetraMatrix< T >::_mat.

{ libmesh_assert(_mat); return _mat; }

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::EpetraMatrix< T >::n ( ) const

overridevirtual

获取全局列数。

返回

全局列数

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 384 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());

  return static_cast<numeric_index_type>(_mat->NumGlobalCols());
}

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::EpetraMatrix< T >::need_full_sparsity_pattern ( ) const

overridevirtual

EpetraMatrix需要完整的稀疏性模式。

返回

始终返回true

重载 libMesh::SparseMatrix< T > .

template<typename T >

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

overridevirtual

获取矩阵元素值。

参数

i	行索引
j	列索引

返回

(i,j)位置的元素值

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 487 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());
  libmesh_assert(this->_mat);
  libmesh_assert (this->_mat->MyGlobalRow(static_cast<int>(i)));
  libmesh_assert_greater_equal (i, this->row_start());
  libmesh_assert_less (i, this->row_stop());


  int row_length;
  int * row_indices;
  double * values;

  _mat->ExtractMyRowView (i-this->row_start(),
                          row_length,
                          values,
                          row_indices);

  //libMesh::out << "row_length=" << row_length << std::endl;

  int * index = std::lower_bound (row_indices, row_indices+row_length, j);

  libmesh_assert_less (*index, row_length);
  libmesh_assert_equal_to (static_cast<numeric_index_type>(row_indices[*index]), j);

  //libMesh::out << "val=" << values[*index] << std::endl;

  return values[*index];
}

template<typename T>

EpetraMatrix& libMesh::EpetraMatrix< T >::operator= ( const EpetraMatrix< T > &  )

delete

template<typename T>

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

delete

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::EpetraMatrix< T >::print_personal ( std::ostream &  os = libMesh::out ) const

overridevirtual

打印矩阵的个性化信息。

参数

os	输出流，默认为libMesh::out

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 543 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());
  libmesh_assert(_mat);

  os << *_mat;
}

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::EpetraMatrix< T >::row_start ( ) const

overridevirtual

获取本地行索引的起始位置。

返回

本地行索引的起始位置

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 394 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());
  libmesh_assert(_map);

  return static_cast<numeric_index_type>(_map->MinMyGID());
}

template<typename T >

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

overridevirtual

获取本地行索引的结束位置。

返回

本地行索引的结束位置

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 405 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());
  libmesh_assert(_map);

  return static_cast<numeric_index_type>(_map->MaxMyGID())+1;
}

template<typename T >

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

overridevirtual

设置矩阵元素值。

参数

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

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 416 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());

  int
    epetra_i = static_cast<int>(i),
    epetra_j = static_cast<int>(j);

  T epetra_value = value;

  if (_mat->Filled())
    _mat->ReplaceGlobalValues (epetra_i, 1, &epetra_value, &epetra_j);
  else
    _mat->InsertGlobalValues (epetra_i, 1, &epetra_value, &epetra_j);
}

template<typename T >

void libMesh::EpetraMatrix< T >::swap

(

EpetraMatrix< T > &

other

)

交换内部数据指针，不交换实际值。

参数

other

要交换数据指针的EpetraMatrix对象

在文件 trilinos_epetra_matrix.C 第 532 行定义.

参考 libMesh::EpetraMatrix< T >::_destroy_mat_on_exit , 以及 libMesh::EpetraMatrix< T >::_mat.

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

template<typename T >

void libMesh::EpetraMatrix< T >::update_sparsity_pattern ( const SparsityPattern::Graph &  graph )

overridevirtual

更新矩阵的稀疏性模式。这将告诉底层矩阵存储方案如何映射(i,j)元素。

参数

graph

稀疏模式的图形

重载 libMesh::SparseMatrix< T > .

在文件 trilinos_epetra_matrix.C 第 42 行定义.

参考 libMesh::initialized().

{
  // clear data, start over
  this->clear ();

  // big trouble if this fails!
  libmesh_assert(this->_dof_map);

  const numeric_index_type n_rows = cast_int<numeric_index_type>
    (sparsity_pattern.size());

  const numeric_index_type m   = this->_dof_map->n_dofs();
  const numeric_index_type n   = m;
  const numeric_index_type n_l = this->_dof_map->n_dofs_on_processor(this->processor_id());
  const numeric_index_type m_l = n_l;

  // error checking
#ifndef NDEBUG
  {
    libmesh_assert_equal_to (n, m);
    libmesh_assert_equal_to (n_l, m_l);

    numeric_index_type
      summed_m_l = m_l,
      summed_n_l = n_l;

    this->comm().sum (summed_m_l);
    this->comm().sum (summed_n_l);

    libmesh_assert_equal_to (m, summed_m_l);
    libmesh_assert_equal_to (n, summed_n_l);
  }
#endif

  // build a map defining the data distribution
  _map = new Epetra_Map (static_cast<int>(m),
                         m_l,
                         0,
                         Epetra_MpiComm (this->comm().get()));

  libmesh_assert_equal_to (static_cast<numeric_index_type>(_map->NumGlobalPoints()), m);
  libmesh_assert_equal_to (static_cast<numeric_index_type>(_map->MaxAllGID()+1), m);

  const std::vector<numeric_index_type> & n_nz = this->_sp->get_n_nz();
  const std::vector<numeric_index_type> & n_oz = this->_sp->get_n_oz();

  // Make sure the sparsity pattern isn't empty
  libmesh_assert_equal_to (n_nz.size(), n_l);
  libmesh_assert_equal_to (n_oz.size(), n_l);

  // Epetra wants the total number of nonzeros, both local and remote.
  std::vector<int> n_nz_tot;  n_nz_tot.reserve(n_nz.size());

  for (auto i : index_range(n_nz))
    n_nz_tot.push_back(std::min(n_nz[i] + n_oz[i], n));

  if (m==0)
    return;

  _graph = new Epetra_CrsGraph(Copy, *_map, n_nz_tot.data());

  // Tell the matrix about its structure.  Initialize it
  // to zero.
  for (numeric_index_type i=0; i<n_rows; i++)
    _graph->InsertGlobalIndices(_graph->GRID(i),
                                cast_int<numeric_index_type>(sparsity_pattern[i].size()),
                                const_cast<int *>(reinterpret_cast<const int *>(sparsity_pattern[i].data())));

  _graph->FillComplete();

  //Initialize the matrix
  libmesh_assert (!this->initialized());
  this->init ();
  libmesh_assert (this->initialized());
}

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::EpetraMatrix< T >::zero ( )

overridevirtual

将矩阵元素设置为零。

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 196 行定义.

参考 libMesh::initialized().

{
  libmesh_assert (this->initialized());

  _mat->Scale(0.0);
}

template<typename T >

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

overridevirtual

创建零克隆矩阵。

返回

零克隆矩阵的唯一指针

实现了 libMesh::SparseMatrix< T >.

在文件 trilinos_epetra_matrix.C 第 206 行定义.

{
  // This function is marked as "not implemented" since it hasn't been
  // tested, the code below might serve as a possible implementation.
  libmesh_not_implemented();

  // Make empty copy with matching comm, initialize, and return.
  auto mat_copy = std::make_unique<EpetraMatrix<T>>(this->comm());
  mat_copy->init();
  mat_copy->zero();

  // 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::SparseMatrix< T >::zero_rows ( std::vector< numeric_index_type > &  rows, T  diag_value = 0.0  )

virtualinherited

将所有行条目设置为 0，然后将 diag_value 放在对角线条目。

被 libMesh::DiagonalMatrix< T > , 以及 libMesh::PetscMatrix< T > 重载.

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

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

类成员变量说明

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

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

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

template<typename T>

bool libMesh::EpetraMatrix< T >::_destroy_mat_on_exit

private

在接口函数中是否销毁_mat。

在文件 trilinos_epetra_matrix.h 第 346 行定义.

参考自 libMesh::EpetraMatrix< T >::swap().

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>

Epetra_CrsGraph* libMesh::EpetraMatrix< T >::_graph

private

稀疏性模式

在文件 trilinos_epetra_matrix.h 第 341 行定义.

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().

template<typename T>

Epetra_Map* libMesh::EpetraMatrix< T >::_map

private

分布映射

在文件 trilinos_epetra_matrix.h 第 336 行定义.

template<typename T>

Epetra_FECrsMatrix* libMesh::EpetraMatrix< T >::_mat

private

实际Epetra数据类型来保存矩阵条目。

在文件 trilinos_epetra_matrix.h 第 331 行定义.

参考自 libMesh::EpetraMatrix< T >::EpetraMatrix(), libMesh::EpetraMatrix< T >::get_transpose(), libMesh::EpetraMatrix< T >::mat() , 以及 libMesh::EpetraMatrix< T >::swap().

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 行定义.

template<typename T>

bool libMesh::EpetraMatrix< T >::_use_transpose

private

手动跟踪是否手动进行了转置。

在文件 trilinos_epetra_matrix.h 第 351 行定义.

参考自 libMesh::EpetraMatrix< T >::get_transpose().

---

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

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