Control/InstructionQueue.cpp

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 -*-

#ifdef MSQ_USE_OLD_STD_HEADERS
#  include <string.h>
#  include <list.h>
#else
#  include <string>
#  include <list>
   using namespace std;
#endif

#include "InstructionQueue.hpp"
#include "MeshSet.hpp"
#include "MsqInterrupt.hpp"
#include "QualityImprover.hpp"
#include "QualityAssessor.hpp"
#include "MsqError.hpp"
#include "MsqDebug.hpp"
#include "MeanMidNodeMover.hpp"
#include "MsqFPE.hpp"
#include "TargetCalculator.hpp"

using namespace Mesquite;

#ifdef MSQ_TRAP_FPE
const bool IQ_TRAP_FPE_DEFAULT = true;
#else
const bool IQ_TRAP_FPE_DEFAULT = false;
#endif


InstructionQueue::InstructionQueue() :
  autoQualAssess(true),
  autoAdjMidNodes(true),
  nbPreConditionners(0),
  isMasterSet(false),
  masterInstrIndex(0),
  globalPatch(0),
  trapFPE(IQ_TRAP_FPE_DEFAULT)
{
}


void InstructionQueue::add_target_calculator( TargetCalculator* tc, MsqError& )
{
  instructions.push_back( tc );
}

void InstructionQueue::add_preconditioner(QualityImprover* instr,
                                        MsqError &err)
{
  if (isMasterSet) {
    MSQ_SETERR(err)("Cannot add preconditionners once the master "
                    "QualityImprover has been set.", MsqError::INVALID_STATE);
    return;
  }
  
  instructions.push_back(instr);
  nbPreConditionners++;
}


void InstructionQueue::remove_preconditioner(size_t index, MsqError &err)
{
  // checks index is valid
  if ( isMasterSet && index == masterInstrIndex ) {
    MSQ_SETERR(err)("cannot remove master QualityImprover.", MsqError::INVALID_ARG);
    return;
  } else if (index >= instructions.size() ) {
    MSQ_SETERR(err)("Index points beyond end of list.",MsqError::INVALID_ARG);
    return;
  }
  
  // position the instruction iterator over the preconditionner to delete
  msq_std::list<PatchDataUser*>::iterator pos;
  pos = instructions.begin();
  advance(pos, index);

  if ( (*pos)->get_algorithm_type() != PatchDataUser::QUALITY_IMPROVER ) 
  {
    MSQ_SETERR(err)("Index does not point to a QualityImprover.",
                    MsqError::INVALID_ARG);
    return;
  }
  
  string name = (*pos)->get_name();
  instructions.erase(pos);
  nbPreConditionners--;
}  


void InstructionQueue::insert_preconditioner(QualityImprover* instr,
                                           size_t index, MsqError &err)
{
  // checks index is valid
  if (isMasterSet==true && index > masterInstrIndex) {
    MSQ_SETERR(err)("Cannot add a preconditionner after the master "
                    "QualityImprover.", MsqError::INVALID_STATE);
    return;
  }
  if (index >= instructions.size() ) {
    MSQ_SETERR(err)("index", MsqError::INVALID_ARG);
    return;
  }

  // position the instruction iterator
  list<PatchDataUser*>::iterator pos;
  pos = instructions.begin();
  advance(pos, index);
  // adds the preconditioner
  instructions.insert(pos,instr);
  nbPreConditionners++;
}


void InstructionQueue::add_quality_assessor(QualityAssessor* instr,
                                            MsqError &/*err*/)
{
  instructions.push_back(instr);
}


void InstructionQueue::remove_quality_assessor(size_t index, MsqError &err)
{
  // checks index is valid
  if (index >= instructions.size() ) {
    MSQ_SETERR(err)("index", MsqError::INVALID_ARG);
    return;
  }
  
  // position the instruction iterator over the QualityAssessor to delete
  list<PatchDataUser*>::iterator pos;
  pos = instructions.begin();
  advance(pos, index);

  if ( (*pos)->get_algorithm_type() != PatchDataUser::QUALITY_ASSESSOR ) 
  {
    MSQ_SETERR(err)("Index does not point to a QualityImprover.",
                    MsqError::INVALID_ARG);
    return;
  }
  
  string name = (*pos)->get_name();
  instructions.erase(pos);
}  


void InstructionQueue::insert_quality_assessor(QualityAssessor* instr,
                                           size_t index, MsqError &err)
{
  // checks index is valid
  if (index > instructions.size()) {
    MSQ_SETERR(err)("index points two positions beyond end of list.",
                    MsqError::INVALID_ARG);
    return;
  }

  // position the instruction iterator
  list<PatchDataUser*>::iterator pos;
  pos = instructions.begin();
  advance(pos, index);
  // adds the QualityAssessor
  instructions.insert(pos,instr);
}


void InstructionQueue::set_master_quality_improver(QualityImprover* instr,
                                                 MsqError &err)
{
  if (isMasterSet) {
    MSQ_DBGOUT(1) << "InstructionQueue::set_master_quality_improver():\n"
        << "\tOverwriting previously specified master quality improver.\n";
    // if master is already set, clears it and insert the new one at the same position.
    list<PatchDataUser*>::iterator master_pos;
    master_pos = this->clear_master(err); MSQ_ERRRTN(err);
    instructions.insert(master_pos, instr);
    isMasterSet = true;
  } else {
    // if master is not set, add it at the end of the queue.
    instructions.push_back(instr);
    isMasterSet = true;
    masterInstrIndex = instructions.size()-1;
  }
}

void InstructionQueue::run_instructions(MeshSet &ms, MsqError &err)
{ 
  MSQ_DBGOUT(1) << version_string(false) << "\n";

  if (nbPreConditionners != 0 && isMasterSet == false ) {
    MSQ_SETERR(err)("no pre-conditionners allowed if master QualityImprover "
                    "is not set.", MsqError::INVALID_STATE);
    return;
  }
  
#ifdef ENABLE_INTERRUPT
   // Register SIGINT handler
  MsqInterrupt msq_interrupt;
#endif

    // Generate SIGFPE on floating point errors
  MsqFPE( this->trapFPE );
  
  msq_std::list<PatchDataUser*>::const_iterator instr_iter;
  
  if (autoAdjMidNodes)
    instructions.push_back( new MeanMidNodeMover );
  
  // For each instruction in the list
  for (instr_iter = instructions.begin();
       !(instr_iter == instructions.end()); ++instr_iter) {
    
    // If instruction uses a global patch, creates one or reuse the existing one.
    if ((*instr_iter)->get_patch_type() == PatchData::GLOBAL_PATCH) {
      if (globalPatch == 0) {
        globalPatch = new PatchData;
        ms.get_next_patch(*globalPatch, (*instr_iter)->get_all_parameters(), err);
        MSQ_ERRRTN(err);
      } 
        
               
      (*instr_iter)->set_global_patch(globalPatch, err); MSQ_ERRRTN(err);
    }
    // If instruction does not use a Global Patch, make sure we discard any existing patch.
    else {
      delete globalPatch;
      globalPatch = 0;
      (*instr_iter)->no_global_patch();
    }
    
    // applies the QualityImprover/QualityAssessor to the MeshSet
      (*instr_iter)->loop_over_mesh(ms, err); MSQ_ERRRTN(err);

    // If this same instruction is reused in this queue, we can't assume the
    // global patch will still be valid. 
    (*instr_iter)->no_global_patch();
  }
  
  if (autoAdjMidNodes)
  {
    delete *instructions.rbegin();
    instructions.pop_back( );
  }  
 
  if (globalPatch != 0)
  {
    delete globalPatch; // clean up once all instructions are executed.
    globalPatch = 0;
  }
}

  
void InstructionQueue::clear()
{
  instructions.clear();
  autoQualAssess = true;
  autoAdjMidNodes = false;
  isMasterSet = false;
  masterInstrIndex = 0;
}


list<PatchDataUser*>::iterator InstructionQueue::clear_master(MsqError &err)
{
  msq_std::list<PatchDataUser*>::iterator instr_iter;
  msq_std::list<PatchDataUser*>::iterator master_pos;
  
  if (!isMasterSet) {
    MSQ_SETERR(err)("No master quality improver to clear.", MsqError::INVALID_STATE);
    return instr_iter;
  }
  
    // position the instruction iterator over the master quality improver
  master_pos = instructions.begin();
  advance(master_pos, masterInstrIndex);
  
    // erases the master quality improver
  instr_iter = instructions.erase(master_pos);
  isMasterSet = false;
  
    // returns the position where the Master was
  return instr_iter;
}