AbstractLinAlgPack_BasisSystem.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 ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H
#define ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H

#include "AbstractLinAlgPack_Types.hpp"
#include "Teuchos_AbstractFactory.hpp"
#include "Teuchos_RCP.hpp"

namespace AbstractLinAlgPack {

class BasisSystem {
public:


  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixOpNonsing> >    mat_nonsing_fcty_ptr_t;
  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixOp> >           mat_fcty_ptr_t;
  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixSymOp> >        mat_sym_fcty_ptr_t;
  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<MatrixSymOpNonsing> > mat_sym_nonsing_fcty_ptr_t;
  class SingularBasis : public std::runtime_error
  {public: SingularBasis(const std::string& what_arg) : std::runtime_error(what_arg) {}};
  enum EMatRelations { MATRICES_INDEP_IMPS, MATRICES_ALLOW_DEP_IMPS };


  BasisSystem(
    const mat_sym_fcty_ptr_t             &factory_transDtD
    ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
    );

  virtual void initialize(
    const mat_sym_fcty_ptr_t             &factory_transDtD
    ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
    );

  virtual ~BasisSystem() {}


  virtual const mat_nonsing_fcty_ptr_t factory_C() const = 0;
  
  virtual const mat_fcty_ptr_t factory_D() const = 0;

  virtual const mat_fcty_ptr_t factory_GcUP() const;

  virtual const mat_sym_fcty_ptr_t factory_transDtD() const;
  
  virtual const mat_sym_nonsing_fcty_ptr_t factory_S() const;
  


  virtual Range1D var_dep() const = 0;
  virtual Range1D var_indep() const = 0;
  virtual Range1D equ_decomp() const;
  virtual Range1D equ_undecomp() const;



  virtual void update_basis(
    const MatrixOp          &Gc
    ,MatrixOpNonsing        *C
    ,MatrixOp               *D
    ,MatrixOp               *GcUP
    ,EMatRelations          mat_rel = MATRICES_INDEP_IMPS
    ,std::ostream           *out    = NULL
    ) const = 0;


private:
  mat_sym_fcty_ptr_t             factory_transDtD_;
  mat_sym_nonsing_fcty_ptr_t     factory_S_;

  // not defined and not to be called
  BasisSystem();

}; // end class BasisSystem

}  // end namespace AbstractLinAlgPack

#endif // ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H