ROL
ROL_TrustRegionFactory.hpp
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 
44 #ifndef ROL_TRUSTREGIONFACTORY_H
45 #define ROL_TRUSTREGIONFACTORY_H
46 
47 #include "ROL_Types.hpp"
48 
49 #include "Teuchos_ParameterList.hpp"
50 #include "Teuchos_RCP.hpp"
51 
52 #include "ROL_TrustRegion.hpp"
53 #include "ROL_CauchyPoint.hpp"
54 #include "ROL_DogLeg.hpp"
55 #include "ROL_DoubleDogLeg.hpp"
56 #include "ROL_TruncatedCG.hpp"
57 
58 namespace ROL {
59 template<class Real>
60  inline Teuchos::RCP<TrustRegion<Real> > TrustRegionFactory(Teuchos::ParameterList &parlist) {
62  parlist.sublist("Step").sublist("Trust Region").get("Subproblem Solver","Dogleg"));
63  switch(etr) {
64  case TRUSTREGION_CAUCHYPOINT: return Teuchos::rcp( new CauchyPoint<Real>(parlist) );
65  case TRUSTREGION_DOGLEG: return Teuchos::rcp( new DogLeg<Real>(parlist) );
66  case TRUSTREGION_DOUBLEDOGLEG: return Teuchos::rcp( new DoubleDogLeg<Real>(parlist) );
67  case TRUSTREGION_TRUNCATEDCG: return Teuchos::rcp( new TruncatedCG<Real>(parlist) );
68  default: return Teuchos::null;
69  }
70  }
71 }
72 
73 #endif
Contains definitions of custom data types in ROL.
Provides interface for the double dog leg trust-region subproblem solver.
Teuchos::RCP< TrustRegion< Real > > TrustRegionFactory(Teuchos::ParameterList &parlist)
Provides interface for truncated CG trust-region subproblem solver.
ETrustRegion StringToETrustRegion(std::string s)
Provides interface for dog leg trust-region subproblem solver.
Definition: ROL_DogLeg.hpp:58
Provides interface for the Cauchy point trust-region subproblem solver.
ETrustRegion
Enumeration of trust-region solver types.