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

EigenPreconditioner 类提供了对 Eigen 库中预处理器集合的接口。 更多...

#include <eigen_preconditioner.h>

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

Public 成员函数
	EigenPreconditioner (const libMesh::Parallel::Communicator &comm_in)
	构造函数。初始化 EigenPreconditioner 的数据结构。 更多...
virtual	~EigenPreconditioner ()
	析构函数。 更多...
virtual void	apply (const NumericVector< T > &x, NumericVector< T > &y) override
	应用预处理器操作。 更多...
virtual void	clear () override
	清空预处理器状态。 更多...
virtual void	init () override
	初始化预处理器。 更多...
bool	initialized () const
virtual void	setup ()
	每当 "操作可能已更改" 时都会调用此函数。 更多...
void	set_matrix (SparseMatrix< Number > &mat)
	设置要进行预处理的矩阵。 更多...
PreconditionerType	type () const
void	set_type (const PreconditionerType pct)
	设置要使用的预处理器类型。 更多...

静态 Public 成员函数
static std::unique_ptr < Preconditioner< T > >	build_preconditioner (const libMesh::Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package())
	构建一个 Preconditioner，使用由 solver_package 指定的线性求解器软件包， 并以 std::unique_ptr 包装结果以确保安全性。 更多...
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 属性
SparseMatrix< T > *	_matrix
	要进行预处理的矩阵 P... 更多...
PreconditionerType	_preconditioner_type
	枚举类型，表示要使用的预处理器类型。 更多...
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::EigenPreconditioner< T >

EigenPreconditioner 类提供了对 Eigen 库中预处理器集合的接口。

该类是一个模板类，处理不同数据类型 T 的情况。继承自 Preconditioner<T>。

作者

Benjamin Kirk

日期

2013

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

成员类型定义说明

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

inline

构造函数。初始化 EigenPreconditioner 的数据结构。

参数

comm_in

通信器对象，指定通信环境。

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

                                                                                       :
  Preconditioner<T>(comm_in)
{
}

template<typename T >

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

inlinevirtual

析构函数。

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

{
  this->clear ();
}

成员函数说明

template<typename T >

void libMesh::EigenPreconditioner< T >::apply ( const NumericVector< T > &  x, NumericVector< T > &  y  )

overridevirtual

应用预处理器操作。

给定输入向量 x，将结果存储在输出向量 y 中。

参数

x	输入向量。
y	输出向量。

实现了 libMesh::Preconditioner< T >.

在文件 eigen_preconditioner.C 第 34 行定义.

{
  libmesh_not_implemented();
}

template<typename T >

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

staticinherited

构建一个 Preconditioner，使用由 solver_package 指定的线性求解器软件包， 并以 std::unique_ptr 包装结果以确保安全性。

参数

comm	通信器对象
solver_package	求解器软件包（默认为 libMesh 的默认求解器软件包）

返回

返回一个包含 Preconditioner 指针的 std::unique_ptr

在文件 preconditioner.C 第 50 行定义.

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

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

  // Build and return the appropriate Preconditioner object.
  switch (solver_package)
    {

#ifdef LIBMESH_HAVE_PETSC
    case PETSC_SOLVERS:
      {
        return std::make_unique<PetscPreconditioner<T>>(comm);
      }
#endif

#ifdef LIBMESH_TRILINOS_HAVE_EPETRA
    case TRILINOS_SOLVERS:
      return std::make_unique<TrilinosPreconditioner<T>>(comm);
#endif

#ifdef LIBMESH_HAVE_EIGEN
    case EIGEN_SOLVERS:
      return std::make_unique<EigenPreconditioner<T>>(comm);
#endif

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

template<typename T >

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

inlineoverridevirtual

清空预处理器状态。

重载 libMesh::Preconditioner< T > .

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

{}

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

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

overridevirtual

初始化预处理器。

重载 libMesh::Preconditioner< T > .

在文件 eigen_preconditioner.C 第 43 行定义.

{
  libmesh_not_implemented();
}

template<typename T >

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

inlineinherited

返回

如果数据结构已初始化，则返回 true，否则返回 false。

在文件 preconditioner.h 第 87 行定义.

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

{ return _is_initialized; }

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::Preconditioner< T >::set_matrix ( SparseMatrix< Number > &  mat )

inherited

设置要进行预处理的矩阵。

参数

mat	要进行预处理的稀疏矩阵

返回

无

在文件 preconditioner.h 第 174 行定义.

参考 libMesh::libMeshPrivateData::_is_initialized.

{
  //如果矩阵发生变化，那么(可能)需要重新初始化。
  _is_initialized = false;
  _matrix = &mat;
}

template<typename T >

void libMesh::Preconditioner< T >::set_type ( const PreconditionerType  pct )

inherited

设置要使用的预处理器类型。

参数

pct

预处理器类型

返回

无

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

参考 libMesh::libMeshPrivateData::_is_initialized.

{
  //如果前置条件类型改变，我们(可能)需要重新初始化。
  _is_initialized = false;
  _preconditioner_type = pct;
}

template<typename T >

virtual void libMesh::Preconditioner< T >::setup ( )

inlinevirtualinherited

每当 "操作可能已更改" 时都会调用此函数。

这是您需要填充预处理矩阵的地方。

返回

无

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

{}

template<typename T >

PreconditionerType libMesh::Preconditioner< T >::type ( ) const

inlineinherited

返回

要使用的预处理器类型。

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

参考 libMesh::Preconditioner< T >::_preconditioner_type.

{ return _preconditioner_type; }

类成员变量说明

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

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

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

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::Preconditioner< T >::_is_initialized

protectedinherited

指示数据结构是否已初始化的标志。

在文件 preconditioner.h 第 158 行定义.

参考自 libMesh::Preconditioner< T >::initialized().

template<typename T >

SparseMatrix<T>* libMesh::Preconditioner< T >::_matrix

protectedinherited

要进行预处理的矩阵 P...

通常是线性系统的实际系统矩阵。

在文件 preconditioner.h 第 148 行定义.

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 >

PreconditionerType libMesh::Preconditioner< T >::_preconditioner_type

protectedinherited

枚举类型，表示要使用的预处理器类型。

在文件 preconditioner.h 第 153 行定义.

参考自 libMesh::Preconditioner< T >::type().

---

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

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