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

该类定义了一个在 LIBMESH_DIM 维度空间中类型为 T 的向量。 更多...

#include <tensor_tools.h>

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

Public 类型
typedef T	value_type
	辅助 typedef 用于 C++98 泛型编程。 更多...
typedef unsigned int	index_type
	辅助 typedef 用于泛型索引编程。 更多...

Public 成员函数
	TypeVector ()
	空构造函数。将向量初始化为 LIBMESH_DIM 维中的零向量。 更多...
template<typename T2 >
	TypeVector (const TypeVector< T2 > &p)
	复制构造函数。 更多...
	TypeVector (const TypeVector &p)=default
	用于特殊情况的复制构造函数。 更多...
	~TypeVector ()=default
	析构函数。 更多...
template<typename T2 >
void	assign (const TypeVector< T2 > &)
	在不创建临时对象的情况下将向量赋值给该向量。 更多...
template<typename Scalar >
boostcopy::enable_if_c < ScalarTraits< Scalar > ::value, TypeVector & >::type	operator= (const Scalar &libmesh_dbg_var(p))
	赋值操作符，用于将标量值赋给该向量以清零。 更多...
const T &	operator() (const unsigned int i) const
	返回向量中的第 i 个分量的常量引用。 更多...
const T &	slice (const unsigned int i) const
T &	operator() (const unsigned int i)
	返回向量中的第 i 个分量的可写引用。 更多...
T &	slice (const unsigned int i)
template<typename T2 >
TypeVector< typename CompareTypes< T, T2 > ::supertype >	operator+ (const TypeVector< T2 > &) const
	向量相加。 更多...
template<typename T2 >
const TypeVector< T > &	operator+= (const TypeVector< T2 > &)
	向量相加。 更多...
template<typename T2 >
TypeVector< typename CompareTypes< T, T2 > ::supertype >	operator- (const TypeVector< T2 > &) const
	从另一个向量中减去该向量。 更多...
template<typename T2 >
const TypeVector< T > &	operator-= (const TypeVector< T2 > &)
	从该向量中减去另一个向量。 更多...
template<typename T2 >
void	subtract (const TypeVector< T2 > &)
	从另一个向量中减去该向量，不创建临时对象。 更多...
template<typename T2 >
void	subtract_scaled (const TypeVector< T2 > &, const T &)
	从该向量中减去另一个向量的缩放值，不创建临时对象。 更多...
TypeVector< T >	operator- () const
	返回该向量的相反向量的副本。 更多...
template<typename Scalar >
boostcopy::enable_if_c < ScalarTraits< Scalar > ::value, TypeVector< typename CompareTypes< T, Scalar > ::supertype > >::type	operator* (const Scalar &) const
	将该向量乘以标量值。 更多...
const TypeVector< T > &	operator*= (const T &)
	将该向量乘以标量值。 更多...
template<typename Scalar >
boostcopy::enable_if_c < ScalarTraits< Scalar > ::value, TypeVector< typename CompareTypes< T, Scalar > ::supertype > >::type	operator/ (const Scalar &) const
	将该向量的每个分量除以标量值。 更多...
const TypeVector< T > &	operator/= (const T &)
	将该向量的每个分量除以标量值。 更多...
template<typename T2 >
CompareTypes< T, T2 >::supertype	operator* (const TypeVector< T2 > &) const
	计算该向量与另一个向量的点积。 更多...
template<typename T2 >
CompareTypes< T, T2 >::supertype	contract (const TypeVector< T2 > &) const
	返回 TypeVector::operator*() 的结果。 更多...
template<typename T2 >
TypeVector< typename CompareTypes< T, T2 > ::supertype >	cross (const TypeVector< T2 > &v) const
	计算该向量与另一个向量的叉积。 更多...
TypeVector< T >	unit () const
	返回指向该向量方向的单位向量。 更多...
auto	norm () const -> decltype(std::norm(T()))
	返回向量的模，即元素平方和的平方根。 更多...
auto	norm_sq () const -> decltype(std::norm(T()))
	返回向量的模的平方，即元素模的平方和。 更多...
bool	is_zero () const
	判断向量的所有值是否为零。 更多...
void	zero ()
	将向量的所有分量设置为零。 更多...
bool	relative_fuzzy_equals (const TypeVector< T > &rhs, Real tol=TOLERANCE) const
	判断两个向量是否在相对容差 tol 内相等。 更多...
bool	absolute_fuzzy_equals (const TypeVector< T > &rhs, Real tol=TOLERANCE) const
	判断两个向量是否在绝对容差 tol 内相等。 更多...
bool	operator== (const TypeVector< T > &rhs) const
	判断两个向量的每个分量是否相等。 更多...
bool	operator!= (const TypeVector< T > &rhs) const
	判断两个向量是否不相等。 更多...
bool	operator< (const TypeVector< T > &rhs) const
	判断该向量是否小于另一个向量。 更多...
bool	operator<= (const TypeVector< T > &rhs) const
	判断该向量是否小于等于另一个向量。 更多...
bool	operator> (const TypeVector< T > &rhs) const
	判断该向量是否大于另一个向量。 更多...
bool	operator>= (const TypeVector< T > &rhs) const
	判断该向量是否大于等于另一个向量。 更多...
void	print (std::ostream &os=libMesh::out) const
	格式化输出，默认输出到 libMesh::out 流。 更多...
void	write_unformatted (std::ostream &out_stream, const bool newline=true) const
	无格式输出到流 out。只是将向量的元素用空格分隔打印出来。 默认情况下，还会打印一个换行符，但可以通过 newline 参数来控制这个行为。 更多...
template<>
bool	operator< (const TypeVector< Complex > &rhs) const
template<>
bool	operator<= (const TypeVector< Complex > &rhs) const
template<>
bool	operator> (const TypeVector< Complex > &rhs) const
template<>
bool	operator>= (const TypeVector< Complex > &rhs) const

Protected 成员函数
	TypeVector (const T &x, const T &y=0, const T &z=0)
	从类型 T 构造向量。默认情况下，将更高维度的分量设置为零。 更多...
template<typename Scalar1 , typename Scalar2 , typename Scalar3 >
	TypeVector (typename boostcopy::enable_if_c< ScalarTraits< Scalar1 >::value, const Scalar1 >::type &x, typename boostcopy::enable_if_c< ScalarTraits< Scalar2 >::value, const Scalar2 >::type &y=0, typename boostcopy::enable_if_c< ScalarTraits< Scalar3 >::value, const Scalar3 >::type &z=0)
	从标量值构造向量。默认情况下，将更高维度的分量设置为零。 更多...
template<typename Scalar >
	TypeVector (const Scalar &x, typename boostcopy::enable_if_c< ScalarTraits< Scalar >::value, const Scalar >::type *sfinae=nullptr)
	从标量值构造向量。将更高维度的分量设置为零。 更多...

Protected 属性
T	_coords [LIBMESH_DIM]
	TypeVector 的坐标。 更多...

友元
template<typename T2 >
class	TypeVector
class	TypeTensor< T >
std::ostream &	operator<< (std::ostream &os, const TypeVector< T > &t)
	格式化输出，支持以下语法： 更多...

详细描述

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

该类定义了一个在 LIBMESH_DIM 维度空间中类型为 T 的向量。

T 可以是实数或复数。请使用派生类型之一，如 Point 或 Node。

作者

Benjamin S. Kirk

日期

2003

在文件 tensor_tools.h 第 34 行定义.

成员类型定义说明

template<typename T>

typedef unsigned int libMesh::TypeVector< T >::index_type

辅助 typedef 用于泛型索引编程。

在文件 type_vector.h 第 211 行定义.

template<typename T>

typedef T libMesh::TypeVector< T >::value_type

辅助 typedef 用于 C++98 泛型编程。

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

构造及析构函数说明

template<typename T >

libMesh::TypeVector< T >::TypeVector ( )

inline

空构造函数。将向量初始化为 LIBMESH_DIM 维中的零向量。

在文件 type_vector.h 第 577 行定义.

{
  _coords[0] = {};

#if LIBMESH_DIM > 1
  _coords[1] = {};
#endif

#if LIBMESH_DIM > 2
  _coords[2] = {};
#endif
}

template<typename T>

libMesh::TypeVector< T >::TypeVector ( const T &  x, const T &  y = 0, const T &  z = 0  )

inlineprotected

从类型 T 构造向量。默认情况下，将更高维度的分量设置为零。

在文件 type_vector.h 第 594 行定义.

参考 libMesh::libmesh_ignore().

{
  _coords[0] = x;

#if LIBMESH_DIM > 1
  _coords[1] = y;
#else
  libmesh_ignore(y);
  libmesh_assert_equal_to (y, 0);
#endif

#if LIBMESH_DIM > 2
  _coords[2] = z;
#else
  libmesh_ignore(z);
  libmesh_assert_equal_to (z, 0);
#endif
}

template<typename T >

template<typename Scalar1 , typename Scalar2 , typename Scalar3 >

libMesh::TypeVector< T >::TypeVector ( typename boostcopy::enable_if_c< ScalarTraits< Scalar1 >::value, const Scalar1 >::type &  x, typename boostcopy::enable_if_c< ScalarTraits< Scalar2 >::value, const Scalar2 >::type &  y = 0, typename boostcopy::enable_if_c< ScalarTraits< Scalar3 >::value, const Scalar3 >::type &  z = 0  )

inlineprotected

从标量值构造向量。默认情况下，将更高维度的分量设置为零。

在文件 type_vector.h 第 619 行定义.

{
  _coords[0] = x;

#if LIBMESH_DIM > 1
  _coords[1] = y;
#else
  libmesh_assert_equal_to (y, 0);
#endif

#if LIBMESH_DIM > 2
  _coords[2] = z;
#else
  libmesh_assert_equal_to (z, 0);
#endif
}

template<typename T >

template<typename Scalar >

libMesh::TypeVector< T >::TypeVector ( const Scalar &  x, typename boostcopy::enable_if_c< ScalarTraits< Scalar >::value, const Scalar >::type *  sfinae = nullptr  )

inlineprotected

从标量值构造向量。将更高维度的分量设置为零。

这是必要的，因为某种原因，仅从标量值构造函数不足以让编译器确定 TypeVector<Complex> v = 0; 这种用法。

在文件 type_vector.h 第 649 行定义.

{
  _coords[0] = x;

#if LIBMESH_DIM > 1
  _coords[1] = 0;
#endif

#if LIBMESH_DIM > 2
  _coords[2] = 0;
#endif
}

template<typename T >

template<typename T2 >

libMesh::TypeVector< T >::TypeVector ( const TypeVector< T2 > &  p )

inline

复制构造函数。

模板参数

T2	要从中复制元素的向量的类型。

参数

p

要从中复制的向量。

在文件 type_vector.h 第 670 行定义.

{
  // copy the nodes from vector p to me
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    _coords[i] = p._coords[i];
}

template<typename T>

libMesh::TypeVector< T >::TypeVector ( const TypeVector< T > &  p )

default

用于特殊情况的复制构造函数。

template<typename T>

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

default

析构函数。

成员函数说明

template<typename T>

bool libMesh::TypeVector< T >::absolute_fuzzy_equals ( const TypeVector< T > &  rhs, Real  tol = TOLERANCE  ) const

inline

判断两个向量是否在绝对容差 tol 内相等。

参数

rhs	另一个向量。
tol	绝对容差。

返回

如果两个向量在绝对容差 tol 内相等，则返回 true。

在文件 type_vector.h 第 1105 行定义.

参考 std::abs().

{
#if LIBMESH_DIM == 1
  return (std::abs(_coords[0] - rhs._coords[0])
          <= tol);
#endif

#if LIBMESH_DIM == 2
  return (std::abs(_coords[0] - rhs._coords[0]) +
          std::abs(_coords[1] - rhs._coords[1])
          <= tol);
#endif

#if LIBMESH_DIM == 3
  return (std::abs(_coords[0] - rhs._coords[0]) +
          std::abs(_coords[1] - rhs._coords[1]) +
          std::abs(_coords[2] - rhs._coords[2])
          <= tol);
#endif
}

template<typename T >

template<typename T2 >

void libMesh::TypeVector< T >::assign ( const TypeVector< T2 > &  p )

inline

在不创建临时对象的情况下将向量赋值给该向量。

模板参数

T2	要从中赋值元素的向量的类型。

参数

v

要赋值的向量。

在文件 type_vector.h 第 682 行定义.

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    _coords[i] = p._coords[i];
}

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::TypeVector< T >::contract ( const TypeVector< T2 > &  p ) const

inline

返回 TypeVector::operator*() 的结果。

模板参数

T2	另一个向量的元素类型。

参数

v

另一个向量。

返回

两个向量的点积结果。

在文件 type_vector.h 第 1022 行定义.

{
  return (*this)*(p);
}

template<typename T >

template<typename T2 >

TypeVector< typename CompareTypes< T, T2 >::supertype > libMesh::TypeVector< T >::cross

