fei_Vector.hpp

/*--------------------------------------------------------------------*/
/*    Copyright 2005 Sandia Corporation.                              */
/*    Under the 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.  Export of this program may require     */
/*    a license from the United States Government.                    */
/*--------------------------------------------------------------------*/

#ifndef _fei_Vector_hpp_
#define _fei_Vector_hpp_

#include <fei_iosfwd.hpp>
#include <fei_SharedPtr.hpp>
#include <fei_Reducer.hpp>

namespace fei {
  class Vector {
  public:
    class Factory {
    public:
      virtual ~Factory(){}

      virtual fei::SharedPtr<fei::Vector>
  createVector(fei::SharedPtr<fei::VectorSpace> vecSpace,
         int numVectors=1) = 0;

      virtual fei::SharedPtr<fei::Vector>
  createVector(fei::SharedPtr<fei::VectorSpace> vecSpace,
         bool isSolutionVector,
         int numVectors=1) = 0;

      virtual fei::SharedPtr<fei::Vector>
  createVector(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
         int numVectors=1) = 0;

      virtual fei::SharedPtr<fei::Vector>
  createVector(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
         bool isSolutionVector,
         int numVectors=1) = 0;
    };

    virtual ~Vector(){}

    virtual const char* typeName() const = 0;

    virtual int putScalar(double scalar) = 0;

    virtual int sumIn(int numValues, const int* indices, const double* values,
          int vectorIndex=0) = 0;

    virtual int copyIn(int numValues, const int* indices, const double* values,
           int vectorIndex=0) = 0;

    virtual int copyOut(int numValues, const int* indices, double* values,
      int vectorIndex=0) const = 0;

    virtual int update(double a,
           const fei::Vector* x,
           double b) = 0;

    virtual int scatterToOverlap() = 0;

    virtual void setCommSizes() = 0;

    virtual int gatherFromOverlap(bool accumulate = true) = 0;

    virtual fei::SharedPtr<fei::VectorSpace> getVectorSpace() const = 0;

    virtual void setVectorSpace(fei::SharedPtr<fei::VectorSpace> vecSpace) = 0;

    virtual int sumInFieldData(int fieldID,
             int idType,
             int numIDs,
             const int* IDs,
             const double* data,
             int vectorIndex=0) = 0;

    virtual int copyInFieldData(int fieldID,
        int idType,
        int numIDs,
        const int* IDs,
        const double* data,
        int vectorIndex=0) = 0;

    virtual int copyInFieldDataLocalIDs(int fieldID,
        int idType,
        int numIDs,
        const int* localIDs,
        const double* data,
        int vectorIndex=0) = 0;

    virtual int copyOutFieldData(int fieldID,
         int idType,
         int numIDs,
         const int* IDs,
         double* data,
         int vectorIndex=0) = 0;

    virtual int writeToFile(const char* filename,
          bool matrixMarketFormat=true) = 0;

    virtual int writeToStream(FEI_OSTREAM& ostrm,
            bool matrixMarketFormat=true) = 0;

  };//class Vector
}//namespace fei

#ifndef _fei_ostream_ops_hpp_
#include <fei_ostream_ops.hpp>
#endif

#endif // _fei_Vector_hpp_