1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/* *****************************************************************
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2006 Sandia National Laboratories.  Developed at the
    University of Wisconsin--Madison under SNL contract number
    624796.  The U.S. Government and the University of Wisconsin
    retain certain rights to this software.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    (2006) [email protected]

  ***************************************************************** */

/** \file AWQualityMetric.hpp
 *  \brief
 *  \author Jason Kraftcheck
 */

#ifndef MSQ_TABS_QUALITY_METRIC_HPP
#define MSQ_TABS_QUALITY_METRIC_HPP

#include "Mesquite.hpp"
#include "TMPQualityMetric.hpp"
#include "MsqMatrix.hpp"

namespace MBMesquite
{

class AWMetric;

/**\brief Compare targets to mapping function Jacobian matrices
 *
 * A quality metric defined using 2D and 3D target metrics,
 * where the active (A) matrix compared to the target by
 * the underlying metrics is the Jacobian matrix of the
 * mapping function at a given sample point.  For surface
 * elements, A is rotated to align the normal with W, such that
 * both matrices can be reduced from 3x2 to 2x2.
 */
class AWQualityMetric : public TMPQualityMetric
{
  public:
    /** Used in tests and other templatized code */
    typedef AWMetric MetricType;

    /**
     *\param tc   The target calculator
     *\param wc   The weight calculator
     *\param target_metric The target metric to use
     */
    AWQualityMetric( TargetCalculator* tc, WeightCalculator* wc, AWMetric* target_metric )
        : TMPQualityMetric( tc, wc ), targetMetric( target_metric )
    {
    }

    /**
     *\param tc   The target calculator
     *\param target_metric The target metric to use
     */
    AWQualityMetric( TargetCalculator* tc, AWMetric* target_metric )
        : TMPQualityMetric( tc, 0 ), targetMetric( target_metric )
    {
    }

    MESQUITE_EXPORT virtual std::string get_name() const;

    MESQUITE_EXPORT virtual bool evaluate_with_gradient( PatchData& pd,
                                                         size_t handle,
                                                         double& value,
                                                         std::vector< size_t >& indices,
                                                         std::vector< Vector3D >& gradient,
                                                         MsqError& err );

    MESQUITE_EXPORT virtual bool evaluate_with_Hessian_diagonal( PatchData& pd,
                                                                 size_t handle,
                                                                 double& value,
                                                                 std::vector< size_t >& indices,
                                                                 std::vector< Vector3D >& gradient,
                                                                 std::vector< SymMatrix3D >& Hessian_diagonal,
                                                                 MsqError& err );

    MESQUITE_EXPORT virtual bool evaluate_with_Hessian( PatchData& pd,
                                                        size_t handle,
                                                        double& value,
                                                        std::vector< size_t >& indices,
                                                        std::vector< Vector3D >& gradient,
                                                        std::vector< Matrix3D >& Hessian,
                                                        MsqError& err );

    AWMetric* get_target_metric() const
    {
        return targetMetric;
    }
    void set_target_metric( AWMetric* m )
    {
        targetMetric = m;
    }

  protected:
    MESQUITE_EXPORT virtual bool evaluate_internal( PatchData& pd,<--- Function in derived class
                                                    size_t handle,
                                                    double& value,
                                                    size_t* indices,
                                                    size_t& num_indices,
                                                    MsqError& err );

  private:
    AWMetric* targetMetric;
};

}  // namespace MBMesquite

#endif