EpetraModelEval4DOpt.hpp

Go to the documentation of this file.

/*
//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - Linear Algebra Services Package
//                 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef EPETRA_MODEL_EVAL_4D_OPT_HPP
#define EPETRA_MODEL_EVAL_4D_OPT_HPP

#include "EpetraExt_ModelEvaluator.h"
#include "Epetra_Map.h"
#include "Epetra_Vector.h"
#include "Epetra_Comm.h"
#include "Epetra_CrsGraph.h"

class EpetraModelEval4DOpt : public EpetraExt::ModelEvaluator {
public:

  EpetraModelEval4DOpt(
                const double xt0 = 1.0
                ,const double xt1 = 1.0
                ,const double pt0 = 2.0
                ,const double pt1 = 0.0
                ,const double d = 10.0
                ,const double x00 = 1.0
                ,const double x01 = 1.0
                ,const double p00 = 2.0
                ,const double p01 = 0.0
    );

  void setSupportDerivs( bool supportDerivs );

  void set_p_bounds( double pL0, double pL1, double pU0, double pU1 );

  void set_x_bounds( double xL0, double xL1, double xU0, double xU1 );


  Teuchos::RCP<const Epetra_Map> get_x_map() const;
  Teuchos::RCP<const Epetra_Map> get_f_map() const;
  Teuchos::RCP<const Epetra_Map> get_p_map(int l) const;
  Teuchos::RCP<const Epetra_Map> get_g_map(int j) const;
  Teuchos::RCP<const Epetra_Vector> get_x_init() const;
  Teuchos::RCP<const Epetra_Vector> get_p_init(int l) const;
  Teuchos::RCP<const Epetra_Vector> get_x_lower_bounds() const;
  Teuchos::RCP<const Epetra_Vector> get_x_upper_bounds() const;
  Teuchos::RCP<const Epetra_Vector> get_p_lower_bounds(int l) const;
  Teuchos::RCP<const Epetra_Vector> get_p_upper_bounds(int l) const;
  Teuchos::RCP<Epetra_Operator> create_W() const;
  InArgs createInArgs() const;
  OutArgs createOutArgs() const;
  void evalModel( const InArgs& inArgs, const OutArgs& outArgs ) const;


private:

  // /////////////////////////////////////
  // Private member data

        double xt0_;
        double xt1_;
        double pt0_;
        double pt1_;
  double d_;

        bool isInitialized_;
  bool supportDerivs_;

  Teuchos::RCP<const Epetra_Comm> epetra_comm_;
        Teuchos::RCP<const Epetra_Map> map_x_;
        Teuchos::RCP<const Epetra_Map> map_p_;
        Teuchos::RCP<const Epetra_Map> map_g_;

        Teuchos::RCP<Epetra_Vector> xL_;
        Teuchos::RCP<Epetra_Vector> xU_;
        Teuchos::RCP<Epetra_Vector> pL_;
        Teuchos::RCP<Epetra_Vector> pU_;
        Teuchos::RCP<Epetra_Vector> gL_;
        Teuchos::RCP<Epetra_Vector> gU_;
        Teuchos::RCP<Epetra_Vector> x0_;
        Teuchos::RCP<Epetra_Vector> p0_;

  Teuchos::RCP<Epetra_CrsGraph> W_graph_;

  // Note defined and not to be called
  EpetraModelEval4DOpt();

};

#endif // EPETRA_MODEL_EVAL_4D_OPT_HPP