MOOCHO (Single Doxygen Collection) Version of the Day
NLPInterfacePack_ExampleNLPFirstOrderRun.cpp
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 #ifdef _INTEL_CXX
00043 // disable Intel C++ 5.0 warnings about debugger limitations
00044 #pragma warning(disable : 985)
00045 #endif
00046 
00047 #include <assert.h>
00048 
00049 #include <fstream>
00050 #include <fstream>
00051 #include <iostream>
00052 #include <iomanip>
00053 #include <typeinfo>
00054 
00055 #include "NLPInterfacePack_ExampleNLPFirstOrderRun.hpp"
00056 #include "NLPInterfacePack_ExampleNLPFirstOrder.hpp"
00057 #include "NLPInterfacePack_ExampleBasisSystem.hpp"
00058 #include "MoochoPack_NLPAlgoConfigMamaJama.hpp"
00059 #include "IterationPack_AlgorithmTracker.hpp"
00060 #include "AbstractLinAlgPack_VectorSpace.hpp"
00061 #include "AbstractLinAlgPack_BasisSystem.hpp"
00062 #include "OptionsFromStreamPack_OptionsFromStream.hpp"
00063 
00064 MoochoPack::MoochoSolver::ESolutionStatus
00065 NLPInterfacePack::ExampleNLPFirstOrderRun(
00066   const VectorSpace&   vec_space
00067   ,value_type          xo
00068   ,bool                has_bounds
00069   ,bool                dep_bounded
00070   ,std::ostream*       console_out
00071   ,std::ostream*       error_out
00072   ,bool                throw_solve_exception
00073   ,std::ostream*       algo_out
00074   ,std::ostream*       summary_out
00075   ,std::ostream*       journal_out
00076   )
00077 {
00078   using std::endl;
00079   using std::setw;
00080   namespace rcp = MemMngPack;
00081   using Teuchos::RCP;
00082   namespace ofsp = OptionsFromStreamPack;
00083   using ofsp::OptionsFromStream;
00084   namespace rsqp = MoochoPack;
00085   using rsqp::MoochoSolver;
00086   using rsqp::NLPAlgoConfigMamaJama;
00087 
00088   MoochoSolver::ESolutionStatus
00089     solve_return = MoochoSolver::SOLVE_RETURN_EXCEPTION;
00090 
00091   int prec = 8;
00092 
00093   if(console_out)
00094     *console_out
00095       << std::setprecision(prec)
00096       << std::scientific
00097       << "*************************************************\n"
00098       << "*** Running Tests on ExampleNLPFirstOrder ***\n"
00099       << "*************************************************\n"
00100       << "\nUsing a vector space of type \'" << typeName(vec_space) << "\'"
00101       << "\nwith a dimension of vec_space.dim() = " << vec_space.dim()
00102       << std::endl;
00103 
00104   // Create the nlp
00105   ExampleNLPFirstOrder
00106     nlp(VectorSpace::space_ptr_t(&vec_space,false),xo,has_bounds,dep_bounded);
00107 
00108   // Create the solver object and set it up
00109   MoochoSolver solver;
00110   solver.set_nlp(Teuchos::rcp(&nlp,false));                  // Set nlp
00111   // set up outputting
00112   solver.set_error_handling(
00113     throw_solve_exception
00114     ,Teuchos::rcp(error_out,false)
00115     );
00116   solver.set_console_out(Teuchos::rcp(console_out,false));
00117   solver.set_summary_out(Teuchos::rcp(summary_out,false));
00118   solver.set_journal_out(Teuchos::rcp(journal_out,false));
00119   solver.set_algo_out(   Teuchos::rcp(algo_out,false)   );
00120 
00121   // Run MOOCHO using the MamaJama configuration
00122   solve_return = solver.solve_nlp();
00123 
00124   return solve_return;
00125 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines