libMesh::VectorValue< T > Class Template Reference

This class defines a vector in LIBMESH_DIM dimensional Real or Complex space. More...

#include <exact_solution.h>

Inheritance diagram for libMesh::VectorValue< T >:

Classes
struct	rebind

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

Public Member Functions
	VectorValue ()
	Empty constructor. More...
	VectorValue (const T &x, const T &y=0, const T &z=0)
	Constructor-from-T. More...
template<typename Scalar1 , typename Scalar2 , typename Scalar3 >
	VectorValue (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 >
	VectorValue (const Scalar &x, typename boostcopy::enable_if_c< ScalarTraits< Scalar >::value, const Scalar >::type *sfinae=nullptr)
	Constructor-from-scalar. More...
template<typename T2 >
	VectorValue (const VectorValue< T2 > &p)
	Copy-constructor. More...
template<typename T2 >
	VectorValue (const TypeVector< T2 > &p)
	Copy-constructor. More...
	VectorValue (const TypeVector< Real > &p_re, const TypeVector< Real > &p_im)
	Constructor that takes two TypeVector<Real> representing the real and imaginary part as arguments. More...
template<typename Scalar >
boostcopy::enable_if_c< ScalarTraits< Scalar >::value, VectorValue & >::type	operator= (const Scalar &libmesh_dbg_var(p))
	Assignment-from-scalar operator. More...
template<typename T2 >
void	assign (const TypeVector< T2 > &)
	Assign to this vector without creating a temporary. More...
const T &	operator() (const unsigned int i) const
T &	operator() (const unsigned int i)
const T &	slice (const unsigned int i) const
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...
TypeVector< T >	operator- () const
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...
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...
template<typename T2 >
CompareTypes< T, T2 >::supertype	operator* (const TypeVector< T2 > &) const
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	contract (const TypeVector< T2 > &) const
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()))
auto	l1_norm () const
template<>
auto	l1_norm () const
template<>
auto	l1_norm () const
bool	is_zero () 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
template<>
bool	operator< (const TypeVector< Complex > &rhs) const
bool	operator<= (const TypeVector< T > &rhs) const
template<>
bool	operator<= (const TypeVector< Complex > &rhs) const
bool	operator> (const TypeVector< T > &rhs) const
template<>
bool	operator> (const TypeVector< Complex > &rhs) const
bool	operator>= (const TypeVector< T > &rhs) const
template<>
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
T	_coords [LIBMESH_DIM]
	The coordinates of the TypeVector. More...

Detailed Description

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

This class defines a vector in LIBMESH_DIM dimensional Real or Complex space.

The typedef RealVectorValue always defines a real-valued vector, and NumberVectorValue defines a real or complex-valued vector depending on how the library was configured.

Author

Benjamin S. Kirk

Date

2003

Definition at line 47 of file exact_solution.h.

Member Typedef Documentation

index_type

template<typename T>

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

inherited

Helper typedef for generic index programming.

Definition at line 122 of file type_vector.h.

value_type

template<typename T>

typedef T libMesh::VectorValue< T >::value_type

Definition at line 50 of file vector_value.h.

Constructor & Destructor Documentation

VectorValue() [1/7]

template<typename T >

libMesh::VectorValue< T >::VectorValue ( )

inline

Empty constructor.

Gives the vector 0 in LIBMESH_DIM dimensional T space.

Definition at line 150 of file vector_value.h.

                             :
  TypeVector<T> ()
{
}

VectorValue() [2/7]

template<typename T>

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

inline

Constructor-from-T.

By default sets higher dimensional entries to 0.

Definition at line 158 of file vector_value.h.

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

VectorValue() [3/7]

template<typename T >

template<typename Scalar1 , typename Scalar2 , typename Scalar3 >

libMesh::VectorValue< T >::VectorValue ( 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  )

inline

Constructor-from-scalars.

By default sets higher dimensional entries to 0.

Definition at line 170 of file vector_value.h.

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

VectorValue() [4/7]

template<typename T >

template<typename Scalar >

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

inline

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 VectorValue<Complex> v = 0;

Definition at line 187 of file vector_value.h.

                                                    :
  TypeVector<T> (x)
{
}

VectorValue() [5/7]

template<typename T >

template<typename T2 >

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

inline

Copy-constructor.

Definition at line 198 of file vector_value.h.

                                                      :
  TypeVector<T> (p)
{
}

VectorValue() [6/7]

template<typename T >

template<typename T2 >

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

inline

Copy-constructor.

Definition at line 208 of file vector_value.h.

                                                     :
  TypeVector<T> (p)
{
}

VectorValue() [7/7]

template<typename T>

libMesh::VectorValue< T >::VectorValue ( const TypeVector< Real > &  p_re, const TypeVector< Real > &  p_im  )

inline

Constructor that takes two TypeVector<Real> representing the real and imaginary part as arguments.

Definition at line 216 of file vector_value.h.

                                                            :
  TypeVector<T> (Complex (p_re(0), p_im(0)),
                 Complex (p_re(1), p_im(1)),
                 Complex (p_re(2), p_im(2)))
{
}

Member Function Documentation

absolute_fuzzy_equals()

template<typename T>

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

inlineinherited

Returns

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

Definition at line 972 of file type_vector.h.

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::LocationMap< T >::find(), libMesh::LineConstraint::is_parallel(), libMesh::PlaneConstraint::is_parallel(), libMesh::Pyramid::local_singular_node(), libMesh::LineConstraint::operator<(), libMesh::PlaneConstraint::operator<(), libMesh::PointConstraint::operator==(), libMesh::LineConstraint::operator==(), libMesh::PlaneConstraint::operator==(), libMesh::Elem::parent_bracketing_nodes(), VolumeTest::test_true_centroid_and_volume(), MeshTriangulationTest::testFoundCenters(), and VolumeTest::testQuad4TrueCentroid().

{
  return libMesh::absolute_fuzzy_equals(*this, rhs, tol);
}

add()

template<typename T >

template<typename T2 >

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

inlineinherited

Add to this vector without creating a temporary.

Definition at line 605 of file type_vector.h.

Referenced by libMesh::FEMap::inverse_map(), libMesh::Polyhedron::Polyhedron(), libMesh::LaplaceMeshSmoother::smooth(), libMesh::MeshTools::Modification::smooth(), and libMesh::Elem::vertex_average().

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

inlineinherited

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

Definition at line 629 of file type_vector.h.

Referenced by libMesh::MeshFunction::_gradient_on_elem(), libMesh::MeshRefinement::add_node(), libMesh::HPCoarsenTest::add_projection(), assemble_cd(), assemble_stokes(), InfFERadialTest::base_point(), libMesh::Elem::coarsen(), compute_stresses(), SolidSystem::element_time_derivative(), libMesh::InfFEMap::inverse_map(), libMesh::InfFEMap::map(), libMesh::FEMap::map(), libMesh::FEMap::map_deriv(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::Elem::parent_bracketing_nodes(), libMesh::ExodusII_IO::read(), libMesh::DynaIO::read_mesh(), libMesh::HPCoarsenTest::select_refinement(), libMesh::MeshTools::Modification::smooth(), TypeVectorTestBase< VectorValue< Number > >::testVectorAddScaled(), and TypeVectorTestBase< VectorValue< Number > >::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 )

inlineinherited

Assign to this vector without creating a temporary.

Definition at line 534 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

inlineinherited

Returns

The result of TypeVector::operator*().

Definition at line 874 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

inherited

Returns

The cross product of this vector with v.

Definition at line 884 of file type_vector.h.

Referenced by libMesh::TriangulatorInterface::Hole::areavec(), assemble_shell(), libMesh::InfFE< Dim, T_radial, T_map >::compute_face_functions(), libMesh::FEMap::compute_face_map(), libMesh::InfFE< Dim, T_radial, T_map >::compute_shape_functions(), libMesh::LineConstraint::contains_point(), ContainsPointTest::containsPointTri3Helper(), libMesh::Plane::create_from_three_points(), libMesh::VariationalSmootherConstraint::determine_constraint(), libMesh::Quad4::has_invertible_map(), libMesh::LineConstraint::intersect(), libMesh::PlaneConstraint::intersect(), libMesh::TriangulatorInterface::MeshedHole::MeshedHole(), libMesh::Quad::quality(), libMesh::Face::quasicircumcenter(), libMesh::C0Polygon::retriangulate(), and libMesh::Quad4::volume().

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

template<typename T >

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

inlineinherited

Returns

True if all values in the vector are zero

Definition at line 947 of file type_vector.h.

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

l1_norm() [1/3]

template<>

auto libMesh::TypeVector< bool >::l1_norm ( ) const

inherited

Definition at line 203 of file type_vector.C.

{
  bool ret{};
  for (const auto i : make_range(libmesh_dim))
    ret += _coords[i];

  return ret;
}

l1_norm() [2/3]

template<typename T >

auto libMesh::TypeVector< T >::l1_norm ( ) const

inherited

Returns

The L1 norm of the vector

Definition at line 961 of file type_vector.h.

{
  decltype(std::abs(T())) ret{};
  for (const auto i : make_range(libmesh_dim))
    ret += std::abs(_coords[i]);

  return ret;
}

l1_norm() [3/3]

template<>

auto libMesh::TypeVector< bool >::l1_norm ( ) const

inherited

norm()

template<typename T>

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

inlineinherited

Returns

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

Definition at line 907 of file type_vector.h.

Referenced by libMesh::Sphere::above_surface(), libMesh::TriangulatorInterface::Hole::area(), assemble_shell(), InfFERadialTest::base_point(), libMesh::InfElemBuilder::build_inf_elem(), libMesh::InfFE< Dim, T_radial, T_map >::compute_shape_functions(), libMesh::VariationalSmootherConstraint::constrain_node_to_plane(), libMesh::InfPrism::contains_point(), libMesh::InfHex::contains_point(), libMesh::Polyhedron::convex(), libMesh::VariationalSmootherConstraint::determine_constraint(), libMesh::Quad4::has_invertible_map(), libMesh::Edge4::has_invertible_map(), libMesh::PlaneConstraint::intersect(), libMesh::InfFEMap::inverse_map(), libMesh::FEMap::inverse_map(), libMesh::LineConstraint::LineConstraint(), ExodusTest< elem_type >::meshes_equal_enough(), libMesh::Tri3::min_and_max_angle(), libMesh::Tet4::min_and_max_angle(), libMesh::Polyhedron::on_reference_element(), libMesh::Sphere::on_surface(), libMesh::PlaneConstraint::PlaneConstraint(), libMesh::Polyhedron::Polyhedron(), libMesh::Tri::quality(), libMesh::Quad::quality(), libMesh::MeshTools::Modification::smooth(), libMesh::Sphere::surface_coords(), InfFERadialTest::testInfQuants(), InfFERadialTest::testInfQuants_numericDeriv(), TypeVectorTestBase< VectorValue< Number > >::testNormBase(), and MeshTriangulationTest::testTriangulatorRoundHole().

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

norm_sq()

template<typename T>

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

inlineinherited

Returns

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

Definition at line 926 of file type_vector.h.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::InfQuad4::contains_point(), libMesh::InfPrism::contains_point(), libMesh::InfHex::contains_point(), libMesh::ExactErrorEstimator::find_squared_element_error(), libMesh::Edge3::has_invertible_map(), libMesh::LineConstraint::intersect(), libMesh::PointLocatorNanoflann::kdtree_distance(), main(), libMesh::Face::quasicircumcenter(), libMesh::HPCoarsenTest::select_refinement(), libMesh::Sphere::Sphere(), InfFERadialTest::testInfQuants(), InfFERadialTest::testInfQuants_numericDeriv(), TypeVectorTestBase< VectorValue< Number > >::testNormSqBase(), MeshTriangulationTest::testTriangulatorRoundHole(), and libMesh::Edge3::volume().

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

inlineinherited

Returns

!(*this == rhs)

Definition at line 1012 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

inlineinherited

Returns

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

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

inlineinherited

Returns

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

Definition at line 555 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

inlineinherited

Multiply this vector by a scalar value.

Returns

A copy of the result, this vector is unchanged.

Definition at line 741 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

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

inlineinherited

Multiply this vector by a scalar value.

Returns

A reference to *this.

Definition at line 778 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

inlineinherited

Add two vectors.

Returns

A copy of the result, this vector is unchanged.

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

inlineinherited

Add to this vector.

Returns

A reference to *this.

Definition at line 593 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

inlineinherited

Subtract from this vector.

Returns

A copy of the result, this vector is unchanged.

Definition at line 654 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

inlineinherited

Returns

The negative of this vector in a separate copy.

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

inlineinherited

Subtract from this vector.

Returns

A reference to *this.

Definition at line 680 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

inlineinherited

Divide each entry of this vector by scalar value.

Returns

A copy of the result, this vector is unchanged.

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

inlineinherited

Divide each entry of this vector by scalar value.

Returns

A reference to *this.

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

template<>

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

inherited

Definition at line 124 of file type_vector.C.

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

template<typename T>

bool libMesh::TypeVector< T >::operator< ( const TypeVector< T > &  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 66 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]

template<>

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

inherited

Definition at line 143 of file type_vector.C.

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

template<typename T>

bool libMesh::TypeVector< T >::operator<= ( const TypeVector< T > &  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 80 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=()

template<typename T>

template<typename Scalar >

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

inline

Assignment-from-scalar operator.

Used only to zero out vectors.

Definition at line 130 of file vector_value.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

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

template<>

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

inherited

Definition at line 162 of file type_vector.C.

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

template<typename T>

bool libMesh::TypeVector< T >::operator> ( const TypeVector< T > &  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 95 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]

template<>

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

inherited

Definition at line 181 of file type_vector.C.

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

template<typename T>

bool libMesh::TypeVector< T >::operator>= ( const TypeVector< T > &  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 109 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()

template<typename T >

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

inherited

Formatted print, by default to libMesh::out.

Definition at line 1129 of file type_vector.h.

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

template<typename T>

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

inlineinherited

Returns

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

Definition at line 981 of file type_vector.h.

Referenced by libMesh::Edge3::has_affine_map(), libMesh::Quad4::has_affine_map(), libMesh::Edge4::has_affine_map(), libMesh::Quad9::has_affine_map(), libMesh::Quad8::has_affine_map(), libMesh::Prism6::has_affine_map(), libMesh::Hex8::has_affine_map(), libMesh::Tri6::has_affine_map(), libMesh::Tri7::has_affine_map(), libMesh::Hex27::has_affine_map(), libMesh::Hex20::has_affine_map(), libMesh::Tet10::has_affine_map(), libMesh::Prism15::has_affine_map(), libMesh::Prism18::has_affine_map(), libMesh::Tet14::has_affine_map(), libMesh::Prism20::has_affine_map(), libMesh::Prism21::has_affine_map(), libMesh::Quad4::volume(), and libMesh::Tri6::volume().

{
  return libMesh::relative_fuzzy_equals(*this, rhs, tol);
}

slice() [1/2]

template<typename T>

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

inlineinherited

Definition at line 160 of file type_vector.h.

{ return (*this)(i); }

slice() [2/2]

template<typename T>

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

inlineinherited

Definition at line 166 of file type_vector.h.

{ return (*this)(i); }

subtract()

template<typename T >

template<typename T2 >

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

inlineinherited

Subtract from this vector without creating a temporary.

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

inlineinherited

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

Definition at line 703 of file type_vector.h.

Referenced by libMesh::HPCoarsenTest::select_refinement().

{
  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

inlineinherited

Returns

A unit vector in the direction of *this.

Definition at line 1104 of file type_vector.h.

Referenced by libMesh::InfFE< Dim, T_radial, T_map >::compute_face_functions(), libMesh::FEMap::compute_face_map(), ContainsPointTest::containsPointTri3Helper(), libMesh::Polyhedron::convex(), libMesh::Plane::create_from_point_normal(), libMesh::Plane::create_from_three_points(), libMesh::VariationalSmootherConstraint::determine_constraint(), libMesh::MeshTools::Modification::distort(), libMesh::Polyhedron::on_reference_element(), libMesh::Polyhedron::Polyhedron(), libMesh::Elem::quality(), libMesh::C0Polygon::retriangulate(), AzimuthalPeriodicBoundary::set_up_rotation_matrix(), and libMesh::Sphere::unit_normal().

{

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

template<typename T >

void libMesh::TypeVector< T >::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 51 of file type_vector.C.

Referenced by libMesh::InfElemBuilder::build_inf_elem(), and libMesh::TecplotIO::write_ascii().

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

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

zero()

template<typename T >

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

inlineinherited

Set all entries of the vector to 0.

Definition at line 916 of file type_vector.h.

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

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

Member Data Documentation

_coords

template<typename T>

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

protectedinherited

The coordinates of the TypeVector.

Definition at line 417 of file type_vector.h.

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

---

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

• include/error_estimation/exact_solution.h
• include/numerics/vector_value.h