ConstrainedOptPack_DecompositionSystemVarReductImp.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 DECOMPOSITION_SYSTEM_VAR_REDUCT_IMP_H
#define DECOMPOSITION_SYSTEM_VAR_REDUCT_IMP_H

#include "ConstrainedOptPack_DecompositionSystemVarReduct.hpp"
#include "AbstractLinAlgPack_BasisSystemTester.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace ConstrainedOptPack {

class DecompositionSystemVarReductImp : public DecompositionSystemVarReduct {
public:


  typedef DecompositionSystem                                inherited;
  typedef Teuchos::RCP<const BasisSystem>       basis_sys_ptr_t;



  STANDARD_COMPOSITION_MEMBERS( BasisSystemTester, basis_sys_tester );

  DecompositionSystemVarReductImp(
    const VectorSpace::space_ptr_t     &space_x
    ,const VectorSpace::space_ptr_t    &space_c
    ,const basis_sys_ptr_t             &basis_sys
    ,const basis_sys_tester_ptr_t      &basis_sys_tester
    ,EExplicitImplicit                 D_imp
    ,EExplicitImplicit                 Uz_imp
    );


  void initialize(
    const VectorSpace::space_ptr_t     &space_x
    ,const VectorSpace::space_ptr_t    &space_c
    ,const basis_sys_ptr_t             &basis_sys
    );

  
  const VectorSpace::space_ptr_t& space_x() const;
  const VectorSpace::space_ptr_t& space_c() const;
  const basis_sys_ptr_t& basis_sys() const;



  void get_basis_matrices(
    std::ostream                                      *out
    ,EOutputLevel                                     olevel
    ,ERunTests                                        test_what
    ,MatrixOp                                         *Z
    ,MatrixOp                                         *Y
    ,MatrixOpNonsing                                  *R
    ,MatrixOp                                         *Uz
    ,MatrixOp                                         *Uy
    ,Teuchos::RCP<MatrixOpNonsing>       *C_ptr
    ,Teuchos::RCP<MatrixOp>              *D_ptr
    );

  void set_basis_matrices(
    std::ostream                                       *out
    ,EOutputLevel                                      olevel
    ,ERunTests                                         test_what
    ,const Teuchos::RCP<MatrixOpNonsing>  &C_ptr
    ,const Teuchos::RCP<MatrixOp>         &D_ptr
    ,MatrixOp                                          *Uz
    ,const basis_sys_ptr_t                             &basis_sys   = Teuchos::null
    );

  EExplicitImplicit D_imp_used() const; 



  size_type n() const;
  size_type m() const;
  size_type r() const;
  const VectorSpace::space_ptr_t space_range() const;
  const VectorSpace::space_ptr_t space_null() const;
  const mat_fcty_ptr_t factory_Z() const;
  const mat_fcty_ptr_t factory_Uz() const;
  void update_decomp(
    std::ostream          *out
    ,EOutputLevel         olevel
    ,ERunTests            test_what
    ,const MatrixOp       &Gc
    ,MatrixOp             *Z
    ,MatrixOp             *Y
    ,MatrixOpNonsing      *R
    ,MatrixOp             *Uz
    ,MatrixOp             *Uy
    ,EMatRelations        mat_rel
    ) const;
  void print_update_decomp(
    std::ostream& out, const std::string& leading_str ) const;



  Range1D var_indep() const;
  Range1D var_dep() const;


protected:

  virtual void update_D_imp_used(EExplicitImplicit *D_imp_used) const;

  virtual mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t uninitialize_matrices(
    std::ostream                     *out
    ,EOutputLevel                    olevel
    ,MatrixOp                        *Y
    ,MatrixOpNonsing                 *R
    ,MatrixOp                        *Uy
    ) const = 0;

  virtual void initialize_matrices(
    std::ostream                                           *out
    ,EOutputLevel                                          olevel
    ,const mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t &C_ptr
    ,const mat_fcty_ptr_t::element_type::obj_ptr_t         &D_ptr
    ,MatrixOp                                              *Y
    ,MatrixOpNonsing                                       *R
    ,MatrixOp                                              *Uy
    ,EMatRelations                                         mat_rel
    ) const = 0;

  virtual void print_update_matrices(
    std::ostream& out, const std::string& leading_str ) const = 0;

private:

  // //////////////////////////////////
  // Private data members
  
#ifdef DOXYGEN_COMPILE
  AbstractLinAlgPack::BasisSystem       *basis_sys;
  VectorSpace                           *space_x;
  VectorSpace                           *space_c;
  VectorSpace                           *space_range;
  VectorSpace                           *space_null;
#else
  basis_sys_ptr_t                       basis_sys_;
  VectorSpace::space_ptr_t              space_x_;
  VectorSpace::space_ptr_t              space_c_;
  VectorSpace::space_ptr_t              space_range_;
  VectorSpace::space_ptr_t              space_null_;
  mutable Teuchos::RCP<MatrixOpNonsing>  C_ptr_;
  mutable Teuchos::RCP<MatrixOp>             D_ptr_;
  mutable EExplicitImplicit                                   D_imp_used_;
#endif
  // //////////////////////////////////
  // Private member functions

  void alloc_new_D_matrix( 
    std::ostream                             *out
    ,EOutputLevel                            olevel
    ,Teuchos::RCP<MatrixOp> *D_ptr
    ) const;
  
  // not defined and not to be called!
  DecompositionSystemVarReductImp(const DecompositionSystemVarReductImp&);
  DecompositionSystemVarReductImp& operator=(const DecompositionSystemVarReductImp&);
  
};  // end class DecompositionSystemVarReductImp

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

inline
const VectorSpace::space_ptr_t&
DecompositionSystemVarReductImp::space_x() const
{
  return space_x_;
}

inline
const VectorSpace::space_ptr_t&
DecompositionSystemVarReductImp::space_c() const
{
  return space_c_;
}

inline
const DecompositionSystemVarReductImp::basis_sys_ptr_t&
DecompositionSystemVarReductImp::basis_sys() const
{
  return basis_sys_;
}

inline
DecompositionSystemVarReductImp::EExplicitImplicit
DecompositionSystemVarReductImp::D_imp_used() const
{
  update_D_imp_used(&D_imp_used_);
  return D_imp_used_;
}

} // end namespace ConstrainedOptPack

#endif  // DECOMPOSITION_SYSTEM_VAR_REDUCT_IMP_H