Commit ec9c8981 authored by Michael Turner's avatar Michael Turner
Browse files

commenting

parent e3781517
......@@ -46,10 +46,8 @@ namespace NekMeshUtils
{
/**
* @brief class for CAD curves.
* @brief base class for CAD curves.
*
* This class wraps the OpenCascade BRepAdaptor_Curve class for use with
* Nektar++.
*/
class CADCurve : public CADObj
{
......@@ -112,19 +110,25 @@ public:
*/
virtual Array<OneD, NekDouble> GetMinMax() = 0;
/// set the ids of the surfaces either side of the curve
/**
* @brief set the ids of the surfaces either side of the curve
*/
void SetAdjSurf(std::vector<CADSurfSharedPtr> i)
{
m_adjSurfs = i;
}
/// returns the ids of neigbouring surfaces
/*
* @brief returns the ids of neigbouring surfaces
*/
std::vector<CADSurfSharedPtr> GetAdjSurf()
{
return m_adjSurfs;
}
/// returns lenght of the curve
/*
* @brief returns lenght of the curve
*/
NekDouble GetTotLength()
{
return m_length;
......@@ -138,8 +142,10 @@ public:
m_mainVerts = falVert;
}
/// get the ids of the vertices that are the ends of the curve,
/// which are in the main cad list
/*
* @brief get the vertices that are the ends of the curve,
* which are in the main cad list
*/
std::vector<CADVertSharedPtr> GetVertex()
{
return m_mainVerts;
......
......@@ -49,7 +49,7 @@ class CADCurve;
typedef boost::shared_ptr<CADCurve> CADCurveSharedPtr;
/**
* @brief class for handleing a cad surface
* @brief base class for a cad surface
*/
class CADSurf : public CADObj
......@@ -65,13 +65,7 @@ public:
~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.
* @brief Get the loop structures which bound the cad surface
*/
std::vector<EdgeLoop> GetEdges()
{
......@@ -153,6 +147,9 @@ public:
m_correctNormal = false;
}
/**
* @brief query reversed normal
*/
bool IsReversedNormal()
{
return !m_correctNormal;
......
......@@ -48,6 +48,7 @@ namespace Nektar
namespace NekMeshUtils
{
//forward declorators
class CADVert;
typedef boost::shared_ptr<CADVert> CADVertSharedPtr;
class CADCurve;
......@@ -56,7 +57,7 @@ class CADSurf;
typedef boost::shared_ptr<CADSurf> CADSurfSharedPtr;
/**
* @brief struct which descibes a collection of cad edges which for a
* @brief struct which descibes a collection of cad edges which are a
* loop on the cad surface
*/
struct EdgeLoop
......@@ -70,7 +71,7 @@ struct EdgeLoop
/**
* @brief Base class for CAD interface system.
*
* A class which can load and interact with CAD for Nektar++ using OpenCascade.
* A class which can load and interact with CAD for Nektar++.
* This class contains maps to subclasses surface and curves.
*/
class CADSystem
......@@ -175,6 +176,7 @@ public:
}
protected:
/// Name of cad file
std::string m_name;
/// Map of curves
std::map<int, CADCurveSharedPtr> m_curves;
......
......@@ -50,10 +50,8 @@ namespace NekMeshUtils
{
/**
* @brief class for CAD curves.
* @brief base class for CAD verticies.
*
* This class wraps the OpenCascade BRepAdaptor_Curve class for use with
* Nektar++.
*/
class CADVert : public CADObj
{
......@@ -122,7 +120,7 @@ protected:
NodeSharedPtr m_node;
/// degen marker
bool degen;
// degen surface
/// degen surface
int degensurf;
};
......
......@@ -44,12 +44,6 @@ namespace Nektar
namespace NekMeshUtils
{
/**
* @brief class for CAD curves.
*
* This class wraps the OpenCascade BRepAdaptor_Curve class for use with
* Nektar++.
*/
class CADCurveOCE : public CADCurve
{
public:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment