mirror.hpp

Go to the documentation of this file.

/* 
 * This file is part of PLaSK (https://plask.app) by Photonics Group at TUL
 * Copyright (c) 2022 Lodz University of Technology
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */
#ifndef PLASK__GEOMETRY_MIRROR_H
#define PLASK__GEOMETRY_MIRROR_H
 
#include "transform.hpp"
 
// Flip - odbicie
// Mirror - odbicie i klonowanie
 
namespace plask {
 
template <int dim> struct PLASK_API Flip : public GeometryObjectTransform<dim> {
    typedef GeometryObjectTransform<dim> BaseClass;
 
    static const char* NAME;
 
    std::string getTypeName() const override;
 
    typedef typename BaseClass::ChildType ChildType;
 
    typedef typename BaseClass::DVec DVec;
 
    typedef typename BaseClass::Box Box;
 
    using BaseClass::getChild;
 
    explicit Flip(typename Primitive<dim>::Direction flipDir,
                  shared_ptr<GeometryObjectD<dim>> child = shared_ptr<GeometryObjectD<dim>>())
        : BaseClass(child), flipDir(flipDir) {}
 
    typename Primitive<dim>::Direction flipDir;
 
    DVec flipped(DVec v) const { return v.flipped(flipDir); }
 
    Box flipped(Box res) const { return res.flipped(flipDir); }
 
    shared_ptr<Material> getMaterial(const DVec& p) const override;
 
    bool contains(const DVec& p) const override;
 
    using GeometryObjectTransform<dim>::getPathsTo;
 
    GeometryObject::Subtree getPathsAt(const DVec& point, bool all = false) const override;
 
    Box fromChildCoords(const typename ChildType::Box& child_bbox) const override;
 
    void getPositionsToVec(const GeometryObject::Predicate& predicate,
                           std::vector<DVec>& dest,
                           const PathHints* path = 0) const override;
 
    shared_ptr<Flip<dim>> copyShallow() const { return shared_ptr<Flip<dim>>(new Flip<dim>(flipDir, getChild())); }
 
    shared_ptr<GeometryObject> shallowCopy() const override;
 
    void addPointsAlongToSet(std::set<double>& points,
                             Primitive<3>::Direction direction,
                             unsigned max_steps,
                             double min_step_size) const override;
 
    void addLineSegmentsToSet(std::set<typename GeometryObjectD<dim>::LineSegment>& segments,
                              unsigned max_steps,
                              double min_step_size) const override;
 
    void writeXMLAttr(XMLWriter::Element& dest_xml_object, const AxisNames& axes) const override;
};
 
PLASK_API_EXTERN_TEMPLATE_STRUCT(Flip<2>)
PLASK_API_EXTERN_TEMPLATE_STRUCT(Flip<3>)
 
 
// TODO add checking of coordinates
template <int dim> struct PLASK_API Mirror : public GeometryObjectTransform<dim> {
    typedef GeometryObjectTransform<dim> BaseClass;
 
    static const char* NAME;
 
    std::string getTypeName() const override;
 
    typedef typename BaseClass::ChildType ChildType;
 
    typedef typename BaseClass::DVec DVec;
 
    typedef typename BaseClass::Box Box;
 
    using BaseClass::getChild;
 
    explicit Mirror(typename Primitive<dim>::Direction flipDir,
                    shared_ptr<GeometryObjectD<dim>> child = shared_ptr<GeometryObjectD<dim>>())
        : BaseClass(child), flipDir(flipDir) {}
 
    typename Primitive<dim>::Direction flipDir;
 
    Box getBoundingBox() const override;
 
    Box getRealBoundingBox() const override;
 
    DVec flipped(DVec v) const { return v.flipped(flipDir); }
 
    DVec flippedIfNeg(DVec v) const { return v[flipDir] >= 0 ? v : v.flipped(flipDir); }
 
    void extend(Box& toExt) const { toExt.lower[flipDir] = -toExt.upper[flipDir]; }
 
    Box extended(Box res) const {
        extend(res);
        return res;
    }
 
    shared_ptr<Material> getMaterial(const DVec& p) const override;
 
    bool contains(const DVec& p) const override;
 
    using GeometryObjectTransform<dim>::getPathsTo;
 
    Box fromChildCoords(const typename ChildType::Box& child_bbox) const override;
 
    void getBoundingBoxesToVec(const GeometryObject::Predicate& predicate,
                               std::vector<Box>& dest,
                               const PathHints* path = 0) const override;
 
    void getObjectsToVec(const GeometryObject::Predicate& predicate,
                         std::vector<shared_ptr<const GeometryObject>>& dest,
                         const PathHints* path = 0) const override;
 
    void getPositionsToVec(const GeometryObject::Predicate& predicate,
                           std::vector<DVec>& dest,
                           const PathHints* path = 0) const override;
 
    GeometryObject::Subtree getPathsTo(const GeometryObject& el, const PathHints* path = 0) const override;
 
    GeometryObject::Subtree getPathsAt(const DVec& point, bool all = false) const override;
 
    std::size_t getChildrenCount() const override;
 
    shared_ptr<GeometryObject> getChildNo(std::size_t child_no) const override;
 
    std::size_t getRealChildrenCount() const override;
 
    shared_ptr<GeometryObject> getRealChildNo(std::size_t child_no) const override;
 
    shared_ptr<Mirror<dim>> copyShallow() const {
        return shared_ptr<Mirror<dim>>(new Mirror<dim>(flipDir, this->_child));
    }
 
    void addPointsAlongToSet(std::set<double>& points,
                             Primitive<3>::Direction direction,
                             unsigned max_steps,
                             double min_step_size) const override;
 
    void addLineSegmentsToSet(std::set<typename GeometryObjectD<dim>::LineSegment>& segments,
                              unsigned max_steps,
                              double min_step_size) const override;
 
    shared_ptr<GeometryObject> shallowCopy() const override;
 
    void writeXMLAttr(XMLWriter::Element& dest_xml_object, const AxisNames& axes) const override;
};
 
PLASK_API_EXTERN_TEMPLATE_STRUCT(Mirror<2>)
PLASK_API_EXTERN_TEMPLATE_STRUCT(Mirror<3>)
 
}  // namespace plask
 
#endif  // MIRROR_H