ROL
src
algorithm
TypeU
linesearch
descent
ROL_DescentDirection_U_Factory.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_DESCENTDIRECTION_U_FACTORY_H
45
#define ROL_DESCENTDIRECTION_U_FACTORY_H
46
47
#include "
ROL_Gradient_U.hpp
"
48
#include "
ROL_QuasiNewton_U.hpp
"
49
#include "
ROL_NonlinearCG_U.hpp
"
50
#include "
ROL_Newton_U.hpp
"
51
#include "
ROL_NewtonKrylov_U.hpp
"
52
53
namespace
ROL
{
54
template
<
typename
Real>
55
inline
Ptr<DescentDirection_U<Real>>
DescentDirectionUFactory
(ParameterList &parlist) {
56
EDescentU
edesc =
StringToEDescentU
(
57
parlist.sublist(
"Step"
).sublist(
"Line Search"
).sublist(
"Descent Method"
).get(
"Type"
,
"Quasi-Newton Method"
));
58
switch
(edesc) {
59
case
DESCENT_U_STEEPEST
:
return
makePtr<Gradient_U<Real>>();
60
case
DESCENT_U_NONLINEARCG
:
return
makePtr<NonlinearCG_U<Real>>(parlist);
61
case
DESCENT_U_SECANT
:
return
makePtr<QuasiNewton_U<Real>>(parlist);
62
case
DESCENT_U_NEWTON
:
return
makePtr<Newton_U<Real>>();
63
case
DESCENT_U_NEWTONKRYLOV
:
return
makePtr<NewtonKrylov_U<Real>>(parlist);
64
default
:
return
nullPtr;
65
}
66
}
67
}
// namespace ROL
68
69
#endif
ROL_Gradient_U.hpp
ROL_NewtonKrylov_U.hpp
ROL_Newton_U.hpp
ROL_NonlinearCG_U.hpp
ROL_QuasiNewton_U.hpp
ROL
Definition
ROL_ElementwiseVector.hpp:61
ROL::EDescentU
EDescentU
Definition
ROL_LineSearch_U_Types.hpp:64
ROL::DESCENT_U_NONLINEARCG
@ DESCENT_U_NONLINEARCG
Definition
ROL_LineSearch_U_Types.hpp:66
ROL::DESCENT_U_NEWTON
@ DESCENT_U_NEWTON
Definition
ROL_LineSearch_U_Types.hpp:68
ROL::DESCENT_U_SECANT
@ DESCENT_U_SECANT
Definition
ROL_LineSearch_U_Types.hpp:67
ROL::DESCENT_U_STEEPEST
@ DESCENT_U_STEEPEST
Definition
ROL_LineSearch_U_Types.hpp:65
ROL::DESCENT_U_NEWTONKRYLOV
@ DESCENT_U_NEWTONKRYLOV
Definition
ROL_LineSearch_U_Types.hpp:69
ROL::DescentDirectionUFactory
Ptr< DescentDirection_U< Real > > DescentDirectionUFactory(ParameterList &parlist)
Definition
ROL_DescentDirection_U_Factory.hpp:55
ROL::StringToEDescentU
EDescentU StringToEDescentU(std::string s)
Definition
ROL_LineSearch_U_Types.hpp:124
Generated by
1.10.0