(

const TypeVector< T2 > &

v

)

const

计算该向量与另一个向量的叉积。

模板参数

T2	另一个向量的元素类型。

参数

v

另一个向量。

返回

两个向量的叉积结果。

在文件 type_vector.h 第 1032 行定义.

参考 libMesh::libmesh_ignore().

{
  typedef typename CompareTypes<T, T2>::supertype TS;
  libmesh_assert_equal_to (LIBMESH_DIM, 3);

  // |     i          j          k    |
  // |(*this)(0) (*this)(1) (*this)(2)|
  // |   p(0)       p(1)       p(2)   |

#if LIBMESH_DIM == 3
  return TypeVector<TS>( _coords[1]*p._coords[2] - _coords[2]*p._coords[1],
                         -_coords[0]*p._coords[2] + _coords[2]*p._coords[0],
                         _coords[0]*p._coords[1] - _coords[1]*p._coords[0]);
#else
  libmesh_ignore(p);
  return TypeVector<TS>(0);
#endif
}

template<typename T >

bool libMesh::TypeVector< T >::is_zero ( ) const

inline

判断向量的所有值是否为零。

返回

如果向量中所有值都为零，则返回 true。

在文件 type_vector.h 第 1095 行定义.

{
  for (const auto & val : _coords)
    if (val != T(0))
      return false;
  return true;
}

template<typename T>

auto libMesh::TypeVector< T >::norm ( ) const -> decltype(std::norm(T()))

inline

返回向量的模，即元素平方和的平方根。

返回

向量的模。

在文件 type_vector.h 第 1055 行定义.

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

{
  return std::sqrt(this->norm_sq());
}

template<typename T>

auto libMesh::TypeVector< T >::norm_sq ( ) const -> decltype(std::norm(T()))

inline

返回向量的模的平方，即元素模的平方和。

返回

向量的模的平方。

在文件 type_vector.h 第 1074 行定义.

参考 libMesh::TensorTools::norm_sq().

{
#if LIBMESH_DIM == 1
  return (TensorTools::norm_sq(_coords[0]));
#endif

#if LIBMESH_DIM == 2
  return (TensorTools::norm_sq(_coords[0]) +
          TensorTools::norm_sq(_coords[1]));
#endif

#if LIBMESH_DIM == 3
  return (TensorTools::norm_sq(_coords[0]) +
          TensorTools::norm_sq(_coords[1]) +
          TensorTools::norm_sq(_coords[2]));
#endif
}

template<typename T>

bool libMesh::TypeVector< T >::operator!= ( const TypeVector< T > &  rhs ) const

inline

判断两个向量是否不相等。

参数

rhs

另一个向量。

返回

如果两个向量不相等，则返回 true。

在文件 type_vector.h 第 1177 行定义.

{
  return (!(*this == rhs));
}

template<typename T >

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

inline

返回向量中的第 i 个分量的常量引用。

参数

i

分量的索引。

返回

向量中的第 i 个分量的常量引用。

在文件 type_vector.h 第 692 行定义.

{
  libmesh_assert_less (i, LIBMESH_DIM);

  return _coords[i];
}

template<typename T >

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

inline

返回向量中的第 i 个分量的可写引用。

参数

i

分量的索引。

返回

向量中的第 i 个分量的可写引用。

在文件 type_vector.h 第 703 行定义.

{
  libmesh_assert_less (i, LIBMESH_DIM);

  return _coords[i];
}

template<typename T >

template<typename Scalar >

boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< T, Scalar >::supertype > >::type libMesh::TypeVector< T >::operator* ( const Scalar &  factor ) const

inline

将该向量乘以标量值。

模板参数

Scalar

标量值的类型。

参数

s

要乘以的标量值。

返回

结果的副本，该向量保持不变。

在文件 type_vector.h 第 889 行定义.

{
  typedef typename CompareTypes<T, Scalar>::supertype SuperType;

#if LIBMESH_DIM == 1
  return TypeVector<SuperType>(_coords[0]*factor);
#endif

#if LIBMESH_DIM == 2
  return TypeVector<SuperType>(_coords[0]*factor,
                               _coords[1]*factor);
#endif

#if LIBMESH_DIM == 3
  return TypeVector<SuperType>(_coords[0]*factor,
                               _coords[1]*factor,
                               _coords[2]*factor);
#endif
}

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::TypeVector< T >::operator* ( const TypeVector< T2 > &  p ) const

inline

计算该向量与另一个向量的点积。

模板参数

T2	另一个向量的元素类型。

参数

v

另一个向量。

返回

两个向量的点积结果。

注解

在复数情况下，不进行复共轭操作。

这两个向量可以包含不同的数值类型。

在文件 type_vector.h 第 1000 行定义.

{
#if LIBMESH_DIM == 1
  return _coords[0]*p._coords[0];
#endif

#if LIBMESH_DIM == 2
  return (_coords[0]*p._coords[0] +
          _coords[1]*p._coords[1]);
#endif

#if LIBMESH_DIM == 3
  return (_coords[0]*p(0) +
          _coords[1]*p(1) +
          _coords[2]*p(2));
#endif
}

template<typename T>

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

inline

将该向量乘以标量值。

模板参数

Scalar

标量值的类型。

参数

s

要乘以的标量值。

返回

指向 *this 的引用。

在文件 type_vector.h 第 926 行定义.

{
#if LIBMESH_DIM == 1
  _coords[0] *= factor;
#endif

#if LIBMESH_DIM == 2
  _coords[0] *= factor;
  _coords[1] *= factor;
#endif

#if LIBMESH_DIM == 3
  _coords[0] *= factor;
  _coords[1] *= factor;
  _coords[2] *= factor;
#endif

  return *this;
}

template<typename T >

template<typename T2 >

TypeVector< typename CompareTypes< T, T2 >::supertype > libMesh::TypeVector< T >::operator+ ( const TypeVector< T2 > &  p ) const

inline

向量相加。

模板参数

T2	另一个向量的元素类型。

参数

v	要相加的另一个向量。

返回

结果的副本，该向量保持不变。

在文件 type_vector.h 第 716 行定义.

{
  typedef typename CompareTypes<T, T2>::supertype TS;
#if LIBMESH_DIM == 1
  return TypeVector<TS> (_coords[0] + p._coords[0]);
#endif

#if LIBMESH_DIM == 2
  return TypeVector<TS> (_coords[0] + p._coords[0],
                         _coords[1] + p._coords[1]);
#endif

#if LIBMESH_DIM == 3
  return TypeVector<TS> (_coords[0] + p._coords[0],
                         _coords[1] + p._coords[1],
                         _coords[2] + p._coords[2]);
#endif

}

template<typename T >

template<typename T2 >

const TypeVector< T > & libMesh::TypeVector< T >::operator+= ( const TypeVector< T2 > &  p )

inline

向量相加。

模板参数

T2	另一个向量的元素类型。

参数

v	要相加的另一个向量。

返回

指向 *this 的引用。

在文件 type_vector.h 第 741 行定义.

{
  this->add (p);

  return *this;
}

template<typename T >

template<typename T2 >

TypeVector< typename CompareTypes< T, T2 >::supertype > libMesh::TypeVector< T >::operator- ( const TypeVector< T2 > &  p ) const

inline

从另一个向量中减去该向量。

模板参数

T2	另一个向量的元素类型。

参数

v

要从中减去的向量。

返回

结果的副本，该向量保持不变。

在文件 type_vector.h 第 802 行定义.

{
  typedef typename CompareTypes<T, T2>::supertype TS;

#if LIBMESH_DIM == 1
  return TypeVector<TS>(_coords[0] - p._coords[0]);
#endif

#if LIBMESH_DIM == 2
  return TypeVector<TS>(_coords[0] - p._coords[0],
                        _coords[1] - p._coords[1]);
#endif

#if LIBMESH_DIM == 3
  return TypeVector<TS>(_coords[0] - p._coords[0],
                        _coords[1] - p._coords[1],
                        _coords[2] - p._coords[2]);
#endif

}

template<typename T >

TypeVector< T > libMesh::TypeVector< T >::operator- ( ) const

inline

返回该向量的相反向量的副本。

返回

相反向量的副本。

在文件 type_vector.h 第 861 行定义.

{

#if LIBMESH_DIM == 1
  return TypeVector(-_coords[0]);
#endif

#if LIBMESH_DIM == 2
  return TypeVector(-_coords[0],
                    -_coords[1]);
#endif

#if LIBMESH_DIM == 3
  return TypeVector(-_coords[0],
                    -_coords[1],
                    -_coords[2]);
#endif

}

template<typename T >

template<typename T2 >

const TypeVector< T > & libMesh::TypeVector< T >::operator-= ( const TypeVector< T2 > &  p )

inline

从该向量中减去另一个向量。

模板参数

T2	另一个向量的元素类型。

参数

v

要从中减去的向量。

返回

指向 *this 的引用。

在文件 type_vector.h 第 828 行定义.

{
  this->subtract (p);

  return *this;
}

template<typename T >

template<typename Scalar >

boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< T, Scalar >::supertype > >::type libMesh::TypeVector< T >::operator/ ( const Scalar &  factor ) const

inline

将该向量的每个分量除以标量值。

模板参数

Scalar

标量值的类型。

参数

s

要除以的标量值。

返回

结果的副本，该向量保持不变。

在文件 type_vector.h 第 954 行定义.

{
  libmesh_assert_not_equal_to (factor, static_cast<T>(0.));

  typedef typename CompareTypes<T, Scalar>::supertype TS;

#if LIBMESH_DIM == 1
  return TypeVector<TS>(_coords[0]/factor);
#endif

#if LIBMESH_DIM == 2
  return TypeVector<TS>(_coords[0]/factor,
                        _coords[1]/factor);
#endif

#if LIBMESH_DIM == 3
  return TypeVector<TS>(_coords[0]/factor,
                        _coords[1]/factor,
                        _coords[2]/factor);
#endif

}

template<typename T>

const TypeVector< T > & libMesh::TypeVector< T >::operator/= ( const T &  factor )

inline

将该向量的每个分量除以标量值。

模板参数

Scalar

标量值的类型。

参数

s

要除以的标量值。

返回

指向 *this 的引用。

在文件 type_vector.h 第 983 行定义.

{
  libmesh_assert_not_equal_to (factor, static_cast<T>(0.));

  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    _coords[i] /= factor;

  return *this;
}

template<>

bool libMesh::TypeVector< Complex >::operator<

(

const TypeVector< Complex > &

rhs

)

const

在文件 type_vector.C 第 148 行定义.

参考 std::imag() , 以及 std::real().

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i).real() < rhs(i).real())
        return true;
      if ((*this)(i).real() > rhs(i).real())
        return false;
      if ((*this)(i).imag() < rhs(i).imag())
        return true;
      if ((*this)(i).imag() > rhs(i).imag())
        return false;
    }
  return false;
}

template<typename T>

bool libMesh::TypeVector< T >::operator<

(

const TypeVector< T > &

rhs

)

const

判断该向量是否小于另一个向量。

参数

rhs

另一个向量。

返回

如果该向量小于另一个向量，则返回 true。

用于排序。还用于选择某些任意基函数的方向。

在文件 type_vector.C 第 90 行定义.

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i) < rhs(i))
        return true;
      if ((*this)(i) > rhs(i))
        return false;
    }
  return false;
}

template<>

bool libMesh::TypeVector< Complex >::operator<=

(

const TypeVector< Complex > &

rhs

)

const

在文件 type_vector.C 第 167 行定义.

参考 std::imag() , 以及 std::real().

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i).real() < rhs(i).real())
        return true;
      if ((*this)(i).real() > rhs(i).real())
        return false;
      if ((*this)(i).imag() < rhs(i).imag())
        return true;
      if ((*this)(i).imag() > rhs(i).imag())
        return false;
    }
  return true;
}

template<typename T>

bool libMesh::TypeVector< T >::operator<=

(

const TypeVector< T > &

rhs

)

const

判断该向量是否小于等于另一个向量。

参数

rhs

另一个向量。

返回

如果该向量小于等于另一个向量，则返回 true。

用于排序。还用于选择某些任意约束方程的方向。

在文件 type_vector.C 第 104 行定义.

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i) < rhs(i))
        return true;
      if ((*this)(i) > rhs(i))
        return false;
    }
  return true;
}

template<typename T>

template<typename Scalar >

boostcopy::enable_if_c< ScalarTraits<Scalar>::value, TypeVector &>::type libMesh::TypeVector< T >::operator= ( const Scalar &  libmesh_dbg_varp )

inline

赋值操作符，用于将标量值赋给该向量以清零。

模板参数

Scalar

赋值的标量值的类型。

参数

p

要赋值的标量值。

返回

指向自身的引用。

在文件 type_vector.h 第 252 行定义.

  { libmesh_assert_equal_to (p, Scalar(0)); this->zero(); return *this; }

template<typename T>

bool libMesh::TypeVector< T >::operator== ( const TypeVector< T > &  rhs ) const

