Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_DefaultFiniteDifferenceModelEvaluator_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_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
43#define THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
44
45#include "Thyra_ModelEvaluatorDelegatorBase.hpp"
46#include "Thyra_DirectionalFiniteDiffCalculator.hpp"
49
50
51namespace Thyra {
52
53
61template<class Scalar>
63 : virtual public ModelEvaluatorDelegatorBase<Scalar>
64{
65public:
66
69
72 DirectionalFiniteDiffCalculator<Scalar>, direcFiniteDiffCalculator );
73
76
78 void initialize(
79 const RCP<ModelEvaluator<Scalar> > &thyraModel
80 ,const RCP<DirectionalFiniteDiffCalculator<Scalar> > &direcFiniteDiffCalculator
81 );
82
84
87
89 std::string description() const;
90
92
93private:
94
97
99 ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
101 void evalModelImpl(
104 ) const;
105
107
108};
109
110
115template<class Scalar>
121
122
127template<class Scalar>
130 const RCP<ModelEvaluator<Scalar> > &thyraModel,
131 const RCP<DirectionalFiniteDiffCalculator<Scalar> > &direcFiniteDiffCalculator
132 )
133{
135 defaultFiniteDifferenceModelEvaluator<Scalar>();
136 fdModel->initialize(thyraModel, direcFiniteDiffCalculator);
137 return fdModel;
138}
139
140
141} // namespace Thyra
142
143
144#endif // THYRA_DEFAULT_FINITE_DIFFERENCE_MODEL_EVALUATOR_DECL_HPP
This class wraps any ModelEvaluator object and computes certain derivatives using finite differences.
STANDARD_COMPOSITION_MEMBERS(DirectionalFiniteDiffCalculator< Scalar >, direcFiniteDiffCalculator)
Utility object that computes directional finite differences.
RCP< DefaultFiniteDifferenceModelEvaluator< Scalar > > defaultFiniteDifferenceModelEvaluator(const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
Nonmember constructor.
void initialize(const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
RCP< DefaultFiniteDifferenceModelEvaluator< Scalar > > defaultFiniteDifferenceModelEvaluator()
Nonmember constructor.
Utility class for computing directional finite differences of a model.
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...
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)