includeLinks/InstructionQueue.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 MSQ_INSTRUCTION_QUEUE_HPP
#define MSQ_INSTRUCTION_QUEUE_HPP

#include "Mesquite.hpp"

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

namespace Mesquite {

  class MsqError;
  class QualityImprover;
  class QualityAssessor;
  class MeshSet;
  class PatchDataUser;
  class PatchData;
  class TargetCalculator;

  class InstructionQueue
  {

  public:
    InstructionQueue();

    virtual ~InstructionQueue() {};
    
    void add_target_calculator( TargetCalculator* tc, MsqError& err );
    
    void add_preconditioner(QualityImprover* instr, MsqError &err);
    void remove_preconditioner(size_t index, MsqError &err);
    void insert_preconditioner(QualityImprover* instr, size_t index, MsqError &err);
    
    void add_quality_assessor(QualityAssessor* instr, MsqError &err);
    void remove_quality_assessor(size_t index, MsqError &err);
    void insert_quality_assessor(QualityAssessor* instr, size_t index, MsqError &err);
    
    void set_master_quality_improver(QualityImprover* instr, MsqError &err);
    
    void disable_automatic_quality_assessment()
       { autoQualAssess = false; }
    void enable_automatic_quality_assessment()
       { autoQualAssess = true; }
    
    void disable_automatic_midnode_adjustment()
       { autoAdjMidNodes = false; }
    void enable_automatic_midnode_adjustment()
       { autoAdjMidNodes = true; }

    virtual void run_instructions(MeshSet &msc, MsqError &err);
    void clear();

    void trap_floating_point_exception( bool enable )
      { trapFPE = enable; }
    bool trap_floating_point_exception() const
      { return trapFPE; }
  
    
  protected:
    
  private:
    msq_std::list<PatchDataUser*>::iterator clear_master(MsqError &err);

    msq_std::list<PatchDataUser*> instructions;

    bool autoQualAssess;
    bool autoAdjMidNodes;
    
    size_t nbPreConditionners;
    bool isMasterSet;
    size_t masterInstrIndex; 

    PatchData* globalPatch; 
                            
    bool trapFPE;
  };


} //namespace


#endif // InstructionQueue_hpp