EpetraExt_BlockJacobi_LinearProblem.h

Go to the documentation of this file.

//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - 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 EPETRAEXT_BLOCKJACOBI_LINEARPROBLEM_H
#define EPETRAEXT_BLOCKJACOBI_LINEARPROBLEM_H

#if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The EpetraExt package is deprecated"
#endif
#endif

#include <EpetraExt_Transform.h>

#include <vector>

class Epetra_LinearProblem;
class Epetra_VbrMatrix;
class Epetra_SerialDenseSVD;
class Epetra_SerialDenseMatrix;

namespace EpetraExt {

class LinearProblem_BlockJacobi : public SameTypeTransform<Epetra_LinearProblem> {

 public:

  ~LinearProblem_BlockJacobi();

  LinearProblem_BlockJacobi( int verbose = 0,
                             int thresholding = 0,
                             double rthresh = 0.0,
                             double athresh = 0.0,
                             bool removeDiag = false )
  : NumBlocks_(0),
    NewProblem_(0),
    NewMatrix_(0),
    thresholding_(thresholding),
    rthresh_(rthresh),
    athresh_(athresh),
    removeDiag_(removeDiag),
    verbose_(verbose)
  {}

  NewTypeRef operator()( OriginalTypeRef orig );

  bool fwd();
  bool rvs();

  void RThresh( double val ) { rthresh_ = val; }

 private:

  int NumBlocks_;

  double rthresh_;
  double athresh_;
  const int thresholding_;

  const bool removeDiag_;

  Epetra_LinearProblem * NewProblem_;
  Epetra_VbrMatrix * NewMatrix_;

  std::vector<Epetra_SerialDenseMatrix**> VbrBlocks_;
  std::vector<int> VbrBlockCnt_;
  std::vector<int> VbrBlockDim_;
  std::vector<int*> VbrBlockIndices_;

  std::vector<Epetra_SerialDenseSVD*> SVDs_;
  std::vector<Epetra_SerialDenseMatrix*> Inverses_;
  std::vector<Epetra_SerialDenseMatrix*> RHSBlocks_;

  const int verbose_;
};

} //namespace EpetraExt

#endif //EPETRAEXT_BLOCKJACOBI_LINEARPROBLEM_H