ROL_DynamicObjective.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//               Rapid Optimization Library (ROL) Package
//
// Copyright 2014 NTESS and the ROL contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#pragma once
#ifndef ROL_DYNAMICOBJECTIVE_HPP
#define ROL_DYNAMICOBJECTIVE_HPP
 
#include "ROL_DynamicFunction.hpp"
 
 
namespace ROL {
 
template<typename Real> 
class DynamicObjective : public DynamicFunction<Real> {
public:
 
  using V  = Vector<Real>;
  using TS = TimeStamp<Real>;
 
  DynamicObjective() : DynamicObjective<Real>( {} ) {}
 
  DynamicObjective( std::initializer_list<std::string> zero_deriv_terms ) :
    DynamicFunction<Real>( zero_deriv_terms ) {}
  
  virtual ~DynamicObjective() {}
 
  virtual void update( const V& uo, const V& un, const V& z, const TS& timeStamp ) {
    update_uo( uo, timeStamp );
    update_un( un, timeStamp );
    update_z( z, timeStamp );
  }
 
  using DynamicFunction<Real>::update_uo;
  using DynamicFunction<Real>::update_un;
  using DynamicFunction<Real>::update_z; 
 
  virtual Real value( const V& uo, const V& un, 
                      const V& z, const TS& timeStamp ) const = 0;
 
  //----------------------------------------------------------------------------
  // Gradient Terms
  virtual void gradient_uo( V& g, const V& uo, const V& un, 
                            const V& z, const TS& timeStamp ) const {}
 
  virtual void gradient_un( V& g, const V& uo, const V& un, 
                            const V& z, const TS& timeStamp ) const {}
 
  virtual void gradient_z( V& g, const V& uo, const V& un, 
                           const V& z, const TS& timeStamp ) const {}
 
  //----------------------------------------------------------------------------
  // Hessian-Vector product terms
  virtual void hessVec_uo_uo( V& hv, const V& v, const V& uo, const V& un, 
                              const V& z, const TS& timeStamp ) const {}
 
  virtual void hessVec_uo_un( V& hv, const V& v, const V& uo, const V& un, 
                              const V& z, const TS& timeStamp ) const {}
 
  virtual void hessVec_uo_z( V& hv, const V& v, const V& uo, const V& un, 
                             const V& z, const TS& timeStamp ) const {}
 
  
  virtual void hessVec_un_uo( V& hv, const V& v, const V& uo, const V& un, 
                              const V& z, const TS& timeStamp ) const {}
 
  virtual void hessVec_un_un( V& hv, const V& v, const V& uo, const V& un, 
                              const V& z, const TS& timeStamp ) const {}
 
  virtual void hessVec_un_z( V& hv, const V& v, const V& uo, const V& un, 
                             const V& z, const TS& timeStamp ) const {}
 
 
  virtual void hessVec_z_uo( V& hv, const V& v, const V& uo, const V& un, 
                              const V& z, const TS& timeStamp ) const {}
 
  virtual void hessVec_z_un( V& hv, const V& v, const V& uo, const V& un, 
                              const V& z, const TS& timeStamp ) const {}
 
  virtual void hessVec_z_z( V& hv, const V& v, const V& uo, const V& un, 
                             const V& z, const TS& timeStamp ) const {}
};
 
} // namespace ROL
 
 
#endif // ROL_DYNAMICOBJECTIVE_HPP