Thyra Version of the Day
Thyra_ResponseOnlyModelEvaluatorBase.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_RESPONSE_ONLY_MODEL_EVALUATOR_BASE_HPP
00043 #define THYRA_RESPONSE_ONLY_MODEL_EVALUATOR_BASE_HPP
00044 
00045 
00046 #include "Thyra_ModelEvaluatorDefaultBase.hpp"
00047 #include "Teuchos_Assert.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00063 template<class Scalar>
00064 class ResponseOnlyModelEvaluatorBase : virtual public ModelEvaluatorDefaultBase<Scalar> {
00065 public:
00066 
00069 
00071   RCP<const VectorSpaceBase<Scalar> > get_x_space() const;
00073   RCP<const Teuchos::Array<std::string> > get_p_names(int l) const;
00075   RCP<const VectorSpaceBase<Scalar> > get_f_space() const;
00077   ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
00079   ModelEvaluatorBase::InArgs<Scalar> getLowerBounds() const;
00081   ModelEvaluatorBase::InArgs<Scalar> getUpperBounds() const;
00083   RCP<LinearOpWithSolveBase<Scalar> > create_W() const;
00085   RCP<LinearOpBase<Scalar> > create_W_op() const;
00087   RCP<const LinearOpWithSolveFactoryBase<Scalar> > get_W_factory() const;
00089   void reportFinalPoint(
00090     const ModelEvaluatorBase::InArgs<Scalar> &finalPoint,
00091     const bool wasSolved
00092     );
00093 
00095   
00096 };
00097 
00098 
00099 // /////////////////////////////////
00100 // Implementations
00101 
00102 
00103 // Public functions overridden from ModelEvaulator
00104 
00105 
00106 template<class Scalar>
00107 RCP<const VectorSpaceBase<Scalar> >
00108 ResponseOnlyModelEvaluatorBase<Scalar>::get_x_space() const
00109 {
00110   return Teuchos::null;
00111 }
00112 
00113 
00114 template<class Scalar>
00115 RCP<const Teuchos::Array<std::string> >
00116 ResponseOnlyModelEvaluatorBase<Scalar>::get_p_names(int l) const
00117 {
00118 #ifdef TEUCHOS_DEBUG
00119   TEUCHOS_ASSERT_IN_RANGE_UPPER_EXCLUSIVE( l, 0, this->Np() );
00120 #endif
00121   return Teuchos::null;
00122 }
00123 
00124 template<class Scalar>
00125 RCP<const VectorSpaceBase<Scalar> >
00126 ResponseOnlyModelEvaluatorBase<Scalar>::get_f_space() const
00127 {
00128   return Teuchos::null;
00129 }
00130 
00131 
00132 template<class Scalar>
00133 ModelEvaluatorBase::InArgs<Scalar>
00134 ResponseOnlyModelEvaluatorBase<Scalar>::getNominalValues() const
00135 { return this->createInArgs(); }
00136 
00137 
00138 template<class Scalar>
00139 ModelEvaluatorBase::InArgs<Scalar>
00140 ResponseOnlyModelEvaluatorBase<Scalar>::getLowerBounds() const
00141 { return this->createInArgs(); }
00142 
00143 
00144 template<class Scalar>
00145 ModelEvaluatorBase::InArgs<Scalar>
00146 ResponseOnlyModelEvaluatorBase<Scalar>::getUpperBounds() const
00147 { return this->createInArgs(); }
00148 
00149 
00150 template<class Scalar>
00151 RCP<LinearOpWithSolveBase<Scalar> >
00152 ResponseOnlyModelEvaluatorBase<Scalar>::create_W() const
00153 {
00154   TEUCHOS_TEST_FOR_EXCEPTION(
00155     true, std::logic_error
00156     ,"Error, if \'W\' is supported by the ModelEvaluator subclass then"
00157     " this function create_W() must be overridden by the subclass to return"
00158     " a non-null object!"
00159     );
00160   return Teuchos::null; // Should never be called!
00161 }
00162 
00163 
00164 template<class Scalar>
00165 RCP<LinearOpBase<Scalar> >
00166 ResponseOnlyModelEvaluatorBase<Scalar>::create_W_op() const
00167 {
00168   TEUCHOS_TEST_FOR_EXCEPTION(
00169     true, std::logic_error
00170     ,"Error, if \'W\' is supported by the ModelEvaluator subclass then"
00171     " this function create_W_op() must be overridden by the subclass "
00172     <<this->description()<<" to return a non-null object!"
00173     );
00174   return Teuchos::null; // Should never be called!
00175 }
00176 
00177 
00178 template<class Scalar>
00179 RCP<const LinearOpWithSolveFactoryBase<Scalar> >
00180 ResponseOnlyModelEvaluatorBase<Scalar>::get_W_factory() const
00181 {
00182   TEUCHOS_TEST_FOR_EXCEPTION(
00183     true, std::logic_error
00184     ,"Error, if \'W\' is supported by the ModelEvaluator subclass then"
00185     " this function get_W_factory() must be overridden by the subclass "
00186     <<this->description()<<" to return a non-null object!"
00187     );
00188   return Teuchos::null; // Should never be called!
00189 }
00190 
00191 
00192 template<class Scalar>
00193 void ResponseOnlyModelEvaluatorBase<Scalar>::reportFinalPoint(
00194   const ModelEvaluatorBase::InArgs<Scalar> &finalPoint,
00195   const bool wasSolved
00196   )
00197 {
00198   // This final point is just ignored by default!
00199 }
00200 
00201 
00202 } // namespace Thyra
00203 
00204 
00205 #endif // THYRA_RESPONSE_ONLY_MODEL_EVALUATOR_BASE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines