为有限元类型的计算定义密集子矩阵。在将元素刚度矩阵相加到全局矩阵之前存储非常有用，特别是在存在方程组时。所有重写的虚拟函数在 dense_matrix_base.h 中有文档。更多...

#include <dense_submatrix.h>

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

Public 成员函数
	DenseSubMatrix (DenseMatrix< T > &new_parent, const unsigned int ioff=0, const unsigned int joff=0, const unsigned int m=0, const unsigned int n=0)
	构造函数。创建矩阵 `parent` 的密集子矩阵。子矩阵的维度为 $(m \times n)$ ，子矩阵的元素位于父矩阵中的位置。更多...

	DenseSubMatrix (DenseSubMatrix &&)=default
	The 5 special functions can be defaulted for this class, as it does not manage any memory itself. 更多...

	DenseSubMatrix (const DenseSubMatrix &)=default

DenseSubMatrix &	operator= (const DenseSubMatrix &)=default

DenseSubMatrix &	operator= (DenseSubMatrix &&)=default

virtual	~DenseSubMatrix ()=default

DenseMatrix< T > &	parent ()
	返回对父矩阵的引用。更多...

virtual void	zero () overridefinal
	覆盖基类的虚拟函数，将子矩阵的所有元素设置为零。更多...

T	operator() (const unsigned int i, const unsigned int j) const
	返回子矩阵的 (i,j) 元素。更多...

T &	operator() (const unsigned int i, const unsigned int j)
	返回子矩阵的 (i,j) 元素的可写引用。更多...

virtual T	el (const unsigned int i, const unsigned int j) const overridefinal
	覆盖基类的虚函数，返回子矩阵的 (i,j) 元素。更多...

virtual T &	el (const unsigned int i, const unsigned int j) overridefinal
	覆盖基类的虚函数，返回子矩阵的 (i,j) 元素的可写引用。更多...

virtual void	left_multiply (const DenseMatrixBase< T > &M2) overridefinal
	覆盖基类的虚函数，左乘子矩阵。更多...

virtual void	right_multiply (const DenseMatrixBase< T > &M3) overridefinal
	覆盖基类的虚函数，右乘子矩阵。更多...

void	reposition (const unsigned int ioff, const unsigned int joff, const unsigned int new_m, const unsigned int new_n)
	修改子矩阵在父矩阵中的位置。更多...

unsigned int	i_off () const
	返回子矩阵在父矩阵中的行偏移。更多...

unsigned int	j_off () const
	返回子矩阵在父矩阵中的列偏移。更多...

void	condense (const unsigned int i, const unsigned int j, const T val, DenseSubVector< T > &rhs)
	将矩阵的 (i,j) 元素压缩成值 `val` 对于施加边界条件在数值模拟中很有用。保持矩阵的对称性。更多...

unsigned int	m () const
	返回矩阵的行维度。更多...

unsigned int	n () const
	返回矩阵的列维度。更多...

void	print (std::ostream &os=libMesh::out) const
	漂亮地打印矩阵，默认为 `libMesh::out。` 更多...

void	print_scientific (std::ostream &os, unsigned precision=8) const
	以科学计数法格式打印矩阵。更多...

template<typename T2 , typename T3 >
boostcopy::enable_if_c < ScalarTraits< T2 >::value, void >::type	add (const T2 factor, const DenseMatrixBase< T3 > &mat)
	将 `factor` 添加到矩阵的每个元素。这应该仅在 T += T2 * T3 是有效的 C++，且 T2 是标量的情况下工作。返回类型是 void。更多...

DenseVector< T >	diagonal () const
	返回矩阵的对角线。更多...

Protected 成员函数
void	condense (const unsigned int i, const unsigned int j, const T val, DenseVectorBase< T > &rhs)
	将矩阵的 (i,j) 条目压缩出来，强制它取值为 `val。这对于在数值模拟中应用边界条件很有用。` 保留矩阵的对称性。更多...

静态 Protected 成员函数
static void	multiply (DenseMatrixBase< T > &M1, const DenseMatrixBase< T > &M2, const DenseMatrixBase< T > &M3)
	辅助函数 - 执行计算 M1 = M2 * M3 其中: M1 = (m x n) M2 = (m x p) M3 = (p x n) 更多...

Protected 属性
unsigned int	_m
	行维度。更多...

