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

允许将任何SparseMatrix对象用作壳矩阵的类。 更多...

#include <sparse_shell_matrix.h>

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

Public 成员函数
	SparseShellMatrix (const SparseMatrix< T > &new_m)
	Constructor; 接受稀疏矩阵的引用。稀疏矩阵本身必须在其他地方存储。 更多...
virtual	~SparseShellMatrix ()
	Destructor（析构函数）。 更多...
virtual numeric_index_type	m () const override
	获取矩阵的行维度。 更多...
virtual numeric_index_type	n () const override
	获取矩阵的列维度。 更多...
virtual void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const override
	将矩阵与参数arg相乘，并将结果存储在dest中。 更多...
virtual void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const override
	将矩阵与参数arg相乘，然后将结果添加到dest中。 更多...
virtual void	get_diagonal (NumericVector< T > &dest) const override
	将矩阵的对角部分复制到dest中。 更多...
void	attach_dof_map (const DofMap &dof_map)
	附加要使用的 DofMap 指针。 更多...
virtual void	clear ()
	清除对象，释放内存。 更多...
virtual void	init ()
	初始化对象。 更多...

静态 Public 成员函数
static std::unique_ptr < ShellMatrix< T > >	build (const Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package())
	使用指定的线性求解器包构建一个 ShellMatrix<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 成员函数
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 属性
const SparseMatrix< T > &	_m
	稀疏矩阵。 更多...
DofMap const *	_dof_map
	与此对象关联的 DofMap 对象。 更多...

静态 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::SparseShellMatrix< T >

允许将任何SparseMatrix对象用作壳矩阵的类。

这个类允许使用任何SparseMatrix对象作为一个壳矩阵。以下是该类的详细注释：

在文件 sparse_shell_matrix.h 第 40 行定义.

成员类型定义说明

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::SparseShellMatrix< T >::SparseShellMatrix ( const SparseMatrix< T > &  new_m )

inlineexplicit

Constructor; 接受稀疏矩阵的引用。稀疏矩阵本身必须在其他地方存储。

参数

new_m

稀疏矩阵的引用

在文件 sparse_shell_matrix.h 第 108 行定义.

                                                                     :
  ShellMatrix<T>(new_m.comm()),
  _m(new_m)
{}

template<typename T >

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

inlinevirtual

Destructor（析构函数）。

在文件 sparse_shell_matrix.h 第 117 行定义.

{}

成员函数说明

template<typename T>

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

inlineinherited

附加要使用的 DofMap 指针。

参数

dof_map

要附加的 DofMap 对象

在文件 shell_matrix.h 第 120 行定义.

参考 libMesh::ShellMatrix< T >::_dof_map.

  { _dof_map = &dof_map; }

template<typename T >

std::unique_ptr< ShellMatrix< T > > libMesh::ShellMatrix< T >::build ( const Parallel::Communicator &  comm, const SolverPackage  solver_package = libMesh::default_solver_package()  )

staticinherited

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

参数

comm	通信器对象
solver_package	线性求解器包

返回

返回一个包含 ShellMatrix<T> 的 std::unique_ptr

在文件 shell_matrix.C 第 32 行定义.

参考 libMesh::libmesh_ignore().

  {
    // Avoid unused parameter warnings when no solver packages are enabled.
    libmesh_ignore(comm);

    // Build the appropriate vector
    switch (solver_package)
      {
  #ifdef LIBMESH_HAVE_PETSC
      case PETSC_SOLVERS:
        return std::make_unique<PetscShellMatrix<T>>(comm);
  #endif

      default:
        libmesh_error_msg("ERROR:  Unrecognized solver package: " << solver_package);
      }
  }

template<typename T>

virtual void libMesh::ShellMatrix< T >::clear ( )

inlinevirtualinherited

清除对象，释放内存。

注解

未实现

被 libMesh::PetscShellMatrix< T > 重载.

在文件 shell_matrix.h 第 128 行定义.

{ libmesh_error_msg ("Not implemented yet"); }

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 >

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

inlineoverridevirtual

将矩阵的对角部分复制到dest中。

参数

dest	存储对角元素的数值向量

实现了 libMesh::ShellMatrix< T >.

在文件 sparse_shell_matrix.h 第 142 行定义.

{
  _m.get_diagonal(dest);
}

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
}

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::ShellMatrix< T >::init ( )

inlinevirtualinherited

初始化对象。

注解

未实现

被 libMesh::PetscShellMatrix< T > 重载.

在文件 shell_matrix.h 第 135 行定义.

{ libmesh_error_msg ("Not implemented yet"); }

template<typename T >

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

inlineoverridevirtual

获取矩阵的行维度。

返回

行维度

实现了 libMesh::ShellMatrix< T >.

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

{
  return _m.m();
}

template<typename T >

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

inlineoverridevirtual

获取矩阵的列维度。

返回

列维度

实现了 libMesh::ShellMatrix< T >.

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

{
  return _m.n();
}

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

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 >

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

overridevirtual

将矩阵与参数arg相乘，并将结果存储在dest中。

参数

dest	存储结果的数值向量
arg	用于乘法的数值向量

实现了 libMesh::ShellMatrix< T >.

在文件 sparse_shell_matrix.C 第 27 行定义.

{
  _m.vector_mult(dest,arg);
}

template<typename T >

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

overridevirtual

将矩阵与参数arg相乘，然后将结果添加到dest中。

参数

dest	存储结果的数值向量
arg	用于乘法的数值向量

实现了 libMesh::ShellMatrix< T >.

在文件 sparse_shell_matrix.C 第 36 行定义.

{
  _m.vector_mult_add(dest,arg);
}

类成员变量说明

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

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

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

template<typename T>

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

protectedinherited

与此对象关联的 DofMap 对象。

在文件 shell_matrix.h 第 141 行定义.

参考自 libMesh::ShellMatrix< T >::attach_dof_map().

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 >

const SparseMatrix<T>& libMesh::SparseShellMatrix< T >::_m

protected

稀疏矩阵。

在文件 sparse_shell_matrix.h 第 99 行定义.

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

---

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

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