RTOpPack_RTOpTDecl.hpp

// @HEADER
// ***********************************************************************
// 
// RTOp: Interfaces and Support Software for Vector Reduction Transformation
//       Operations
//                Copyright (2006) 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 RTOPPACK_RTOP_NEW_T_DECL_HPP
#define RTOPPACK_RTOP_NEW_T_DECL_HPP

#include "RTOpPack_Types.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "Teuchos_PrimitiveTypeTraits.hpp"
#include "Teuchos_Describable.hpp"

namespace RTOpPack {


class ReductTarget : public Teuchos::Describable
{};

template<class Scalar>
class RTOpT : public Teuchos::Describable {
public:


  typedef typename Teuchos::PrimitiveTypeTraits<Scalar>::primitiveType  primitive_value_type;


  RTOpT( const std::string &op_name_base );


  virtual void get_reduct_type_num_entries(
    int*   num_values
    ,int*  num_indexes
    ,int*  num_chars
    ) const;
  virtual Teuchos::RefCountPtr<ReductTarget> reduct_obj_create() const;
  virtual void reduce_reduct_objs(
    const ReductTarget& in_reduct_obj, ReductTarget* inout_reduct_obj
    ) const;
  virtual void reduct_obj_reinit( ReductTarget* reduct_obj ) const;
  virtual void extract_reduct_obj_state(
    const ReductTarget        &reduct_obj
    ,int                      num_values
    ,primitive_value_type     value_data[]
    ,int                      num_indexes
    ,index_type               index_data[]
    ,int                      num_chars
    ,char_type                char_data[]
    ) const;
  virtual void load_reduct_obj_state(
    int                            num_values
    ,const primitive_value_type    value_data[]
    ,int                           num_indexes
    ,const index_type              index_data[]
    ,int                           num_chars
    ,const char_type               char_data[]
    ,ReductTarget                 *reduct_obj
    ) const;



  virtual const char* op_name() const;
  virtual RTOpT<Scalar>& operator=(const RTOpT<Scalar>& op);
  virtual void get_op_type_num_entries(
    int*  num_values
    ,int* num_indexes
    ,int* num_chars
    ) const;
  virtual void extract_op_state(
    int                             num_values
    ,primitive_value_type           value_data[]
    ,int                            num_indexes
    ,index_type                     index_data[]
    ,int                            num_chars
    ,char_type                      char_data[]
    ) const;
  virtual void load_op_state(
    int                           num_values
    ,const primitive_value_type   value_data[]
    ,int                          num_indexes
    ,const index_type             index_data[]
    ,int                          num_chars
    ,const char_type              char_data[]
    );
  virtual bool coord_invariant() const;
  virtual void apply_op(
    const int   num_vecs,       const ConstSubVectorView<Scalar>  sub_vecs[]
    ,const int  num_targ_vecs,  const SubVectorView<Scalar>       targ_sub_vecs[]
    ,ReductTarget *reduct_obj
    ) const = 0;


private:

  std::string op_name_;

}; // end class RTOpT

} // end namespace RTOpPack

#endif // RTOPPACK_RTOP_NEW_T_DECL_HPP

---