MoochoPack_DecompositionSystemStateStepBuilderStd.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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef DECOMPOSITION_SYSTEM_STATE_STEP_BUILDER_STD_H
#define DECOMPOSITION_SYSTEM_STATE_STEP_BUILDER_STD_H

#include "MoochoPack_Types.hpp"
#ifndef MOOCHO_NO_BASIS_PERM_DIRECT_SOLVERS
#include "AbstractLinAlgPack_BasisSystemPerm.hpp"
#endif
#include "MoochoPack_NewDecompositionSelection_Strategy.hpp"

namespace OptionsFromStreamPack {
  class OptionsFromStream;
}

namespace MoochoPack {

class DecompositionSystemStateStepBuilderStd
{
public:
  

  enum ENullSpaceMatrixType {
    NULL_SPACE_MATRIX_AUTO, NULL_SPACE_MATRIX_EXPLICIT
    , NULL_SPACE_MATRIX_IMPLICIT };
  enum ERangeSpaceMatrixType {
    RANGE_SPACE_MATRIX_AUTO, RANGE_SPACE_MATRIX_COORDINATE
    , RANGE_SPACE_MATRIX_ORTHOGONAL };



  struct SOptionValues {
    // Constructor (sets default values)
    SOptionValues();
    ENullSpaceMatrixType  null_space_matrix_type_;
    ERangeSpaceMatrixType range_space_matrix_type_;
    int           max_dof_quasi_newton_dense_;    // If < 0, don't change default
  };

  
  typedef Teuchos::RCP<
    const OptionsFromStreamPack::OptionsFromStream>             options_ptr_t;

  DecompositionSystemStateStepBuilderStd();

  void set_options( const options_ptr_t& options );
  const options_ptr_t& get_options() const;
  void process_nlp_and_options(
    std::ostream          *trase_out
    ,NLP                  &nlp
    ,NLPFirstOrder        **nlp_foi
    ,NLPSecondOrder       **nlp_soi
    ,NLPDirect            **nlp_fod
    ,bool                 *tailored_approach
    );
  void create_decomp_sys(
    std::ostream                                       *trase_out
    ,NLP                                               &nlp
    ,NLPFirstOrder                                     *nlp_foi
    ,NLPSecondOrder                                    *nlp_soi
    ,NLPDirect                                         *nlp_fod
    ,bool                                              tailored_approach
    ,Teuchos::RCP<DecompositionSystem>         *decomp_sys
    );
  void add_iter_quantities(
    std::ostream                                           *trase_out
    ,NLP                                                   &nlp
    ,NLPFirstOrder                                         *nlp_foi
    ,NLPSecondOrder                                        *nlp_soi
    ,NLPDirect                                             *nlp_fod
    ,bool                                                  tailored_approach
    ,const Teuchos::RCP<DecompositionSystem>       &decomp_sys
    ,const Teuchos::RCP<NLPAlgoState>              &state
    );

  void create_eval_new_point(
    std::ostream                                                 *trase_out
    ,NLP                                                         &nlp
    ,NLPFirstOrder                                               *nlp_foi
    ,NLPSecondOrder                                              *nlp_soi
    ,NLPDirect                                                   *nlp_fod
    ,bool                                                        tailored_approach
    ,const Teuchos::RCP<DecompositionSystem>             &decomp_sys
    ,Teuchos::RCP<IterationPack::AlgorithmStep>          *eval_new_point_step
    ,Teuchos::RCP<CalcFiniteDiffProd>                    *calc_fd_prod
    ,Teuchos::RCP<VariableBoundsTester>                  *bounds_tester
    ,Teuchos::RCP<NewDecompositionSelection_Strategy>    *new_decomp_selection_strategy
    );

  SOptionValues& current_option_values();

private:
  
  // ///////////////////////////
  // Private data members

  options_ptr_t   options_;

  SOptionValues       uov_; // options set by user
  SOptionValues       cov_; // current option values actually used

#ifndef MOOCHO_NO_BASIS_PERM_DIRECT_SOLVERS
  Teuchos::RCP<BasisSystemPerm> basis_sys_perm_;
#endif

  // /////////////////////////
  // Private member functions

  static void readin_options(
    const OptionsFromStreamPack::OptionsFromStream& options
    ,SOptionValues *option_values, std::ostream* trase_out
    );

  static void set_default_options(
    const SOptionValues& user_option_values
    ,SOptionValues *current_option_values
    ,std::ostream* trase_out
    );

}; // end class DecompositionSystemStateStepBuilderStd

// ///////////////////////////////
// Inline members

inline
DecompositionSystemStateStepBuilderStd::SOptionValues&
DecompositionSystemStateStepBuilderStd::current_option_values()
{
  return cov_;
}

}  // end namespace MoochoPack

#endif // DECOMPOSITION_SYSTEM_STATE_STEP_BUILDER_STD_H