Epetra_FEVector.h

Go to the documentation of this file.

/*
//@HEADER
// ************************************************************************
//
//               Epetra: Linear Algebra Services Package
//                 Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
*/

#ifndef EPETRA_FEVECTOR_H
#define EPETRA_FEVECTOR_H

#include <Epetra_ConfigDefs.h>
#include <Epetra_CombineMode.h>
#include <Epetra_Map.h>
#include <Epetra_MultiVector.h>

#include <vector>

class Epetra_IntSerialDenseVector;

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
class Epetra_LongLongSerialDenseVector;
#endif

class Epetra_SerialDenseVector;


class EPETRA_LIB_DLL_EXPORT Epetra_FEVector : public Epetra_MultiVector {
 public:
   Epetra_FEVector(const Epetra_BlockMap& Map,
                   int numVectors=1,
       bool ignoreNonLocalEntries=false);


  Epetra_FEVector(Epetra_DataAccess CV, const Epetra_BlockMap& Map,
         double *A, int MyLDA, int NumVectors,
        bool ignoreNonLocalEntries=false);


  Epetra_FEVector(Epetra_DataAccess CV, const Epetra_BlockMap& Map,
         double **ArrayOfPointers, int NumVectors,
            bool ignoreNonLocalEntries=false);

  Epetra_FEVector(const Epetra_FEVector& source);

   virtual ~Epetra_FEVector();

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
   int SumIntoGlobalValues(int numIDs,
                           const int* GIDs, const double* values,
                           int vectorIndex=0);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
   int SumIntoGlobalValues(int numIDs,
                           const long long* GIDs, const double* values,
                           int vectorIndex=0);
#endif

   int SumIntoGlobalValues(const Epetra_IntSerialDenseVector& GIDs,
         const Epetra_SerialDenseVector& values,
                           int vectorIndex=0);
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
   int SumIntoGlobalValues(const Epetra_LongLongSerialDenseVector& GIDs,
         const Epetra_SerialDenseVector& values,
                           int vectorIndex=0);
#endif

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
   int ReplaceGlobalValues(int numIDs, const int* GIDs, const double* values,
                           int vectorIndex=0);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
   int ReplaceGlobalValues(int numIDs, const long long* GIDs, const double* values,
                           int vectorIndex=0);
#endif

   int ReplaceGlobalValues(const Epetra_IntSerialDenseVector& GIDs,
         const Epetra_SerialDenseVector& values,
                           int vectorIndex=0);
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
   int ReplaceGlobalValues(const Epetra_LongLongSerialDenseVector& GIDs,
         const Epetra_SerialDenseVector& values,
                           int vectorIndex=0);
#endif
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
   int SumIntoGlobalValues(int numIDs,
                           const int* GIDs,
         const int* numValuesPerID,
         const double* values,
                           int vectorIndex=0);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
   int SumIntoGlobalValues(int numIDs,
                           const long long* GIDs,
         const int* numValuesPerID,
         const double* values,
                           int vectorIndex=0);
#endif

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
   int ReplaceGlobalValues(int numIDs, const int* GIDs,
         const int* numValuesPerID,
         const double* values,
                           int vectorIndex=0);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
   int ReplaceGlobalValues(int numIDs, const long long* GIDs,
         const int* numValuesPerID,
         const double* values,
                           int vectorIndex=0);
#endif

   int GlobalAssemble(Epetra_CombineMode mode = Add,
                      bool reuse_map_and_exporter = false);

   void setIgnoreNonLocalEntries(bool flag) {
     ignoreNonLocalEntries_ = flag;
   }

   Epetra_FEVector& operator=(const Epetra_FEVector& source);

 protected:
  template<typename int_type>
  int inputValues(int numIDs,
                  const int_type* GIDs, const double* values,
                  bool suminto,
                  int vectorIndex);

  template<typename int_type>
  int inputValues(int numIDs,
                  const int_type* GIDs, const int* numValuesPerID,
      const double* values,
                  bool suminto,
                  int vectorIndex);

  template<typename int_type>
  int inputNonlocalValue(int_type GID, double value, bool suminto,
                         int vectorIndex);

  template<typename int_type>
  int inputNonlocalValues(int_type GID, int numValues, const double* values,
        bool suminto, int vectorIndex);

  template<typename int_type>
  void createNonlocalMapAndExporter();

  void destroyNonlocalMapAndExporter();

  template<typename int_type>
  void zeroNonlocalData();

  void destroyNonlocalData();

  long long myFirstID_;
  int myNumIDs_;

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
  std::vector<int> nonlocalIDs_int_;
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
  std::vector<long long> nonlocalIDs_LL_;
#endif

  template<typename int_type> std::vector<int_type>& nonlocalIDs();

  std::vector<int> nonlocalElementSize_;

  std::vector<std::vector<double> > nonlocalCoefs_;

  Epetra_BlockMap* nonlocalMap_;

  Epetra_Export* exporter_;

  Epetra_MultiVector* nonlocalVector_;

  bool ignoreNonLocalEntries_;

private:
  template<typename int_type>
  int GlobalAssemble(Epetra_CombineMode mode, bool reuse_map_and_exporter);
};

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
template<> inline std::vector<int>& Epetra_FEVector::nonlocalIDs<int>()
{
   return nonlocalIDs_int_;
}
#endif

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
template<> inline std::vector<long long>& Epetra_FEVector::nonlocalIDs<long long>()
{
  return nonlocalIDs_LL_;
}
#endif

#endif