MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_PreProcessBarrierLineSearch_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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef PRE_PROCESS_BARRIER_LINE_SEARCH_STEP_H
00043 #define PRE_PROCESS_BARRIER_LINE_SEARCH_STEP_H
00044 
00045 #include <list>
00046 
00047 #include "MoochoPack_Types.hpp"
00048 #include "MoochoPack_LineSearchFilter_Step.hpp"
00049 #include "IterationPack_AlgorithmStep.hpp"
00050 #include "Teuchos_StandardCompositionMacros.hpp"
00051 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00052 
00053 #include "OptionsFromStreamPack_SetOptionsFromStreamNode.hpp"
00054 #include "OptionsFromStreamPack_SetOptionsToTargetBase.hpp"
00055 
00056 namespace MoochoPack {
00057 
00066 class PreProcessBarrierLineSearch_Step
00067   : public IterationPack::AlgorithmStep // doxygen needs full path
00068   {
00069   public:
00070 
00073 
00078     STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, tau_boundary_frac );
00079 
00082     PreProcessBarrierLineSearch_Step(
00083       Teuchos::RCP<NLPInterfacePack::NLPBarrier> barrier_nlp,
00084       const value_type tau_boundary_frac = 0.99
00085       );
00087 
00091     bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00092            , poss_type assoc_step_poss);
00093     
00094     
00095     void print_step( const IterationPack::Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00096              , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
00098 
00099   private:
00100 
00101     // //////////////////////////
00102     // Private data members
00103 
00104     Teuchos::RCP<NLPInterfacePack::NLPBarrier> barrier_nlp_;
00105     CastIQMember< Filter_T > filter_;
00106 
00107   }; // end class PreProcessBarrierLineSearch_Step
00108 
00109 
00110 class PreProcessBarrierLineSearch_StepSetOptions
00111   : public OptionsFromStreamPack::SetOptionsFromStreamNode,
00112     public OptionsFromStreamPack::SetOptionsToTargetBase< PreProcessBarrierLineSearch_Step >
00113   {
00114   public:
00115     PreProcessBarrierLineSearch_StepSetOptions(
00116       PreProcessBarrierLineSearch_Step* target = 0,
00117       const char opt_grp_name[] = "PreProcessBarrierLineSearch" );
00118 
00119   protected:
00120 
00122     void setOption( int option_num, const std::string& option_value );
00123   
00124   };  // end class PreProcessBarrierLineSearch_StepSetOptions
00125 
00126 } // end namespace MoochoPack
00127 
00128 #endif // #if !defined PRE_PROCESS_BARRIER_LINE_SEARCH_STEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines