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 {
namespace cplscheme {
 
class CompositionalCouplingScheme final : public CouplingScheme {
public:
  virtual ~CompositionalCouplingScheme() {}
 
  void addCouplingScheme(const PtrCouplingScheme &scheme);
 
  void initialize(
      double startTime,
      int    startTimeWindow) final override;
 
  bool sendsInitializedData() const override final;
 
  bool isInitialized() const final override;
 
  bool addComputedTime(double timeToAdd) final override;
 
  //void advance() final 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 override final;
 
  bool willDataBeExchanged(double lastSolverTimeStepSize) const final override;
 
  bool hasDataBeenReceived() const final override;
 
  double getTime() const final override;
 
  double getTimeWindowStart() const override final;
 
  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;
 
  bool hasConverged() const final;
 
  bool requiresSubsteps() const override final;
 
  ImplicitData implicitDataToReceive() const override final;
 
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 cplscheme
} // namespace precice