AbstractLinAlgPack_VectorSpaceBlocked.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 VECTOR_SPACE_COMPOSITE_STE_H
#define VECTOR_SPACE_COMPOSITE_STE_H

#include <vector>

#include "AbstractLinAlgPack_VectorSpace.hpp"

namespace AbstractLinAlgPack {

class VectorSpaceBlocked : public VectorSpace {
public:

  VectorSpaceBlocked(
    const VectorSpace::space_ptr_t          vector_spaces[]
    ,int                                    num_vector_spaces
    ,const VectorSpace::space_fcty_ptr_t   &small_vec_spc_fcty = Teuchos::null
    );
  
  void initialize(
    const VectorSpace::space_ptr_t         vec_spaces[]
    ,int                                   num_vector_spaces
    ,const VectorSpace::space_fcty_ptr_t   &small_vec_spc_fcty = Teuchos::null
    );

  int num_vector_spaces() const;

    /* Returns an array (length <tt>this->num_vector_spaces()</tt>) consistent with
     * <tt>vec_spaces</tt> passed into <tt>this->initialize()</tt>.
     */
  const VectorSpace::space_ptr_t*  vector_spaces() const;

  const index_type* vector_spaces_offsets() const;

  void get_vector_space_position( index_type i, int* kth_vector_space, index_type* kth_global_offset ) const;

  
   bool is_compatible(const VectorSpace& vec_space) const;
  index_type dim() const;
  space_fcty_ptr_t small_vec_spc_fcty() const;
  vec_mut_ptr_t create_member() const;
  multi_vec_mut_ptr_t create_members(size_type num_vecs) const;
  space_ptr_t clone() const;
  space_ptr_t sub_space(const Range1D& rng) const;


private:

  // ////////////////////////////////////////////
  // Private types

  typedef std::vector<VectorSpace::space_ptr_t>   vector_spaces_t;
  typedef std::vector<index_type>                 vec_spaces_offsets_t;

  // ////////////////////////////////////////////
  // Private data members

#ifdef DOXYGEN_COMPILE
  VectorSpace           *vector_spaces;
  VectorSpaceFactory    *small_vec_spc_fcty;
#else
  vector_spaces_t       vector_spaces_;
  // Pointer to the list of vector spaces.

  vec_spaces_offsets_t  vec_spaces_offsets_;
  // vec_spaces_offset_[k] gives the offset for vector_spaces_[k] in the 
  // global composite vector.  vec_spaces_offset_[vector_spaces_.size()] gives
  // the total dimension of the global composite vector.

  VectorSpace::space_fcty_ptr_t   small_vec_spc_fcty_;
  // Vector space factory for small_vec_spc_fcty
#endif

  // Not defined and not to be called
  VectorSpaceBlocked();

}; // end class VectorSpaceBlocked

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

inline
int VectorSpaceBlocked::num_vector_spaces() const
{
  return vector_spaces_.size();
}

inline
const VectorSpace::space_ptr_t*
VectorSpaceBlocked::vector_spaces() const
{
  return &vector_spaces_[0];
}

inline
const index_type* VectorSpaceBlocked::vector_spaces_offsets() const
{
  return &vec_spaces_offsets_[0];
}

} // end namespace AbstractLinAlgPack

#endif // VECTOR_SPACE_COMPOSITE_STE_H