mcell/libmcell/api/region.h

/******************************************************************************
 *
 * Copyright (C) 2020 by
 * The Salk Institute for Biological Studies
 *
 * Use of this source code is governed by an MIT-style
 * license that can be found in the LICENSE file or at
 * https://opensource.org/licenses/MIT.
 *
******************************************************************************/

#ifndef API_REGION_H
#define API_REGION_H

#include "generated/gen_region.h"
#include "api/api_common.h"

namespace MCell {
namespace API {

enum class RegionType {
  UNKNOWN,
  VOLUME,
  SURFACE
};


class Region: public GenRegion, public std::enable_shared_from_this<Region> {
public:
  REGION_CTOR()

  void postprocess_in_ctor() {
    set_all_custom_attributes_to_default();
  }

  void set_all_custom_attributes_to_default() override {
    region_type = RegionType::UNKNOWN;
  }

  std::shared_ptr<Region> __add__(std::shared_ptr<Region> other) override {
    check_has_compatible_type(other, false);
    std::shared_ptr<Region> res = std::make_shared<Region>(RegionNodeType::UNION, shared_from_this(), other);
    res->region_type = other->region_type;
    return res;
  }
  std::shared_ptr<Region> __sub__(std::shared_ptr<Region> other) override {
    check_has_compatible_type(other, true);
    std::shared_ptr<Region> res = std::make_shared<Region>(RegionNodeType::DIFFERENCE, shared_from_this(), other);
    res->region_type = other->region_type;
    return res;
  }
  std::shared_ptr<Region> __mul__(std::shared_ptr<Region> other) override {
    check_has_compatible_type(other, false);
    std::shared_ptr<Region> res = std::make_shared<Region>(RegionNodeType::INTERSECT, shared_from_this(), other);
    res->region_type = other->region_type;
    return res;
  }

  // added
  void check_has_compatible_type(std::shared_ptr<Region> other, const bool is_sub = false) {
    bool ok = true;
    if (is_sub) {
      ok = (class_name == NAME_CLASS_GEOMETRY_OBJECT && other->region_type == RegionType::SURFACE) ||
          region_type == other->region_type;
    }
    else {
      ok = (region_type == other->region_type);
    }

    if (!ok) {
      throw RuntimeError(S("When creating regions, one can only combine regions of identical type ") +
          "(both volume or both surface)" +
          ", also one can subtract a " + NAME_CLASS_SURFACE_REGION + " from a " + NAME_CLASS_GEOMETRY_OBJECT + ", error for:\n" +
          to_str() + "and\n" + other->to_str() +
          "-- end of error message related to combining regions of different type --");
    }
  }

  // set to true in GeometryObject, allows to find out whether it is safe to
  // cast this object to a GeometryObject
  RegionType region_type;
};

} // namespace API
} // namespace MCell

#endif // API_REGION_H