ROL_Objective_TimeSimOpt.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER

#pragma once
#ifndef ROL_OBJECTIVE_TIMESIMOPT_HPP
#define ROL_OBJECTIVE_TIMESIMOPT_HPP

#include "ROL_Objective_SimOpt.hpp"
#include "ROL_VectorWorkspace.hpp"

namespace ROL {

template<typename Real>
class Objective_TimeSimOpt : public Objective_SimOpt<Real> {
private:

  // Get the end point of the time intervals vector
  template<int I>
  Vector<Real> & getVector(Vector<Real> & x) const  { 
    return *(static_cast<PartitionedVector<Real>&>(x).get(I));
  }
 
  template<int I>
  const Vector<Real> & getVector(const Vector<Real> & x) const { 
    return *(static_cast<const PartitionedVector<Real>&>(x).get(I));
  }

  mutable VectorWorkspace<Real> workspace_;

protected:

  VectorWorkspace<Real>& getVectorWorkspace() const { return workspace_; }

public:

  using Objective_SimOpt<Real>::Objective_SimOpt;

  // Interface functions (to be overloaded)

  virtual void update( const Vector<Real>& u_old,
                       const Vector<Real>& u_new,
                       const Vector<Real>& z, 
                       bool flag = true, int iter = -1 ) {
    update_1_old( u_old, flag, iter );
    update_1_new( u_new, flag, iter );
    update_2( z, flag, iter );  
  }
};

  virtual void update_1_old( const Vector<Real>& u_old, bool flag = true, int iter = -1 ) {}

  virtual void update_1_new( const Vector<Real>& u_new, bool flag = true, int iter = -1 ) {}

  virtual void update_2( const Vector<Real> &z, bool flag = true, int iter = -1 ) override {}


  virtual Real value( const Vector<Real>& u_old, const Vector<Real>& u_new, 
                      const Vector<Real>& z, Real& tol ) { return 0; }


   virtual void gradient_1_old( Vector<Real>& g, const Vector<Real>& u_old, 
                                Vector<Real>& u_new, const Vector<Real>& z, Real& tol ) {}

   virtual void gradient_1_new( Vector<Real>& g, const Vector<Real>& u_old, 
                                Vector<Real>& u_new, const Vector<Real>& z, Real& tol ) {}
  
   
  virtual void gradient_2( Vector<Real>& g, const Vector<Real>& u_old, 
                           Vector<Real>& u_new, const Vector<Real>& z, Real& tol ) override {}

  virtual void hessVec_11_old( Vector<Real> &hv, const Vector<Real> &v_old, 
                               const Vector<Real> &u_old,  const Vector<Real>& u_new,
                               const Vector<Real> &z, Real &tol ) {}

  virtual void hessVec_11_new( Vector<Real> &hv, const Vector<Real> &v_new, 
                               const Vector<Real> &u_old,  const Vector<Real>& u_new,
                               const Vector<Real> &z, Real &tol ) {}
     
  // Functions from SimOpt that are overriden

  virtual void update( const Vector<Real>& u, const Vector<Real>& z, 
                       bool flag = true, int iter = -1 ) override {
    update(getVector<0>(u), getVector<1>(u), z, flag,iter);  
  }

  virtual Real value( const Vector<Real>& u, const Vector<Real>& z, 
                      Real& tol ) override {
    return value( getVector<0>(u), getVector<1>(u), z, tol );
  }
  
  virtual void solve( Vector<Real>& c, Vector<Real>& u, const Vector<Real>& z ) override {
    solve( c, getVector<0>(u), getVector<1>(u), z, tol ); 
  }

  virtual void gradient_1( Vector<Real>& g, const Vector<Real>& u, 
                           const Vector<Real>& z, Real& tol ) override {

    auto& u_old = getVector<0>(u); 
    auto& u_new = getVector<1>(u);

    gradient_1_old( g, u_old, u_new, z, tol );

    auto g_new = workspace_.clone(g);
    
    gradient_1_new( *g_new, u_old, u_new, z, tol );

    g.plus(*g_new);
  }

  virtual void gradient_2( Vector<Real>& g, const Vector<Real>& u, 
                           const Vector<Real>& z, Real& tol ) override {
    auto& u_old = getVector<0>(u); 
    auto& u_new = getVector<1>(u);
  
    gradient_2( g, u_old, u_new, z, tol ); 
  }
 
  virtual void hessVec_11( Vector<Real>& hv, const Vector<Real>& v, 
                           const Vector<Real>& u, const Vector<Real>& z, 
                           Real& tol ) override {

    auto& hv_old = getVector<0>(hv);
    auto& hv_new = getVector<1>(hv);
    auto& v_old  = getVector<0>(v);
    auto& v_new  = getVector<1>(v):
    auto& u_old  = getVector<0>(u);
    auto& u_new  = getVector<1>(u);
  
    hessVec_11( hv_old, v_old, u_old, u_new, z, tol );
    hessVec_11( hv_new, v_new, u_old, u_new, z, tol );  
    
  }
                          
   virtual void hessVec_12( Vector<Real>& hv, const Vector<Real>& v, 
                           const Vector<Real>& u, const Vector<Real>& z, 
                           Real& tol ) override { hv.zero(); }
 
   virtual void hessVec_21( Vector<Real>& hv, const Vector<Real>& v, 
                           const Vector<Real>& u, const Vector<Real>& z, 
                           Real& tol ) override { hv.zero(); }

   virtual void hessVec_22( Vector<Real>& hv, const Vector<Real>& v, 
                           const Vector<Real>& u, const Vector<Real>& z, 
                           Real& tol ) override { hv.zero(); }

} // namespace ROL


#endif // ROL_OBJECTIVE_TIMESIMOPT_HPP