MultiMeshManager.hpp

Go to the documentation of this file.

#pragma once
 
#include <tuple>
#include <optional>
#include <wmtk/Tuple.hpp>
#include <wmtk/attribute/Accessor.hpp>
// included to make a friend as this requires IDs
#include <wmtk/utils/MerkleTreeInteriorNode.hpp>
 
// debug function that reads into this structure
#include "utils/check_map_valid.hpp"
 
 
namespace wmtk {
 
class Mesh;
class HDF5Reader;
namespace operations {
class EdgeOperationData;
namespace utils {
class UpdateEdgeOperationMultiMeshMapFunctor;
}
} // namespace operations
namespace attribute {
}
namespace multimesh {
template <int64_t cell_dimension, typename NodeFunctor>
class MultiMeshSimplexVisitor;
template <typename Visitor>
class MultiMeshSimplexVisitorExecutor;
 
template <typename NodeFunctor>
class MultiMeshVisitor;
template <typename Visitor>
class MultiMeshVisitorExecutor;
 
namespace utils {
class MapValidator;
}
 
} // namespace multimesh
class Mesh;
namespace simplex {
class Simplex;
class SimplexCollection;
} // namespace simplex
} // namespace wmtk
namespace wmtk::multimesh {
class MultiMeshManager : public wmtk::utils::MerkleTreeInteriorNode
{
public:
 
    // let the visitor object access the internal details
    template <int64_t cell_dimension, typename NodeFunctor>
    friend class multimesh::MultiMeshSimplexVisitor;
    friend class wmtk::Mesh;
    template <typename Visitor>
    friend class multimesh::MultiMeshSimplexVisitorExecutor;
    friend class operations::utils::UpdateEdgeOperationMultiMeshMapFunctor;
 
    template <typename NodeFunctor>
    friend class multimesh::MultiMeshVisitor;
    template <typename Visitor>
    friend class multimesh::MultiMeshVisitorExecutor;
    friend class wmtk::HDF5Reader;
 
    friend class utils::MapValidator;
 
 
    // @param the max dimension of the mesh we will get passed
    MultiMeshManager(int64_t dimension);
    ~MultiMeshManager();
    MultiMeshManager(const MultiMeshManager& o);
    MultiMeshManager(MultiMeshManager&& o);
    MultiMeshManager& operator=(const MultiMeshManager& o);
    MultiMeshManager& operator=(MultiMeshManager&& o);
 
    // attribute directly hashes its "children" components so it overrides "child_hashes"
    std::map<std::string, const wmtk::utils::Hashable*> child_hashables() const override;
    std::map<std::string, std::size_t> child_hashes() const override;
 
 
    void detach_children();
 
    //=========================================================
    // Storage of MultiMesh
    //=========================================================
 
    /*
     * @brief The set of attribute handles used by this manager (owned by this mesh)
     *
     * @returns a vector of attribute handles
     */
    std::vector<TypedAttributeHandle<int64_t>> map_handles() const;
    bool is_root() const;
    int64_t child_id() const;
    // @brief a unique id for this mesh with respect to its multi-mesh tree
    //
    // This is guaranteed to be the sequence of mesh indices used to traverse from the root of the
    // structure to this mesh (backwards)
    std::vector<int64_t> absolute_id() const;
 
 
    Mesh& get_mesh(Mesh& m, const std::vector<int64_t>& absolute_id);
    const Mesh& get_mesh(const Mesh& m, const std::vector<int64_t>& absolute_id) const;
 
 
    Mesh& get_child_mesh(Mesh& m, const std::vector<int64_t>& relative_id);
    const Mesh& get_child_mesh(const Mesh& m, const std::vector<int64_t>& relative_id) const;
 
    void register_child_mesh(
        Mesh& my_mesh,
        const std::shared_ptr<Mesh>& child_mesh,
        const std::vector<std::array<Tuple, 2>>& child_tuple_my_tuple_map);
 
    void deregister_child_mesh(Mesh& my_mesh, const std::shared_ptr<Mesh>& child_mesh_ptr);
 
    void update_child_handles(Mesh& my_mesh);
 
 
    // bool are_maps_valid(const Mesh& my_mesh) const;
 
    //===========
    //===========
    // Map functions
    //===========
    //===========
    // Note that when we map a M-tuple from a K-complex to a J-complex there are different
    // relationships necessary if K == J
    //    if M == K then this is unique
    //    if M < K then this is many to many
    // if K < J
    //    if M == K then it is one to many
    //    if M < K then it is many to many
    //
    //    Note also that functions that end with _tuple or _tuples willl return tuples rather than
    //    simplices
 
    //===========
    // simplex::Simplex maps
    //===========
    std::vector<simplex::Simplex>
    map(const Mesh& my_mesh, const Mesh& other_mesh, const simplex::Simplex& my_simplex) const;
    std::vector<Tuple> lub_map_tuples(
        const Mesh& my_mesh,
        const Mesh& other_mesh,
        const simplex::Simplex& my_simplex) const;
 
 
    std::vector<simplex::Simplex>
    lub_map(const Mesh& my_mesh, const Mesh& other_mesh, const simplex::Simplex& my_simplex) const;
    std::vector<Tuple> map_tuples(
        const Mesh& my_mesh,
        const Mesh& other_mesh,
        const simplex::Simplex& my_simplex) const;
 
    simplex::Simplex map_to_parent(const Mesh& my_mesh, const simplex::Simplex& my_simplex) const;
    Tuple map_to_parent_tuple(const Mesh& my_mesh, const simplex::Simplex& my_simplex) const;
 
 
    simplex::Simplex map_to_root(const Mesh& my_mesh, const simplex::Simplex& my_simplex) const;
    Tuple map_to_root_tuple(const Mesh& my_mesh, const simplex::Simplex& my_simplex) const;
 
    std::vector<simplex::Simplex> map_to_child(
        const Mesh& my_mesh,
        const Mesh& child_mesh,
        const simplex::Simplex& my_simplex) const;
    std::vector<Tuple> map_to_child_tuples(
        const Mesh& my_mesh,
        const Mesh& child_mesh,
        const simplex::Simplex& my_simplex) const;
 
 
    bool can_map(const Mesh& my_mesh, const Mesh& other_mesh, const simplex::Simplex& my_simplex)
        const;
    bool can_map_child(
        const Mesh& my_mesh,
        const Mesh& other_mesh,
        const simplex::Simplex& my_simplex) const;
 
    /* @brief obtains the root mesh of this multi-mesh tree
     *
     * @param my_mesh the mesh that this structure is owned by
     */
    const Mesh& get_root_mesh(const Mesh& my_mesh) const;
    /* @brief obtains the root mesh of this multi-mesh tree
     *
     * @param my_mesh the mesh that this structure is owned by
     */
    Mesh& get_root_mesh(Mesh& my_mesh);
    std::vector<std::shared_ptr<Mesh>> get_child_meshes() const;
 
    void serialize(MeshWriter& writer, const Mesh* local_root = nullptr) const;
 
    bool has_child_mesh_in_dimension(int64_t dimension) const
    {
        return m_has_child_mesh_in_dimension[dimension];
    }
 
    bool has_child_mesh() const;
 
protected:
    // Storage of a child mesh (a pointer from the mesh + the map from this mesh -> the child)
    struct ChildData
    {
        std::shared_ptr<Mesh> mesh;
        // store the map from the manager's mesh to the child mesh (on the top
        // level simplex of the mesh)
        // encoded by a pair of two tuples, from a tuple in current mesh to a tuple in
        // child_mesh
        TypedAttributeHandle<int64_t> map_handle;
    };
 
protected:
    Mesh* m_parent = nullptr;
    // only valid if this is the child of some other mesh
    // store the map to the base_tuple of the my_mesh
    TypedAttributeHandle<int64_t> map_to_parent_handle;
 
    // the index of this mesh with respect to its parent's m_children
    int64_t m_child_id = -1;
 
 
    // Child Meshes
    std::vector<ChildData> m_children;
 
    // indicates which kind of child mesh the parent mesh has
    std::vector<bool> m_has_child_mesh_in_dimension;
 
protected: // protected to enable unit testing
    //===========
    // Tuple maps
    //===========
 
    // generic mapping function that maps a tuple from "this" mesh to its parent. We don't actually
    // need the simplex parent of the tuple being mapped up so we can throw away the simplex-nes
    Tuple map_tuple_to_parent_tuple(const Mesh& my_mesh, const Tuple& my_tuple) const;
 
    Tuple map_tuple_to_root_tuple(const Mesh& my_mesh, const Tuple& my_tuple) const;
 
    // wrapper for implementing converting tuple to a child using the internal map data
    std::vector<Tuple> map_to_child_tuples(
        const Mesh& my_mesh,
        const ChildData& child_data,
        const simplex::Simplex& simplex) const;
 
    // wrapper for implementing converting tuple to a child using the internal map data
    std::vector<Tuple> map_to_child_tuples(
        const Mesh& my_mesh,
        int64_t child_id,
        const simplex::Simplex& simplex) const;
 
 
    // utility static function for mapping a tuple between the source and target given a specified
    // map accessor
    static Tuple map_tuple_between_meshes(
        const Mesh& source_mesh,
        const Mesh& target_mesh,
        const wmtk::attribute::Accessor<int64_t>& source_to_target_map_accessor,
        const Tuple& source_tuple);
 
    const std::vector<ChildData>& children() const { return m_children; }
    std::vector<ChildData>& children() { return m_children; }
 
    // uility for consistently specifying the name of the attribute used to map this mesh to its
    // parent
    static std::string parent_to_child_map_attribute_name(int64_t index);
    // uility for consistently specifying the name of the attribute used to map this mesh to its
    // parent
    static std::string child_to_parent_map_attribute_name();
 
    // returns {parent_to_child, child_to_parent} accessors
    std::array<wmtk::attribute::Accessor<int64_t>, 2> get_map_accessors(
        Mesh& my_mesh,
        ChildData& c);
    // returns {parent_to_child, child_to_parent} accessors
    std::array<const wmtk::attribute::Accessor<int64_t>, 2> get_map_const_accessors(
        const Mesh& my_mesh,
        const ChildData& c) const;
 
 
    //===========
    // Utilities for updating maps after operations
    //===========
    // updates the map tuples to children for a particular dimension.
    // for eeach simplex we store its global index and all variations of that face using a
    // consistent set of subsimplices wrt the tuple representation If the new tuple has a
    // representation
    //
    // it cannot handle map updates of its faces?
    void update_map_tuple_hashes(
        Mesh& my_mesh,
        PrimitiveType primitive_type,
        const std::vector<std::tuple<int64_t, std::vector<Tuple>>>& simplices_to_update,
        const std::vector<std::tuple<int64_t, std::array<int64_t, 2>>>& split_cell_maps = {});
 
    void update_maps_from_edge_operation(
        Mesh& my_mesh,
        PrimitiveType primitive_type,
        const operations::EdgeOperationData& operation_data);
 
 
    // uses the available parameters to find a tuple that is equivalent to old_smiplex but using
    // still-existing top level simplices. by equivalent each sub-simplex of old_simplex's tuple
    // maps to the same thing as the returned tuple
    std::optional<Tuple> find_valid_tuple(
        Mesh& my_mesh,
        const simplex::Simplex& old_simplex,
        const int64_t old_gid,
        const std::vector<Tuple>& tuple_alternatives,
        const std::vector<std::tuple<int64_t, std::array<int64_t, 2>>>& split_cell_maps = {}) const;
 
    // returns a tuple such that every subsmipelx in old_simplex's tuple maps to the same smiplex as
    std::optional<Tuple> find_valid_tuple_from_alternatives(
        Mesh& my_mesh,
        PrimitiveType primitive_type,
        const std::vector<Tuple>& tuple_alternatives) const;
 
    // returns a tuple such that every subsmipelx in old_simplex's tuple maps to the same smiplex as
    // before
    std::optional<Tuple> find_valid_tuple_from_split(
        Mesh& my_mesh,
        const simplex::Simplex& old_simplex,
        const int64_t old_gid,
        const std::vector<Tuple>& tuple_alternatives,
        const std::vector<std::tuple<int64_t, std::array<int64_t, 2>>>& split_cell_maps) const;
 
    std::optional<Tuple> try_updating_map_tuple_from_split(
        Mesh& my_mesh,
        const simplex::Simplex& old_simplex, // map tuple is contained in this
        const int64_t old_gid,
        const std::vector<Tuple>& tuple_alternatives,
        const std::tuple<int64_t, std::array<int64_t, 2>>& split_cell_maps) const;
 
 
    static std::optional<Tuple> find_tuple_from_gid(
        const Mesh& my_mesh,
        PrimitiveType primitive_type,
        const std::vector<Tuple>& tuples,
        int64_t gid);
 
    // helper for updating multimap used in the update multimesh edge functor
    static int64_t child_global_cid(
        const wmtk::attribute::Accessor<int64_t>& parent_to_child,
        int64_t parent_gid);
    // helper for updating multimap used in the update multimesh edge functor
    static int64_t parent_global_cid(
        const wmtk::attribute::Accessor<int64_t>& child_to_parent,
        int64_t child_gid);
    // helper for updating multimap used in the update multimesh edge functor
    static int64_t parent_local_fid(
        const wmtk::attribute::Accessor<int64_t>& child_to_parent,
        int64_t child_gid);
 
 
    // ===============================================================================
    // ===============================================================================
    // ===============================================================================
    // ===============================================================================
 
 
    // internal function for mapping up a multimesh tree by a certain number of edges
    //
    // @return the mesh found at the top and the tuple that was found
    std::pair<const Mesh&, Tuple>
    map_up_to_tuples(const Mesh& my_mesh, const simplex::Simplex& simplex, int64_t depth) const;
 
    // internal function for mapping down a multimesh tree by following a sequence of ids
    //
    // @return the mesh found at the top and the tuple that was found
    std::vector<Tuple> map_down_relative_tuples(
        const Mesh& my_mesh,
        const simplex::Simplex& my_simplex,
        const std::vector<int64_t>& local_id_path) const;
 
 
public:
    static std::vector<int64_t> least_upper_bound_id(
        const std::vector<int64_t>& a,
        const std::vector<int64_t>& b);
    static std::vector<int64_t> relative_id(
        const std::vector<int64_t>& parent,
        const std::vector<int64_t>& child);
 
public:
    std::vector<int64_t> relative_id(const Mesh& my_mesh, const Mesh& parent_mesh) const;
 
    static bool is_child(const std::vector<int64_t>& child, const std::vector<int64_t>& parent);
    bool is_child(const Mesh& my_mesh, const Mesh& parent_mesh) const;
 
    // this is defined internally but is preferablly invoked through the multimesh free function
    static std::vector<std::array<Tuple, 2>> same_simplex_dimension_surjection(
        const Mesh& parent,
        const Mesh& child,
        const std::vector<int64_t>& parent_simplices);
 
public:
public:
    // remove after bug fix
    void check_map_valid(const Mesh& my_mesh) const;
 
    void check_child_map_valid(const Mesh& my_mesh, const ChildData& child_data) const;
};
} // namespace wmtk::multimesh