Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_ModelEvaluator.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Thyra: Interfaces and Support for Abstract Numerical Algorithms
5// Copyright (2004) 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 Roscoe A. Bartlett (bartlettra@ornl.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42
43#ifndef THYRA_MODEL_EVALUATOR_HPP
44#define THYRA_MODEL_EVALUATOR_HPP
45
46
47#include "Thyra_ModelEvaluatorBase.hpp"
48#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
49
50
51namespace Thyra {
52
53
773template<class Scalar>
775public:
776
779
782
787 virtual int Np() const = 0;
788
794 virtual int Ng() const = 0;
795
797
800
803
806
809
823
838
852
862
877
879
882
903
918
933
935
938
956
982
1009
1020 virtual RCP<LinearOpBase<Scalar> > create_DfDp_op(int l) const = 0;
1021
1033
1044 virtual RCP<LinearOpBase<Scalar> > create_DgDx_op(int j) const = 0;
1045
1058 virtual RCP<LinearOpBase<Scalar> > create_DgDp_op( int j, int l ) const = 0;
1059
1060#ifdef Thyra_BUILD_HESSIAN_SUPPORT
1061
1069 virtual RCP<LinearOpBase<Scalar> > create_hess_f_xx() const = 0;
1070
1080 virtual RCP<LinearOpBase<Scalar> > create_hess_f_xp(int l) const = 0;
1081
1094 virtual RCP<LinearOpBase<Scalar> > create_hess_f_pp( int l1, int l2 ) const = 0;
1095
1105 virtual RCP<LinearOpBase<Scalar> > create_hess_g_xx(int j) const = 0;
1106
1118 virtual RCP<LinearOpBase<Scalar> > create_hess_g_xp( int j, int l ) const = 0;
1119
1132 virtual RCP<LinearOpBase<Scalar> > create_hess_g_pp( int j, int l1, int l2 ) const = 0;
1133
1134#endif // ifdef Thyra_BUILD_HESSIAN_SUPPORT
1135
1137
1140
1162
1164
1167
1180
1193
1255 virtual void evalModel(
1258 ) const = 0;
1259
1261
1264
1271 virtual void reportFinalPoint(
1272 const ModelEvaluatorBase::InArgs<Scalar> &finalPoint,
1273 const bool wasSolved
1274 ) = 0;
1275
1277
1278private:
1279
1280 // Not defined and not to be called
1282 operator=(const ModelEvaluator<Scalar>&);
1283
1284};
1285
1286} // namespace Thyra
1287
1288
1289#endif // THYRA_MODEL_EVALUATOR_HPP
Concrete aggregate class for all input arguments computable by a ModelEvaluator subclass object.
Concrete aggregate class for all output arguments computable by a ModelEvaluator subclass object.
Base subclass for ModelEvaluator that defines some basic types.
Pure abstract base interface for evaluating a stateless "model" that can be mapped into a number of d...
virtual int Ng() const =0
Return the number of sets of auxiliary response functions.
virtual RCP< LinearOpWithSolveBase< Scalar > > create_W() const =0
If supported, create a LinearOpWithSolveBase object for W to be evaluated.
virtual void reportFinalPoint(const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)=0
Report the final point and whether the problem was considered solved or not.
virtual RCP< const VectorSpaceBase< Scalar > > get_f_space() const =0
Return the vector space for the state function f(...) <: RE^n_x.
virtual RCP< LinearOpBase< Scalar > > create_DgDx_dot_op(int j) const =0
If supported, create a linear operator derivative object for D(g(j))/D(x_dot).
virtual RCP< LinearOpBase< Scalar > > create_W_op() const =0
If supported, create a LinearOpBase object for W to be evaluated.
Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
virtual ModelEvaluatorBase::InArgs< Scalar > getUpperBounds() const =0
Return the set of upper bounds for the input arguments.
virtual RCP< const VectorSpaceBase< Scalar > > get_g_multiplier_space(int j) const =0
Return the dual vector space for the auxiliary response functions g(j) <: RE^n_g_j.
virtual RCP< const LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const =0
If supported, return a LinearOpWithSolveFactoryBase object that can be used to initialize a LOWSB obj...
virtual ModelEvaluatorBase::OutArgs< Scalar > createOutArgs() const =0
Create an empty output functions/derivatives object that can be set up and passed to evalModel().
virtual RCP< const VectorSpaceBase< Scalar > > get_f_multiplier_space() const =0
Return the dual vector space for the state function f(...) <: RE^n_x.
virtual RCP< LinearOpBase< Scalar > > create_DgDp_op(int j, int l) const =0
If supported, create a linear operator derivative object for D(g(j))/D(p(l)).
virtual RCP< const Teuchos::Array< std::string > > get_p_names(int l) const =0
Get the names of the parameters associated with parameter subvector l if available.
virtual ModelEvaluatorBase::InArgs< Scalar > getLowerBounds() const =0
Return the set of lower bounds for the input arguments.
virtual Teuchos::ArrayView< const std::string > get_g_names(int j) const =0
Get the names of the response functions associated with subvector j if available.
virtual RCP< LinearOpBase< Scalar > > create_DgDx_op(int j) const =0
If supported, create a linear operator derivative object for D(g(j))/D(x).
virtual ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const =0
Return the set of nominal values or initial guesses for the supported the input arguments.
virtual RCP< PreconditionerBase< Scalar > > create_W_prec() const =0
If supported, create a PreconditionerBase object for W_prec to be evaluated.
virtual RCP< const VectorSpaceBase< Scalar > > get_g_space(int j) const =0
Return the vector space for the auxiliary response functions g(j) <: RE^n_g_j.
virtual ModelEvaluatorBase::InArgs< Scalar > createInArgs() const =0
Create an empty input arguments object that can be set up and passed to evalModel().
virtual RCP< const VectorSpaceBase< Scalar > > get_p_space(int l) const =0
Return the vector space for the auxiliary parameters p(l) <: RE^n_p_l.
virtual int Np() const =0
Return the number of sets of auxiliary parameters.
virtual RCP< LinearOpBase< Scalar > > create_DfDp_op(int l) const =0
If supported, create a linear operator derivative object for D(f)/D(p(l)).
virtual RCP< const VectorSpaceBase< Scalar > > get_x_space() const =0
Return the vector space for the state variables x <: RE^n_x.
virtual void evalModel(const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const =0
Compute all of the requested functions/derivatives at the given point.