MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_BasisSystem.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H
00043 #define ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H
00044 
00045 #include "AbstractLinAlgPack_Types.hpp"
00046 #include "Teuchos_AbstractFactory.hpp"
00047 #include "Teuchos_RCP.hpp"
00048 
00049 namespace AbstractLinAlgPack {
00050 
00228 class BasisSystem {
00229 public:
00230 
00233 
00235   typedef Teuchos::RCP<
00236     const Teuchos::AbstractFactory<MatrixOpNonsing> >    mat_nonsing_fcty_ptr_t;
00238   typedef Teuchos::RCP<
00239     const Teuchos::AbstractFactory<MatrixOp> >           mat_fcty_ptr_t;
00241   typedef Teuchos::RCP<
00242     const Teuchos::AbstractFactory<MatrixSymOp> >        mat_sym_fcty_ptr_t;
00244   typedef Teuchos::RCP<
00245     const Teuchos::AbstractFactory<MatrixSymOpNonsing> > mat_sym_nonsing_fcty_ptr_t;
00247   class SingularBasis : public std::runtime_error
00248   {public: SingularBasis(const std::string& what_arg) : std::runtime_error(what_arg) {}};
00250   enum EMatRelations { MATRICES_INDEP_IMPS, MATRICES_ALLOW_DEP_IMPS };
00251 
00253 
00256   BasisSystem(
00257     const mat_sym_fcty_ptr_t             &factory_transDtD
00258     ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
00259     );
00260 
00268   virtual void initialize(
00269     const mat_sym_fcty_ptr_t             &factory_transDtD
00270     ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
00271     );
00272 
00274   virtual ~BasisSystem() {}
00275 
00278 
00281   virtual const mat_nonsing_fcty_ptr_t factory_C() const = 0;
00282   
00288   virtual const mat_fcty_ptr_t factory_D() const = 0;
00289 
00295   virtual const mat_fcty_ptr_t factory_GcUP() const;
00296 
00306   virtual const mat_sym_fcty_ptr_t factory_transDtD() const;
00307   
00316   virtual const mat_sym_nonsing_fcty_ptr_t factory_S() const;
00317   
00319 
00322 
00334   virtual Range1D var_dep() const = 0;
00343   virtual Range1D var_indep() const = 0;
00351   virtual Range1D equ_decomp() const;
00359   virtual Range1D equ_undecomp() const;
00360 
00362 
00365 
00444   virtual void update_basis(
00445     const MatrixOp          &Gc
00446     ,MatrixOpNonsing        *C
00447     ,MatrixOp               *D
00448     ,MatrixOp               *GcUP
00449     ,EMatRelations          mat_rel = MATRICES_INDEP_IMPS
00450     ,std::ostream           *out    = NULL
00451     ) const = 0;
00452 
00454 
00455 private:
00456   mat_sym_fcty_ptr_t             factory_transDtD_;
00457   mat_sym_nonsing_fcty_ptr_t     factory_S_;
00458 
00459   // not defined and not to be called
00460   BasisSystem();
00461 
00462 }; // end class BasisSystem
00463 
00464 }  // end namespace AbstractLinAlgPack
00465 
00466 #endif // ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines