MOAB: Mesh Oriented datABase  (version 5.4.1)
CurveDomain.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2010 Sandia National Laboratories.  Developed at the
00005     University of Wisconsin--Madison under SNL contract number
00006     624796.  The U.S. Government and the University of Wisconsin
00007     retain certain rights to this software.
00008 
00009     This library is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU Lesser General Public
00011     License as published by the Free Software Foundation; either
00012     version 2.1 of the License, or (at your option) any later version.
00013 
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Lesser General Public License for more details.
00018 
00019     You should have received a copy of the GNU Lesser General Public License
00020     (lgpl.txt) along with this library; if not, write to the Free Software
00021     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 
00023     (2010) [email protected]
00024 
00025   ***************************************************************** */
00026 
00027 /** \file CurveDomain.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_CURVE_DOMAIN_HPP
00033 #define MSQ_CURVE_DOMAIN_HPP
00034 
00035 #include "Mesquite.hpp"
00036 
00037 namespace MBMesquite
00038 {
00039 
00040 /**\brief Domain used for optional curve smoother
00041  *
00042  * Provide necessary functionality for interogating a topologically
00043  * one-dimensional domain (a curve).
00044  */
00045 class CurveDomain
00046 {
00047   public:
00048     /**\brief Measure arc length along curve
00049      *
00050      * Get the length along a curve between two points on the curve.
00051      */
00052     virtual double arc_length( const double position1[3], const double position2[3], MsqError& err ) = 0;
00053     /**\brief Get a position on the curve given an arc length
00054      *
00055      * Measure a specified arc length along a curve.
00056      *\param from_here Point on curve from which to measure
00057      *\param length    Length along curve to move
00058      *\param result_point Output.  A point on the curve \c length units
00059      *                 from the point \c from_here in the forward
00060      *                 direction along the curve.
00061      */
00062     virtual void position_from_length( const double from_here[3],
00063                                        double length,
00064                                        double result_point[3],
00065                                        MsqError& err ) = 0;
00066 };
00067 
00068 }  // namespace MBMesquite
00069 
00070 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines