PDEOptIterCallbackBase.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                             Sundance
//                 Copyright 2011 Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */


#ifndef PDEOPT_ITER_CALLBACK_BASE_H
#define PDEOPT_ITER_CALLBACK_BASE_H

#include "SundanceDefs.hpp"
#include <string>

namespace Sundance
{

class PDEConstrainedObjBase;

/**
 * IterCallbackBase provides an abstract interface for callbacks to be
 * performed at the start of each optimization iteration.
 */
class IterCallbackBase 
{
public:
  /** */
  virtual ~IterCallbackBase(){}

  /** */
  virtual void call(const PDEConstrainedObjBase* obj, int iter) const = 0 ;
};



/**
 * Default callback writes all variables to disk at a specified frequency
 */
class DefaultIterCallback : public IterCallbackBase
{
public:

  /** */
  DefaultIterCallback(
    const std::string& filename, 
    const std::string& type,
    int frequency=1);

  /** */
  virtual ~DefaultIterCallback(){}

  /** */
  void call(const PDEConstrainedObjBase* obj, int iter) const ;

private:
  std::string type_;
  std::string filename_;
  int frequency_;
};




  
}

#endif