ROL
step/fletcher/test_01.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 
52 #include "ROL_Fletcher.hpp"
53 
54 #include "ROL_Stream.hpp"
55 #include "Teuchos_GlobalMPISession.hpp"
56 
57 
58 #include <iostream>
59 
60 typedef double RealT;
61 
62 int main(int argc, char *argv[]) {
63 
64  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
65 
66  std::string filename = "input.xml";
67 
68  auto parlist = ROL::getParametersFromXmlFile( filename );
69 
71  using V = ROL::Vector<RealT>;
72 
73  // This little trick lets us print to std::cout only if a (dummy) command-line argument is provided.
74  int iprint = argc - 1;
75  ROL::Ptr<std::ostream> outStream;
76  ROL::nullstream bhs; // outputs nothing
77  if (iprint > 0)
78  outStream = ROL::makePtrFromRef(std::cout);
79  else
80  outStream = ROL::makePtrFromRef(bhs);
81 
82  // Save the format state of the original std::cout.
83  ROL::nullstream oldFormatState;
84  oldFormatState.copyfmt(std::cout);
85 
86  int errorFlag = 0;
87 
88  // *** Test body.
89 
90  try {
91 
92  // Set up optimization problem
93  ROL::Ptr<V> x;
94  std::vector<ROL::Ptr<V> > sol;
95  ROL::Ptr<Opt> optProb;
97  SEC.get( optProb, x, sol );
98  ROL::Ptr<V> error = x->clone();
99 
100  // Solve optimization problem
101  ROL::OptimizationSolver<RealT> optSolver(*optProb, *parlist);
102  optSolver.solve(*outStream);
103 
104  error->set(*sol[0]);
105  error->axpy(static_cast<RealT>(-1), *x);
106  RealT solnErr = error->norm();
107 
108  *outStream << "Distance from true solution: " << solnErr << "\n";
109 
110  errorFlag += (solnErr < static_cast<RealT>(1e-6)) ? 0 : 1;
111  }
112  catch (std::logic_error& err) {
113  *outStream << err.what() << "\n";
114  errorFlag = -1000;
115  }; // end try
116 
117  if (errorFlag != 0)
118  std::cout << "End Result: TEST FAILED\n";
119  else
120  std::cout << "End Result: TEST PASSED\n";
121 
122  // reset format state of std::cout
123  std::cout.copyfmt(oldFormatState);
124 
125  return 0;
126 }
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
Defines a no-output stream class ROL::NullStream and a function makeStreamPtr which either wraps a re...
void get(Ptr< OptimizationProblem< Real >> &problem, Ptr< Vector< Real >> &x0, std::vector< Ptr< Vector< Real >>> &x) const
Contains definitions for the equality constrained NLP from Nocedal/Wright, 2nd edition, page 574, example 18.2; note the typo in reversing the initial guess and the solution.
Provides a simplified interface for solving a wide range of optimization problems.
basic_nullstream< char, char_traits< char >> nullstream
Definition: ROL_Stream.hpp:72
int main(int argc, char *argv[])
int solve(const ROL::Ptr< StatusTest< Real > > &status=ROL::nullPtr, const bool combineStatus=true)
Solve optimization problem with no iteration output.