MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MoochoPack_PostProcessBarrierLineSearch_Step.cpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include <ostream>
43 #include <typeinfo>
44 #include <iostream>
45 #include <math.h>
46 
53 #include "MoochoPack_IpState.hpp"
56 #include "Teuchos_dyn_cast.hpp"
57 #include "Teuchos_Assert.hpp"
58 
59 #define min(a,b) ( (a < b) ? a : b )
60 #define max(a,b) ( (a > b) ? a : b )
61 
62 namespace MoochoPack {
63 
66  )
67  :
68  barrier_nlp_(barrier_nlp)
69  {
71  !barrier_nlp_.get(),
72  std::logic_error,
73  "PostProcessBarrierLineSearch_Step given NULL NLPBarrier."
74  );
75  }
76 
77 
79  Algorithm& _algo, poss_type step_poss, IterationPack::EDoStepType type
80  ,poss_type assoc_step_poss
81  )
82  {
83  using Teuchos::dyn_cast;
86 
87  NLPAlgo &algo = dyn_cast<NLPAlgo>(_algo);
88  IpState &s = dyn_cast<IpState>(_algo.state());
89 
90  EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
91  std::ostream& out = algo.track().journal_out();
92 
93  // print step header.
94  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_ALGORITHM_STEPS) )
95  {
97  print_algorithm_step( _algo, step_poss, type, assoc_step_poss, out );
98  }
99 
100  // Get iteration quantities...
101  value_type& f_kp1 = s.f().set_k(+1);
102  f_kp1 = barrier_nlp_->objective_term();
103 
104  VectorMutable& Gf_kp1 = s.Gf().set_k(+1);
105  Gf_kp1 = *(barrier_nlp_->grad_objective_term());
106 
107  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_ALGORITHM_STEPS) )
108  {
109  out << "\nf = " << f_kp1
110  << "\nbarrier_term = " << barrier_nlp_->barrier_term() << std::endl;
111 
112  }
113 
114  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_VECTORS) )
115  {
116  out << "Gf = \n" << Gf_kp1
117  << "\ngrad_barrier_term = \n" << *(barrier_nlp_->grad_barrier_term());
118 
119  }
120  return true;
121  }
122 
123 
125  const Algorithm& _algo, poss_type step_poss, IterationPack::EDoStepType type
126  ,poss_type assoc_step_poss, std::ostream& out, const std::string& L
127  ) const
128  {
129  //const NLPAlgo &algo = rsqp_algo(_algo);
130  //const NLPAlgoState &s = algo.rsqp_state();
131  out << L << "# Process out the temporary barrier term used for line search\n"
132  << L << "f_k -= barrier_term_k\n";
133  }
134 } // end namespace MoochoPack
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
void print_step(const IterationPack::Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
Called by Algorithm::print_algorithm() to print out what this step does in Matlab like format...
value_type barrier_term() const
Get the barrier term. Must be called after calc_f().
PostProcessBarrierLineSearch_Step(Teuchos::RCP< NLPInterfacePack::NLPBarrier > barrier_nlp)
Constructor.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
void Vp_StV(VectorMutable *v_lhs, const value_type &alpha, const Vector &v_rhs)
v_lhs = alpha * v_rhs + v_lhs
rSQP Algorithm control class.
T * get() const
const Teuchos::RCP< Vector > grad_objective_term() const
Get the value of the gradient of the true objective term. Must be called after calc_Gf().
virtual std::ostream & journal_out() const
Return a reference to a std::ostream to be used to output debug information and the like...
EJournalOutputLevel
enum for journal output.
T_To & dyn_cast(T_From &from)
std::ostream * out
void print_algorithm_step(const Algorithm &algo, Algorithm::poss_type step_poss, EDoStepType type, Algorithm::poss_type assoc_step_poss, std::ostream &out)
Prints to 'out' the algorithm step.
AlgorithmTracker & track()
value_type objective_term() const
Get the true objective term value. Must be called after calc_f().
AbstractLinAlgPack::value_type value_type
Acts as the central hub for an iterative algorithm.
const Teuchos::RCP< Vector > grad_barrier_term() const
Get the value of the gradient of the barrier term. Must be called after calc_Gf() ...