IterationPack_Types.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// 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 along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef GENERAL_ITERATION_PACK_TYPES_H
#define GENERAL_ITERATION_PACK_TYPES_H

#include "Teuchos_TypeNameTraits.hpp"

namespace MemMngPack {}

namespace IterationPack {

using Teuchos::typeName;
using Teuchos::TypeNameTraits;

enum EAssocStepType {
  PRE_STEP   = 0
  ,POST_STEP = 1
};
enum EDoStepType {
  DO_MAIN_STEP  = 0
  ,DO_PRE_STEP  = 1
  ,DO_POST_STEP = 2
};
enum EAlgoReturn {
  TERMINATE_TRUE
  ,TERMINATE_FALSE
  ,MAX_ITER_EXCEEDED
  ,MAX_RUN_TIME_EXCEEDED
  ,INTERRUPTED_TERMINATE_TRUE
  ,INTERRUPTED_TERMINATE_FALSE
};
class InvalidTypeCastException : public std::logic_error
{public: InvalidTypeCastException(const std::string& what_arg) : std::logic_error(what_arg) {}};

class IterQuantity;
template<class T> class IterQuantityAccess;
template<class T> class IterQuantityAccessContiguous;
template<class T_Base, class T_Derived> class IterQuantityAccessDerivedToBase;
class Algorithm;
class AlgorithmStep;
class AlgorithmState;
class AlgorithmTracker;
class AlgorithmTrackerComposite;
template<class T> class CastIQMember;

} // end namespace IterationPack

#endif  // GENERAL_ITERATION_PACK_TYPES_H