unsigned int	_n
	列维度。更多...

Private 属性
DenseMatrix< T > &	_parent_matrix
	包含该子矩阵的父矩阵。引用父矩阵的对象，表示该子矩阵属于哪个父矩阵。更多...

unsigned int	_i_off
	子矩阵在父矩阵中的行偏移。更多...

unsigned int	_j_off
	子矩阵在父矩阵中的列偏移。更多...

详细描述

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

为有限元类型的计算定义密集子矩阵。在将元素刚度矩阵相加到全局矩阵之前存储非常有用，特别是在存在方程组时。所有重写的虚拟函数在 dense_matrix_base.h 中有文档。

作者: Benjamin S. Kirk

日期: 2003

在文件 dense_submatrix.h 第 43 行定义.

构造及析构函数说明

template<typename T >

libMesh::DenseSubMatrix< T >::DenseSubMatrix	(	DenseMatrix< T > &	new_parent,
		const unsigned int	ioff = `0`,
		const unsigned int	joff = `0`,
		const unsigned int	m = `0`,
		const unsigned int	n = `0`
	)

inline

构造函数。创建矩阵 parent 的密集子矩阵。子矩阵的维度为 $(m \times n)$ ，子矩阵的 $(0,0)$ 元素位于父矩阵中的 $(ioff,joff)$ 位置。

参数

new_parent	父矩阵的引用。
ioff	子矩阵在父矩阵中的行偏移。
joff	子矩阵在父矩阵中的列偏移。
m	子矩阵的行数。
n	子矩阵的列数。

在文件 dense_submatrix.h 第 210 行定义.

参考 libMesh::DenseSubMatrix< T >::reposition().

                                                             :
   DenseMatrixBase<T>(new_m,new_n),
   _parent_matrix(new_parent)
 {
   this->reposition (ioff, joff, new_m, new_n);
 }

template<typename T>

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

default

The 5 special functions can be defaulted for this class, as it does not manage any memory itself.

template<typename T>

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

default

template<typename T>

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

virtualdefault

成员函数说明

template<typename T >

template<typename T2 , typename T3 >

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

inlineinherited

将 factor 添加到矩阵的每个元素。这应该仅在 T += T2 * T3 是有效的 C++，且 T2 是标量的情况下工作。返回类型是 void。

参数

factor	要添加的标量因子。
mat	乘法的右操作数矩阵。

在文件 dense_matrix_base.h 第 217 行定义.

参考 libMesh::DenseMatrixBase< T >::el(), libMesh::DenseMatrixBase< T >::m() , 以及 libMesh::DenseMatrixBase< T >::n().

 {
   libmesh_assert_equal_to (this->m(), mat.m());
   libmesh_assert_equal_to (this->n(), mat.n());
 
   for (auto j : make_range(this->n()))
     for (auto i : make_range(this->m()))
       this->el(i,j) += factor*mat.el(i,j);
 }

template<typename T>

void libMesh::DenseSubMatrix< T >::condense	(	const unsigned int	i,
		const unsigned int	j,
		const T	val,
		DenseSubVector< T > &	rhs
	)

inline

将矩阵的 (i,j) 元素压缩成值 val 对于施加边界条件在数值模拟中很有用。保持矩阵的对称性。

参数

i	元素的行索引。
j	元素的列索引。
val	要施加的值。
rhs	子矩阵的右侧向量。

在文件 dense_submatrix.h 第 176 行定义.

参考 libMesh::DenseSubMatrix< T >::i_off(), libMesh::DenseSubMatrix< T >::j_off(), libMesh::DenseSubVector< T >::parent() , 以及 libMesh::DenseSubMatrix< T >::parent().

   {
     this->parent().condense(this->i_off()+i,
                             this->j_off()+j,
                             val, rhs.parent());
   }

template<typename T >

void libMesh::DenseMatrixBase< T >::condense	(	const unsigned int	iv,
		const unsigned int	jv,
		const T	val,
		DenseVectorBase< T > &	rhs
	)

protectedinherited

将矩阵的 (i,j) 条目压缩出来，强制它取值为 val。这对于在数值模拟中应用边界条件很有用。 保留矩阵的对称性。

将矩阵列约减为已知值。

参数

i	要压缩的行索引。
j	要压缩的列索引。
val	压缩出的值。
rhs	与压缩操作相关联的右侧向量。

模板参数

T 矩阵元素类型。

参数

iv	列索引。
jv	列索引。
val	已知值。
rhs	包含右侧向量的 DenseVectorBase 对象。

在文件 dense_matrix_base_impl.h 第 94 行定义.

参考 libMesh::DenseVectorBase< T >::el() , 以及 libMesh::DenseVectorBase< T >::size().

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

 {
     libmesh_assert_equal_to(this->_m, rhs.size());
     libmesh_assert_equal_to(iv, jv);
 
     // 将已知值移入 RHS，并将列置零
     for (auto i : make_range(this->m()))
     {
         rhs.el(i) -= this->el(i, jv) * val;
         this->el(i, jv) = 0.;
     }
 
     // 将行置零
     for (auto j : make_range(this->n()))
         this->el(iv, j) = 0.;
 
     this->el(iv, jv) = 1.;
     rhs.el(iv) = val;
 }

template<typename T >

DenseVector< T > libMesh::DenseMatrixBase< T >::diagonal ( ) const

inherited

返回矩阵的对角线。

返回稠密矩阵的对角线。

返回: 矩阵对角线的 DenseVector。

模板参数

T 矩阵元素类型。

返回: 返回包含对角线元素的 DenseVector 对象。

在文件 dense_matrix_base_impl.h 第 43 行定义.

参考自 libMesh::DiagonalMatrix< T >::add_matrix().

 {
     DenseVector<T> ret(_m);
     for (decltype(_m) i = 0; i < _m; ++i)
         ret(i) = el(i, i);
     return ret;
 }

template<typename T>

virtual T libMesh::DenseSubMatrix< T >::el	(	const unsigned int	i,
		const unsigned int	j
	)		const

inlinefinaloverridevirtual

覆盖基类的虚函数，返回子矩阵的 (i,j) 元素。

参数

i	元素的行索引。
j	元素的列索引。

返回: 子矩阵的 (i,j) 元素。

实现了 libMesh::DenseMatrixBase< T >.

在文件 dense_submatrix.h 第 112 行定义.

114 { return (*this)(i,j); }

template<typename T>

virtual T& libMesh::DenseSubMatrix< T >::el	(	const unsigned int	i,
		const unsigned int	j
	)

inlinefinaloverridevirtual

覆盖基类的虚函数，返回子矩阵的 (i,j) 元素的可写引用。

参数

i	元素的行索引。
j	元素的列索引。

返回: 子矩阵的 (i,j) 元素的可写引用。

实现了 libMesh::DenseMatrixBase< T >.

在文件 dense_submatrix.h 第 123 行定义.

125 { return (*this)(i,j); }

template<typename T>

unsigned int libMesh::DenseSubMatrix< T >::i_off ( ) const

inline

返回子矩阵在父矩阵中的行偏移。

返回: 子矩阵在父矩阵中的行偏移。

在文件 dense_submatrix.h 第 159 行定义.

参考 libMesh::DenseSubMatrix< T >::_i_off.

参考自 libMesh::DenseSubMatrix< T >::condense().

159 { return _i_off; }

libMesh::DenseSubMatrix::_i_off

unsigned int _i_off

子矩阵在父矩阵中的行偏移。

Definition: dense_submatrix.h:197

template<typename T>

unsigned int libMesh::DenseSubMatrix< T >::j_off ( ) const

inline

返回子矩阵在父矩阵中的列偏移。

返回: 子矩阵在父矩阵中的列偏移。

在文件 dense_submatrix.h 第 166 行定义.

参考 libMesh::DenseSubMatrix< T >::_j_off.

参考自 libMesh::DenseSubMatrix< T >::condense().

166 { return _j_off; }

libMesh::DenseSubMatrix::_j_off

unsigned int _j_off

子矩阵在父矩阵中的列偏移。

Definition: dense_submatrix.h:202

template<typename T >

void libMesh::DenseSubMatrix< T >::left_multiply ( const DenseMatrixBase< T > & M2 )

finaloverridevirtual

覆盖基类的虚函数，左乘子矩阵。

参数

M2	另一个矩阵，用于左乘子矩阵。

