MueLu_AggregationExportFactory_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

/*
 * MueLu_AggregationExportFactory_decl.hpp
 *
 *  Created on: Feb 10, 2012
 *      Author: wiesner
 */

#ifndef MUELU_AGGREGATIONEXPORTFACTORY_DECL_HPP_
#define MUELU_AGGREGATIONEXPORTFACTORY_DECL_HPP_

#include <Xpetra_Matrix_fwd.hpp>

#include "MueLu_ConfigDefs.hpp"
#include "MueLu_TwoLevelFactoryBase.hpp"
#include "MueLu_VisualizationHelpers.hpp"
#include "MueLu_AggregationExportFactory_fwd.hpp"
#include "MueLu_Aggregates_fwd.hpp"

#include "MueLu_LWGraph.hpp"
#include "MueLu_AmalgamationFactory_fwd.hpp"
#include "MueLu_AmalgamationInfo_fwd.hpp"

namespace MueLu {

class Level;

template <class Scalar        = DefaultScalar,
          class LocalOrdinal  = DefaultLocalOrdinal,
          class GlobalOrdinal = DefaultGlobalOrdinal,
          class Node          = DefaultNode>
class AggregationExportFactory : public TwoLevelFactoryBase, public VisualizationHelpers<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
#undef MUELU_AGGREGATIONEXPORTFACTORY_SHORT
#include "MueLu_UseShortNames.hpp"

 public:


  AggregationExportFactory();

  virtual ~AggregationExportFactory();

  RCP<const ParameterList> GetValidParameterList() const;



  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;



  void Build(Level& fineLevel, Level& coarseLevel) const;

  using coordinate_type       = typename Teuchos::ScalarTraits<SC>::coordinateType;
  using CoordinateMultiVector = typename Xpetra::MultiVector<coordinate_type, LO, GO, NO>;


 private:
  // Break different viz styles into separate functions for organization:
  void doJacksPlus_(std::vector<int>& vertices, std::vector<int>& geomSizes) const;
  void doConvexHulls(std::vector<int>& vertices, std::vector<int>& geomSizes) const;
  void doGraphEdges_(std::ofstream& fout, Teuchos::RCP<Matrix>& A, Teuchos::RCP<LWGraph>& G, bool fine, int dofs) const;  // add geometry to display node connections from a matrix. Connections in graph but not matrix have different color.

  // write VTK data
  void writeFile_(std::ofstream& fout, std::string styleName, std::vector<int>& vertices, std::vector<int>& geomSizes) const;
  void buildColormap_() const;
  void writePVTU_(std::ofstream& pvtu, std::string baseFname, int numProcs) const;

  static const int CONTRAST_1_ = -1;
  static const int CONTRAST_2_ = -2;
  static const int CONTRAST_3_ = -3;

  // Data that the different styles need to have available when building geometry
  mutable Teuchos::RCP<CoordinateMultiVector> coords_;        // fine local coordinates
  mutable Teuchos::RCP<CoordinateMultiVector> coordsCoarse_;  // coarse local coordinates
  mutable Teuchos::ArrayRCP<LocalOrdinal> vertex2AggId_;
  mutable Teuchos::ArrayRCP<LocalOrdinal> aggSizes_;
  mutable std::vector<bool> isRoot_;
  mutable bool doFineGraphEdges_;
  mutable bool doCoarseGraphEdges_;
  mutable int numNodes_;
  mutable int numAggs_;
  mutable int dims_;
  mutable int myRank_;
  mutable Teuchos::RCP<const Map> nodeMap_;        // map used in A and Coordinates to map local ordinals to global ordinals. Need the whole map especially if it's not contiguous.
  mutable Teuchos::RCP<const Map> nodeMapCoarse_;  // Map for Ac
  mutable int aggsOffset_;                         // in a global list of aggregates, the offset of local aggregate indices
};                                                 // class AggregationExportFactory
}  // namespace MueLu

#define MUELU_AGGREGATIONEXPORTFACTORY_SHORT

#endif /* MUELU_AGGREGATIONEXPORTFACTORY_DECL_HPP_ */