AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_BasisSystem.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H
43 #define ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H
44 
45 #include "AbstractLinAlgPack_Types.hpp"
46 #include "Teuchos_AbstractFactory.hpp"
47 #include "Teuchos_RCP.hpp"
48 
49 namespace AbstractLinAlgPack {
50 
228 class BasisSystem {
229 public:
230 
233 
235  typedef Teuchos::RCP<
238  typedef Teuchos::RCP<
241  typedef Teuchos::RCP<
244  typedef Teuchos::RCP<
247  class SingularBasis : public std::runtime_error
248  {public: SingularBasis(const std::string& what_arg) : std::runtime_error(what_arg) {}};
250  enum EMatRelations { MATRICES_INDEP_IMPS, MATRICES_ALLOW_DEP_IMPS };
251 
253 
256  BasisSystem(
259  );
260 
268  virtual void initialize(
271  );
272 
274  virtual ~BasisSystem() {}
275 
278 
281  virtual const mat_nonsing_fcty_ptr_t factory_C() const = 0;
282 
288  virtual const mat_fcty_ptr_t factory_D() const = 0;
289 
295  virtual const mat_fcty_ptr_t factory_GcUP() const;
296 
306  virtual const mat_sym_fcty_ptr_t factory_transDtD() const;
307 
316  virtual const mat_sym_nonsing_fcty_ptr_t factory_S() const;
317 
319 
322 
334  virtual Range1D var_dep() const = 0;
343  virtual Range1D var_indep() const = 0;
351  virtual Range1D equ_decomp() const;
359  virtual Range1D equ_undecomp() const;
360 
362 
365 
444  virtual void update_basis(
445  const MatrixOp &Gc
446  ,MatrixOpNonsing *C
447  ,MatrixOp *D
448  ,MatrixOp *GcUP
449  ,EMatRelations mat_rel = MATRICES_INDEP_IMPS
450  ,std::ostream *out = NULL
451  ) const = 0;
452 
454 
455 private:
456  mat_sym_fcty_ptr_t factory_transDtD_;
457  mat_sym_nonsing_fcty_ptr_t factory_S_;
458 
459  // not defined and not to be called
460  BasisSystem();
461 
462 }; // end class BasisSystem
463 
464 } // end namespace AbstractLinAlgPack
465 
466 #endif // ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_H
Interface for the creation and maintainance of a basis matrix for a decomposition of linearlized cons...
virtual Range1D equ_undecomp() const
Range of undecomposed general equality constriants.
Teuchos::RCP< const Teuchos::AbstractFactory< MatrixOp > > mat_fcty_ptr_t
Teuchos::RCP< const Teuchos::AbstractFactory< MatrixOpNonsing > > mat_nonsing_fcty_ptr_t
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
Update a basis and posssibly the direct sensitivity matrix for a set of Jacobian matrices.
virtual const mat_fcty_ptr_t factory_GcUP() const
Return a matrix factory object for auxiliary sensitivity matrix GcUP = Gc(var_indep,equ_undecomp)' + Gc(var_dep,equ_undecomp)'*D.
virtual Range1D var_indep() const =0
Range of independnet (nonbasic) variables.
virtual void initialize(const mat_sym_fcty_ptr_t &factory_transDtD, const mat_sym_nonsing_fcty_ptr_t &factory_S)
Initialize the factory objects for the special matrices for D'*D and S = I + D'*D.
Teuchos::RCP< const Teuchos::AbstractFactory< MatrixSymOp > > mat_sym_fcty_ptr_t
virtual const mat_fcty_ptr_t factory_D() const =0
Return a matrix factory object for sensitivity matrix D = -inv(C)*N.
Base class for all matrices that support basic matrix operations.
Teuchos::RCP< const Teuchos::AbstractFactory< MatrixSymOpNonsing > > mat_sym_nonsing_fcty_ptr_t
virtual Range1D var_dep() const =0
Range of dependent (basic) variables.
virtual Range1D equ_decomp() const
Range of decomposed general equality constraints.
virtual const mat_sym_nonsing_fcty_ptr_t factory_S() const
Returns a matrix factory for the result of S = I + D'*D
virtual const mat_sym_fcty_ptr_t factory_transDtD() const
Returns a matrix factory for the result of J = D'*D
Abstract base class for all nonsingular polymorphic matrices that can be used to compute matrix-vecto...
virtual const mat_nonsing_fcty_ptr_t factory_C() const =0
Return a matrix factory object for basis C = [ Gc(var_dep,equ_decomp)'; Gh(var_dep,inequ_decomp)' ].