ROL_DynamicFunction.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_DYNAMICFUNCTION_HPP
#define ROL_DYNAMICFUNCTION_HPP

#include <initializer_list>

#include "ROL_TimeStamp.hpp"

#include "ROL_PartitionedVector.hpp"
#include "ROL_VectorWorkspace.hpp"

namespace ROL {
template<typename Real> 
class DynamicFunction {
public:

  using V  = Vector<Real>;
  using PV = PartitionedVector<Real>;
  using TS = TimeStamp<Real>;

  DynamicFunction( std::initializer_list<std::string> zero_deriv_terms={} ) :
    zero_deriv_terms_(zero_deriv_terms) {
    
    if( is_zero_derivative("uo") )    add_terms("uo_uo","uo_un","uo_z");  
    if( is_zero_derivative("un") )    add_terms("un_uo","un_un","un_z");
    if( is_zero_derivative("z")  )    add_terms("z_uo", "z_un", "z_z" );
    if( is_zero_derivative("uo_un") ) add_terms("un_uo");  
    if( is_zero_derivative("uo_z") )  add_terms("z_uo");  
    if( is_zero_derivative("un_z") )  add_terms("z_un");  
    if( is_zero_derivative("un_uo") ) add_terms("uo_un");  
    if( is_zero_derivative("z_uo") )  add_terms("uo_z");  
    if( is_zero_derivative("z_un") )  add_terms("un_z");  

  }

  virtual ~DynamicFunction() {}

  // Update old state
  virtual void update_uo( const V& x, const TS& ts ) {}

  // Update new state
  virtual void update_un( const V& x, const TS& ts ) {}

  // Update control
  virtual void update_z( const V& x, const TS& ts ) {}

  bool is_zero_derivative( const std::string& key ) {
    return std::find( std::begin(zero_deriv_terms_),
                      std::end(zero_deriv_terms_),
                      key ) != std::end(zero_deriv_terms_); 
  }


protected:

  VectorWorkspace<Real>& getVectorWorkspace() const;

  PV& partition( V& x ) const;
  const PV& partition( const V& x ) const;

  V& getNew( V& x ) const;
  const V& getNew( const V& x ) const;

  V& getOld( V& x ) const;
  const V& getOld( const V& x ) const;  

private:

  mutable VectorWorkspace<Real> workspace_;
  std::vector<std::string>      zero_deriv_terms_;

  template<typename First>
  void add_terms( const First& first ) {
    if( !is_zero_derivative(first) ) 
      zero_deriv_terms_.push_back(first);
  }

  template<typename First, typename...Rest>
  void add_terms( const First& first, const Rest&... rest ) {
    if( !is_zero_derivative(first) ) 
      zero_deriv_terms_.push_back(first);
    add_terms(rest...);
  }

};


} // namespace ROL



#include "ROL_DynamicFunctionDef.hpp"

#endif // ROL_DYNAMICFUNCTION_HPP