Tpetra_LinearProblem_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TPETRA_LINEARPROBLEM_DECL_HPP
#define TPETRA_LINEARPROBLEM_DECL_HPP


#include "Teuchos_DataAccess.hpp"

#include "Tpetra_Vector_decl.hpp"
#include "Tpetra_MultiVector_decl.hpp"
#include "Tpetra_RowMatrix_decl.hpp"
#include "Tpetra_DistObject.hpp"
#include "Tpetra_Details_ExecutionSpacesUser.hpp"

namespace Tpetra {


  template <class Scalar,
            class LocalOrdinal,
            class GlobalOrdinal,
            class Node>
  class LinearProblem :
    public DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node>,
    public Details::Spaces::User
  {

  private:
    using dist_object_type = DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node>;

  public:


    using map_type = Map<LocalOrdinal, GlobalOrdinal, Node>;
    using row_matrix_type = RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
    using multivector_type = MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
    using vector_type = Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
    using linear_problem_type = LinearProblem<Scalar, LocalOrdinal, GlobalOrdinal, Node>;




    LinearProblem();

    LinearProblem(const Teuchos::RCP<row_matrix_type> & A,
                  const Teuchos::RCP<multivector_type>& X,
                  const Teuchos::RCP<multivector_type>& B);

    LinearProblem(const LinearProblem<Scalar, LocalOrdinal,
                             GlobalOrdinal, Node>& Problem);

    virtual ~LinearProblem() = default;




    void checkInput() const;




    virtual bool
    checkSizes (const SrcDistObject& source) override;





    void setMatrix(Teuchos::RCP<row_matrix_type> A)
      { A_ = A; }

    void setLHS(Teuchos::RCP<multivector_type> X) {X_ = X;}

    void setRHS(Teuchos::RCP<multivector_type> B) {B_ = B;}




    void leftScale(const Teuchos::RCP<const vector_type> & D,
                   Teuchos::ETransp mode = Teuchos::NO_TRANS);

    void rightScale(const Teuchos::RCP<const vector_type> & D,
                    Teuchos::ETransp mode = Teuchos::NO_TRANS);




    Teuchos::RCP<row_matrix_type> getMatrix() const {return(A_);}
    Teuchos::RCP<multivector_type> getLHS() const {return(X_);}
    Teuchos::RCP<multivector_type> getRHS() const {return(B_);}


 private:

  Teuchos::RCP<row_matrix_type> A_;
  Teuchos::RCP<multivector_type> X_;
  Teuchos::RCP<multivector_type> B_;

  LinearProblem & operator=(const LinearProblem<Scalar, LocalOrdinal,
                                       GlobalOrdinal, Node>& Problem) = default;
};

} // namespace Tpetra

#endif // TPETRA_LINEARPROBLEM_DECL_HPP