GlobiPack Package Browser (Single Doxygen Collection) Version of the Day
GlobiPack_MeritFunc1DBase.hpp
Go to the documentation of this file.
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 //    GlobiPack: Collection of Scalar 1D globalizaton utilities
00006 //                 Copyright (2009) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #ifndef GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
00045 #define GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
00046 
00047 
00048 #include "GlobiPack_Types.hpp"
00049 #include "Teuchos_Describable.hpp"
00050 
00051 
00052 namespace GlobiPack {
00053 
00054 
00061 template<typename Scalar>
00062 class MeritFunc1DBase : virtual public Teuchos::Describable
00063 {
00064 public:
00065 
00067   virtual bool supportsDerivEvals() const = 0;
00068 
00087   virtual void eval( const Scalar &alpha, const Ptr<Scalar> &phi,
00088     const Ptr<Scalar> &Dphi ) const = 0;
00089 
00090 };
00091 
00092 
00097 template<typename Scalar>
00098 typename ScalarTraits<Scalar>::magnitudeType
00099 computeValue(const MeritFunc1DBase<Scalar> &phi, const Scalar &alpha)
00100 {
00101   Scalar phi_val = ScalarTraits<Scalar>::zero();
00102   phi.eval(alpha, Teuchos::outArg(phi_val), Teuchos::null);
00103   return phi_val;
00104 }
00105 
00106 
00111 template<typename Scalar>
00112 PointEval1D<Scalar>
00113 computePoint(const MeritFunc1DBase<Scalar> &phi, const Scalar &alpha,
00114   const bool compute_phi = true, const bool compute_Dphi = false)
00115 {
00116   using Teuchos::null;
00117   using Teuchos::outArg;
00118   PointEval1D<Scalar> p;
00119   p.alpha = alpha;
00120   phi.eval( alpha, compute_phi ? outArg(p.phi) : null ,
00121     compute_Dphi ? outArg(p.Dphi) : null );
00122   return p;
00123 }
00124 
00125 
00126 } // namespace GlobiPack
00127 
00128 
00129 #endif // GLOBIPACK_MERIT_FUNC_1D_BASE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends