MOAB: Mesh Oriented datABase  (version 5.4.0)
AWQualityMetric.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 AWQualityMetric.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_TABS_QUALITY_METRIC_HPP
00033 #define MSQ_TABS_QUALITY_METRIC_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "TMPQualityMetric.hpp"
00037 #include "MsqMatrix.hpp"
00038 
00039 namespace MBMesquite
00040 {
00041 
00042 class AWMetric;
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 AWQualityMetric : public TMPQualityMetric
00054 {
00055   public:
00056     /** Used in tests and other templatized code */
00057     typedef AWMetric MetricType;
00058 
00059     /**
00060      *\param tc   The target calculator
00061      *\param wc   The weight calculator
00062      *\param target_metric The target metric to use
00063      */
00064     AWQualityMetric( TargetCalculator* tc, WeightCalculator* wc, AWMetric* 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 to use
00072      */
00073     AWQualityMetric( TargetCalculator* tc, AWMetric* 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,
00081                                                          size_t handle,
00082                                                          double& value,
00083                                                          std::vector< size_t >& indices,
00084                                                          std::vector< Vector3D >& gradient,
00085                                                          MsqError& err );
00086 
00087     MESQUITE_EXPORT virtual bool evaluate_with_Hessian_diagonal( PatchData& pd,
00088                                                                  size_t handle,
00089                                                                  double& value,
00090                                                                  std::vector< size_t >& indices,
00091                                                                  std::vector< Vector3D >& gradient,
00092                                                                  std::vector< SymMatrix3D >& Hessian_diagonal,
00093                                                                  MsqError& err );
00094 
00095     MESQUITE_EXPORT virtual bool evaluate_with_Hessian( PatchData& pd,
00096                                                         size_t handle,
00097                                                         double& value,
00098                                                         std::vector< size_t >& indices,
00099                                                         std::vector< Vector3D >& gradient,
00100                                                         std::vector< Matrix3D >& Hessian,
00101                                                         MsqError& err );
00102 
00103     AWMetric* get_target_metric() const
00104     {
00105         return targetMetric;
00106     }
00107     void set_target_metric( AWMetric* m )
00108     {
00109         targetMetric = m;
00110     }
00111 
00112   protected:
00113     MESQUITE_EXPORT virtual bool evaluate_internal( PatchData& pd,
00114                                                     size_t handle,
00115                                                     double& value,
00116                                                     size_t* indices,
00117                                                     size_t& num_indices,
00118                                                     MsqError& err );
00119 
00120   private:
00121     AWMetric* targetMetric;
00122 };
00123 
00124 }  // namespace MBMesquite
00125 
00126 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines