CADSurf.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////////////
//
//  File: CADSurf.h
//
//  For more information, please see: http://www.nektar.info/
//
//  The MIT License
//
//  Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
//  Department of Aeronautics, Imperial College London (UK), and Scientific
//  Computing and Imaging Institute, University of Utah (USA).
//
//  License for the specific language governing rights and limitations under
//  Permission is hereby granted, free of charge, to any person obtaining a
//  copy of this software and associated documentation files (the "Software"),
//  to deal in the Software without restriction, including without limitation
//  the rights to use, copy, modify, merge, publish, distribute, sublicense,
//  and/or sell copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included
//  in all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
//  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//  DEALINGS IN THE SOFTWARE.
//
//  Description: CAD object surface.
//
////////////////////////////////////////////////////////////////////////////////

#ifndef NekMeshUtils_CADSYSTEM_CADSURF
#define NekMeshUtils_CADSYSTEM_CADSURF

#include <boost/shared_ptr.hpp>

#include <LibUtilities/BasicUtils/SharedArray.hpp>
#include <LibUtilities/Memory/NekMemoryManager.hpp>

#include <NekMeshUtils/CADSystem/OpenCascade.h>
#include <NekMeshUtils/CADSystem/CADObj.h>
#include <NekMeshUtils/CADSystem/CADVert.h>

namespace Nektar
{
namespace NekMeshUtils
{

class CADCurve;
typedef boost::shared_ptr<CADCurve> CADCurveSharedPtr;

/**
 * @brief struct which descibes a collection of cad edges which for a
 *        loop on the cad surface
 */
struct EdgeLoop
{
    std::vector<CADCurveSharedPtr> edges;
    std::vector<int> edgeo; //0 is forward 1 is backward
    Array<OneD, NekDouble> center;
    NekDouble area;
};

/**
 * @brief class for handleing a cad surface
 */

class CADSurf : public CADObj
{
public:
    friend class MemoryManager<CADSurf>;

    /**
     * @brief Default constructor.
     */
    CADSurf(int i, TopoDS_Shape in, std::vector<EdgeLoop> ein);

    ~CADSurf(){};

    /**
     * @brief Get the IDs of the edges which bound the surface.
     *
     * The edges are organsised into two vectors, which are grouped into the
     * continuous loops of the bounding edges, then the edges, which are a
     * pair of integers. The first item is the edge ID and the second is an
     * integer that indicates whether this edge is orientated forwards or
     * backwards on this surface to form the loop.
     */
    std::vector<EdgeLoop> GetEdges()
    {
        return m_edges;
    }

    /**
     * @brief Get the limits of the parametric space for the surface.
     *
     * @return Array of 4 entries with parametric umin,umax,vmin,vmax.
     */
    Array<OneD, NekDouble> GetBounds()
    {
        Array<OneD,NekDouble> b(4);

        b[0] = m_occSurface.FirstUParameter();
        b[1] = m_occSurface.LastUParameter();
        b[2] = m_occSurface.FirstVParameter();
        b[3] = m_occSurface.LastVParameter();

        return b;
    }

    /**
     * @brief Get the normal vector at parametric point u,v.
     *
     * @param uv Array of u and v parametric coords.
     * @return Array of xyz components of normal vector.
     */
    Array<OneD, NekDouble> N    (Array<OneD, NekDouble> uv);

    /**
     * @brief Get the set of first derivatives at parametric point u,v
     *
     * @param uv Array of u and v parametric coords.
     * @return Array of xyz copmonents of first derivatives.
     */
    Array<OneD, NekDouble> D1   (Array<OneD, NekDouble> uv);

    /**
     * @brief Get the set of second derivatives at parametric point u,v
     *
     * @param uv array of u and v parametric coords
     * @return array of xyz copmonents of second derivatives
     */
    Array<OneD, NekDouble> D2   (Array<OneD, NekDouble> uv);

    /**
     * @brief Get the x,y,z at parametric point u,v.
     *
     * @param uv Array of u and v parametric coords.
     * @return Array of xyz location.
     */
    Array<OneD, NekDouble> P    (Array<OneD, NekDouble> uv);

    /**
     * @brief Performs a reverse look up to find u,v and x,y,z.
     *
     * @param p Array of xyz location
     * @return The parametric location of xyz on this surface
     */
    Array<OneD, NekDouble> locuv(Array<OneD, NekDouble> p);

    /**
     * @brief returns true if the surface is flat (2D)
     */
    bool IsPlane();

    /**
     * @brief sets the flag to reverse the normal for this suface,
     * this is determined in cadsystem and ensures all surface normals,
     * point internaly
     */
    void SetReverseNomral()
    {
        m_correctNormal = false;
    }

    bool IsReversedNormal()
    {
        return !m_correctNormal;
    }

    /**
     * @brief surface needs to know if it is bounded by only two curves
     */
    void SetTwoC()
    {
        m_hasTwoCurves = true;
    }

    /**
     * @brief query two curves
     */
    bool GetTwoC(){return m_hasTwoCurves;}

    /**
     * @brief does unconstrained locuv to project point from anywhere
     */
    NekDouble DistanceTo(Array<OneD, NekDouble> p);

    void ProjectTo(Array<OneD, NekDouble> &tp, Array<OneD, NekDouble> &uv);

    /**
     * @brief returns curvature at point uv
     */
    NekDouble Curvature(Array<OneD, NekDouble> uv);

private:

    /// Function which tests the the value of uv used is within the surface
    void Test(Array<OneD, NekDouble> uv);
    /// normal
    bool m_correctNormal;
    /// flag to alert the mesh generation to a potential problem is both
    /// curves have only two points in the mesh
    bool m_hasTwoCurves;
    /// OpenCascade object for surface.
    BRepAdaptor_Surface m_occSurface;
    /// Alternate OpenCascade object for surface. Used by reverse lookup.
    Handle(Geom_Surface) m_s;
    /// List of bounding edges in loops with orientation.
    std::vector<EdgeLoop> m_edges;
};

typedef boost::shared_ptr<CADSurf> CADSurfSharedPtr;

}
}

#endif