edge.hpp

Go to the documentation of this file.

// OpenBEM - Copyright (C) 2026 Shashwat Sharma
 
// This file is part of OpenBEM.
 
// OpenBEM is free software: you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, either version 3
// of the License, or (at your option) any later version.
 
// You should have received a copy of the GNU General Public License along with OpenBEM.
// If not, see <https://www.gnu.org/licenses/>.
 
 
#ifndef EDGE_H
#define EDGE_H
 
#include <stdexcept>
 
#include "types.hpp"
 
 
namespace bem
{
 
const Float EDGE_DEFAULT_TOL = 1.0e-6;
 
template <uint8_t dim>
class Edge
{
 
    static_assert((dim == 1 || dim == 2 || dim == 3), "Edge must be defined in one, two, or three dimensions.");
 
public:
 
    Edge(ConstEigRef<EigMatMN<Float, dim, 2>> v)
    {
        set_v(v);
        return;
    };
 
 
    Edge(ConstEigRef<EigColVecN<Float, dim>> v1, ConstEigRef<EigColVecN<Float, dim>> v2)
    {
        EigMatMN<Float, dim, 2> v;
        v << v1, v2;
        set_v(v);
        return;
    };
 
 
    const EigMatMN<Float, dim, 2>& v() const
    {
        return v_;
    };
 
 
    EigColVecN<Float, dim> v(const uint8_t idx) const
    {
        if (idx >= 2)
            throw std::out_of_range("Edge::v(): vertex index out of bounds.");
        return v_.col(idx);
    };
 
 
    void set_v(ConstEigRef<EigMatMN<Float, dim, 2>> v);
 
 
    Float length() const
    { return length_; };
 
 
    EigColVecN<Float, dim> edge_vec() const
    { return edge_vec_; };
 
 
    EigColVecN<Float, dim> unit_vec() const
    { return unit_vec_; };
 
 
    EigColVecN<Float, dim> centroid() const
    { return centroid_; };
 
 
    static Edge<dim> reference_edge();
 
 
    Edge<2> to_2d() const;
 
 
    Edge<3> to_3d() const;
 
 
    bool point_on_edge(ConstEigRef<EigColVecN<Float, dim>> r, const Float tol = EDGE_DEFAULT_TOL) const;
 
 
private:
 
    EigColVecN<Float, dim> compute_edge_vec() const { return v_.col(1) - v_.col(0); };
 
 
    Float compute_length() const { return edge_vec().norm(); };
 
 
    EigColVecN<Float, dim> compute_unit_vec() const { return edge_vec() / length(); };
 
 
    EigColVecN<Float, dim> compute_centroid() const { return v_.rowwise().sum() / 2.0; };
 
 
    EigMatMN<Float, dim, 2> v_;
    Float length_;
    EigColVecN<Float, dim> edge_vec_, unit_vec_, centroid_;
 
};
 
}
 
#ifndef BEM_LINKED
#include "geometry/primitives/edge.cpp"
#endif
 
#endif