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_OPTIMIZATIONPROBLEMFACTORY_H
45 #define ROL_OPTIMIZATIONPROBLEMFACTORY_H
46 
47 #include "ROL_Ptr.hpp"
48 #include "ROL_OptimizationProblem.hpp"
49 
50 /** @ingroup func_group
51     \class ROL::OptimizationProblemFactory
52     \brief Defines the pebbl OptimizationProblemFactory interface.
53 
54     ROL's OptimizationProblemFactory constructs a new (identical)
55     instance of an optimization problem for use in pebbl.
56 
57     ---
58 */
59 
60 
61 namespace ROL {
62 
63 template <class Real>
64 class OptimizationProblemFactory {
65 public:
~OptimizationProblemFactory(void)66   virtual ~OptimizationProblemFactory(void) {}
67 
68   virtual Ptr<Objective<Real>>       buildObjective(void) = 0;
69   virtual Ptr<Vector<Real>>          buildSolutionVector(void) = 0;
70 
buildBoundConstraint(void)71   virtual Ptr<BoundConstraint<Real>> buildBoundConstraint(void) {
72     return nullPtr;
73   }
74 
buildEqualityConstraint(void)75   virtual Ptr<Constraint<Real>>      buildEqualityConstraint(void) {
76     return nullPtr;
77   }
buildEqualityMultiplier(void)78   virtual Ptr<Vector<Real>>          buildEqualityMultiplier(void) {
79     return nullPtr;
80   }
81 
buildInequalityConstraint(void)82   virtual Ptr<Constraint<Real>>      buildInequalityConstraint(void) {
83     return nullPtr;
84   }
buildInequalityMultiplier(void)85   virtual Ptr<Vector<Real>>          buildInequalityMultiplier(void) {
86     return nullPtr;
87   }
buildInequalityBoundConstraint(void)88   virtual Ptr<BoundConstraint<Real>> buildInequalityBoundConstraint(void) {
89     return nullPtr;
90   }
91 
update(void)92   virtual void update(void) {}
93 
build(void)94   Ptr<OptimizationProblem<Real>> build(void) {
95     update();
96     return makePtr<OptimizationProblem<Real>>(buildObjective(),
97                                               buildSolutionVector(),
98                                               buildBoundConstraint(),
99                                               buildEqualityConstraint(),
100                                               buildEqualityMultiplier(),
101                                               buildInequalityConstraint(),
102                                               buildInequalityMultiplier(),
103                                               buildInequalityBoundConstraint());
104   }
105 
106 }; // class OptimizationProblemFactory
107 
108 } // namespace ROL
109 
110 #endif
111