Branch data     Line data    Source code

       1                 :            : /* *****************************************************************
       2                 :            :     MESQUITE -- The Mesh Quality Improvement Toolkit
       3                 :            : 
       4                 :            :     Copyright 2004 Sandia Corporation and Argonne National
       5                 :            :     Laboratory.  Under the terms of Contract DE-AC04-94AL85000
       6                 :            :     with Sandia Corporation, the U.S. Government retains certain
       7                 :            :     rights in this software.
       8                 :            : 
       9                 :            :     This library is free software; you can redistribute it and/or
      10                 :            :     modify it under the terms of the GNU Lesser General Public
      11                 :            :     License as published by the Free Software Foundation; either
      12                 :            :     version 2.1 of the License, or (at your option) any later version.
      13                 :            : 
      14                 :            :     This library is distributed in the hope that it will be useful,
      15                 :            :     but WITHOUT ANY WARRANTY; without even the implied warranty of
      16                 :            :     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      17                 :            :     Lesser General Public License for more details.
      18                 :            : 
      19                 :            :     You should have received a copy of the GNU Lesser General Public License
      20                 :            :     (lgpl.txt) along with this library; if not, write to the Free Software
      21                 :            :     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
      22                 :            : 
      23                 :            :     [email protected], [email protected], [email protected],
      24                 :            :     [email protected], [email protected], [email protected]
      25                 :            : 
      26                 :            :   ***************************************************************** */
      27                 :            : // -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3
      28                 :            : // -*-
      29                 :            : 
      30                 :            : /*! \file ConditionNumberQualityMetric.hpp
      31                 :            : 
      32                 :            : Header file for the MBMesquite::ConditionNumberQualityMetric class
      33                 :            : 
      34                 :            :   \author Michael Brewer
      35                 :            :   \date   2002-06-19
      36                 :            :  */
      37                 :            : 
      38                 :            : #ifndef ConditionNumberQualityMetric_hpp
      39                 :            : #define ConditionNumberQualityMetric_hpp
      40                 :            : 
      41                 :            : #include "Mesquite.hpp"
      42                 :            : #include "ElementQM.hpp"
      43                 :            : #include "AveragingQM.hpp"
      44                 :            : 
      45                 :            : namespace MBMesquite
      46                 :            : {
      47                 :            : /*! \class ConditionNumberQualityMetric
      48                 :            :   \brief Computes the condition number of given element.
      49                 :            : 
      50                 :            :   The metric does not use the sample point functionality or the
      51                 :            :   compute_weighted_jacobian.  It evaluates the metric at
      52                 :            :   the element vertices, and uses the isotropic ideal element.
      53                 :            :   It does require a feasible region, and the metric needs
      54                 :            :   to be minimized.
      55                 :            : */
      56                 :            : class ConditionNumberQualityMetric : public ElementQM, public AveragingQM
      57                 :            : {
      58                 :            :   public:
      59                 :            :     MESQUITE_EXPORT ConditionNumberQualityMetric();
      60                 :            : 
      61                 :            :     //! virtual destructor ensures use of polymorphism during destruction
      62         [ -  + ]:         20 :     MESQUITE_EXPORT virtual ~ConditionNumberQualityMetric() {}
      63                 :            : 
      64                 :            :     MESQUITE_EXPORT virtual std::string get_name() const;
      65                 :            : 
      66                 :            :     //! 1 if metric should be minimized, -1 if metric should be maximized.
      67                 :            :     MESQUITE_EXPORT virtual int get_negate_flag() const;
      68                 :            : 
      69                 :            :     MESQUITE_EXPORT virtual bool evaluate( PatchData& pd, size_t handle, double& value, MsqError& err );
      70                 :            : };
      71                 :            : 
      72                 :            : }  // namespace MBMesquite
      73                 :            : 
      74                 :            : #endif  // ConditionNumberQualityMetric_hpp