AbstractLinAlgPack_BasisSystemComposite.hpp

Go to the documentation of this file.

// @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 BASIS_SYSTEM_COMPOSITE_STD_H
#define BASIS_SYSTEM_COMPOSITE_STD_H

#include "AbstractLinAlgPack_BasisSystem.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"

namespace AbstractLinAlgPack {

class BasisSystemComposite
  : public AbstractLinAlgPack::BasisSystem
{
public:


  typedef Teuchos::RCP<const Teuchos::AbstractFactory<MatrixOp> >  fcty_Gc_ptr_t;
  typedef Teuchos::RCP<MatrixOpNonsing>                               C_ptr_t;
  typedef Teuchos::RCP<MatrixOp>                                      N_ptr_t;



  static void initialize_space_x(
    const VectorSpace::space_ptr_t    &space_xD
    ,const VectorSpace::space_ptr_t   &space_xI
    ,Range1D                          *var_dep
    ,Range1D                          *var_indep
    ,VectorSpace::space_ptr_t         *space_x
    );

  static const fcty_Gc_ptr_t factory_Gc();
  
  static void initialize_Gc(
    const VectorSpace::space_ptr_t    &space_x
    ,const Range1D                    &var_dep
    ,const Range1D                    &var_indep
    ,const VectorSpace::space_ptr_t   &space_c
    ,const C_ptr_t                    &C
    ,const N_ptr_t                    &N
    ,MatrixOp                         *Gc
    );

  static void get_C_N(
      MatrixOp               *Gc
    ,MatrixOpNonsing       **C
    ,MatrixOp              **N
    );

  static void get_C_N(
    const MatrixOp               &Gc
    ,const MatrixOpNonsing       **C
    ,const MatrixOp              **N
    );



  BasisSystemComposite();

  BasisSystemComposite(
    const VectorSpace::space_ptr_t       &space_x
    ,const VectorSpace::space_ptr_t      &space_c
    ,const mat_nonsing_fcty_ptr_t        &factory_C
    ,const mat_sym_fcty_ptr_t            &factory_transDtD
    ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
    );

  BasisSystemComposite(
    const VectorSpace::space_ptr_t       &space_x
    ,const Range1D                       &var_dep
    ,const Range1D                       &var_indep
    ,const VectorSpace::space_ptr_t      &space_c
    ,const mat_nonsing_fcty_ptr_t        &factory_C
    ,const mat_sym_fcty_ptr_t            &factory_transDtD
    ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
    ,const mat_fcty_ptr_t                &factory_D        = Teuchos::null
    );
  
  void initialize(
    const VectorSpace::space_ptr_t       &space_x
    ,const Range1D                       &var_dep
    ,const Range1D                       &var_indep
    ,const VectorSpace::space_ptr_t      &space_c
    ,const mat_nonsing_fcty_ptr_t        &factory_C
    ,const mat_sym_fcty_ptr_t            &factory_transDtD
    ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
    ,const mat_fcty_ptr_t                &factory_D        = Teuchos::null
    );

  virtual void set_uninitialized();



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



  virtual void update_D(
    const MatrixOpNonsing       &C
    ,const MatrixOp             &N
    ,MatrixOp                   *D
    ,EMatRelations              mat_rel
    ) const;



  const mat_nonsing_fcty_ptr_t factory_C() const;
  const mat_fcty_ptr_t factory_D() const;
  Range1D var_dep() const;
  Range1D var_indep() const;
  void update_basis(
    const MatrixOp          &Gc
    ,MatrixOpNonsing        *C
    ,MatrixOp               *D
    ,MatrixOp               *GcUP
    ,EMatRelations          mat_rel
    ,std::ostream           *out
    ) const;


private:
  
#ifndef DOXYGEN_COMPILE
  VectorSpace::space_ptr_t   space_x_;
  Range1D                    var_dep_;
  Range1D                    var_indep_;
  VectorSpace::space_ptr_t   space_c_;
  mat_nonsing_fcty_ptr_t     factory_C_;
  mat_fcty_ptr_t             factory_D_;
#endif

}; // end class BasisSystemComposite

} // end namespace AbstractPack

#endif // BASIS_SYSTEM_COMPOSITE_STD_H