Stokhos_MatrixFreeOperator.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                           Stokhos Package
//                 Copyright (2009) 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.
//
// 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 Eric T. Phipps (etphipp@sandia.gov).
//
// ***********************************************************************
// @HEADER

#ifndef STOKHOS_MATRIX_FREE_OPERATOR_HPP
#define STOKHOS_MATRIX_FREE_OPERATOR_HPP

#include "Stokhos_SGOperator.hpp"
#include "EpetraExt_MultiComm.h"
#include "Stokhos_OrthogPolyBasis.hpp"
#include "Stokhos_EpetraSparse3Tensor.hpp"
#include "Epetra_Map.h"
#include "Epetra_Import.h"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_Array.hpp"

namespace Stokhos {

  class MatrixFreeOperator : public Stokhos::SGOperator {

  public:

    MatrixFreeOperator(
      const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
      const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
      const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
      const Teuchos::RCP<const Epetra_Map>& domain_base_map,
      const Teuchos::RCP<const Epetra_Map>& range_base_map,
      const Teuchos::RCP<const Epetra_Map>& domain_sg_map,
      const Teuchos::RCP<const Epetra_Map>& range_sg_map,
      const Teuchos::RCP<Teuchos::ParameterList>& params);

    virtual ~MatrixFreeOperator();

    double countApplyFlops() const;


    virtual void setupOperator(
      const Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly >& poly);

    virtual Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly >
    getSGPolynomial();

    virtual Teuchos::RCP<const Stokhos::EpetraOperatorOrthogPoly >
    getSGPolynomial() const;



    virtual int SetUseTranspose(bool UseTranspose);

    virtual int Apply(const Epetra_MultiVector& Input,
                      Epetra_MultiVector& Result) const;

    virtual int ApplyInverse(const Epetra_MultiVector& X,
                             Epetra_MultiVector& Y) const;

    virtual double NormInf() const;

    virtual const char* Label () const;

    virtual bool UseTranspose() const;

    virtual bool HasNormInf() const;

    virtual const Epetra_Comm & Comm() const;

    virtual const Epetra_Map& OperatorDomainMap () const;

    virtual const Epetra_Map& OperatorRangeMap () const;


  private:

    MatrixFreeOperator(const MatrixFreeOperator&);

    MatrixFreeOperator& operator=(const MatrixFreeOperator&);

  protected:

    std::string label;

    Teuchos::RCP<const EpetraExt::MultiComm> sg_comm;

    Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > sg_basis;

    Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> epetraCijk;

    Teuchos::RCP<const Epetra_Map> domain_base_map;

    Teuchos::RCP<const Epetra_Map> range_base_map;

    Teuchos::RCP<const Epetra_Map> domain_sg_map;

    Teuchos::RCP<const Epetra_Map> range_sg_map;

    bool is_stoch_parallel;

    Teuchos::RCP<Epetra_Map> global_col_map;

    Teuchos::RCP<Epetra_Map> global_col_map_trans;

    Teuchos::RCP<const Epetra_BlockMap> stoch_col_map;

    Teuchos::RCP<Epetra_Import> col_importer;

    Teuchos::RCP<Epetra_Import> col_importer_trans;

    typedef Stokhos::Sparse3Tensor<int,double> Cijk_type;

    Teuchos::RCP<const Cijk_type> Cijk;

    Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly > block_ops;

    bool scale_op;

    bool include_mean;

    bool only_use_linear;

    bool useTranspose;

    bool use_block_apply;

    int expansion_size;

    int num_blocks;

    int max_num_mat_vec;

    mutable Teuchos::RCP<Epetra_MultiVector> input_col;

    mutable Teuchos::RCP<Epetra_MultiVector> input_col_trans;

    mutable Teuchos::Array< Teuchos::RCP<const Epetra_MultiVector> > input_block;

    mutable Teuchos::Array< Teuchos::RCP<Epetra_MultiVector> > result_block;

    mutable Teuchos::RCP<Epetra_MultiVector> tmp;

    mutable Teuchos::RCP<Epetra_MultiVector> tmp_trans;

    Cijk_type::k_iterator k_begin;

    Cijk_type::k_iterator k_end;

  }; // class MatrixFreeOperator

} // namespace Stokhos

#endif // STOKHOS_MATRIX_FREE_OPERATOR_HPP