实现了 libMesh::DenseMatrixBase< T >.

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

 {
   // (*this) <- M2 * M3
   // Where:
   // (*this) = (m x n),
   // M2      = (m x p),
   // M3      = (p x n)
 
   // M3 is a simply a copy of *this
   DenseSubMatrix<T> M3(*this);
 
   // Call the multiply function in the base class
   this->multiply(*this, M2, M3);
 }

template<typename T>

unsigned int libMesh::DenseMatrixBase< T >::m ( ) const

inlineinherited

返回矩阵的行维度。

返回: 矩阵的行维度。

在文件 dense_matrix_base.h 第 115 行定义.

参考 libMesh::DenseMatrixBase< T >::_m.

115 { return _m; }

libMesh::DenseMatrixBase::_m

unsigned int _m

行维度。

Definition: dense_matrix_base.h:204

template<typename T >

void libMesh::DenseMatrixBase< T >::multiply	(	DenseMatrixBase< T > &	M1,
		const DenseMatrixBase< T > &	M2,
		const DenseMatrixBase< T > &	M3
	)

staticprotectedinherited

辅助函数 - 执行计算 M1 = M2 * M3 其中: M1 = (m x n) M2 = (m x p) M3 = (p x n)

将两个矩阵相乘。

参数

M1	乘法的结果矩阵。
M2	乘法的左操作数矩阵。
M3	乘法的右操作数矩阵。

模板参数

T 矩阵元素类型。

参数

M1	存储结果的矩阵。
M2	第一个矩阵。
M3	第二个矩阵。

在文件 dense_matrix_base_impl.h 第 61 行定义.

参考 libMesh::DenseMatrixBase< T >::el(), libMesh::DenseMatrixBase< T >::m() , 以及 libMesh::DenseMatrixBase< T >::n().

 {
     // 断言确保我们传递了正确维度的矩阵
     libmesh_assert_equal_to(M1.m(), M2.m());
     libmesh_assert_equal_to(M1.n(), M3.n());
     libmesh_assert_equal_to(M2.n(), M3.m());
 
     const unsigned int m_s = M2.m();
     const unsigned int p_s = M2.n();
     const unsigned int n_s = M1.n();
 
     // 通过这种方式执行是因为有很大的机会（至少对于约束矩阵来说）
     // 在右乘时 M3(k,j) = 0.
     for (unsigned int k = 0; k < p_s; k++)
         for (unsigned int j = 0; j < n_s; j++)
             if (M3.el(k, j) != 0.)
                 for (unsigned int i = 0; i < m_s; i++)
                     M1.el(i, j) += M2.el(i, k) * M3.el(k, j);
 }

template<typename T>

unsigned int libMesh::DenseMatrixBase< T >::n ( ) const

inlineinherited

返回矩阵的列维度。

返回: 矩阵的列维度。

在文件 dense_matrix_base.h 第 122 行定义.

参考 libMesh::DenseMatrixBase< T >::_n.

122 { return _n; }

libMesh::DenseMatrixBase::_n

unsigned int _n

列维度。

Definition: dense_matrix_base.h:209

template<typename T >

T libMesh::DenseSubMatrix< T >::operator()	(	const unsigned int	i,
		const unsigned int	j
	)		const

inline

返回子矩阵的 (i,j) 元素。

参数

i	元素的行索引。
j	元素的列索引。

返回: 子矩阵的 (i,j) 元素。

在文件 dense_submatrix.h 第 255 行定义.

 {
   libmesh_assert_less (i, this->m());
   libmesh_assert_less (j, this->n());
   libmesh_assert_less (i + this->i_off(), _parent_matrix.m());
   libmesh_assert_less (j + this->j_off(), _parent_matrix.n());
 
   return _parent_matrix (i + this->i_off(),
                          j + this->j_off());
 }

template<typename T >

T & libMesh::DenseSubMatrix< T >::operator()	(	const unsigned int	i,
		const unsigned int	j
	)

inline

返回子矩阵的 (i,j) 元素的可写引用。

参数

i	元素的行索引。
j	元素的列索引。

返回: 子矩阵的 (i,j) 元素的可写引用。

在文件 dense_submatrix.h 第 270 行定义.

 {
   libmesh_assert_less (i, this->m());
   libmesh_assert_less (j, this->n());
   libmesh_assert_less (i + this->i_off(), _parent_matrix.m());
   libmesh_assert_less (j + this->j_off(), _parent_matrix.n());
 
   return _parent_matrix (i + this->i_off(),
                          j + this->j_off());
 }

