ActionConfiguration.hpp

Go to the documentation of this file.

#pragma once
 
#include <list>
#include <string>
#include <vector>
#include "action/Action.hpp"
#include "action/SharedPointer.hpp"
#include "logging/Logger.hpp"
#include "mesh/SharedPointer.hpp"
#include "xml/XMLTag.hpp"
 
namespace precice::action {

class ActionConfiguration : public xml::XMLTag::Listener {
public:
  ActionConfiguration(
      xml::XMLTag               &parent,
      mesh::PtrMeshConfiguration meshConfig);

  void xmlTagCallback(const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override;

  void xmlEndTagCallback(const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override;

  int getUsedMeshID() const;

  const std::list<PtrAction> &actions() const
  {
    return _actions;
  }

  std::list<PtrAction> extractActions()
  {
    return std::exchange(_actions, std::list<PtrAction>{});
  }
 
private:
  struct ConfiguredAction {
    std::string              type;
    std::string              timing;
    std::vector<std::string> sourceDataVector;
    std::string              targetData;
    std::string              mesh;
    double                   convergenceTolerance = 0;
    int                      maxIterations        = 0;
    std::string              path;
    std::string              module;
  };
 
  mutable logging::Logger _log{"config::ActionConfiguration"};
 
  const std::string TAG = "action";
 
  const std::string NAME_DIVIDE_BY_AREA;
  const std::string NAME_MULTIPLY_BY_AREA;
  const std::string NAME_SUMMATION;
  const std::string NAME_COMPUTE_CURVATURE;
  const std::string NAME_PYTHON;
  const std::string NAME_RECORDER;
 
  const std::string TAG_SOURCE_DATA;
  const std::string TAG_TARGET_DATA;
  const std::string TAG_CONVERGENCE_TOLERANCE;
  const std::string TAG_MAX_ITERATIONS;
  const std::string TAG_MODULE_PATH;
  const std::string TAG_MODULE_NAME;
 
  const std::string ATTR_TYPE   = "type";
  const std::string ATTR_TIMING = "timing";
  const std::string ATTR_NAME   = "name";
  const std::string ATTR_VALUE  = "value";
  const std::string ATTR_MESH   = "mesh";
 
  const std::string WRITE_MAPPING_POST;
  const std::string READ_MAPPING_POST;
 
  mesh::PtrMeshConfiguration _meshConfig;
 
  ConfiguredAction _configuredAction;
 
  std::list<PtrAction> _actions;
 
  //  /**
  //   * @brief Adds all required subtags to the main action tag.
  //   */
  //  void addSubtags (
  //    std::list<xml::XMLTag>& tags,
  //    const std::string&        type );

  void createAction();
 
  Action::Timing getTiming() const;
};
 
} // namespace precice::action