定义用于有限元计算的稠密向量类。该类基本上是为了补充 DenseMatrix 类而设计的。它相对于 std::vector 具有额外的功能，使其在有限元中特别有用，特别是对于方程组。所有重写的虚拟函数都在 dense_vector_base.h 中有文档说明。更多...

#include <dof_map.h>

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

[图例]

Public 成员函数
	DenseVector (const unsigned int n=0)
	构造函数。创建一个维数为 `n` 的稠密向量。更多...

	DenseVector (const unsigned int n, const T &val)
	构造函数。创建一个维数为 `n，所有条目值为` `val` 的稠密向量。更多...

template<typename T2 >
	DenseVector (const DenseVector< T2 > &other_vector)
	复制构造函数。更多...

template<typename T2 >
	DenseVector (const std::vector< T2 > &other_vector)
	从 `std::vector` 复制构造函数。更多...

template<typename T2 >
	DenseVector (std::initializer_list< T2 > init_list)
	初始值列表构造函数。更多...

	DenseVector (DenseVector &&)=default
	这五个特殊函数可以在该类中默认实现，因为它本身不管理任何内存。更多...

	DenseVector (const DenseVector &)=default

DenseVector &	operator= (const DenseVector &)=default

DenseVector &	operator= (DenseVector &&)=default

virtual	~DenseVector ()=default

virtual unsigned int	size () const overridefinal

virtual bool	empty () const overridefinal

virtual void	zero () overridefinal
	将向量中的每个元素设置为0。由于派生类中的存储方法可能不同，需要将其声明为纯虚函数。更多...

const T &	operator() (const unsigned int i) const

T &	operator() (const unsigned int i)

virtual T	el (const unsigned int i) const overridefinal

virtual T &	el (const unsigned int i) overridefinal

template<typename T2 >
DenseVector< T > &	operator= (const DenseVector< T2 > &other_vector)
	赋值运算符。更多...

void	swap (DenseVector< T > &other_vector)
	STL 风格的交换方法。更多...

void	resize (const unsigned int n)
	调整向量的大小。将所有元素设置为0。更多...

template<typename T2 >
void	append (const DenseVector< T2 > &other_vector)
	将其他向量的额外条目附加到（调整大小但不改变）向量。更多...

void	scale (const T factor)
	将向量中的每个元素乘以 `factor。` 更多...

DenseVector< T > &	operator*= (const T factor)
	将向量中的每个元素乘以 `factor。` 更多...

template<typename T2 , typename T3 >
boostcopy::enable_if_c < ScalarTraits< T2 >::value, void >::type	add (const T2 factor, const DenseVector< T3 > &vec)
	将 `factor` 乘以 `vec` 添加到该向量。这应该仅在 T += T2 * T3 是有效的 C++ 且 T2 是标量的情况下起作用。返回类型是 void。更多...

template<typename T2 >
CompareTypes< T, T2 >::supertype	dot (const DenseVector< T2 > &vec) const

template<typename T2 >
CompareTypes< T, T2 >::supertype	indefinite_dot (const DenseVector< T2 > &vec) const

template<typename T2 >
bool	operator== (const DenseVector< T2 > &vec) const

template<typename T2 >
bool	operator!= (const DenseVector< T2 > &vec) const

template<typename T2 >
DenseVector< T > &	operator+= (const DenseVector< T2 > &vec)
	将 `vec` 添加到该向量。更多...

template<typename T2 >
DenseVector< T > &	operator-= (const DenseVector< T2 > &vec)
	从该向量中减去 `vec。` 更多...

Real	min () const

Real	max () const

Real	l1_norm () const

Real	l2_norm () const

Real	linfty_norm () const

void	get_principal_subvector (unsigned int sub_n, DenseVector< T > &dest) const
	将大小为 `sub_n（即前` `sub_n` 个条目）的主子向量放入 `dest。` 更多...

std::vector< T > &	get_values ()

const std::vector< T > &	get_values () const

void	print (std::ostream &os) const
	将向量漂亮地打印到 `stdout。` 更多...

