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

这个类允许使用 PETSc shell 矩阵。 所有覆盖的虚拟函数都在 shell_matrix.h 中有文档说明。 更多...

#include <petsc_shell_matrix.h>

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

Public 成员函数
	PetscShellMatrix (const Parallel::Communicator &comm_in)
	构造函数。 更多...
virtual	~PetscShellMatrix ()=default
	默认虚拟析构函数。 更多...
virtual numeric_index_type	m () const override
	获取矩阵的行数。 更多...
virtual numeric_index_type	n () const override
	获取矩阵的列数。 更多...
virtual numeric_index_type	local_m () const
	获取本地处理的矩阵行数。 更多...
virtual numeric_index_type	local_n () const
	获取本地处理的矩阵列数。 更多...
virtual void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const override
	执行矩阵与向量的乘法。 更多...
virtual void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const override
	执行矩阵与向量的乘法，并将结果添加到目标向量。 更多...
virtual void	get_diagonal (NumericVector< T > &dest) const override
	获取矩阵的对角线。 更多...
virtual void	clear () override
	清除矩阵的内部数据结构。 更多...
virtual void	init () override
	初始化矩阵。 更多...
virtual bool	initialized () const
	检查矩阵是否已初始化。 更多...
Mat	mat ()
	返回指向底层 PETSc Mat 对象的指针。调用此函数前必须调用 init()。 更多...
void	attach_dof_map (const DofMap &dof_map)
	附加要使用的 DofMap 指针。 更多...

静态 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 属性
WrappedPetsc< Mat >	_mat
	PETSc Shell 矩阵。 更多...
bool	_is_initialized
	表示矩阵是否已初始化的标志。 更多...
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::PetscShellMatrix< T >

这个类允许使用 PETSc shell 矩阵。 所有覆盖的虚拟函数都在 shell_matrix.h 中有文档说明。

作者

Fande Kong (fdkong.jd.com)

日期

2019

在文件 petsc_shell_matrix.h 第 57 行定义.

成员类型定义说明

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::PetscShellMatrix< T >::PetscShellMatrix ( const Parallel::Communicator &  comm_in )

inline

构造函数。

参数

comm_in

用于初始化的并行通信器。

在文件 petsc_shell_matrix.h 第 168 行定义.

                                                                          :
  ShellMatrix<T>(comm_in),
  _is_initialized(false)
{}

template<typename T >

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

virtualdefault

默认虚拟析构函数。

成员函数说明

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 >

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

overridevirtual

清除矩阵的内部数据结构。

重载 libMesh::ShellMatrix< T > .

在文件 petsc_shell_matrix.C 第 53 行定义.

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

{
  if (this->initialized())
    {
      _mat.destroy();
      this->_is_initialized = false;
    }
}

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

inlineoverridevirtual

获取矩阵的对角线。

参数

dest

存储对角线的向量。

实现了 libMesh::ShellMatrix< T >.

在文件 petsc_shell_matrix.h 第 235 行定义.

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

{
  // 确保传入的NumericVector确实是PetscVector
  PetscVector<T> & petsc_dest = cast_ref<PetscVector<T> &>(dest);

  PetscErrorCode ierr = MatGetDiagonal(_mat, petsc_dest.vec());
  LIBMESH_CHKERR(ierr);
}

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 >

void libMesh::PetscShellMatrix< T >::init ( )

overridevirtual

初始化矩阵。

重载 libMesh::ShellMatrix< T > .

在文件 petsc_shell_matrix.C 第 64 行定义.

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

{
  libmesh_assert(this->_dof_map);

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

  this->_is_initialized = true;


  const numeric_index_type my_m = this->_dof_map->n_dofs();
  const numeric_index_type my_n = my_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;


  PetscErrorCode ierr = 0;
  PetscInt m_global   = static_cast<PetscInt>(my_m);
  PetscInt n_global   = static_cast<PetscInt>(my_n);
  PetscInt m_local    = static_cast<PetscInt>(m_l);
  PetscInt n_local    = static_cast<PetscInt>(n_l);

  ierr = MatCreate(this->comm().get(), _mat.get());
  LIBMESH_CHKERR(ierr);
  ierr = MatSetSizes(_mat, m_local, n_local, m_global, n_global);
  LIBMESH_CHKERR(ierr);
  PetscInt blocksize  = static_cast<PetscInt>(this->_dof_map->block_size());
  ierr = MatSetBlockSize(_mat, blocksize);
  LIBMESH_CHKERR(ierr);

  ierr = MatSetType(_mat, MATSHELL);
  LIBMESH_CHKERR(ierr);

  // Is prefix information available somewhere? Perhaps pass in the system name?
  ierr = MatSetOptionsPrefix(_mat, "");
  LIBMESH_CHKERR(ierr);
  ierr = MatSetFromOptions(_mat);
  LIBMESH_CHKERR(ierr);
  ierr = MatSetUp(_mat);
  LIBMESH_CHKERR(ierr);
}

