CompositionalCouplingScheme.hpp

Go to the documentation of this file.

#pragma once
 
#include <list>
#include <string>
#include <vector>
#include "Constants.hpp"
#include "CouplingScheme.hpp"
#include "SharedPointer.hpp"
#include "com/SharedPointer.hpp"
#include "logging/Logger.hpp"
 
namespace precice::cplscheme {

class CompositionalCouplingScheme final : public CouplingScheme {
public:
  ~CompositionalCouplingScheme() override = default;

  void addCouplingScheme(const PtrCouplingScheme &scheme);

  void initialize() final override;
 
  void reinitialize() final override;

  bool sendsInitializedData() const final override;

  bool isInitialized() const final override;

  bool addComputedTime(double timeToAdd) final override;

  // void advance() final override override;
 
  ChangedMeshes firstSynchronization(const ChangedMeshes &changes) override;
 
  void firstExchange() override;
 
  ChangedMeshes secondSynchronization() override;
 
  void secondExchange() override;

  void finalize() final override;

  std::vector<std::string> getCouplingPartners() const final override;

  std::string localParticipant() const final override;

  bool willDataBeExchanged(double lastSolverTimeStepSize) const final override;

  bool hasDataBeenReceived() const final override;

  double getTime() const final override;
 
  double getTimeWindowStart() const final override;

  int getTimeWindows() const final override;

  bool hasTimeWindowSize() const final override;

  double getTimeWindowSize() const final override;

  double getNextTimeStepMaxSize() const final override;

  bool isCouplingOngoing() const final override;

  bool isTimeWindowComplete() const final override;

  bool isActionRequired(Action action) const final override;

  bool isActionFulfilled(Action action) const final override;

  void markActionFulfilled(Action action) final override;

  void requireAction(Action action) final override;

  std::string printCouplingState() const final override;

  bool isImplicitCouplingScheme() const final override;

  bool hasConverged() const final override;

  bool requiresSubsteps() const final override;

  ImplicitData implicitDataToReceive() const final override;
 
private:
  mutable logging::Logger _log{"cplscheme::CompositionalCouplingScheme"};
 
  using Schemes = std::vector<PtrCouplingScheme>;

  Schemes _explicitSchemes;

  PtrCouplingScheme _implicitScheme;

  bool _explicitOnHold = false;

  std::vector<CouplingScheme *> _activeSchemes;

  void updateActiveSchemes();

  std::vector<CouplingScheme *> allSchemes() const;

  std::vector<CouplingScheme *> activeOrAllSchemes() const;

  void checkCompatibleTimeWindowSizes(const CouplingScheme &impl, const CouplingScheme &expl) const;
};
 
} // namespace precice::cplscheme