ROL_SerialFunction.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
// 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_SERIALFUNCION_HPP
#define ROL_SERIALFUNCION_HPP

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

namespace ROL {

template<typename Real>
class SerialFunction {
public:
  using size_type = typename std::vector<Real>::size_type;

private:
  using PV = PartitionedVector<Real>;

  Ptr<Vector<Real>>             u_initial_;                // Initial condition 
  Ptr<Vector<Real>>             u_zero_;                   // Zero state vector
  TimeStampsPtr<Real>           timeStampsPtr_;            // Set of all time stamps
  mutable VectorWorkspace<Real> workspace_;                // Memory bank for vector clones
  size_type                     Nt_;                       // Number of type steps
  bool                          skipInitialCond_ = false;

protected:

  const TimeStamp<Real>& ts( size_type i ) const { return timeStampsPtr_->at(i); }
  Ptr<Vector<Real>> clone( const Vector<Real>& x ) { return workspace_.clone(x); }

public:

  SerialFunction( const Vector<Real>& u_initial,
                  const TimeStampsPtr<Real>& timeStampsPtr ) : 
    u_initial_(u_initial.clone()), 
    u_zero_(u_initial.clone()), 
    timeStampsPtr_(timeStampsPtr),
    Nt_(timeStampsPtr->size()) {
    u_initial_->set(u_initial);
    u_zero_->zero();
  }

  size_type numTimeSteps() const { return Nt_; }

  const Vector<Real>& getInitialCondition() const { return *u_initial_; }
  void setInitialCondition( const Vector<Real>& u_initial ) { u_initial_->set(u_initial); }

  const Vector<Real>& getZeroState() const { return *u_zero_; }

  bool getSkipInitialCondition() const { return skipInitialCond_; }
  void setSkipInitialCondition( bool skip ) { skipInitialCond_ = skip; }

  // Get and set methods for all TimeStamps
  TimeStampsPtr<Real> getTimeStampsPtr() const { return timeStampsPtr_; }

  void setTimeStampsPtr( const TimeStampsPtr<Real>& timeStampsPtr ) {
    timeStampsPtr_ = timeStampsPtr; 
    Nt_ = timeStampsPtr_->size(); 
  }

  // Get and set methods for individual TimeStamp objects 
  TimeStamp<Real>& getTimeStamp( size_type i ) { return timeStampsPtr_->at(i); }
  const TimeStamp<Real>& getTimeStamp( size_type i ) const { return timeStampsPtr_->at(i); }

  void setTimeStamp( size_type i, const TimeStamp<Real>& timeStamp ) {
    timeStampsPtr_->at(i) = timeStamp;
  }


}; // class SerialFunction


} // namespace ROL

#endif  // ROL_SERIALFUNCION_HPP