MoochoPack_MoochoThyraSolver.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef MOOCHOPACK_MOOCHO_THYRA_SOLVER_HPP
#define MOOCHOPACK_MOOCHO_THYRA_SOLVER_HPP

#include "MoochoPack_MoochoSolver.hpp"
#include "Thyra_ModelEvaluator.hpp"
#include "Thyra_DirectionalFiniteDiffCalculator.hpp"
#include "Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp"
#include "Thyra_DefaultFinalPointCaptureModelEvaluator.hpp"
#include "Thyra_MultiVectorFileIOBase.hpp"
#include "Thyra_ParameterDrivenMultiVectorInput.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace MoochoPack {

using Teuchos::RCP;

class MoochoThyraSolver
  : virtual public Teuchos::ParameterListAcceptor
{
public:


  enum ESolveMode {
    SOLVE_MODE_FORWARD    
    ,SOLVE_MODE_OPTIMIZE  
  };



  MoochoThyraSolver(
    const std::string    &paramsXmlFileName                = ""
    ,const std::string   &extraParamsXmlString             = ""
    ,const std::string   &paramsUsedXmlOutFileName         = ""
    ,const std::string   &paramsXmlFileNameOption          = "moocho-thyra-params-file"
    ,const std::string   &extraParamsXmlStringOption       = "extra-moocho-thyra-params"
    ,const std::string   &paramsUsedXmlOutFileNameOption   = "moocho-thyra-params-used-file"
    );
  
  ~MoochoThyraSolver();
  
  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,paramsXmlFileName);
    
  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extraParamsXmlString);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,paramsUsedXmlOutFileName);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,paramsXmlFileNameOption);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extraParamsXmlStringOption);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,paramsUsedXmlOutFileNameOption);

  STANDARD_NONCONST_COMPOSITION_MEMBERS( Thyra::MultiVectorFileIOBase<value_type>, stateVectorIO );

  STANDARD_NONCONST_COMPOSITION_MEMBERS( Thyra::MultiVectorFileIOBase<value_type>, parameterVectorIO );
  
  void setupCLP(
    Teuchos::CommandLineProcessor *clp
    );

  void readParameters( std::ostream *out );



  void setParameterList(RCP<Teuchos::ParameterList> const& paramList);
  RCP<Teuchos::ParameterList> getNonconstParameterList();
  RCP<Teuchos::ParameterList> unsetParameterList();
  RCP<const Teuchos::ParameterList> getParameterList() const;
  RCP<const Teuchos::ParameterList> getValidParameters() const;


  //@

  void setSolveMode( const ESolveMode solveMode );

  ESolveMode getSolveMode() const;
  
  MoochoSolver& getSolver();
  
  const MoochoSolver& getSolver() const;


  
  void setModel(
    const RCP<Thyra::ModelEvaluator<value_type> > &origModel,
    const int p_idx  = 0,
    const int g_idx  = 0
    );
  
  const RCP<Thyra::ModelEvaluator<value_type> >
  getOrigModel() const;
  
  const RCP<Thyra::ModelEvaluator<value_type> >
  getOuterModel() const;
    
  void readInitialGuess(
    std::ostream *out = NULL
    );
    
  void setInitialGuess(
    const RCP<const Thyra::ModelEvaluatorBase::InArgs<value_type> > &initialGuess
    );
    
  void setInitialGuess(
    const Thyra::ModelEvaluatorBase::InArgs<value_type> &initialGuess
    );
  
  MoochoSolver::ESolutionStatus solve();
    
  const Thyra::ModelEvaluatorBase::InArgs<value_type>& getFinalPoint() const;
  
  void writeFinalSolution(
    std::ostream *out = NULL
    ) const;

  void writeParamsFile(
    const std::string &outputXmlFileName  = "" 
    ) const;


public:

  // I am just making these public so that I can access them from
  // the anonymous namespace in the *.cpp file
  enum ENLPType { NLP_TYPE_FIRST_ORDER, NLP_TYPE_DIRECT };

private:

  typedef value_type Scalar;

  MoochoSolver solver_;
 
  RCP<Thyra::ModelEvaluator<value_type> > origModel_;
  int p_idx_;
  int g_idx_;

  mutable Thyra::ParameterDrivenMultiVectorInput<value_type> x_reader_;
  mutable Thyra::ParameterDrivenMultiVectorInput<value_type> p_reader_;
  mutable Thyra::ParameterDrivenMultiVectorInput<value_type> p_l_reader_;
  mutable Thyra::ParameterDrivenMultiVectorInput<value_type> p_u_reader_;

  RCP<Teuchos::ParameterList> paramList_;
 
  RCP<Thyra::DefaultNominalBoundsOverrideModelEvaluator<value_type> >
  nominalModel_;
 
  RCP<Thyra::DefaultFinalPointCaptureModelEvaluator<value_type> >
  finalPointModel_;

  RCP<Thyra::ModelEvaluator<value_type> > outerModel_;

  ESolveMode solveMode_;
  ENLPType nlpType_;
  bool nonlinearlyElimiateStates_;
  bool use_finite_diff_for_obj_;
  bool use_finite_diff_for_con_;
  double fwd_newton_tol_;
  int fwd_newton_max_iters_;
  bool fwd_newton_dampening_;
  int fwd_newton_max_ls_iters_;
  bool useInvObjFunc_;
  bool useParameterLumping_;
  std::string outputFileTag_;
  bool showModelEvaluatorTrace_;
  std::string stateSoluFileBase_;
  std::string paramSoluFileBase_;

};

} // namespace MoochoPack

#endif  // MOOCHOPACK_MOOCHO_THYRA_SOLVER_HPP