libMesh::PointConstraint Class Reference

Represents a fixed point constraint. More...

#include <variational_smoother_constraint.h>

Public Member Functions
	PointConstraint ()=default
	PointConstraint (const Point &point, const Real &tol=TOLERANCE *TOLERANCE)
	Constructor. More...
bool	operator< (const PointConstraint &other) const
	Comparison operator for ordering PointConstraint objects. More...
bool	operator== (const PointConstraint &other) const
	Equality operator. More...
bool	contains_point (const PointConstraint &p) const
	Query whether a point lies on another point. More...
ConstraintVariant	intersect (const ConstraintVariant &other) const
	Computes the intersection of this point with another constraint. More...
const Point &	point () const
	Const getter for the _point attribute. More...
const Real &	tol () const
	Const getter for the _tol attribute. More...

Private Attributes
Point	_point
	Location of constraint. More...
Real	_tol
	Tolerance to use for numerical comparisons. More...

Detailed Description

Represents a fixed point constraint.

Definition at line 49 of file variational_smoother_constraint.h.

Constructor & Destructor Documentation

PointConstraint() [1/2]

libMesh::PointConstraint::PointConstraint ( )

default

PointConstraint() [2/2]

libMesh::PointConstraint::PointConstraint	(	const Point &	point,
		const Real &	tol = TOLERANCE * TOLERANCE
	)

Constructor.

Parameters

point	The point defining the constraint.
tol	The tolerance to use for numerical comparisons.

Definition at line 48 of file variational_smoother_constraint.C.

                                                                      : _point(point), _tol(tol)
{
}

Member Function Documentation

contains_point()

bool libMesh::PointConstraint::contains_point ( const PointConstraint &  p ) const

inline

Query whether a point lies on another point.

Parameters

p	The point in question

Returns

bool indicating whether p lies on this point.

Definition at line 84 of file variational_smoother_constraint.h.

{ return *this == p; }

intersect()

ConstraintVariant libMesh::PointConstraint::intersect

(

const ConstraintVariant &

other

)

const

Computes the intersection of this point with another constraint.

Handles intersection with PointConstraint, LineConstraint, or PlaneConstraint.

Parameters

other

The constraint to intersect with.

Returns

The most specific ConstraintVariant that satisfies both constraints. constraints. If no intersection exists, return an InvalidConstraint.

Definition at line 65 of file variational_smoother_constraint.C.

{
  // using visit to resolve the variant to its actual type
  return std::visit(
      [&](auto && o) -> ConstraintVariant {
        if (!o.contains_point(*this))
          // Point is not on the constraint
          return InvalidConstraint();

        return *this;
      },
      other);
}

operator<()

bool libMesh::PointConstraint::operator<

(

const PointConstraint &

other

)

const

Comparison operator for ordering PointConstraint objects.

A PointConstraint is considered less than another if its location is lexicographically less than the other's location.

Parameters

other	The PointConstraint to compare with.
tol	The tolerance to use for numerical comparisons.

Returns

True if this PointConstraint is less than the other.

Definition at line 52 of file variational_smoother_constraint.C.

References _point, and point().

{
  if (*this == other)
    return false;

  return _point < other.point();
}

operator==()

bool libMesh::PointConstraint::operator==

(

const PointConstraint &

other

)

const

Equality operator.

Parameters

other

The PointConstraint to compare with.

Returns

True if both PointConstraints have the same location.

Definition at line 60 of file variational_smoother_constraint.C.

References _point, _tol, libMesh::TypeVector< T >::absolute_fuzzy_equals(), and point().

{
  return _point.absolute_fuzzy_equals(other.point(), _tol);
}

point()

const Point& libMesh::PointConstraint::point ( ) const

inline

Const getter for the _point attribute.

Definition at line 100 of file variational_smoother_constraint.h.

References _point.

Referenced by libMesh::LineConstraint::contains_point(), libMesh::PlaneConstraint::contains_point(), libMesh::PlaneConstraint::intersect(), operator<(), and operator==().

{ return _point; }

tol()

const Real& libMesh::PointConstraint::tol ( ) const

inline

Const getter for the _tol attribute.

Definition at line 105 of file variational_smoother_constraint.h.

References _tol.

{ return _tol; }

Member Data Documentation

_point

Point libMesh::PointConstraint::_point

private

Location of constraint.

Definition at line 112 of file variational_smoother_constraint.h.

Referenced by operator<(), operator==(), and point().

_tol

Real libMesh::PointConstraint::_tol

private

Tolerance to use for numerical comparisons.

Definition at line 117 of file variational_smoother_constraint.h.

Referenced by operator==(), and tol().

---

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

• include/systems/variational_smoother_constraint.h
• src/systems/variational_smoother_constraint.C