template<typename T>

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

default

template<typename T>

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

default

template<typename T>

DenseMatrix<T>& libMesh::DenseSubMatrix< T >::parent ( )

inline

返回对父矩阵的引用。

返回: 对父矩阵的引用。

在文件 dense_submatrix.h 第 78 行定义.

参考 libMesh::DenseSubMatrix< T >::_parent_matrix.

参考自 libMesh::DenseSubMatrix< T >::condense().

78 { return _parent_matrix; }

libMesh::DenseSubMatrix::_parent_matrix

DenseMatrix< T > & _parent_matrix

包含该子矩阵的父矩阵。引用父矩阵的对象，表示该子矩阵属于哪个父矩阵。

Definition: dense_submatrix.h:192

template<typename T >

void libMesh::DenseMatrixBase< T >::print ( std::ostream & os = libMesh::out ) const

inherited

漂亮地打印矩阵，默认为 libMesh::out。

以普通格式打印矩阵。

参数

os	输出流，默认为 `libMesh::out。`

模板参数

T 矩阵元素类型。

参数

os 输出流。

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

 {
     for (auto i : make_range(this->m()))
     {
         for (auto j : make_range(this->n()))
             os << std::setw(8)
                << this->el(i, j) << " ";
 
         os << std::endl;
     }
 
     return;
 }

template<typename T >

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

inherited

以科学计数法格式打印矩阵。

参数

os	输出流。
precision	打印的精度。

模板参数

T 矩阵元素类型。

参数

os	输出流。
precision	打印的精度。

在文件 dense_matrix_base_impl.h 第 126 行定义.

 {
     // 保存初始格式标志
     std::ios_base::fmtflags os_flags = os.flags();
 
     // 打印矩阵元素
     for (auto i : make_range(this->m()))
     {
         for (auto j : make_range(this->n()))
             os << std::setw(15)
                << std::scientific
                << std::setprecision(precision)
                << this->el(i, j) << " ";
 
         os << std::endl;
     }
 
     // 恢复原始格式标志
     os.flags(os_flags);
 }

template<typename T >

void libMesh::DenseSubMatrix< T >::reposition	(	const unsigned int	ioff,
		const unsigned int	joff,
		const unsigned int	new_m,
		const unsigned int	new_n
	)

inline

修改子矩阵在父矩阵中的位置。

参数

ioff	子矩阵在父矩阵中的新行偏移。
joff	子矩阵在父矩阵中的新列偏移。
new_m	子矩阵的新行数。
new_n	子矩阵的新列数。

在文件 dense_submatrix.h 第 224 行定义.

参考自 libMesh::DenseSubMatrix< T >::DenseSubMatrix().

 {
   _i_off = ioff;
   _j_off = joff;
   this->_m = new_m;
   this->_n = new_n;
 
   // Make sure we still fit in the parent matrix.
   libmesh_assert_less_equal ((this->i_off() + this->m()), _parent_matrix.m());
   libmesh_assert_less_equal ((this->j_off() + this->n()), _parent_matrix.n());
 }

template<typename T >

void libMesh::DenseSubMatrix< T >::right_multiply ( const DenseMatrixBase< T > & M3 )

finaloverridevirtual

覆盖基类的虚函数，右乘子矩阵。

参数

M3	另一个矩阵，用于右乘子矩阵。

实现了 libMesh::DenseMatrixBase< T >.

在文件 dense_submatrix.C 第 49 行定义.

 {
   // (*this) <- M2 * M3
   // Where:
   // (*this) = (m x n),
   // M2      = (m x p),
   // M3      = (p x n)
 
   // M2 is simply a copy of *this
   DenseSubMatrix<T> M2(*this);
 
   // Call the multiply function in the base class
   this->multiply(*this, M2, M3);
 }

template<typename T >

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

inlinefinaloverridevirtual

覆盖基类的虚拟函数，将子矩阵的所有元素设置为零。

实现了 libMesh::DenseMatrixBase< T >.

在文件 dense_submatrix.h 第 243 行定义.

 {
   for (auto i : make_range(this->m()))
     for (auto j : make_range(this->n()))
       _parent_matrix(i + this->i_off(),
                      j + this->j_off()) = 0.;
 }