PipelineGraph.hpp

Go to the documentation of this file.

/**
 * @file PipelineGraph.hpp
 * @author your name (you@domain.com)
 * @version 0.1
 * @date 2025-12-26
 * 
 * @copyright Copyright (c) 2025
 * 
 */
 
#ifndef MOFEM_PIPELINEGRAPH_HPP
#define MOFEM_PIPELINEGRAPH_HPP
 
namespace MoFEM {
 
struct PipelineGraph : public UnknownInterface {
 
  /**
   * @brief Query interface for type-safe casting
   *
   * @param type_index Type index of the requested interface
   * @param iface Pointer to interface pointer to be set
   * @return MoFEMErrorCode Error code (0 on success)
   */
  MoFEMErrorCode query_interface(boost::typeindex::type_index type_index,
                                 UnknownInterface **iface) const;
 
  PipelineGraph(const MoFEM::Core &core);
 
  /**
   * @brief Pipeline graph to Graphviz file
   * 
   * @param filename 
   * @param pip_name 
   * @param pip 
   * @return MoFEMErrorCode 
   */
  static MoFEMErrorCode writeGraphGraphviz(
      std::string filename, std::string pip_name,
      const boost::ptr_deque<ForcesAndSourcesCore::UserDataOperator> &pip);
 
  /**
   * @brief KSP graph to Graphviz file
   * 
   * @param ts 
   * @param filename 
   * @return MoFEMErrorCode 
   */
  static MoFEMErrorCode writeKSPGraphGraphviz(KspCtx *ksp_ctx,
                                              std::string filename);
 
  /**
   * @brief SNES graph to Graphviz file
   * 
   * @param snes_ctx 
   * @param file_name 
   * @return MoFEMErrorCode 
   */
  static MoFEMErrorCode writeSNESGraphGraphviz(SnesCtx *snes_ctx,
                                               std::string file_name);
 
  /**
   * @brief TS graph to Graphviz file
   * 
   * @param snes_ctx 
   * @param file_name 
   * @return MoFEMErrorCode 
   */
  static MoFEMErrorCode writeTSGraphGraphviz(TsCtx *ts_ctx,
                                             std::string file_name);
 
  /**
   * @brief Write pipeline manager graph to Graphviz file
   * @param filename 
   * @return MoFEMErrorCode 
   */
  static MoFEMErrorCode
  writePiplineManagerGraphGraphviz(std::string filename,
                                   PipelineManager *pip_mng);
 
private:
  MoFEM::Core &cOre; ///< Reference to MoFEM core instance
};
} // namespace MoFEM
 
#endif // MOFEM_PIPELINEGRAPH_HPP