IterationPack_Types.hpp

Go to the documentation of this file.

// @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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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