MOAB: Mesh Oriented datABase  (version 5.2.1)
TQualityMetric.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2006 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     (2006) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file TQualityMetric.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_T_QUALITY_METRIC_HPP
00033 #define MSQ_T_QUALITY_METRIC_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "TMPQualityMetric.hpp"
00037 #include "MsqMatrix.hpp"
00038 
00039 namespace MBMesquite
00040 {
00041 
00042 class TMetric;
00043 
00044 /**\brief Compare targets to mapping function Jacobian matrices
00045  *
00046  * A quality metric defined using 2D and 3D target metrics,
00047  * where the active (A) matrix compared to the target by
00048  * the underlying metrics is the Jacobian matrix of the
00049  * mapping function at a given sample point.  For surface
00050  * elements, A is rotated to align the normal with W, such that
00051  * both matrices can be reduced from 3x2 to 2x2.
00052  */
00053 class TQualityMetric : public TMPQualityMetric
00054 {
00055   public:
00056     /** Used in tests and other templatized code */
00057     typedef TMetric MetricType;
00058 
00059     /**
00060      *\param tc   The target calculator
00061      *\param wc   The weight calculator
00062      *\param target_metric The target metric
00063      */
00064     TQualityMetric( TargetCalculator* tc, WeightCalculator* wc, TMetric* target_metric )
00065         : TMPQualityMetric( tc, wc ), targetMetric( target_metric )
00066     {
00067     }
00068 
00069     /**
00070      *\param tc   The target calculator
00071      *\param target_metric The target metric
00072      */
00073     TQualityMetric( TargetCalculator* tc, TMetric* target_metric )
00074         : TMPQualityMetric( tc, 0 ), targetMetric( target_metric )
00075     {
00076     }
00077 
00078     MESQUITE_EXPORT virtual std::string get_name() const;
00079 
00080     MESQUITE_EXPORT virtual bool evaluate_with_gradient( PatchData& pd, size_t handle, double& value,
00081                                                          std::vector< size_t >& indices,
00082                                                          std::vector< Vector3D >& gradient, MsqError& err );
00083 
00084     MESQUITE_EXPORT virtual bool evaluate_with_Hessian_diagonal( PatchData& pd, size_t handle, double& value,
00085                                                                  std::vector< size_t >& indices,
00086                                                                  std::vector< Vector3D >& gradient,
00087                                                                  std::vector< SymMatrix3D >& Hessian_diagonal,
00088                                                                  MsqError& err );
00089 
00090     MESQUITE_EXPORT virtual bool evaluate_with_Hessian( PatchData& pd, size_t handle, double& value,
00091                                                         std::vector< size_t >& indices,
00092                                                         std::vector< Vector3D >& gradient,
00093                                                         std::vector< Matrix3D >& Hessian, MsqError& err );
00094 
00095     TMetric* get_target_metric() const
00096     {
00097         return targetMetric;
00098     }
00099     void set_target_metric( TMetric* m )
00100     {
00101         targetMetric = m;
00102     }
00103 
00104   protected:
00105     MESQUITE_EXPORT virtual bool evaluate_internal( PatchData& pd, size_t handle, double& value, size_t* indices,
00106                                                     size_t& num_indices, MsqError& err );
00107 
00108   private:
00109     TMetric* targetMetric;
00110 };
00111 
00112 }  // namespace MBMesquite
00113 
00114 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines