ROL
step/test_04.cpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) 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 lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
48 #define USE_HESSVEC 1
49 
50 #include "ROL_TestObjectives.hpp"
51 #include "ROL_Algorithm.hpp"
52 #include "Teuchos_oblackholestream.hpp"
53 #include "Teuchos_GlobalMPISession.hpp"
54 #include "Teuchos_XMLParameterListHelpers.hpp"
55 
56 #include <iostream>
57 
58 typedef double RealT;
59 
60 int main(int argc, char *argv[]) {
61 
62  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
63 
64  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
65  int iprint = argc - 1;
66  Teuchos::RCP<std::ostream> outStream;
67  Teuchos::oblackholestream bhs; // outputs nothing
68  if (iprint > 0)
69  outStream = Teuchos::rcp(&std::cout, false);
70  else
71  outStream = Teuchos::rcp(&bhs, false);
72 
73  int errorFlag = 0;
74 
75  // *** Test body.
76 
77  try {
78 
79  std::string filename = "input.xml";
80  Teuchos::RCP<Teuchos::ParameterList> parlist = Teuchos::rcp( new Teuchos::ParameterList() );
81  Teuchos::updateParametersFromXmlFile( filename, parlist.ptr() );
82  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",true);
83 #if USE_HESSVEC
84  parlist->sublist("General").set("Inexact Hessian-Times-A-Vector",false);
85 #endif
86 
88  if ( prob == ROL::TESTOPTPROBLEM_HS2 || prob == ROL::TESTOPTPROBLEM_BVP ) {
89  parlist->sublist("Step").sublist("Line Search").set("Initial Step Size",1.e-4);
90  parlist->sublist("Step").sublist("Trust Region").set("Initial Radius",-1.e1);
91  parlist->sublist("Step").sublist("Trust Region").set("Safeguard Size",1.e-4);
92  parlist->sublist("Status Test").set("Gradient Tolerance",1.e-6);
93  }
94  else if ( prob == ROL::TESTOPTPROBLEM_HS25 ) {
95  parlist->sublist("Step").sublist("Line Search").set("Initial Step Size",1.0);
96  parlist->sublist("Step").sublist("Trust Region").set("Initial Radius",1.e3);
97  parlist->sublist("Step").sublist("Trust Region").set("Safeguard Size",1.e4);
98  parlist->sublist("Status Test").set("Gradient Tolerance",1.e-8);
99  }
100  else {
101  parlist->sublist("Step").sublist("Line Search").set("Initial Step Size",1.0);
102  parlist->sublist("Step").sublist("Trust Region").set("Initial Radius",-1.e1);
103  parlist->sublist("Step").sublist("Trust Region").set("Safeguard Size",1.e4);
104  parlist->sublist("Status Test").set("Gradient Tolerance",1.e-6);
105  }
106  parlist->sublist("General").set("Scale for Epsilon Active Sets",1.0);
107  if ( prob == ROL::TESTOPTPROBLEM_HS4 ) {
108  parlist->sublist("General").set("Scale for Epsilon Active Sets",1.e-2);
109  }
110  *outStream << std::endl << std::endl << ROL:: ETestOptProblemToString(prob) << std::endl << std::endl;
111 
112  // Get Objective Function
113  Teuchos::RCP<ROL::Vector<RealT> > x0, z;
114  Teuchos::RCP<ROL::Objective<RealT> > obj;
115  Teuchos::RCP<ROL::BoundConstraint<RealT> > con;
116  ROL::getTestObjectives<RealT>(obj,con,x0,z,prob);
117  Teuchos::RCP<ROL::Vector<RealT> > x = x0->clone();;
118 
119  // Get Dimension of Problem
120  int dim = x0->dimension();
121  parlist->sublist("General").sublist("Krylov").set("Iteration Limit", 2*dim);
122 
123  // Error Vector
124  Teuchos::RCP<ROL::Vector<RealT> > e = x0->clone();;
125  e->zero();
126 
127  //ROL::ETrustRegion tr = ROL::TRUSTREGION_CAUCHYPOINT;
128  //ROL::ETrustRegion tr = ROL::TRUSTREGION_DOGLEG;
129  //ROL::ETrustRegion tr = ROL::TRUSTREGION_DOUBLEDOGLEG;
131  parlist->sublist("Step").sublist("Trust Region").set("Subproblem Solver", ROL::ETrustRegionToString(tr));
132  *outStream << std::endl << std::endl << ROL::ETrustRegionToString(tr) << std::endl << std::endl;
133 
134  // Define Algorithm
135  ROL::Algorithm<RealT> algo("Trust Region",*parlist,false);
136 
137  // Run Algorithm
138  x->set(*x0);
139  algo.run(*x, *obj, *con, true, *outStream);
140 
141  // Compute Error
142  e->set(*x);
143  e->axpy(-1.0,*z);
144  *outStream << std::endl << "Norm of Error: " << e->norm() << std::endl;
145  }
146  }
147  catch (std::logic_error err) {
148  *outStream << err.what() << std::endl;
149  errorFlag = -1000;
150  }; // end try
151 
152  if (errorFlag != 0)
153  std::cout << "End Result: TEST FAILED" << std::endl;
154  else
155  std::cout << "End Result: TEST PASSED" << std::endl;
156 
157  return 0;
158 
159 }
160 
ETestOptProblem
Enumeration of test optimization problems.
Definition: ROL_Types.hpp:948
double RealT
int main(int argc, char *argv[])
Contains definitions of test objective functions.
std::string ETestOptProblemToString(ETestOptProblem to)
Definition: ROL_Types.hpp:961
Provides an interface to run optimization algorithms.
virtual std::vector< std::string > run(Vector< Real > &x, Objective< Real > &obj, bool print=false, std::ostream &outStream=std::cout)
Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
ETrustRegion
Enumeration of trust-region solver types.
Definition: ROL_Types.hpp:786
std::string ETrustRegionToString(ETrustRegion tr)
Definition: ROL_Types.hpp:794