void	print_scientific (std::ostream &os, unsigned precision=8) const
	以科学计数法在额外的小数位数下打印向量的条目。更多...

Private 属性
std::vector< T >	_val
	实际数据值，存储为一维数组。更多...

详细描述

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

定义用于有限元计算的稠密向量类。该类基本上是为了补充 DenseMatrix 类而设计的。它相对于 std::vector 具有额外的功能，使其在有限元中特别有用，特别是对于方程组。所有重写的虚拟函数都在 dense_vector_base.h 中有文档说明。

作者: Benjamin S. Kirk

日期: 2003

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

构造及析构函数说明

template<typename T >

libMesh::DenseVector< T >::DenseVector ( const unsigned int n = 0 )

inlineexplicit

构造函数。创建一个维数为 n 的稠密向量。

参数

n 向量的维数。

在文件 dense_vector.h 第 319 行定义.

                                                 :
   _val (n, T{})
 {
 }

template<typename T>

libMesh::DenseVector< T >::DenseVector	(	const unsigned int	n,
		const T &	val
	)

inlineexplicit

构造函数。创建一个维数为 n，所有条目值为 val 的稠密向量。

参数

n	向量的维数。
val	所有条目的初始值。

在文件 dense_vector.h 第 327 行定义.

                                            :
   _val (n, val)
 {
 }

template<typename T >

template<typename T2 >

libMesh::DenseVector< T >::DenseVector ( const DenseVector< T2 > & other_vector )

inline

复制构造函数。

参数

other_vector 要复制的另一个向量。

在文件 dense_vector.h 第 338 行定义.

参考 libMesh::DenseVector< T >::_val.

                                                                  :
   DenseVectorBase<T>()
 {
   const std::vector<T2> & other_vals = other_vector.get_values();
 
   _val.clear();
 
   const int N = cast_int<int>(other_vals.size());
   _val.reserve(N);
 
   for (int i=0; i<N; i++)
     _val.push_back(other_vals[i]);
 }

template<typename T >

template<typename T2 >

libMesh::DenseVector< T >::DenseVector ( const std::vector< T2 > & other_vector )

inline

从 std::vector 复制构造函数。

参数

other_vector 要复制的另一个向量。

在文件 dense_vector.h 第 357 行定义.

                                                                :
   _val(other_vector)
 {
 }

template<typename T >

template<typename T2 >

libMesh::DenseVector< T >::DenseVector ( std::initializer_list< T2 > init_list )

inline

初始值列表构造函数。

参数

init_list 初始化值列表。

在文件 dense_vector.h 第 366 行定义.

                                                               :
   _val(init_list.begin(), init_list.end())
 {
 }

template<typename T>

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

default

这五个特殊函数可以在该类中默认实现，因为它本身不管理任何内存。

template<typename T>

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

default

template<typename T>

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

virtualdefault

成员函数说明

template<typename T >

template<typename T2 , typename T3 >

boostcopy::enable_if_c< ScalarTraits< T2 >::value, void >::type libMesh::DenseVector< T >::add	(	const T2	factor,
		const DenseVector< T3 > &	vec
	)

inline

将 factor 乘以 vec 添加到该向量。这应该仅在 T += T2 * T3 是有效的 C++ 且 T2 是标量的情况下起作用。返回类型是 void。

返回: 对 *this 的引用。

参数

factor	乘法因子。
vec	与该向量相乘的向量。

在文件 dense_vector.h 第 485 行定义.

参考自 libMesh::DenseMatrix< T >::vector_mult_add().

 {
   libmesh_assert_equal_to (this->size(), vec.size());
 
   const int N = cast_int<int>(_val.size());
   for (int i=0; i<N; i++)
     (*this)(i) += static_cast<T>(factor)*vec(i);
 }

template<typename T >

template<typename T2 >

void libMesh::DenseVector< T >::append ( const DenseVector< T2 > & other_vector )

inline

将其他向量的额外条目附加到（调整大小但不改变）向量。

参数

other_vector 要附加的其他向量。

在文件 dense_vector.h 第 416 行定义.

 {
   const std::vector<T2> & other_vals = other_vector.get_values();
 
   _val.reserve(this->size() + other_vals.size());
   _val.insert(_val.end(), other_vals.begin(), other_vals.end());
 }

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::DenseVector< T >::dot ( const DenseVector< T2 > & vec ) const

inline

返回: *this 与 vec 的点积。

在复数值的情况下，使用 vec 的复共轭。

参数

vec	与 *this 相乘的向量。

在文件 dense_vector.h 第 500 行定义.

参考 libMesh::libmesh_conj().

 {
   if (!_val.size())
     return 0.;
 
   libmesh_assert_equal_to (this->size(), vec.size());
 
 #ifdef LIBMESH_HAVE_EIGEN
   // We reverse the order of the arguments to dot() here since
   // the convention in Eigen is to take the complex conjugate of the
   // *first* argument, while ours is to take the complex conjugate of
   // the second.
   return Eigen::Map<const typename Eigen::Matrix<T2, Eigen::Dynamic, 1>>(vec.get_values().data(), vec.size())
     .dot(Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()));
 #else
   typename CompareTypes<T, T2>::supertype val = 0.;
 
   const int N = cast_int<int>(_val.size());
   // The following pragma tells clang's vectorizer that it is safe to
   // reorder floating point operations for this loop.
 #ifdef __clang__
 #pragma clang loop vectorize(enable)
 #endif
   for (int i=0; i<N; i++)
     val += (*this)(i)*libmesh_conj(vec(i));
 
   return val;
 #endif
 }

template<typename T>

virtual T libMesh::DenseVector< T >::el ( const unsigned int i ) const

inlinefinaloverridevirtual

返回: 向量的 (i) 元素。

参数

i 元素的索引。

实现了 libMesh::DenseVectorBase< T >.

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

136 { return (*this)(i); }

template<typename T>

virtual T& libMesh::DenseVector< T >::el ( const unsigned int i )

inlinefinaloverridevirtual

返回: 向量的 (i) 元素的可写引用。

参数

i 元素的索引。

实现了 libMesh::DenseVectorBase< T >.

在文件 dense_vector.h 第 138 行定义.

139 { return (*this)(i); }

template<typename T>

virtual bool libMesh::DenseVector< T >::empty ( ) const

inlinefinaloverridevirtual

返回: 如果 size() 为 0，则为 true。

重载 libMesh::DenseVectorBase< T > .

在文件 dense_vector.h 第 116 行定义.

参考自 libMesh::NumericVector< T >::add_vector() , 以及 libMesh::NumericVector< T >::insert().

117 { return _val.empty(); }

libMesh::DenseVector::_val

std::vector< T > _val

实际数据值，存储为一维数组。

Definition: dense_vector.h:310

template<typename T>

void libMesh::DenseVector< T >::get_principal_subvector	(	unsigned int	sub_n,
		DenseVector< T > &	dest
	)		const

inline

将大小为 sub_n（即前 sub_n 个条目）的主子向量放入 dest。

参数

sub_n	主子向量的大小。
dest	存储主子向量的目标向量。

在文件 dense_vector.h 第 721 行定义.

 {
   libmesh_assert_less_equal ( sub_n, this->size() );
 
   dest.resize(sub_n);
   const int N = cast_int<int>(sub_n);
   for (int i=0; i<N; i++)
     dest(i) = _val[i];
 }

template<typename T>

std::vector<T>& libMesh::DenseVector< T >::get_values ( )

inline

返回: 对底层数据存储向量的引用。

注意：这应该谨慎使用（即不应更改向量的大小等），但用于与期望简单数组的低级 BLAS 例程进行交互时很有用。

在文件 dense_vector.h 第 298 行定义.

参考自 libMesh::DenseMatrix< T >::_evd_lapack(), libMesh::DenseMatrix< T >::_lu_back_substitute_lapack(), libMesh::DenseMatrix< T >::_matvec_blas() , 以及 libMesh::DenseMatrix< T >::_svd_solve_lapack().

298 { return _val; }

libMesh::DenseVector::_val

std::vector< T > _val

实际数据值，存储为一维数组。

Definition: dense_vector.h:310

template<typename T>

const std::vector<T>& libMesh::DenseVector< T >::get_values ( ) const

inline

返回: 对底层数据存储向量的常量引用。

在文件 dense_vector.h 第 303 行定义.

303 { return _val; }

libMesh::DenseVector::_val

std::vector< T > _val

实际数据值，存储为一维数组。

Definition: dense_vector.h:310

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::DenseVector< T >::indefinite_dot ( const DenseVector< T2 > & vec ) const

inline

返回: *this 与 vec 的点积。

在复数值的情况下，不使用 vec 的复共轭。

参数

vec	与 *this 相乘的向量。

在文件 dense_vector.h 第 533 行定义.

 {
   libmesh_assert_equal_to (this->size(), vec.size());
 
   typename CompareTypes<T, T2>::supertype val = 0.;
 
   const int N = cast_int<int>(_val.size());
   for (int i=0; i<N; i++)
     val += (*this)(i)*(vec(i));
 
   return val;
 }

template<typename T >

Real libMesh::DenseVector< T >::l1_norm ( ) const

inline

返回: 向量的 -范数，即条目的绝对值之和。

在文件 dense_vector.h 第 650 行定义.

参考 std::abs() , 以及 libMesh::Real.

 {
   if (!_val.size())
     return 0.;
 
 #ifdef LIBMESH_HAVE_EIGEN
   return Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()).template lpNorm<1>();
 #else
   Real my_norm = 0.;
   const int N = cast_int<int>(_val.size());
   for (int i=0; i!=N; i++)
     my_norm += std::abs((*this)(i));
 
   return my_norm;
 #endif
 }

template<typename T >

Real libMesh::DenseVector< T >::l2_norm ( ) const

inline

返回: 向量的 -范数，即条目平方和的平方根。

在文件 dense_vector.h 第 671 行定义.

参考 std::norm(), libMesh::TensorTools::norm_sq(), libMesh::Real , 以及 std::sqrt().

 {
   if (!_val.size())
     return 0.;
 
 #ifdef LIBMESH_HAVE_EIGEN
   return Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()).norm();
 #else
   Real my_norm = 0.;
   const int N = cast_int<int>(_val.size());
   // The following pragma tells clang's vectorizer that it is safe to
   // reorder floating point operations for this loop.
 #ifdef __clang__
 #pragma clang loop vectorize(enable)
 #endif
   for (int i=0; i!=N; i++)
     my_norm += TensorTools::norm_sq((*this)(i));
 
   return sqrt(my_norm);
 #endif
 }

template<typename T >

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

inline

返回: 向量的 $l_\infty$ -范数，即条目的最大绝对值。

在文件 dense_vector.h 第 697 行定义.

参考 libMesh::TensorTools::norm_sq(), libMesh::Real , 以及 std::sqrt().

 {
   if (!_val.size())
     return 0.;
 
 #ifdef LIBMESH_HAVE_EIGEN
   return Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()).template lpNorm<Eigen::Infinity>();
 #else
   Real my_norm = TensorTools::norm_sq((*this)(0));
 
   const int N = cast_int<int>(_val.size());
   for (int i=1; i!=N; i++)
     {
       Real current = TensorTools::norm_sq((*this)(i));
       my_norm = (my_norm > current? my_norm : current);
     }
   return sqrt(my_norm);
 #endif
 }

template<typename T >

Real libMesh::DenseVector< T >::max ( ) const

inline

返回: 向量的最大条目，或者在复数的情况下是最大的实部。

在文件 dense_vector.h 第 632 行定义.

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

 {
   libmesh_assert (this->size());
   Real my_max = libmesh_real((*this)(0));
 
   const int N = cast_int<int>(_val.size());
   for (int i=1; i!=N; i++)
     {
       Real current = libmesh_real((*this)(i));
       my_max = (my_max > current? my_max : current);
     }
   return my_max;
 }

template<typename T >

Real libMesh::DenseVector< T >::min ( ) const

inline

返回: 向量的最小条目，或者在复数的情况下是最小的实部。

在文件 dense_vector.h 第 614 行定义.

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

 {
   libmesh_assert (this->size());
   Real my_min = libmesh_real((*this)(0));
 
   const int N = cast_int<int>(_val.size());
   for (int i=1; i!=N; i++)
     {
       Real current = libmesh_real((*this)(i));
       my_min = (my_min < current? my_min : current);
     }
   return my_min;
 }

template<typename T >

template<typename T2 >

bool libMesh::DenseVector< T >::operator!= ( const DenseVector< T2 > & vec ) const

inline

返回: 如果 vec 与该向量不完全相等，则为 true，否则为 false。

参数

vec	与 *this 进行比较的向量。

在文件 dense_vector.h 第 566 行定义.

 {
   libmesh_assert_equal_to (this->size(), vec.size());
 
   const int N = cast_int<int>(_val.size());
   for (int i=0; i<N; i++)
     if ((*this)(i) != vec(i))
       return true;
 
   return false;
 }

template<typename T >

const T & libMesh::DenseVector< T >::operator() ( const unsigned int i ) const

inline

返回: 向量的第 i 个条目的常量引用。

参数

i 条目的索引。

在文件 dense_vector.h 第 439 行定义.

 {
   libmesh_assert_less (i, _val.size());
 
   return _val[i];
 }

template<typename T >

T & libMesh::DenseVector< T >::operator() ( const unsigned int i )

inline

返回: 向量的第 i 个条目的可写引用。

参数

i 条目的索引。

在文件 dense_vector.h 第 450 行定义.

 {
   libmesh_assert_less (i, _val.size());
 
   return _val[i];
 }

template<typename T>

DenseVector< T > & libMesh::DenseVector< T >::operator*= ( const T factor )

inline

将向量中的每个元素乘以 factor。

返回: 对 *this 的引用。

参数

factor 缩放因子。

在文件 dense_vector.h 第 472 行定义.

 {
   this->scale(factor);
   return *this;
 }

template<typename T >

template<typename T2 >

DenseVector< T > & libMesh::DenseVector< T >::operator+= ( const DenseVector< T2 > & vec )

inline

将 vec 添加到该向量。

返回: 对 *this 的引用。

参数

vec 要添加的向量。

在文件 dense_vector.h 第 583 行定义.

 {
   libmesh_assert_equal_to (this->size(), vec.size());
 
   const int N = cast_int<int>(_val.size());
   for (int i=0; i<N; i++)
     (*this)(i) += vec(i);
 
   return *this;
 }

template<typename T >

template<typename T2 >

DenseVector< T > & libMesh::DenseVector< T >::operator-= ( const DenseVector< T2 > & vec )

inline

从该向量中减去 vec。

返回: 对 *this 的引用。

参数

vec 要减去的向量。

在文件 dense_vector.h 第 599 行定义.

 {
   libmesh_assert_equal_to (this->size(), vec.size());
 
   const int N = cast_int<int>(_val.size());
   for (int i=0; i<N; i++)
     (*this)(i) -= vec(i);
 
   return *this;
 }

template<typename T>

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

default

template<typename T>

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

default

template<typename T >

template<typename T2 >

DenseVector< T > & libMesh::DenseVector< T >::operator= ( const DenseVector< T2 > & other_vector )

inline

赋值运算符。

返回: 对 *this 的引用。

参数

other_vector 要复制的另一个向量。

在文件 dense_vector.h 第 376 行定义.

 {
   const std::vector<T2> & other_vals = other_vector.get_values();
 
   _val.clear();
 
   const int N = cast_int<int>(other_vals.size());
   _val.reserve(N);
 
   for (int i=0; i<N; i++)
     _val.push_back(other_vals[i]);
 
   return *this;
 }

template<typename T >

template<typename T2 >

bool libMesh::DenseVector< T >::operator== ( const DenseVector< T2 > & vec ) const

inline

