通用的Shell矩阵，即一个仅定义其对向量的作用的矩阵。此类包含必须在派生类中重写的纯虚拟成员。更多...

#include <eigen_preconditioner.h>

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

Public 成员函数
	ShellMatrix (const Parallel::Communicator &comm_in)
	构造函数；更多...

virtual	~ShellMatrix ()
	析构函数。更多...

virtual numeric_index_type	m () const =0

virtual numeric_index_type	n () const =0

virtual void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const =0
	将矩阵与 `arg` 相乘并将结果存储在 `dest` 中。更多...

virtual void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const =0
	将矩阵与 `arg` 相乘并将结果添加到 `dest` 中。更多...

virtual void	get_diagonal (NumericVector< T > &dest) const =0
	将矩阵的对角线部分复制到 `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 属性
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::ShellMatrix< T >

通用的Shell矩阵，即一个仅定义其对向量的作用的矩阵。此类包含必须在派生类中重写的纯虚拟成员。

作者: Tim Kroeger

日期: 2008

在文件 eigen_preconditioner.h 第 36 行定义.

成员类型定义说明

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

inline

构造函数；

参数

comm_in 通信器对象

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

                                                                  :
   ParallelObject(comm_in),
   _dof_map(nullptr)
 {}

template<typename T >

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

inlinevirtual

析构函数。

返回: 无

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

158 {}

成员函数说明

template<typename T>

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

inline

附加要使用的 DofMap 指针。

参数

dof_map 要附加的 DofMap 对象

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

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

121 { _dof_map = &dof_map; }

libMesh::ShellMatrix::_dof_map

DofMap const * _dof_map

与此对象关联的 DofMap 对象。

Definition: shell_matrix.h:141

template<typename T >

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

static

使用指定的线性求解器包构建一个 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 ( )

inlinevirtual

清除对象，释放内存。

注解: 未实现

被 libMesh::PetscShellMatrix< T > 重载.

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

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>

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

pure virtual

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

参数

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

在 libMesh::PetscShellMatrix< T >, libMesh::SumShellMatrix< T >, libMesh::TensorShellMatrix< T > , 以及 libMesh::SparseShellMatrix< T > 内被实现.

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

inlinevirtual

初始化对象。

注解: 未实现

被 libMesh::PetscShellMatrix< T > 重载.

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

135 { libmesh_error_msg ("Not implemented yet"); }

template<typename T>

virtual numeric_index_type libMesh::ShellMatrix< T >::m ( ) const

pure virtual

返回: m ，矩阵的行维度，其中矩阵是 $M \times N$ 。; 返回行维度

在 libMesh::PetscShellMatrix< T >, libMesh::SumShellMatrix< T >, libMesh::TensorShellMatrix< T > , 以及 libMesh::SparseShellMatrix< T > 内被实现.

template<typename T>

virtual numeric_index_type libMesh::ShellMatrix< T >::n ( ) const

pure virtual

返回: n ，矩阵的列维度，其中矩阵是 $M \times N$ 。; 返回列维度

在 libMesh::PetscShellMatrix< T >, libMesh::SumShellMatrix< T >, libMesh::TensorShellMatrix< T > , 以及 libMesh::SparseShellMatrix< T > 内被实现.

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

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:132

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

pure virtual

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

参数

dest	存储结果的数值向量
arg	输入向量

在 libMesh::PetscShellMatrix< T >, libMesh::SumShellMatrix< T >, libMesh::TensorShellMatrix< T > , 以及 libMesh::SparseShellMatrix< T > 内被实现.

template<typename T>

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

pure virtual

将矩阵与 arg 相乘并将结果添加到 dest 中。

参数

dest	存储结果的数值向量
arg	输入向量

在 libMesh::PetscShellMatrix< T >, libMesh::SumShellMatrix< T >, libMesh::TensorShellMatrix< T > , 以及 libMesh::SparseShellMatrix< T > 内被实现.

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

类成员变量说明

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

protected

与此对象关联的 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().

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/eigen_preconditioner.h
/home/lwz/libmesh/include/numerics/shell_matrix.h
/home/lwz/libmesh/src/numerics/shell_matrix.C

Public 成员函数

静态 Public 成员函数

Protected 类型

Protected 成员函数

Protected 属性

静态 Protected 属性

详细描述

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

成员类型定义说明

构造及析构函数说明

成员函数说明

类成员变量说明

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