libMesh::TypeVector< T > Class Template Reference

This class defines a vector in LIBMESH_DIM dimensional space of type T. More...

#include <tensor_tools.h>

Inheritance diagram for libMesh::TypeVector< T >:

Public Types
typedef T	value_type
	Helper typedef for C++98 generic programming. More...
typedef unsigned int	index_type
	Helper typedef for generic index programming. More...

Public Member Functions
	TypeVector ()
	Empty constructor. More...
template<typename T2 >
	TypeVector (const TypeVector< T2 > &p)
	Copy-constructor. More...
	~TypeVector ()
	Destructor. More...
template<typename T2 >
void	assign (const TypeVector< T2 > &)
	Assign to this vector without creating a temporary. More...
template<typename Scalar >
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector & >::type	operator= (const Scalar &libmesh_dbg_var(p))
	Assignment-from-scalar operator. More...
const T &	operator() (const unsigned int i) const
const T &	slice (const unsigned int i) const
T &	operator() (const unsigned int i)
T &	slice (const unsigned int i)
template<typename T2 >
TypeVector< typename CompareTypes< T, T2 >::supertype >	operator+ (const TypeVector< T2 > &) const
	Add two vectors. More...
template<typename T2 >
const TypeVector< T > &	operator+= (const TypeVector< T2 > &)
	Add to this vector. More...
template<typename T2 >
void	add (const TypeVector< T2 > &)
	Add to this vector without creating a temporary. More...
template<typename T2 >
void	add_scaled (const TypeVector< T2 > &, const T)
	Add a scaled value to this vector without creating a temporary. More...
template<typename T2 >
TypeVector< typename CompareTypes< T, T2 >::supertype >	operator- (const TypeVector< T2 > &) const
	Subtract from this vector. More...
template<typename T2 >
const TypeVector< T > &	operator-= (const TypeVector< T2 > &)
	Subtract from this vector. More...
template<typename T2 >
void	subtract (const TypeVector< T2 > &)
	Subtract from this vector without creating a temporary. More...
template<typename T2 >
void	subtract_scaled (const TypeVector< T2 > &, const T)
	Subtract a scaled value from this vector without creating a temporary. More...
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
	Multiply this vector by a scalar value. More...
const TypeVector< T > &	operator*= (const T)
	Multiply this vector by a scalar value. More...
template<typename Scalar >
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< T, Scalar >::supertype > >::type	operator/ (const Scalar) const
	Divide each entry of this vector by scalar value. More...
const TypeVector< T > &	operator/= (const T)
	Divide each entry of this vector by scalar value. More...
template<typename T2 >
CompareTypes< T, T2 >::supertype	operator* (const TypeVector< T2 > &) const
template<typename T2 >
CompareTypes< T, T2 >::supertype	contract (const TypeVector< T2 > &) const
template<typename T2 >
TypeVector< typename CompareTypes< T, T2 >::supertype >	cross (const TypeVector< T2 > &v) const
TypeVector< T >	unit () const
Real	size () const
Real	norm () const
Real	size_sq () const
Real	norm_sq () const
void	zero ()
	Set all entries of the vector to 0. More...
bool	relative_fuzzy_equals (const TypeVector< T > &rhs, Real tol=TOLERANCE) const
bool	absolute_fuzzy_equals (const TypeVector< T > &rhs, Real tol=TOLERANCE) 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
bool	operator>= (const TypeVector< T > &rhs) const
void	print (std::ostream &os=libMesh::out) const
	Formatted print, by default to libMesh::out. More...
void	write_unformatted (std::ostream &out, const bool newline=true) const
	Unformatted print to the stream out. More...

Protected Member Functions
	TypeVector (const T x, const T y=0, const T z=0)
	Constructor-from-T. More...
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)
	Constructor-from-scalars. More...
template<typename Scalar >
	TypeVector (const Scalar x, typename boostcopy::enable_if_c< ScalarTraits< Scalar >::value, const Scalar >::type *sfinae=nullptr)
	Constructor-from-scalar. More...

Protected Attributes
T	_coords [LIBMESH_DIM]
	The coordinates of the TypeVector. More...

Friends
template<typename T2 >
class	TypeVector
class	TypeTensor< T >
std::ostream &	operator<< (std::ostream &os, const TypeVector< T > &t)
	Formatted print as above but supports the syntax: More...

Detailed Description

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

This class defines a vector in LIBMESH_DIM dimensional space of type T.

T may either be Real or Complex. Instead use one of the derived types such as Point or Node.

Author

Benjamin S. Kirk

Date

2003

Definition at line 30 of file tensor_tools.h.

Member Typedef Documentation

index_type

template<typename T>

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

Helper typedef for generic index programming.

Definition at line 110 of file type_vector.h.

value_type

template<typename T>

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

Helper typedef for C++98 generic programming.

Definition at line 105 of file type_vector.h.

Constructor & Destructor Documentation

TypeVector() [1/5]

template<typename T >

libMesh::TypeVector< T >::TypeVector

(

)

Empty constructor.

Gives the vector 0 in LIBMESH_DIM dimensions.

Definition at line 421 of file type_vector.h.

{
  _coords[0] = 0;

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

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

TypeVector() [2/5]

template<typename T>

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

protected

Constructor-from-T.

By default sets higher dimensional entries to 0.

Definition at line 438 of file type_vector.h.

{
  _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
}

TypeVector() [3/5]

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  )

protected

Constructor-from-scalars.

By default sets higher dimensional entries to 0.

Definition at line 461 of file type_vector.h.

{
  _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
}

TypeVector() [4/5]

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  )

protected

Constructor-from-scalar.

Sets higher dimensional entries to 0. Necessary because for some reason the constructor-from-scalars alone is insufficient to let the compiler figure out TypeVector<Complex> v = 0;

Definition at line 491 of file type_vector.h.

{
  _coords[0] = x;

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

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

TypeVector() [5/5]

template<typename T >

template<typename T2 >

libMesh::TypeVector< T >::TypeVector

(

const TypeVector< T2 > &

p

)

Copy-constructor.

Definition at line 512 of file type_vector.h.

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

~TypeVector()

template<typename T >

libMesh::TypeVector< T >::~TypeVector

(

)

Destructor.

Definition at line 523 of file type_vector.h.

{
}

Member Function Documentation

absolute_fuzzy_equals()

template<typename T>

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

Returns

true if two vectors are equal to within an absolute tolerance of tol.

Definition at line 965 of file type_vector.h.

{
#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
}

add()

template<typename T >

template<typename T2 >

void libMesh::TypeVector< T >::add

(

const TypeVector< T2 > &

p

)

Add to this vector without creating a temporary.

Definition at line 603 of file type_vector.h.

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

#if LIBMESH_DIM == 2
  _coords[0] += p._coords[0];
  _coords[1] += p._coords[1];
#endif

#if LIBMESH_DIM == 3
  _coords[0] += p._coords[0];
  _coords[1] += p._coords[1];
  _coords[2] += p._coords[2];
#endif

}

add_scaled()

template<typename T>

template<typename T2 >

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

Add a scaled value to this vector without creating a temporary.

Definition at line 627 of file type_vector.h.

Referenced by TypeVectorTestBase< DerivedClass >::testVectorAddScaledBase().

{
#if LIBMESH_DIM == 1
  _coords[0] += factor*p(0);
#endif

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

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

}

assign()

template<typename T >

template<typename T2 >

void libMesh::TypeVector< T >::assign

(

const TypeVector< T2 > &

p

)

Assign to this vector without creating a temporary.

Definition at line 532 of file type_vector.h.

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

contract()

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::TypeVector< T >::contract

(

const TypeVector< T2 > &

p

)

const

Returns

The result of TypeVector::operator*().

Definition at line 872 of file type_vector.h.

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

cross()

template<typename T >

template<typename T2 >

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

(

const TypeVector< T2 > &

v

)

const

Returns

The cross product of this vector with v.

Definition at line 882 of file type_vector.h.

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

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

norm()

template<typename T >

Real libMesh::TypeVector< T >::norm

(

)

const

Returns

The magnitude of the vector, i.e. the square-root of the sum of the elements squared.

Definition at line 912 of file type_vector.h.

Referenced by libMesh::Sphere::surface_coords(), and TypeVectorTestBase< DerivedClass >::testNormBase().

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

norm_sq()

template<typename T >

Real libMesh::TypeVector< T >::norm_sq