inline

判断两个向量的每个分量是否相等。

参数

rhs

另一个向量。

返回

如果两个向量的每个分量都相等，则返回 true。

注解

对于浮点类型 T，可能更适合使用 absolute_fuzzy_equals() 函数。

在文件 type_vector.h 第 1155 行定义.

{
#if LIBMESH_DIM == 1
  return (_coords[0] == rhs._coords[0]);
#endif

#if LIBMESH_DIM == 2
  return (_coords[0] == rhs._coords[0] &&
          _coords[1] == rhs._coords[1]);
#endif

#if LIBMESH_DIM == 3
  return (_coords[0] == rhs._coords[0] &&
          _coords[1] == rhs._coords[1] &&
          _coords[2] == rhs._coords[2]);
#endif
}

template<>

bool libMesh::TypeVector< Complex >::operator>

(

const TypeVector< Complex > &

rhs

)

const

在文件 type_vector.C 第 186 行定义.

参考 std::imag() , 以及 std::real().

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i).real() > rhs(i).real())
        return true;
      if ((*this)(i).real() < rhs(i).real())
        return false;
      if ((*this)(i).imag() > rhs(i).imag())
        return true;
      if ((*this)(i).imag() < rhs(i).imag())
        return false;
    }
  return false;
}

template<typename T>

bool libMesh::TypeVector< T >::operator>

(

const TypeVector< T > &

rhs

)

const

判断该向量是否大于另一个向量。

参数

rhs

另一个向量。

返回

如果该向量大于另一个向量，则返回 true。

用于排序。还用于选择某些任意基函数的方向。

在文件 type_vector.C 第 119 行定义.

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i) > rhs(i))
        return true;
      if ((*this)(i) < rhs(i))
        return false;
    }
  return false;
}

template<>

bool libMesh::TypeVector< Complex >::operator>=

(

const TypeVector< Complex > &

rhs

)

const

在文件 type_vector.C 第 205 行定义.

参考 std::imag() , 以及 std::real().

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i).real() > rhs(i).real())
        return true;
      if ((*this)(i).real() < rhs(i).real())
        return false;
      if ((*this)(i).imag() > rhs(i).imag())
        return true;
      if ((*this)(i).imag() < rhs(i).imag())
        return false;
    }
  return true;
}

template<typename T>

bool libMesh::TypeVector< T >::operator>=

(

const TypeVector< T > &

rhs

)

const

判断该向量是否大于等于另一个向量。

参数

rhs

另一个向量。

返回

如果该向量大于等于另一个向量，则返回 true。

用于排序。还用于选择某些任意约束方程的方向。

在文件 type_vector.C 第 133 行定义.

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    {
      if ((*this)(i) > rhs(i))
        return true;
      if ((*this)(i) < rhs(i))
        return false;
    }
  return true;
}

template<typename T >

void libMesh::TypeVector< T >::print

(

std::ostream &

os = libMesh::out

)

const

格式化输出，默认输出到 libMesh::out 流。

参数

[out]

os

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

在文件 type_vector.C 第 47 行定义.

{
#if LIBMESH_DIM == 1

  os << "x=" << (*this)(0);

#endif
#if LIBMESH_DIM == 2

  os << "(x,y)=("
     << std::setw(8) << (*this)(0) << ", "
     << std::setw(8) << (*this)(1) << ")";

#endif
#if LIBMESH_DIM == 3

  os <<  "(x,y,z)=("
     << std::setw(8) << (*this)(0) << ", "
     << std::setw(8) << (*this)(1) << ", "
     << std::setw(8) << (*this)(2) << ")";
#endif
}

template<typename T>

bool libMesh::TypeVector< T >::relative_fuzzy_equals ( const TypeVector< T > &  rhs, Real  tol = TOLERANCE  ) const

inline

判断两个向量是否在相对容差 tol 内相等。

参数

rhs	另一个向量。
tol	相对容差。

返回

如果两个向量在相对容差 tol 内相等，则返回 true。

在文件 type_vector.h 第 1130 行定义.

参考 std::abs().

{
#if LIBMESH_DIM == 1
  return this->absolute_fuzzy_equals(rhs, tol *
                                     (std::abs(_coords[0]) + std::abs(rhs._coords[0])));
#endif

#if LIBMESH_DIM == 2
  return this->absolute_fuzzy_equals(rhs, tol *
                                     (std::abs(_coords[0]) + std::abs(rhs._coords[0]) +
                                      std::abs(_coords[1]) + std::abs(rhs._coords[1])));
#endif

#if LIBMESH_DIM == 3
  return this->absolute_fuzzy_equals(rhs, tol *
                                     (std::abs(_coords[0]) + std::abs(rhs._coords[0]) +
                                      std::abs(_coords[1]) + std::abs(rhs._coords[1]) +
                                      std::abs(_coords[2]) + std::abs(rhs._coords[2])));
#endif
}

template<typename T>

const T& libMesh::TypeVector< T >::slice ( const unsigned int  i ) const

inline

在文件 type_vector.h 第 262 行定义.

{ return (*this)(i); }

template<typename T>

T& libMesh::TypeVector< T >::slice ( const unsigned int  i )

inline

在文件 type_vector.h 第 271 行定义.

{ return (*this)(i); }

template<typename T >

template<typename T2 >

void libMesh::TypeVector< T >::subtract ( const TypeVector< T2 > &  p )

inline

从另一个向量中减去该向量，不创建临时对象。

模板参数

T2	另一个向量的元素类型。

参数

v

要从中减去的向量。

在文件 type_vector.h 第 840 行定义.

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    _coords[i] -= p._coords[i];
}

template<typename T>

template<typename T2 >

void libMesh::TypeVector< T >::subtract_scaled ( const TypeVector< T2 > &  p, const T &  factor  )

inline

从该向量中减去另一个向量的缩放值，不创建临时对象。

模板参数

T2	另一个向量的元素类型。

参数

v	要从中减去的向量。
scale	缩放值。

在文件 type_vector.h 第 851 行定义.

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    _coords[i] -= factor*p(i);
}

template<typename T >

TypeVector< T > libMesh::TypeVector< T >::unit ( ) const

inline

返回指向该向量方向的单位向量。

返回

单位向量。

在文件 type_vector.h 第 1246 行定义.

参考 std::norm().

{

  auto && length = norm();

  libmesh_assert_not_equal_to (length, static_cast<Real>(0.));

#if LIBMESH_DIM == 1
  return TypeVector<T>(_coords[0]/length);
#endif

#if LIBMESH_DIM == 2
  return TypeVector<T>(_coords[0]/length,
                       _coords[1]/length);
#endif

#if LIBMESH_DIM == 3
  return TypeVector<T>(_coords[0]/length,
                       _coords[1]/length,
                       _coords[2]/length);
#endif

}

template<typename T >

void libMesh::TypeVector< T >::write_unformatted	(	std::ostream &	out_stream,
		const bool	newline = true
	)		const

无格式输出到流 out。只是将向量的元素用空格分隔打印出来。 默认情况下，还会打印一个换行符，但可以通过 newline 参数来控制这个行为。

参数

[out]	out_stream	输出流。
	newline	是否打印换行符，默认为 true。

在文件 type_vector.C 第 75 行定义.

{
  os << std::setiosflags(std::ios::showpoint)
     << (*this)(0) << " "
     << (*this)(1) << " "
     << (*this)(2) << " ";

  if (newline)
    os << '\n';
}

template<typename T >

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

inline

将向量的所有分量设置为零。

在文件 type_vector.h 第 1064 行定义.

参考自 libMesh::VectorValue< Real >::operator=() , 以及 libMesh::TypeVector< Real >::operator=().

{
  for (unsigned int i=0; i<LIBMESH_DIM; i++)
    _coords[i] = 0.;
}

友元及相关函数文档

template<typename T>

std::ostream& operator<< ( std::ostream &  os, const TypeVector< T > &  t  )

friend

格式化输出，支持以下语法：

Point p(1,2,3);
std::cout << p << std::endl;

在文件 type_vector.h 第 545 行定义.

{
  t.print(os);
  return os;
}

template<typename T>

friend class TypeTensor< T >

friend

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

template<typename T>

template<typename T2 >

friend class TypeVector

friend

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

类成员变量说明

template<typename T>

T libMesh::TypeVector< T >::_coords[LIBMESH_DIM]

protected

TypeVector 的坐标。

在文件 type_vector.h 第 565 行定义.

参考自 libMesh::TypeTensor< T >::row().

---

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

• /home/lwz/libmesh/include/numerics/tensor_tools.h
• /home/lwz/libmesh/include/numerics/type_vector.h
• /home/lwz/libmesh/src/numerics/type_vector.C