返回: 如果 vec 与该向量完全相等，则为 true，否则为 false。

参数

vec	与 *this 进行比较的向量。

在文件 dense_vector.h 第 549 行定义.

 {
   libmesh_assert_equal_to (this->size(), vec.size());
 
   const int N = cast_int<int>(_val.size());
   for (int i=0; i<N; i++)
     if ((*this)(i) != vec(i))
       return false;
 
   return true;
 }

template<typename T >

void libMesh::DenseVectorBase< T >::print ( std::ostream & os ) const

inherited

将向量漂亮地打印到 stdout。

参数

os 输出流。

在文件 dense_vector_base.C 第 51 行定义.

 {
   for (auto i : make_range(this->size()))
     os << std::setw(8)
        << this->el(i)
        << std::endl;
 }

template<typename T >

void libMesh::DenseVectorBase< T >::print_scientific	(	std::ostream &	os,
		unsigned	precision = `8`
	)		const

inherited

以科学计数法在额外的小数位数下打印向量的条目。

参数

os	输出流。
precision	小数点后的精度。

在文件 dense_vector_base.C 第 31 行定义.

 {
   // save the initial format flags
   std::ios_base::fmtflags os_flags = os.flags();
 
   // Print the vector entries.
   for (auto i : make_range(this->size()))
     os << std::setw(10)
        << std::scientific
        << std::setprecision(precision)
        << this->el(i)
        << std::endl;
 
   // reset the original format flags
   os.flags(os_flags);
 }

template<typename T >

void libMesh::DenseVector< T >::resize ( const unsigned int n )

inline

调整向量的大小。将所有元素设置为0。

参数

n 新的向量大小。

在文件 dense_vector.h 第 404 行定义.

参考 libMesh::zero.

 {
   _val.resize(n);
 
   zero();
 }

template<typename T>

void libMesh::DenseVector< T >::scale ( const T factor )

inline

将向量中的每个元素乘以 factor。

参数

factor 缩放因子。

在文件 dense_vector.h 第 461 行定义.

 {
   const int N = cast_int<int>(_val.size());
   for (int i=0; i<N; i++)
     _val[i] *= factor;
 }

template<typename T>

virtual unsigned int libMesh::DenseVector< T >::size ( ) const

inlinefinaloverridevirtual

返回: 向量的大小。

实现了 libMesh::DenseVectorBase< T >.

在文件 dense_vector.h 第 111 行定义.

   {
     return cast_int<unsigned int>(_val.size());
   }

template<typename T>

void libMesh::DenseVector< T >::swap ( DenseVector< T > & other_vector )

inline

STL 风格的交换方法。

参数

other_vector 要交换的另一个向量。

在文件 dense_vector.h 第 395 行定义.

 {
   _val.swap(other_vector._val);
 }

template<typename T >

void libMesh::DenseVector< T >::zero ( )

inlinefinaloverridevirtual

将向量中的每个元素设置为0。由于派生类中的存储方法可能不同，需要将其声明为纯虚函数。

注解: 这是一个纯虚函数，需要在派生类中实现。

实现了 libMesh::DenseVectorBase< T >.

在文件 dense_vector.h 第 428 行定义.

参考自 libMesh::CompositeFEMFunction< Output >::operator()() , 以及 libMesh::CompositeFunction< Output >::operator()().

 {
   std::fill (_val.begin(),
              _val.end(),
              T{});
 }

类成员变量说明

template<typename T>

std::vector<T> libMesh::DenseVector< T >::_val

private

实际数据值，存储为一维数组。

在文件 dense_vector.h 第 310 行定义.

参考自 libMesh::DenseVector< T >::DenseVector(), libMesh::DenseVector< Output >::empty(), libMesh::DenseVector< Output >::get_values() , 以及 libMesh::DenseVector< Output >::size().

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

/home/lwz/libmesh/include/base/dof_map.h
/home/lwz/libmesh/include/numerics/dense_vector.h

Public 成员函数

Private 属性

详细描述

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

构造及析构函数说明

成员函数说明

类成员变量说明

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