File CouplingInterface.hpp

Location: CouplingInterface.hpp

Classes

• sysc::CouplingInterface

Namespaces

• sysc

Includes

• SystemCouplingParticipant/LibraryType.hpp
• SystemCouplingParticipant/DataTransfer.hpp
• SystemCouplingParticipant/Region.hpp

graph LR
3["SystemCouplingParticipant/DataTransfer.hpp"]

5["string"]

4["SystemCouplingParticipant/Region.hpp"]

6["vector"]

2["SystemCouplingParticipant/LibraryType.hpp"]

1["CouplingInterface.hpp"]
click 1 "CouplingInterface_8hpp.md#CouplingInterface_8hpp"
1 --> 2
1 --> 3
1 --> 4
1 --> 5
1 --> 6

Source

/*
 * Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
 */

#pragma once

#include "SystemCouplingParticipant/LibraryType.hpp"

#include "SystemCouplingParticipant/DataTransfer.hpp"
#include "SystemCouplingParticipant/Region.hpp"

#include <string>
#include <vector>

namespace sysc {

class SYSTEM_COUPLING_PARTICIPANT_DLL CouplingInterface {
public:
  CouplingInterface(CouplingInterfaceName interfaceName);

  void addSideOneRegion(const Region& region);

  void addSideTwoRegion(const Region& region);

  const CouplingInterfaceName& getName() const;

  std::size_t getNumSideOneRegions() const;

  std::size_t getNumSideTwoRegions() const;

  const Region& getSideOneRegion(std::size_t index) const;

  const Region& getSideTwoRegion(std::size_t index) const;

  void addDataTransfer(const DataTransfer& dataTransfer);

  std::size_t getNumDataTransfers() const noexcept;

  const DataTransfer& getDataTransfer(std::size_t index) const;

private:
  CouplingInterfaceName m_name;

  std::vector<Region> m_sideOneRegions;
  std::map<RegionName, std::size_t> m_sideOneRegionsNameToIndex;

  std::vector<Region> m_sideTwoRegions;
  std::map<RegionName, std::size_t> m_sideTwoRegionsNameToIndex;

  std::vector<DataTransfer> m_dataTransfers;
};

}  // namespace sysc