template<typename T >

bool libMesh::PetscShellMatrix< T >::initialized ( ) const

virtual

检查矩阵是否已初始化。

返回

如果矩阵已初始化，则返回 true；否则返回 false。

在文件 petsc_shell_matrix.C 第 108 行定义.

参考 libMesh::libMeshPrivateData::_is_initialized.

{
  return _is_initialized;
}

template<typename T >

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

inlinevirtual

获取本地处理的矩阵行数。

返回

返回本地处理的矩阵行数。

在文件 petsc_shell_matrix.h 第 206 行定义.

{
  PetscErrorCode ierr;
  PetscInt m;

  ierr = MatGetLocalSize(_mat, &m, nullptr);
  LIBMESH_CHKERR(ierr);

  return m;
}

template<typename T >

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

inlinevirtual

获取本地处理的矩阵列数。

返回

返回本地处理的矩阵列数。

在文件 petsc_shell_matrix.h 第 221 行定义.

{
  PetscErrorCode ierr;
  PetscInt n;

  ierr = MatGetLocalSize(_mat, nullptr, &n);
  LIBMESH_CHKERR(ierr);

  return n;
}

template<typename T >

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

inlineoverridevirtual

获取矩阵的行数。

返回

返回矩阵的行数。

实现了 libMesh::ShellMatrix< T >.

在文件 petsc_shell_matrix.h 第 177 行定义.

{
  PetscErrorCode ierr;
  PetscInt m;

  ierr = MatGetSize(_mat, &m, nullptr);
  LIBMESH_CHKERR(ierr);

  return m;
}

template<typename T >

Mat libMesh::PetscShellMatrix< T >::mat

(

)

返回指向底层 PETSc Mat 对象的指针。调用此函数前必须调用 init()。

返回

返回 PETSc Mat 对象的指针。

在文件 petsc_shell_matrix.C 第 114 行定义.

{
  libmesh_error_msg_if(!_mat, "A petsc shell matrix is not created yet. Please call init() first.");
  return _mat;
}

template<typename T >

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

inlineoverridevirtual

获取矩阵的列数。

返回

返回矩阵的列数。

实现了 libMesh::ShellMatrix< T >.

在文件 petsc_shell_matrix.h 第 192 行定义.

{
  PetscErrorCode ierr;
  PetscInt n;

  ierr = MatGetSize(_mat, nullptr, &n);
  LIBMESH_CHKERR(ierr);

  return 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::PetscShellMatrix< T >::vector_mult ( NumericVector< T > &  dest, const NumericVector< T > &  arg  ) const

overridevirtual

执行矩阵与向量的乘法。

参数

dest	结果向量。
arg	输入向量。

实现了 libMesh::ShellMatrix< T >.

在文件 petsc_shell_matrix.C 第 28 行定义.

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

{
  PetscVector<T> & petsc_dest = cast_ref<PetscVector<T> &>(dest);
  const PetscVector<T> & petsc_arg = cast_ref<const PetscVector<T> &>(arg);

  PetscErrorCode ierr = MatMult(_mat, petsc_arg.vec(), petsc_dest.vec());
  LIBMESH_CHKERR(ierr);
}

template<typename T >

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

overridevirtual

执行矩阵与向量的乘法，并将结果添加到目标向量。

参数

dest	结果向量。
arg	输入向量。

实现了 libMesh::ShellMatrix< T >.

在文件 petsc_shell_matrix.C 第 41 行定义.

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

{
  PetscVector<T> & petsc_dest = cast_ref<PetscVector<T> &>(dest);
  const PetscVector<T> & petsc_arg = cast_ref<const PetscVector<T> &>(arg);

  PetscErrorCode ierr = MatMultAdd(_mat, petsc_arg.vec(), petsc_dest.vec(), petsc_dest.vec());
  LIBMESH_CHKERR(ierr);
}

类成员变量说明

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 >

bool libMesh::PetscShellMatrix< T >::_is_initialized

protected

表示矩阵是否已初始化的标志。

在文件 petsc_shell_matrix.h 第 160 行定义.

template<typename T >

WrappedPetsc<Mat> libMesh::PetscShellMatrix< T >::_mat

protected

PETSc Shell 矩阵。

在文件 petsc_shell_matrix.h 第 155 行定义.

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/petsc_shell_matrix.h
• /home/lwz/libmesh/src/numerics/petsc_shell_matrix.C