MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_CheckConvergenceStd_AddedStep.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef CHECK_CONVERGENCE_STD_ADDEDSTEP_H
00030 #define CHECK_CONVERGENCE_STD_ADDEDSTEP_H
00031 
00032 #include "MoochoPack_Types.hpp"
00033 #include "IterationPack_AlgorithmStep.hpp"
00034 #include "Teuchos_StandardCompositionMacros.hpp"
00035 #include "MoochoPack_CheckConvergence_Strategy.hpp"
00036 
00037 namespace MoochoPack {
00038 
00041 class CheckConvergenceStd_AddedStep
00042   : public IterationPack::AlgorithmStep // doxygen needs full path
00043   {
00044   public:
00045     
00049     STANDARD_COMPOSITION_MEMBERS( CheckConvergence_Strategy, convergence_strategy );
00050 
00052     CheckConvergenceStd_AddedStep(
00053       Teuchos::RCP<CheckConvergence_Strategy> convergence_strategy
00054       );
00055 
00059     bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00060            , poss_type assoc_step_poss);
00062     void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00063              , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
00065 
00066 private:
00067 
00068 };  // end class CheckConvergenceStd_AddedStep
00069 
00070 } // end namespace MoochoPack 
00071 
00072 #endif  // CHECK_CONVERGENCE_STD_ADDEDSTEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines