Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_ScaledModelEvaluator_decl.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#ifndef THYRA_SCALED_MODEL_EVALUATOR_HPP
43#define THYRA_SCALED_MODEL_EVALUATOR_HPP
44
45#include "Thyra_ModelEvaluatorDelegatorBase.hpp"
46
47namespace Thyra {
48
49
58template<class Scalar>
60 virtual public ModelEvaluatorDelegatorBase<Scalar>
61{
62public:
63
66
68 std::string description() const;
69
71 void set_f_scaling(const RCP<const Thyra::VectorBase<Scalar> >& f_scaling);
72
73private:
74
77
79 void evalModelImpl(
82 ) const;
83
85
86private:
87
88 //* Diagonal scaling vector */
90
91};
92
93
95template<class Scalar>
97createNonconstScaledModelEvaluator(const RCP<ModelEvaluator<Scalar > > &model)
98{
100 srme->initialize(model);
101 return srme;
102}
103
104
105} // namespace Thyra
106
107
108#endif // THYRA_SCALED_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.
This is a base class that delegetes almost all function to a wrapped model evaluator object.
Pure abstract base interface for evaluating a stateless "model" that can be mapped into a number of d...
This class decorates a ModelEvaluator and returns scaled residual and Jacobian values.
void set_f_scaling(const RCP< const Thyra::VectorBase< Scalar > > &f_scaling)
ScaledModelEvaluator()
Constructs to uninitialized.
Abstract interface for finite-dimensional dense vectors.