Extended doxygen information for LRSplines3D

Author: VibekeSkytt

Doxyfile

@@ -150,6 +150,7 @@ STRIP_FROM_INC_PATH    = gotools-core/include \
                          qualitymodule/include \
                          isogeometric_model/include \
                          lrsplines2D/include \
+                         lrsplines3D/include \
                          topology/include \
                          viewlib/include
 

gotools-core/include/GoTools/geometry/streamable_doxymain.h

@@ -86,6 +86,7 @@ g2-format:
 \arg \c \em CylinderVolume, entity code = 722,
 \arg \c \em ConeVolume, entity code = 723,
 \arg \c \em TorusVolume, entity code = 724
+\arg \c \em LRSplineVolume, entity code = 793
 
 In the following the file format corresponding to  most of the entities listed 
 above will be described. Note that the g2-file format is a simple format that

gotools-core/include/GoTools/utils/gotools-doxymain.h

@@ -88,6 +88,7 @@ on the model
 \li \ref qualitymodule. A set of tools to check the quality of CAD models
 \li \ref isogeometric_model. A set of tools related to isogeometric analysis
 \li \ref lrsplines2d. LR spline surfaces
+\li \ref lrsplines3d. LR spline volumes
 
 GoTools depends on:
 \li <a href="http://www.sintef.no/SISL">SISL</a> (available with

lrsplines3D/include/GoTools/lrsplines3D/LRSpline3DUtils.h

@@ -36,7 +36,7 @@
 namespace Go
 {
 
-  /// Utility functionality used in computations involving LR B-spline surfaces
+  /// Utility functionality used in computations involving LR B-spline volumes
   namespace LRSpline3DUtils
   {
 

lrsplines3D/include/GoTools/lrsplines3D/Mesh3D.h

@@ -20,6 +20,7 @@
 
 namespace Go
 {
+  /// Utility functions for operating on an LR Mesh (Mesh3D)
   namespace Mesh3DUtils
   {
   // Finds the largest [smallest] index of the knotvalue in the mesh 'm' along direction 'd' that is 

lrsplines3D/include/GoTools/lrsplines3D/Mesh3DUtils.h

@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 1998, 2000-2007, 2010, 2011, 2012, 2013 SINTEF ICT,
+ * Applied Mathematics, Norway.
+ *
+ * Contact information: E-mail: [email protected]                      
+ * SINTEF ICT, Department of Applied Mathematics,                         
+ * P.O. Box 124 Blindern,                                                 
+ * 0314 Oslo, Norway.                                                     
+ *
+ * This file is part of GoTools.
+ *
+ * GoTools is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version. 
+ *
+ * GoTools is distributed in the hope that it will be useful,        
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of         
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public
+ * License along with GoTools. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public
+ * License, a covered work must retain the producer line in every data
+ * file that is created or manipulated using GoTools.
+ *
+ * Other Usage
+ * You can be released from the requirements of the license by purchasing
+ * a commercial license. Buying such a license is mandatory as soon as you
+ * develop commercial activities involving the GoTools library without
+ * disclosing the source code of your own applications.
+ *
+ * This file may be used in accordance with the terms contained in a
+ * written agreement between you and SINTEF ICT. 
+ */
+
+#ifndef _LRSPLINES3D_DOXYMAIN_H
+#define _LRSPLINES3D_DOXYMAIN_H
+/**
+ \page lrsplines3d GoTools LRsplines3D
+
+ This module contains classes and tools for working with LR spline volumes.
+
+
+The module lrsplines3D represents LR-spline volumes.
+This module depends on:
+- GoTools Core library
+- GoTools trivariate
+- GoTools LRSplines2D
+- SISL library
+
+LRSplineVolume inherits \link Go::ParamVolume ParamVolume \endlink and is a spline volume with the property local refinement.
+\link Go::LRVolApprox  LRVolApprox \endlink implements an adaptive and iterative algorithm for approximating a trivariate point 
+cloud with format (x,y,z,f(x,y,z)) by local refinenement and approximation (\link Go::LRSpline3DMBA LRSpline3DMBA \endlink).
+
+**/
+#endif // _LRSPLINES3D_DOXYMAIN_H