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
127
128
129
130
131
132
133
134
135
136
137
/* *****************************************************************
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2010 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

    (2010) [email protected]

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

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

#ifndef MSQ_UNTANGLE_WRAPPER_HPP
#define MSQ_UNTANGLE_WRAPPER_HPP

#include "Mesquite.hpp"
#include "Wrapper.hpp"

namespace MBMesquite
{

/**\brief Wrapper that implements several TMP-based untanglers */
class UntangleWrapper : public Wrapper
{

  public:
    /**\brief Which quality metric to use */
    enum UntangleMetric
    {
        BETA,      //!< Use TMP UntangleBeta metric
        SIZE,      //!< Use UntangleMu(TargetSize}
        SHAPESIZE  //!< Use UntangleMu(TargetShapeSize}
    };

    /**\brief Specify which untangle metric to use */
    MESQUITE_EXPORT
    void set_untangle_metric( UntangleMetric metric );

    /**\brief Specify constant value for untangle metric */
    MESQUITE_EXPORT
    void set_metric_constant( double value );

    /**\brief Specify timeout after which untangler will exit */
    MESQUITE_EXPORT
    void set_cpu_time_limit( double seconds );

    /**\brief Specify max number of outer iterations after which untangler will exit */
    MESQUITE_EXPORT
    void set_outer_iteration_limit( int maxIt );

    /**\brief Specify factor by which to minimum distance a vertex must
     *        move in an iteration to avoid termination of the untangler */
    MESQUITE_EXPORT
    void set_vertex_movement_limit_factor( double f );

    MESQUITE_EXPORT
    UntangleWrapper();

    MESQUITE_EXPORT
    UntangleWrapper( UntangleMetric m );

    MESQUITE_EXPORT
    ~UntangleWrapper();

    /**\brief Check if vertex culling will be used */
    inline bool is_culling_enabled() const
    {
        return doCulling;
    }

    /**\brief Enable vertex culling */
    inline void enable_culling( bool yesno )
    {
        doCulling = yesno;
    }

    /**\brief Check if a Jacobi optimization strategy will be used */
    inline bool is_jacobi_optimization() const
    {
        return doJacobi;
    }

    /**\brief Check if a Gauss optimization strategy will be used */
    inline bool is_gauss_optimization() const
    {
        return !doJacobi;
    }

    /**\brief Use a Jacobi optimization strategy */
    inline void do_jacobi_optimization()
    {
        doJacobi = true;
    }

    /**\brief Use a Gauss optimization strategy */
    inline void do_gauss_optimization()
    {
        doJacobi = false;
    }

  protected:
    MESQUITE_EXPORT
    void run_wrapper( MeshDomainAssoc* mesh_and_domain,<--- Function in derived class
                      ParallelMesh* pmesh,
                      Settings* settings,
                      QualityAssessor* qa,
                      MsqError& err );

  private:
    UntangleMetric qualityMetric;
    double maxTime, movementFactor, metricConstant;
    int maxIterations;
    bool doCulling, doJacobi;
};

}  // namespace MBMesquite

#endif