MueLu_MultiPhys_decl.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//        MueLu: A package for multigrid based preconditioning
//                  Copyright 2012 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
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef MUELU_MULTIPHYS_DECL_HPP
#define MUELU_MULTIPHYS_DECL_HPP
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_BaseClass.hpp"
 
#include "MueLu_SaPFactory_fwd.hpp"
 
#include "MueLu_SmootherFactory_fwd.hpp"
#include "MueLu_TrilinosSmoother.hpp"
#include "MueLu_Utilities_fwd.hpp"
#include "MueLu_Level_fwd.hpp"
#include "MueLu_Hierarchy_fwd.hpp"
#include "MueLu_RAPFactory_fwd.hpp"
#include "MueLu_PerfUtils_fwd.hpp"
#include "MueLu_SmootherBase.hpp"
 
#if defined(HAVE_MUELU_KOKKOS_REFACTOR)
#include "MueLu_Utilities_kokkos_fwd.hpp"
#endif
 
#include "Xpetra_Map_fwd.hpp"
#include "Xpetra_Matrix_fwd.hpp"
#include "Xpetra_MatrixFactory_fwd.hpp"
#include "Xpetra_MultiVectorFactory_fwd.hpp"
#include "Xpetra_VectorFactory_fwd.hpp"
#include "Xpetra_CrsMatrixWrap_fwd.hpp"
 
namespace MueLu {

  template <class Scalar,
            class LocalOrdinal,
            class GlobalOrdinal,
            class Node>
  class MultiPhys : public VerboseObject, public Xpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
 
#undef MUELU_MULTIPHYS_SHORT
#include "MueLu_UseShortNames.hpp"
 
  public:
 
    typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
    typedef typename Teuchos::ScalarTraits<Scalar>::coordinateType coordinateType;
    typedef typename Xpetra::MultiVector<coordinateType,LO,GO,NO> RealValuedMultiVector;

    MultiPhys() :
      AmatMultiphysics_(Teuchos::null), hierarchyMultiphysics_(Teuchos::null), nBlks_(0)
    {
    }

    MultiPhys(const Teuchos::RCP<Matrix> &                                 AmatMultiPhysics,
              const Teuchos::ArrayRCP<RCP<Matrix>>                         arrayOfAuxMatrices,
              const Teuchos::ArrayRCP<Teuchos::RCP<MultiVector>>           arrayOfNullspaces,
              const Teuchos::ArrayRCP<Teuchos::RCP<RealValuedMultiVector>> arrayOfCoords,
              const int nBlks,
              Teuchos::ParameterList& List, 
               bool ComputePrec = true):
      AmatMultiphysics_(AmatMultiPhysics), arrayOfAuxMatrices_(arrayOfAuxMatrices), arrayOfNullspaces_(arrayOfNullspaces),
      arrayOfCoords_(arrayOfCoords), nBlks_(nBlks)
    {
      initialize(AmatMultiPhysics, arrayOfAuxMatrices, arrayOfNullspaces, arrayOfCoords, nBlks, List);
      compute(false);
    }

    virtual ~MultiPhys() {}

    Teuchos::RCP<const Map> getDomainMap() const;

    Teuchos::RCP<const Map> getRangeMap() const;

    void setParameters(Teuchos::ParameterList& list);

    void compute(bool reuse=false);

    void resetMatrix(Teuchos::RCP<Matrix> SM_Matrix_new, bool ComputePrec=true);

    void apply (const MultiVector& X, MultiVector& Y,
                Teuchos::ETransp mode = Teuchos::NO_TRANS,
                Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
                Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const;

    bool hasTransposeApply() const;
 
    void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::VERB_HIGH) const;

    void residual(const MultiVector & X,
                  const MultiVector & B,
                  MultiVector & R) const {
      using STS = Teuchos::ScalarTraits<Scalar>;
      R.update(STS::one(),B,STS::zero());
      this->apply (X, R, Teuchos::NO_TRANS, -STS::one(), STS::one());
    }
    
 
  private:
    void initialize(const Teuchos::RCP<Matrix> &                                 AmatMultiPhysics,
                    const Teuchos::ArrayRCP<RCP<Matrix>>                         arrayOfAuxMatrices,
                    const Teuchos::ArrayRCP<Teuchos::RCP<MultiVector>>           arrayOfNullspaces,
                    const Teuchos::ArrayRCP<Teuchos::RCP<RealValuedMultiVector>> arrayOfCoords,
                    const int nBlks,
                    Teuchos::ParameterList& List);
 

    void applyInverse(const MultiVector& RHS, MultiVector& X) const;

    void allocateMemory(int numVectors) const;

    Teuchos::RCP<Teuchos::TimeMonitor> getTimer(std::string name, RCP<const Teuchos::Comm<int> > comm=Teuchos::null) const;

    mutable Teuchos::ParameterList parameterList_;

 
       
    Teuchos::RCP<Matrix> AmatMultiphysics_;    // multiphysics discretization matrix 
    Teuchos::RCP<Teuchos::ParameterList> paramListMultiphysics_;// array of parameter lists directing MueLu's construct of subblock P operators
    Teuchos::RCP<Hierarchy> hierarchyMultiphysics_;    // multiphysics discretization matrix 
 
    Teuchos::ArrayRCP<Teuchos::RCP<Teuchos::ParameterList>> arrayOfParamLists_;  // array of parameter lists directing MueLu's construct of subblock P operators
    Teuchos::ArrayRCP<Teuchos::RCP<Hierarchy>>              arrayOfHierarchies_; 
    Teuchos::ArrayRCP<Teuchos::RCP<Matrix>>                 arrayOfAuxMatrices_; // array of discretization/auxiliary matrices used to generate subblock prolongators
    Teuchos::ArrayRCP<Teuchos::RCP<MultiVector>>             arrayOfNullspaces_; // array of nullspaces for smoothed aggregation.
    Teuchos::ArrayRCP<Teuchos::RCP<RealValuedMultiVector>> arrayOfCoords_;       // array of coordinates for smoothed aggregation/rebalancing.
 
    int  nBlks_;    // number of PDE sub-systems within multiphysics system
    bool useKokkos_, enable_reuse_, syncTimers_;
 
  };
 
} // namespace
 
#define MUELU_MULTIPHYS_SHORT
#endif // MUELU_MULTIPHYS_DECL_HPP