(

)

const

Returns

The magnitude of the vector squared, i.e. the sum of the element magnitudes squared.

Definition at line 943 of file type_vector.h.

Referenced by libMesh::TensorTools::norm_sq(), and TypeVectorTestBase< DerivedClass >::testNormSqBase().

{
#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
}

operator!=()

template<typename T>

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

(

const TypeVector< T > &

rhs

)

const

Returns

!(*this == rhs)

Definition at line 1037 of file type_vector.h.

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

operator()() [1/2]

template<typename T >

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

(

const unsigned int

i

)

const

Returns

A const reference to the entry of the vector.

Definition at line 542 of file type_vector.h.

{
  libmesh_assert_less (i, LIBMESH_DIM);

  return _coords[i];
}

operator()() [2/2]

template<typename T >

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

(

const unsigned int

i

)

Returns

A writable reference to the entry of the vector.

Definition at line 553 of file type_vector.h.

{
  libmesh_assert_less (i, LIBMESH_DIM);

  return _coords[i];
}

operator*() [1/2]

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

Multiply this vector by a scalar value.

Returns

A copy of the result, this vector is unchanged.

Definition at line 739 of file type_vector.h.

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

operator*() [2/2]

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::TypeVector< T >::operator*

(

const TypeVector< T2 > &

p

)

const

Returns

The dot-product of this vector with another vector.

Note

The complex conjugate is not taken in the complex-valued case.

The vectors may contain different numeric types.

Definition at line 850 of file type_vector.h.

{
#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
}

operator*=()

template<typename T>

const TypeVector< T > & libMesh::TypeVector< T >::operator*=

(

const T

factor

)

Multiply this vector by a scalar value.

Returns

A reference to *this.

Definition at line 776 of file type_vector.h.

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

operator+()

template<typename T >

template<typename T2 >

TypeVector< typename CompareTypes< T, T2 >::supertype > libMesh::TypeVector< T >::operator+

(

const TypeVector< T2 > &

p

)

const

Add two vectors.

Returns

A copy of the result, this vector is unchanged.

Definition at line 566 of file type_vector.h.

{
  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

}

operator+=()

template<typename T >

template<typename T2 >

const TypeVector< T > & libMesh::TypeVector< T >::operator+=

(

const TypeVector< T2 > &

p

)

Add to this vector.

Returns

A reference to *this.

Definition at line 591 of file type_vector.h.

{
  this->add (p);

  return *this;
}

operator-() [1/2]

template<typename T >

template<typename T2 >

TypeVector< typename CompareTypes< T, T2 >::supertype > libMesh::TypeVector< T >::operator-

(

const TypeVector< T2 > &

p

)

const

Subtract from this vector.

Returns

A copy of the result, this vector is unchanged.

Definition at line 652 of file type_vector.h.

{
  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

}

operator-() [2/2]

template<typename T >

TypeVector< T > libMesh::TypeVector< T >::operator-

(

)

const

Returns

The negative of this vector in a separate copy.

Definition at line 711 of file type_vector.h.

{

#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

}

operator-=()

template<typename T >

template<typename T2 >

const TypeVector< T > & libMesh::TypeVector< T >::operator-=

(

const TypeVector< T2 > &

p

)

Subtract from this vector.

Returns

A reference to *this.

Definition at line 678 of file type_vector.h.

{
  this->subtract (p);

  return *this;
}

operator/()

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

Divide each entry of this vector by scalar value.

Returns

A copy of the result, this vector is unchanged.

Definition at line 804 of file type_vector.h.

{
  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

}

operator/=()

template<typename T>

const TypeVector< T > & libMesh::TypeVector< T >::operator/=

(

const T

factor

)

Divide each entry of this vector by scalar value.

Returns

A reference to *this.

Definition at line 833 of file type_vector.h.

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

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

  return *this;
}

operator<()

template<typename T>

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

(

const TypeVector< T > &

rhs

)

const

Returns

true if this vector is "less" than rhs.

Useful for sorting. Also used for choosing some arbitrary basis function orientations.

operator<=()

template<typename T>

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

(

const TypeVector< T > &

rhs

)

const

Returns

true if this vector is <= to rhs.

Useful for sorting. Also used for choosing some arbitrary constraint equation directions.

operator=()

template<typename T>

template<typename Scalar >

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

(

const Scalar &

libmesh_dbg_varp

)

Assignment-from-scalar operator.

Used only to zero out vectors.

Definition at line 136 of file type_vector.h.

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

operator==()

template<typename T>

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

(

const TypeVector< T > &

rhs

)

const

Returns

true if this(i)==rhs(i) for each component of the vector.

Note

For floating point types T, the function absolute_fuzzy_equals() may be a more appropriate choice.

Definition at line 1015 of file type_vector.h.

{
#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
}

operator>()

template<typename T>

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

(

const TypeVector< T > &

rhs

)

const

Returns

true if this vector is "greater" than rhs.

Useful for sorting. Also used for choosing some arbitrary basis function orientations.

operator>=()

template<typename T>

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

(

const TypeVector< T > &

rhs

)

const

Returns

true if this vector is >= rhs.

Useful for sorting. Also used for choosing some arbitrary constraint equation directions.

print()

template<typename T>

void libMesh::TypeVector< T >::print

(

std::ostream &

os = libMesh::out

)

const

Formatted print, by default to libMesh::out.

relative_fuzzy_equals()

template<typename T>

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

Returns

true if two vectors are equal to within a relative tolerance of tol.

Definition at line 990 of file type_vector.h.

{
#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
}

size()

template<typename T >

Real libMesh::TypeVector< T >::size

(

)

const

Returns

The magnitude of the vector, i.e. the square-root of the sum of the elements squared.

Deprecated:

Use the norm() function instead.

Definition at line 901 of file type_vector.h.

{
  libmesh_deprecated();
  return this->norm();
}

size_sq()

template<typename T >

Real libMesh::TypeVector< T >::size_sq

(

)

const

Returns

The magnitude of the vector squared, i.e. the sum of the element magnitudes squared.

Deprecated:

Use the norm_sq() function instead.

Definition at line 932 of file type_vector.h.

{
  libmesh_deprecated();
  return this->norm_sq();
}

slice() [1/2]

template<typename T>

const T& libMesh::TypeVector< T >::slice

(

const unsigned int

i

)

const

Definition at line 143 of file type_vector.h.

{ return (*this)(i); }

slice() [2/2]

template<typename T>

T& libMesh::TypeVector< T >::slice

(

const unsigned int

i

)

Definition at line 149 of file type_vector.h.

{ return (*this)(i); }

subtract()

template<typename T >

template<typename T2 >

void libMesh::TypeVector< T >::subtract

(

const TypeVector< T2 > &

p

)

Subtract from this vector without creating a temporary.

Definition at line 690 of file type_vector.h.

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

subtract_scaled()

template<typename T>

template<typename T2 >

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

Subtract a scaled value from this vector without creating a temporary.

Definition at line 701 of file type_vector.h.

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

unit()

template<typename T>

TypeVector<T> libMesh::TypeVector< T >::unit

(

)

const

Returns

A unit vector in the direction of *this.

write_unformatted()

template<typename T>

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

Unformatted print to the stream out.

Simply prints the elements of the vector separated by spaces. Also prints a newline by default, however, this behavior can be controlled with the newline parameter.

zero()

template<typename T >

void libMesh::TypeVector< T >::zero

(

)

Set all entries of the vector to 0.

Definition at line 921 of file type_vector.h.

Referenced by libMesh::VectorValue< Real >::operator=(), libMesh::TypeVector< Real >::operator=(), and TypeVectorTestBase< DerivedClass >::testZeroBase().

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

Friends And Related Function Documentation

operator<<

template<typename T>

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

friend

Formatted print as above but supports the syntax:

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

Definition at line 390 of file type_vector.h.

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

TypeTensor< T >

template<typename T>

friend class TypeTensor< T >

friend

Definition at line 55 of file type_vector.h.

TypeVector

template<typename T>

template<typename T2 >

friend class TypeVector

friend

Definition at line 53 of file type_vector.h.

Member Data Documentation

_coords

template<typename T>

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

protected

The coordinates of the TypeVector.

Definition at line 409 of file type_vector.h.

Referenced by libMesh::TypeTensor< T >::row().

---

The documentation for this class was generated from the following files:

• include/numerics/tensor_tools.h
• include/numerics/type_vector.h