MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_UpdateBarrierParameter_Step.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 UPDATE_BARRIER_PARAMETER_STEP_H
00030 #define UPDATE_BARRIER_PARAMETER_STEP_H
00031 
00032 #include "MoochoPack_Types.hpp"
00033 #include "IterationPack_AlgorithmStep.hpp"
00034 #include "Teuchos_StandardCompositionMacros.hpp"
00035 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00036 
00037 #include "OptionsFromStreamPack_SetOptionsFromStreamNode.hpp"
00038 #include "OptionsFromStreamPack_SetOptionsToTargetBase.hpp"
00039 
00040 namespace MoochoPack {
00041 
00048 class UpdateBarrierParameter_Step
00049   : public IterationPack::AlgorithmStep // doxygen needs full path
00050   {
00051   public:
00052 
00055 
00060     STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, init_barrier_parameter );
00061 
00066     STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, tau_mu );
00067 
00072     STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, theta_mu );
00073 
00078     STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, tau_epsilon );
00079 
00084     STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, theta_epsilon );
00085 
00089     STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, e_tol_max );
00090 
00093     UpdateBarrierParameter_Step(
00094       const value_type init_barrier_parameter = 0.1,
00095       const value_type tau_mu = 0.2,
00096       const value_type theta_mu = 1.5,
00097       const value_type tau_epsilon = 10,
00098       const value_type theta_epsilon = 1.1,
00099       const value_type e_tol_max = 1000
00100       );
00102 
00106     bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00107            , poss_type assoc_step_poss);
00108     
00109     
00110     void print_step( const IterationPack::Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00111              , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
00113 
00114   private:
00115     value_type Calculate_e_tol(value_type mu);
00116 
00117   }; // end class UpdateBarrierParameter_Step
00118 
00119 
00120 class UpdateBarrierParameter_StepSetOptions
00121   : public OptionsFromStreamPack::SetOptionsFromStreamNode,
00122     public OptionsFromStreamPack::SetOptionsToTargetBase< UpdateBarrierParameter_Step >
00123   {
00124   public:
00125     UpdateBarrierParameter_StepSetOptions(
00126       UpdateBarrierParameter_Step* target = 0,
00127       const char opt_grp_name[] = "UpdateBarrierParameter" );
00128 
00129   protected:
00130 
00132     void setOption( int option_num, const std::string& option_value );
00133   
00134   };  // end class UpdateBarrierParameter_StepSetOptions
00135 
00136 } // end namespace MoochoPack
00137 
00138 #endif // #if !defined UPDATE_BARRIER_PARAMETER_STEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines