Epetra_BasicRowMatrix.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_BASICROWMATRIX_H
#define EPETRA_BASICROWMATRIX_H

#if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Epetra package is deprecated"
#endif
#endif



#include "Epetra_ConfigDefs.h"
#include "Epetra_RowMatrix.h"
#include "Epetra_Object.h"
#include "Epetra_CompObject.h"
#include "Epetra_Map.h"
#include "Epetra_Comm.h"
#include "Epetra_SerialDenseVector.h"
#include "Epetra_IntSerialDenseVector.h"
#include "Epetra_MultiVector.h"

class Epetra_Vector;
class Epetra_Import;
class Epetra_Export;


class EPETRA_LIB_DLL_EXPORT Epetra_BasicRowMatrix: public Epetra_CompObject, public Epetra_Object, public virtual Epetra_RowMatrix  {

 public:



  Epetra_BasicRowMatrix(const Epetra_Comm & Comm);

  virtual ~Epetra_BasicRowMatrix();



  void SetMaps(const Epetra_Map & RowMap, const Epetra_Map & ColMap);

  void SetMaps(const Epetra_Map & RowMap, const Epetra_Map & ColMap,
         const Epetra_Map & DomainMap, const Epetra_Map & RangeMap);






  virtual int ExtractMyRowCopy(int MyRow, int Length, int & NumEntries, double *Values, int * Indices) const = 0;


    virtual int ExtractMyEntryView(int CurEntry, double * & Value, int & RowIndex, int & ColIndex) = 0;


    virtual int ExtractMyEntryView(int CurEntry, double const * & Value, int & RowIndex, int & ColIndex) const = 0;


    virtual int NumMyRowEntries(int MyRow, int & NumEntries) const = 0;




    virtual int Multiply(bool TransA, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;


    virtual int Solve(bool Upper, bool Trans, bool UnitDiagonal,
                      const Epetra_MultiVector& X,
                      Epetra_MultiVector& Y) const
    {
      (void)Upper;
      (void)Trans;
      (void)UnitDiagonal;
      (void)X;
      (void)Y;
      return(-1);
    }


    virtual int ExtractDiagonalCopy(Epetra_Vector & Diagonal) const;


    virtual int InvRowSums(Epetra_Vector& x) const;


    virtual int LeftScale(const Epetra_Vector& x);


    virtual int InvColSums(Epetra_Vector& x) const;


    virtual int RightScale(const Epetra_Vector& x);




    virtual bool Filled() const {return(true);}

    bool LowerTriangular() const {if (!HaveNumericConstants_) ComputeNumericConstants(); return(LowerTriangular_);}

    virtual bool UpperTriangular() const {if (!HaveNumericConstants_) ComputeNumericConstants(); return(UpperTriangular_);}




    virtual double NormInf() const{if (!HaveNumericConstants_) ComputeNumericConstants(); return(NormInf_);}

    virtual double NormOne() const{if (!HaveNumericConstants_) ComputeNumericConstants(); return(NormOne_);}

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
    virtual int NumGlobalNonzeros() const {
      if(OperatorRangeMap().GlobalIndicesInt() && OperatorDomainMap().GlobalIndicesInt()) {
        if (!HaveStructureConstants_)
          ComputeStructureConstants();
        return (int) NumGlobalNonzeros_;
      }

      throw "Epetra_BasicRowMatrix::NumGlobalNonzeros: GlobalIndices not int.";
    }
#endif
    virtual long long NumGlobalNonzeros64() const{if (!HaveStructureConstants_) ComputeStructureConstants(); return(NumGlobalNonzeros_);}

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
  virtual int NumGlobalRows() const {
      if(OperatorRangeMap().GlobalIndicesInt()) {
        return (int) NumGlobalRows64();
      }

      throw "Epetra_BasicRowMatrix::NumGlobalRows: GlobalIndices not int.";
    }
#endif
    virtual long long NumGlobalRows64() const {return(OperatorRangeMap().NumGlobalPoints64());}

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
    virtual int NumGlobalCols() const {
      if(OperatorDomainMap().GlobalIndicesInt()) {
        return (int) NumGlobalCols64();
      }

      throw "Epetra_BasicRowMatrix::NumGlobalCols: GlobalIndices not int.";
    }
#endif
    virtual long long NumGlobalCols64() const {return(OperatorDomainMap().NumGlobalPoints64());}

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
    virtual int NumGlobalDiagonals() const {
      if(OperatorDomainMap().GlobalIndicesInt()) {
        return (int) NumGlobalDiagonals64();
      }

      throw "Epetra_BasicRowMatrix::NumGlobalDiagonals: GlobalIndices not int.";
    }
#endif
    virtual long long NumGlobalDiagonals64() const{return(OperatorDomainMap().NumGlobalPoints64());}

    virtual int NumMyNonzeros() const{if (!HaveStructureConstants_) ComputeStructureConstants(); return(NumMyNonzeros_);}

    virtual int NumMyRows() const {return(OperatorRangeMap().NumMyPoints());}

    virtual int NumMyCols() const {return(RowMatrixColMap().NumMyPoints());}

    virtual int NumMyDiagonals() const {return(OperatorRangeMap().NumMyPoints());}

    virtual int MaxNumEntries() const{ if (!HaveStructureConstants_) ComputeStructureConstants(); return(MaxNumEntries_);}

    virtual const Epetra_Map & OperatorDomainMap() const {return(OperatorDomainMap_);}

    virtual const Epetra_Map & OperatorRangeMap() const  {return(OperatorRangeMap_);}

    virtual const Epetra_BlockMap& Map() const {return(RowMatrixRowMap());}

    virtual const Epetra_Map & RowMatrixRowMap() const {return(RowMatrixRowMap_);}

    virtual const Epetra_Map & RowMatrixColMap() const {return(RowMatrixColMap_);}

    virtual const Epetra_Import * RowMatrixImporter() const {return(Importer_);}

    virtual const Epetra_Comm & Comm() const {return(*Comm_);}




  virtual void Print(std::ostream & os) const;




  virtual int SetUseTranspose(bool use_transpose) {UseTranspose_ = use_transpose; return(0);}

  virtual const char* Label() const {return(Epetra_Object::Label());}


  virtual int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const {
    return(Multiply(Epetra_BasicRowMatrix::UseTranspose(), X, Y));}


  virtual int ApplyInverse(const Epetra_MultiVector& X,
                           Epetra_MultiVector& Y) const
   {
     (void)X;
     (void)Y;
     return(-1);
   }

  bool HasNormInf() const {return(true);}

  virtual bool UseTranspose() const {return(UseTranspose_);}





  virtual const Epetra_Import* Importer() const {return(Importer_);}


  virtual const Epetra_Export* Exporter() const {return(Exporter_);}


 protected:


  /* Several constants are pre-computed to save excess computations.  However, if the structure of the
     problem changes, specifically if the nonzero count in any given row changes, then this function should be called
     to update these constants.
  */
  virtual void ComputeStructureConstants() const;
  /* Several numeric constants are pre-computed to save excess computations.  However, if the values of the
     problem change, then this function should be called to update these constants.
  */
  virtual void ComputeNumericConstants() const;

  void Setup();
  void UpdateImportVector(int NumVectors) const;
  void UpdateExportVector(int NumVectors) const;
  void SetImportExport();
  Epetra_Comm * Comm_;
  Epetra_Map OperatorDomainMap_;
  Epetra_Map OperatorRangeMap_;
  Epetra_Map RowMatrixRowMap_;
  Epetra_Map RowMatrixColMap_;

  mutable int NumMyNonzeros_;
  mutable long long NumGlobalNonzeros_;
  mutable int MaxNumEntries_;
  mutable double NormInf_;
  mutable double NormOne_;
  int NumMyRows_;
  int NumMyCols_;

  bool UseTranspose_;
  bool HasNormInf_;
  mutable bool LowerTriangular_;
  mutable bool UpperTriangular_;
  mutable bool HaveStructureConstants_;
  mutable bool HaveNumericConstants_;
  mutable bool HaveMaps_;


  mutable Epetra_MultiVector * ImportVector_;
  mutable Epetra_MultiVector * ExportVector_;
  Epetra_Import * Importer_;
  Epetra_Export * Exporter_;

};
#endif /* EPETRA_BASICROWMATRIX_H */