Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_StateFuncModelEvaluatorBase.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_STATE_FUNC_MODEL_EVALUATOR_BASE_HPP
43#define THYRA_STATE_FUNC_MODEL_EVALUATOR_BASE_HPP
44
45#include "Thyra_ModelEvaluatorDefaultBase.hpp"
46
47
48namespace Thyra {
49
50
61template<class Scalar>
97
98
99// /////////////////////////////////
100// Implementations
101
102
103// Public functions overridden from ModelEvaulator
104
105
106template<class Scalar>
109{
111 true,std::logic_error
112 ,"ModelEvaluator<"<<Teuchos::ScalarTraits<Scalar>::name()<<">::get_p_space(l): "
113 "Error, this function was not overridden in *this = \'"<<this->description()<<"\'!"
114 );
116}
117
118
119template<class Scalar>
122{
124 true,std::logic_error
125 ,"ModelEvaluator<"<<Teuchos::ScalarTraits<Scalar>::name()<<">::get_p_names(l): "
126 "Error, this function was not overridden in *this = \'"<<this->description()<<"\'!"
127 );
129}
130
131
132template<class Scalar>
135{
137 true,std::logic_error
138 ,"ModelEvaluator<"<<Teuchos::ScalarTraits<Scalar>::name()<<">::get_g_space(j): "
139 " Error, this function was not overridden in \'"
140 <<this->description()<<"\'!"
141 );
143}
144
145
146template<class Scalar>
149{
151 true,std::logic_error
152 ,"ModelEvaluator<"<<Teuchos::ScalarTraits<Scalar>::name()<<">::get_g_names(j): "
153 "Error, this function was not overridden in *this = \'"<<this->description()<<"\'!"
154 );
156}
157
158
159template<class Scalar>
162{ return this->createInArgs(); }
163
164
165template<class Scalar>
168{ return this->createInArgs(); }
169
170
171template<class Scalar>
174{ return this->createInArgs(); }
175
176
177template<class Scalar>
180{
182 true, std::logic_error
183 ,"Error, if \'W_op\' is supported by the ModelEvaluator subclass then"
184 " this function create_W_op() must be overridden by the subclass "
185 <<this->description()<<" to return a non-null object!"
186 );
188}
189
190
191template<class Scalar>
197
198
199template<class Scalar>
205
206
207template<class Scalar>
209 const ModelEvaluatorBase::InArgs<Scalar> &/* finalPoint */,
210 const bool /* wasSolved */
211 )
212{
213 // This final point is just ignored by default!
214}
215
216
217} // namespace Thyra
218
219
220#endif // THYRA_STATE_FUNC_MODEL_EVALUATOR_BASE_HPP
Concrete aggregate class for all input arguments computable by a ModelEvaluator subclass object.
Default base class for concrete model evaluators.
This base class defines default function implementations appropritate for a set of nonlinear state fu...
RCP< const LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
Returns null .
RCP< PreconditionerBase< Scalar > > create_W_prec() const
Returns null.
ModelEvaluatorBase::InArgs< Scalar > getUpperBounds() const
Returns this->createInArgs().
ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
Returns this->createInArgs().
ModelEvaluatorBase::InArgs< Scalar > getLowerBounds() const
Returns this->createInArgs().
Teuchos::ArrayView< const std::string > get_g_names(int j) const
Throws exception.
RCP< LinearOpBase< Scalar > > create_W_op() const
Throws exception.
RCP< const VectorSpaceBase< Scalar > > get_p_space(int l) const
Throws exception.
RCP< const Teuchos::Array< std::string > > get_p_names(int l) const
Throws exception.
void reportFinalPoint(const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)
Ignores input and does nothing.
RCP< const VectorSpaceBase< Scalar > > get_g_space(int j) const
Throws exception.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal)
T_To & dyn_cast(T_From &from)