parallel_environment.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main author:     Jordi Cotela
//
 
#pragma once
 
// System includes
#include <string>
#include <iostream>
#include <unordered_map>
 
// External includes
 
// Project includes
#include "includes/define.h"
#include "includes/data_communicator.h"
#include "includes/fill_communicator.h"
 
namespace Kratos
{
 
 
class KRATOS_API(KRATOS_CORE) EnvironmentManager
{
  public:
    typedef std::unique_ptr<EnvironmentManager> Pointer;
 
    EnvironmentManager(EnvironmentManager& rOther) = delete;
 
    virtual ~EnvironmentManager() = default;
 
    virtual bool IsInitialized() const = 0;
 
    virtual bool IsFinalized() const = 0;
 
  protected:
    EnvironmentManager() = default;
};
 
 
class KRATOS_API(KRATOS_CORE) ParallelEnvironment
{
  public:
 
    constexpr static bool MakeDefault = true;
    constexpr static bool DoNotMakeDefault = false;
 
 
 
    static DataCommunicator& GetDataCommunicator(const std::string& rName);
 
    static DataCommunicator& GetDefaultDataCommunicator();
 
 
    static void SetDefaultDataCommunicator(const std::string& rName);
 
    static int GetDefaultRank();
 
    static int GetDefaultSize();
 
    static std::string RetrieveRegisteredName(const DataCommunicator& rComm);
 
 
    static void SetUpMPIEnvironment(EnvironmentManager::Pointer pEnvironmentManager);
 
    template<class TDataCommunicatorInputType>
    static void RegisterFillCommunicatorFactory(std::function<FillCommunicator::Pointer(ModelPart&, TDataCommunicatorInputType&)> FillCommunicatorFactory);
 
    template<class TDataCommunicatorInputType>
    static void RegisterCommunicatorFactory(std::function<Communicator::UniquePointer(ModelPart&, TDataCommunicatorInputType&)> CommunicatorFactory);
 
    KRATOS_DEPRECATED_MESSAGE("This function is deprecated, please use \"CreateFillCommunicatorFromGlobalParallelism\" instead")
    static FillCommunicator::Pointer CreateFillCommunicator(ModelPart& rModelPart);
 
    static FillCommunicator::Pointer CreateFillCommunicatorFromGlobalParallelism(
      ModelPart& rModelPart,
      const std::string& rDataCommunicatorName);
 
    static FillCommunicator::Pointer CreateFillCommunicatorFromGlobalParallelism(
      ModelPart& rModelPart,
      const DataCommunicator& rDataCommunicator);
 
    static Communicator::UniquePointer CreateCommunicatorFromGlobalParallelism(
      ModelPart& rModelPart,
      const std::string& rDataCommunicatorName);
 
    static Communicator::UniquePointer CreateCommunicatorFromGlobalParallelism(
      ModelPart& rModelPart,
      const DataCommunicator& rDataCommunicator);
 
 
    static void RegisterDataCommunicator(
        const std::string& rName,
        DataCommunicator::UniquePointer pPrototype,
        const bool Default = DoNotMakeDefault);
 
 
    static void UnregisterDataCommunicator(
        const std::string& rName);
 
 
    static bool HasDataCommunicator(const std::string& rName);
 
 
    static std::string GetDefaultDataCommunicatorName();
 
    static bool MPIIsInitialized();
 
    static bool MPIIsFinalized();
 
 
    static std::string Info();
 
    static void PrintInfo(std::ostream &rOStream);
 
    static void PrintData(std::ostream &rOStream);
 
 
  private:
 
 
    ParallelEnvironment();
 
    ~ParallelEnvironment();
 
 
    static void Create();
 
    void SetUpMPIEnvironmentDetail(EnvironmentManager::Pointer pEnvironmentManager);
 
    template<class TDataCommunicatorInputType>
    void RegisterFillCommunicatorFactoryDetail(std::function<FillCommunicator::Pointer(ModelPart&, TDataCommunicatorInputType&)> FillCommunicatorFactory);
 
    template<class TDataCommunicatorInputType>
    void RegisterCommunicatorFactoryDetail(std::function<Communicator::UniquePointer(ModelPart&, TDataCommunicatorInputType&)> CommunicatorFactory);
 
    void RegisterDataCommunicatorDetail(
        const std::string& Name,
        DataCommunicator::UniquePointer pPrototype,
        const bool Default = DoNotMakeDefault);
 
    void UnregisterDataCommunicatorDetail(const std::string& Name);
 
    DataCommunicator& GetDataCommunicatorDetail(const std::string& rName) const;
 
    DataCommunicator& GetDefaultDataCommunicatorDetail() const;
 
    void SetDefaultDataCommunicatorDetail(const std::string& rName);
 
 
    bool HasDataCommunicatorDetail(const std::string& rName) const;
 
    bool MPIIsInitializedDetail() const;
 
    bool MPIIsFinalizedDetail() const;
 
 
    static ParallelEnvironment& GetInstance();
 
    void SetAsDefault(std::unordered_map<std::string, DataCommunicator::UniquePointer>::iterator& rThisCommunicator);
 
 
    std::string InfoDetail() const;
 
    void PrintInfoDetail(std::ostream &rOStream) const;
 
    void PrintDataDetail(std::ostream &rOStream) const;
 
 
    std::unordered_map<std::string, DataCommunicator::UniquePointer> mDataCommunicators;
 
    std::unordered_map<std::string, DataCommunicator::UniquePointer>::iterator mDefaultCommunicator;
 
    std::function<FillCommunicator::Pointer(ModelPart&, const std::string&)> mFillCommunicatorStringFactory;
 
    std::function<FillCommunicator::Pointer(ModelPart&, const DataCommunicator&)> mFillCommunicatorReferenceFactory;
 
    std::function<Communicator::UniquePointer(ModelPart&, const std::string&)> mCommunicatorStringFactory;
 
    std::function<Communicator::UniquePointer(ModelPart&, const DataCommunicator&)> mCommunicatorReferenceFactory;
 
    int mDefaultRank;
    int mDefaultSize;
 
    EnvironmentManager::Pointer mpEnvironmentManager;
 
    static ParallelEnvironment* mpInstance;
    static bool mDestroyed;
 
 
    ParallelEnvironment &operator=(ParallelEnvironment const &rOther) = delete;
 
    ParallelEnvironment(ParallelEnvironment const &rOther) = delete;
 
 
}; // Class ParallelEnvironment
 
 
 
} // namespace Kratos.