libMesh::Point Class Reference

A Point defines a location in LIBMESH_DIM dimensional Real space. More...

#include <point.h>

Inheritance diagram for libMesh::Point:

Public Types
typedef Real	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
	Point (const Real x=0., const Real y=0., const Real z=0.)
	Constructor. More...
	Point (const Point &p)=default
	Trivial copy-constructor. More...
	Point (const TypeVector< Real > &p)
	Copy-constructor from non-point Typevector. More...
Point &	operator= (const Point &p)=default
	Copy-assignment operator. More...
template<typename T , typename = typename boostcopy::enable_if_c<ScalarTraits<T>::value,void>::type>
	Point (const T x)
	Disambiguate constructing from non-Real scalars. More...
	~Point ()=default
	Destructor. More...
void	assign (const TypeVector< T2 > &)
	Assign to this vector without creating a temporary. More...
const Real &	operator() (const unsigned int i) const
Real &	operator() (const unsigned int i)
const Real &	slice (const unsigned int i) const
Real &	slice (const unsigned int i)
TypeVector< typename CompareTypes< Real, T2 >::supertype >	operator+ (const TypeVector< T2 > &) const
	Add two vectors. More...
const TypeVector< Real > &	operator+= (const TypeVector< T2 > &)
	Add to this vector. More...
void	add (const TypeVector< T2 > &)
	Add to this vector without creating a temporary. More...
void	add_scaled (const TypeVector< T2 > &, const Real &)
	Add a scaled value to this vector without creating a temporary. More...
TypeVector< typename CompareTypes< Real, T2 >::supertype >	operator- (const TypeVector< T2 > &) const
	Subtract from this vector. More...
TypeVector< Real >	operator- () const
const TypeVector< Real > &	operator-= (const TypeVector< T2 > &)
	Subtract from this vector. More...
void	subtract (const TypeVector< T2 > &)
	Subtract from this vector without creating a temporary. More...
void	subtract_scaled (const TypeVector< T2 > &, const Real &)
	Subtract a scaled value from this vector without creating a temporary. More...
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< Real, Scalar >::supertype > >::type	operator* (const Scalar &) const
	Multiply this vector by a scalar value. More...
CompareTypes< Real, T2 >::supertype	operator* (const TypeVector< T2 > &) const
const TypeVector< Real > &	operator*= (const Real &)
	Multiply this vector by a scalar value. More...
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, TypeVector< typename CompareTypes< Real, Scalar >::supertype > >::type	operator/ (const Scalar &) const
	Divide each entry of this vector by scalar value. More...
const TypeVector< Real > &	operator/= (const Real &)
	Divide each entry of this vector by scalar value. More...
CompareTypes< Real, T2 >::supertype	contract (const TypeVector< T2 > &) const
TypeVector< typename CompareTypes< Real, T2 >::supertype >	cross (const TypeVector< T2 > &v) const
TypeVector< Real >	unit () const
auto	norm () const -> decltype(std::norm(Real()))
auto	norm_sq () const -> decltype(std::norm(Real()))
bool	is_zero () const
void	zero ()
	Set all entries of the vector to 0. More...
bool	relative_fuzzy_equals (const TypeVector< Real > &rhs, Real tol=TOLERANCE) const
bool	absolute_fuzzy_equals (const TypeVector< Real > &rhs, Real tol=TOLERANCE) const
bool	operator== (const TypeVector< Real > &rhs) const
bool	operator!= (const TypeVector< Real > &rhs) const
bool	operator< (const TypeVector< Real > &rhs) const
bool	operator< (const TypeVector< Complex > &rhs) const
bool	operator<= (const TypeVector< Real > &rhs) const
bool	operator<= (const TypeVector< Complex > &rhs) const
bool	operator> (const TypeVector< Real > &rhs) const
bool	operator> (const TypeVector< Complex > &rhs) const
bool	operator>= (const TypeVector< Real > &rhs) const
bool	operator>= (const TypeVector< Complex > &rhs) const
void	print (std::ostream &os=libMesh::out) const
	Formatted print, by default to libMesh::out. More...
void	write_unformatted (std::ostream &out_stream, const bool newline=true) const
	Unformatted print to the stream out. More...

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

Friends
class	Node
	Make the derived class a friend. More...

Detailed Description

A Point defines a location in LIBMESH_DIM dimensional Real space.

Points are always real-valued, even if the library is configured with –enable-complex.

Author

Benjamin S. Kirk

Date

2003 A geometric point in (x,y,z) space.

Definition at line 39 of file point.h.

Member Typedef Documentation

index_type

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

inherited

Helper typedef for generic index programming.

Definition at line 149 of file type_vector.h.

value_type

typedef Real libMesh::TypeVector< Real >::value_type

inherited

Helper typedef for C++98 generic programming.

Definition at line 144 of file type_vector.h.

Constructor & Destructor Documentation

Point() [1/4]

libMesh::Point::Point ( const Real  x = 0., const Real  y = 0., const Real  z = 0.  )

inline

Constructor.

By default sets all entries to 0. Gives the point 0 in LIBMESH_DIM dimensions.

Definition at line 47 of file point.h.

                          :
    TypeVector<Real> (x,y,z)
  {}

Point() [2/4]

libMesh::Point::Point ( const Point &  p )

default

Trivial copy-constructor.

Point() [3/4]

libMesh::Point::Point ( const TypeVector< Real > &  p )

inline

Copy-constructor from non-point Typevector.

Definition at line 61 of file point.h.

                                     :
    TypeVector<Real> (p)
  {}

Point() [4/4]

template<typename T , typename = typename boostcopy::enable_if_c<ScalarTraits<T>::value,void>::type>

libMesh::Point::Point ( const T  x )

inline

Disambiguate constructing from non-Real scalars.

Definition at line 76 of file point.h.

                    :
    TypeVector<Real> (x,0,0)
  {}

~Point()

libMesh::Point::~Point ( )

default

Destructor.

Member Function Documentation

absolute_fuzzy_equals()

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

inlineinherited

Returns

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

Definition at line 979 of file type_vector.h.

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

add()

void libMesh::TypeVector< Real >::add ( const TypeVector< T2 > &  p )

inlineinherited

Add to this vector without creating a temporary.

Definition at line 627 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()

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

inlineinherited

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

Definition at line 651 of file type_vector.h.

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

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

inlineinherited

Assign to this vector without creating a temporary.

Definition at line 556 of file type_vector.h.

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

contract()

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

inlineinherited

Returns

The result of TypeVector::operator*().

Definition at line 896 of file type_vector.h.

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

cross()

TypeVector< typename CompareTypes< Real , T2 >::supertype > libMesh::TypeVector< Real >::cross ( const TypeVector< T2 > &  v ) const

inherited

Returns

The cross product of this vector with v.

Definition at line 906 of file type_vector.h.

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

is_zero()

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

inlineinherited

Returns

True if all values in the vector are zero

Definition at line 969 of file type_vector.h.

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

norm()

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

inlineinherited

Returns

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

Definition at line 929 of file type_vector.h.

References libMesh::TensorTools::norm_sq(), and std::sqrt().

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

norm_sq()

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

inlineinherited

Returns

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

Definition at line 948 of file type_vector.h.

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

operator!=()

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

inlineinherited

Returns

!(*this == rhs)

Definition at line 1051 of file type_vector.h.

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

operator()() [1/2]

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

inlineinherited

Returns

A const reference to the \( i^{th} \) entry of the vector.

Definition at line 566 of file type_vector.h.

{
  libmesh_assert_less (i, LIBMESH_DIM);

  return _coords[i];
}

operator()() [2/2]

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

inlineinherited

Returns

A writable reference to the \( i^{th} \) entry of the vector.

Definition at line 577 of file type_vector.h.

{
  libmesh_assert_less (i, LIBMESH_DIM);

  return _coords[i];
}

operator*() [1/2]

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

inlineinherited

Multiply this vector by a scalar value.

Returns

A copy of the result, this vector is unchanged.

Definition at line 763 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]

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

inlineinherited

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 874 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*=()

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

inlineinherited

Multiply this vector by a scalar value.

Returns

A reference to *this.

Definition at line 800 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+()

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

inlineinherited

Add two vectors.

Returns

A copy of the result, this vector is unchanged.

Definition at line 590 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+=()

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

inlineinherited

Add to this vector.

Returns

A reference to *this.

Definition at line 615 of file type_vector.h.

{
  this->add (p);

  return *this;
}

operator-() [1/2]

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

inlineinherited

Subtract from this vector.

Returns

A copy of the result, this vector is unchanged.

Definition at line 676 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]

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

inlineinherited

Returns

The negative of this vector in a separate copy.

Definition at line 735 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-=()

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

inlineinherited

Subtract from this vector.

Returns

A reference to *this.

Definition at line 702 of file type_vector.h.

{
  this->subtract (p);

  return *this;
}

operator/()

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

inlineinherited

Divide each entry of this vector by scalar value.

Returns

A copy of the result, this vector is unchanged.

Definition at line 828 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/=()

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

inlineinherited

Divide each entry of this vector by scalar value.

Returns

A reference to *this.

Definition at line 857 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<() [1/2]

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

inherited

Definition at line 148 of file type_vector.C.

References std::imag(), and 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;
}

operator<() [2/2]

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

inherited

Returns

true if this vector is "less" than rhs.

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

Definition at line 90 of file type_vector.C.

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

operator<=() [1/2]

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

inherited

Definition at line 167 of file type_vector.C.

References std::imag(), and 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;
}

operator<=() [2/2]

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

inherited

Returns

true if this vector is <= to rhs.

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

Definition at line 104 of file type_vector.C.

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

operator=()

Point& libMesh::Point::operator= ( const Point &  p )

default

Copy-assignment operator.

operator==()

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

inlineinherited

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 1029 of file type_vector.h.

Referenced by libMesh::Node::operator==().

{
#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>() [1/2]

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

inherited

Definition at line 186 of file type_vector.C.

References std::imag(), and 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;
}

operator>() [2/2]

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

inherited

Returns

true if this vector is "greater" than rhs.

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

Definition at line 119 of file type_vector.C.

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

operator>=() [1/2]

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

inherited

Definition at line 205 of file type_vector.C.

References std::imag(), and 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;
}

operator>=() [2/2]

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

inherited

Returns

true if this vector is >= rhs.

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

Definition at line 133 of file type_vector.C.

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

print()

void libMesh::TypeVector< Real >::print ( std::ostream &  os = libMesh::out ) const

inherited

Formatted print, by default to libMesh::out.

Definition at line 47 of file type_vector.C.

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

relative_fuzzy_equals()

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

inlineinherited

Returns

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

Definition at line 1004 of file type_vector.h.

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

slice() [1/2]

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

inlineinherited

Definition at line 187 of file type_vector.h.

{ return (*this)(i); }

slice() [2/2]

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

inlineinherited

Definition at line 193 of file type_vector.h.

{ return (*this)(i); }

subtract()

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

inlineinherited

Subtract from this vector without creating a temporary.

Definition at line 714 of file type_vector.h.

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

subtract_scaled()

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

inlineinherited

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

Definition at line 725 of file type_vector.h.

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

unit()

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

inlineinherited

Returns

A unit vector in the direction of *this.

Definition at line 1120 of file type_vector.h.

References 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

}

write_unformatted()

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

inherited

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.

Definition at line 75 of file type_vector.C.

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

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

zero()

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

inlineinherited

Set all entries of the vector to 0.

Definition at line 938 of file type_vector.h.

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

Friends And Related Function Documentation

Node

friend class Node

friend

Make the derived class a friend.

Definition at line 90 of file point.h.

Member Data Documentation

_coords

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

protectedinherited

The coordinates of the TypeVector.

Definition at line 439 of file type_vector.h.

---

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

• include/geom/point.h