includeLinks/TerminationCriterion.hpp

Go to the documentation of this file.

/* ***************************************************************** 
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2004 Sandia Corporation and Argonne National
    Laboratory.  Under the terms of Contract DE-AC04-94AL85000 
    with Sandia Corporation, the U.S. Government retains certain 
    rights in 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
 
    diachin2@llnl.gov, djmelan@sandia.gov, mbrewer@sandia.gov, 
    pknupp@sandia.gov, tleurent@mcs.anl.gov, tmunson@mcs.anl.gov      
   
  ***************************************************************** */
// -*- Mode : c++; tab-width: 3; c-tab-always-indent: t; indent-tabs-mode: nil; c-basic-offset: 3 -*-

#ifndef TerminationCriterion_hpp
#define TerminationCriterion_hpp

#include "Mesquite.hpp"
#include "PatchDataUser.hpp"
#include "MsqTimer.hpp"

#include <string>

#ifdef MSQ_USE_OLD_STD_HEADERS
#  include <vector.h>
#else
#  include <vector>
#endif

namespace Mesquite
{
   class MeshSet;
   class MsqError;
   class ObjectiveFunction;
   
  class TerminationCriterion
  {
  public:
    
    enum TCType {
       NONE    = 0,
       GRADIENT_L2_NORM_ABSOLUTE = 1,  
       GRADIENT_INF_NORM_ABSOLUTE = 2,
       GRADIENT_L2_NORM_RELATIVE = 4,
       GRADIENT_INF_NORM_RELATIVE = 8,
       KKT  = 16,
       QUALITY_IMPROVEMENT_ABSOLUTE = 32,
       QUALITY_IMPROVEMENT_RELATIVE = 64,
       NUMBER_OF_ITERATES = 128,
       CPU_TIME  = 256,
       VERTEX_MOVEMENT_ABSOLUTE  = 512,
       VERTEX_MOVEMENT_RELATIVE  = 1024,
       SUCCESSIVE_IMPROVEMENTS_ABSOLUTE = 2048,
       SUCCESSIVE_IMPROVEMENTS_RELATIVE = 4096,
       BOUNDED_VERTEX_MOVEMENT = 8192
    };

    TerminationCriterion();
    
    ~TerminationCriterion(){};

      //Functions with which the user can specify the criteria to be used
    void add_criterion_type_with_double(TCType tc_type, double eps,
                                        MsqError &err);
    void add_criterion_type_with_int(TCType tc_type, int bound,
                                     MsqError &err);
    void remove_criterion_type(TCType tc_type, MsqError &err);
    
    void set_culling_type(TCType tc_type, double eps, MsqError &err);
    void remove_culling(MsqError &err);
    
    void reset_outer( MeshSet& ms, ObjectiveFunction* of, MsqError& err );
    
    void reset_inner( PatchData& pd, ObjectiveFunction* of, MsqError& err );
    
    void reset_patch( PatchData& pd, MsqError& err );
    
    void accumulate_inner( PatchData& pd, MsqError& err );
    
    void accumulate_inner( PatchData& pd, double of_value, Vector3D* of_grads, 
                           MsqError& err );
    
    void accumulate_patch( PatchData& pd, MsqError& err );
    
    void accumulate_outer( MeshSet& ms, MsqError& err );
    
    bool terminate();
    
    
    bool cull_vertices(PatchData &pd, ObjectiveFunction* obj_ptr, MsqError &err);
    void cleanup(MeshSet &ms, MsqError &err);


    double get_current_function_value()
       {return currentOFValue;}
       
    void set_debug_output_level( int i )
      { debugLevel = i; }
    
 protected:
    
 private:
    //PRIVATE DATA MEMBERS
    long unsigned int terminationCriterionFlag;
    long unsigned int cullingMethodFlag;
      //epsiloon used in culling methods.
    double cullingEps;

      // ObjectiveFunction pointer
    ObjectiveFunction* OFPtr;

      //Data not specific to a single criterion
    double initialOFValue;
    double previousOFValue;
    double currentOFValue;
    double lowerOFBound;

      //Data specific to termination criterion 1 (gradient bounds)
    msq_std::vector<Vector3D> mGrad;
    double initialGradL2Norm;
    double currentGradL2Norm;
    double gradL2NormAbsoluteEps;
    double gradL2NormRelativeEps;
    double initialGradInfNorm;
    double currentGradInfNorm;
    double gradInfNormAbsoluteEps;
    double gradInfNormRelativeEps;
      //Data specific to termination criterion 2 (KKT)
      //???????????????????????????????????????????
      //Data specific to termination criterion 3 (Quality Improvement)
    double qualityImprovementAbsoluteEps;
    double qualityImprovementRelativeEps;
      //Data specific to termination criterion 4 (inner iterations)
    int iterationBound;
    int iterationCounter;
      //Data specific to termination criterion 5 (cpu time)
    Timer mTimer;
    double timeBound;
      //Data specific to termination criterion 6 (vertex movement)
    PatchDataVerticesMemento* initialVerticesMemento;
    PatchDataVerticesMemento* previousVerticesMemento;//if we want relative
    double vertexMovementAbsoluteEps;
    double vertexMovementRelativeEps;
    double maxSquaredInitialMovement;
    double maxSquaredMovement;
    
      //Data specific to termination criterion 7 (successive improvement to F)
    double successiveImprovementsAbsoluteEps;
    double successiveImprovementsRelativeEps;
      //crit 8
    double boundedVertexMovementEps;
    int vertexMovementExceedsBound;
    
    int debugLevel;
    
  };

} //namespace


#endif // TerminationCriterion_hpp