FieldEntsMultiIndices.hpp

Go to the documentation of this file.

/** \file FieldEntsMultiIndices.hpp
 * \brief Multi-index contains, for mofem entities data structures and other
 * low-level functions
 */
 
 
 
#ifndef __FIELD_ENTSMULTIINDICES_HPP__
#define __FIELD_ENTSMULTIINDICES_HPP__
 
namespace MoFEM {
 
struct EntityCacheDofs;
struct EntityCacheNumeredDofs;
 
struct EntityStorage {
  virtual ~EntityStorage() = default;
};
 
/**
 * \brief Struct keeps handle to entity in the field.
 * \ingroup ent_multi_indices
 */
struct FieldEntity : public interface_Field<Field, RefEntity> {
 
  using interface_type_Field = interface_Field<Field, RefEntity>;
  using interface_type_RefEntity = interface_RefEntity<RefEntity>;
 
  /**
   * @brief  Local unique id for this entity. Unique on CPU partition.
   *
   * @note Global UId use entity handle from owning processor, so is unique
   * across all CPUs. Local UId, uses local entity handle.  Local id is
   * convenient to use, is easley accessible from MOAB.
   *
   */
  UId localUId; 
 
  FieldEntity(const boost::shared_ptr<Field> field_ptr,
              const boost::shared_ptr<RefEntity> ref_ents_ptr,
              boost::shared_ptr<double *const> field_data_adaptor_ptr,
              boost::shared_ptr<const int> t_max_order_ptr);
 
  virtual ~FieldEntity() = default;
 
  /**
   * \brief Get number of active DOFs on entity
   * @return Number of DOFs
   */
  inline int getNbDofsOnEnt() const {
    return getOrderNbDofs(getMaxOrder()) * this->getNbOfCoeffs();
  }
 
  /**
   * @brief Return shared pointer to entity field data vector adaptor
   *
   * @return boost::shared_ptr<VectorAdaptor>
   */
  static boost::shared_ptr<FieldData *const> makeSharedFieldDataAdaptorPtr(
      const boost::shared_ptr<Field> &field_ptr,
      const boost::shared_ptr<RefEntity> &ref_ents_ptr);
 
  /**
   * @brief Get shared ptr to vector adaptor pointing to the field tag data on
   * entity
   *
   * @return boost::shared_ptr<VectorAdaptor>&
   */
  inline boost::shared_ptr<FieldData *const> &getEntFieldDataPtr() const {
    return fieldDataAdaptorPtr;
  }
 
  /**
   * \brief Get vector of DOFs active values on entity
   * @return Vector of DOFs values
   */
  inline VectorAdaptor getEntFieldData() const {
    return getVectorAdaptor(*fieldDataAdaptorPtr, getNbDofsOnEnt());
  }
 
  /**
   * \brief Get number of DOFs on entity for given order of approximation
   * @param  order Order of approximation
   * @return       Number of DOFs
   */
  inline int getOrderNbDofs(ApproximationOrder order) const {
    return (this->getFieldRawPtr()->forderTable[this->getEntType()])(order);
  }
 
  /**
   * \brief Get difference of number of DOFs between order and order-1
   * @param  order Approximation order
   * @return       Difference number of DOFs
   */
  inline int getOrderNbDofsDiff(ApproximationOrder order) const {
    return getOrderNbDofs(order) - getOrderNbDofs(order - 1);
  }
 
  /**
   * \brief Get pinter to Tag keeping approximation order
   * @return Pointer to Tag
   */
  inline const ApproximationOrder *getMaxOrderPtr() const {
    return tagMaxOrderPtr.get();
  }
 
  /**
   * \brief Get order set to the entity (Allocated tag size for such number)
   * @return Approximation order
   */
  inline ApproximationOrder getMaxOrder() const {
    return *tagMaxOrderPtr.get();
  }
 
  /**
   * @brief Get the Local Unique Id Calculate
   *
   * @param bit_number
   * @param handle
   * @return UId
   */
  static inline UId getLocalUniqueIdCalculate(const char bit_number,
                                              const EntityHandle handle) {
    return
 
        (static_cast<UId>(handle) << proc_shift | static_cast<UId>(bit_number)
                                                      << proc_shift + ent_shift)
        << dof_shift;
  }
 
  /**
   * @brief Get the Local Unique Id Calculate object
   *
   * @return UId
   */
  inline UId getLocalUniqueIdCalculate() {
    return getLocalUniqueIdCalculate(this->getBitNumber(), this->getEnt());
  }
 
  /**
   * \brief Get global unique id
   * @return Global UId
   */
  UId getGlobalUniqueId() const { return getGlobalUniqueIdCalculate(); }
 
  /**
   * \brief Get global unique id
   * @return Global UId
   */
  const UId &getLocalUniqueId() const { return localUId; }
 
  /**
   * \brief Calculate UId for field entity
   *
   * UId is constructed such that all DOFs are ordered by processor, entity,
   * field.
   *
   * UId is 128 bit
   *
   * @param  owner_proc               owning processor
   * @param  bit_number               field bit number
   * @param  moab_owner_handle        entity handle on owning processor
   * meshes
   * @return                          UId
   */
  static inline UId
  getGlobalUniqueIdCalculate(const int owner_proc, const char bit_number,
                             const EntityHandle moab_owner_handle) {
    return
 
        (static_cast<UId>(owner_proc) |
         static_cast<UId>(moab_owner_handle) << proc_shift |
         static_cast<UId>(bit_number) << proc_shift + ent_shift)
        << dof_shift;
  }
 
  static inline auto getOwnerFromUniqueId(const UId uid) {
    constexpr int proc_mask = MAX_PROCESSORS_NUMBER - 1;
    return static_cast<int>(
 
        (uid & getGlobalUniqueIdCalculate(proc_mask, 0, 0)) >> dof_shift
 
    );
  };
 
  /**
   * @brief Get the Handle From Unique Id
   * 
   * @param uid 
   * @return EntityHandle
   */
  static inline auto getHandleFromUniqueId(const UId uid) {
    constexpr EntityHandle handle_mask = ~(EntityHandle(0));
    return static_cast<EntityHandle>(
        (uid & getGlobalUniqueIdCalculate(0, 0, handle_mask)) >> proc_shift >>
        dof_shift);
  };
 
  /**
   * @brief Get the Field Bit Number From Unique Id
   *
   * @param uid
   * @return FieldId
   */
  static inline auto getFieldBitNumberFromUniqueId(const UId uid) {
    constexpr int bit_field_mask = ~(char(0));
    return static_cast<char>(
        (uid & getGlobalUniqueIdCalculate(0, bit_field_mask, 0)) >>
        (proc_shift + ent_shift) >> dof_shift);
  };
 
  /**
   * \brief Calculate global UId
   * @return Global UId
   */
  inline UId getGlobalUniqueIdCalculate() const {
    return getGlobalUniqueIdCalculate(this->getRefEntityPtr()->getOwnerProc(),
                                      this->getBitNumber(),
                                      this->getRefEntityPtr()->getOwnerEnt());
  }
 
  static inline UId getLoBitNumberUId(const FieldBitNumber bit_number) {
    return
 
        static_cast<UId>(bit_number) << dof_shift + ent_shift + proc_shift;
  }
 
  static inline UId getHiBitNumberUId(const FieldBitNumber bit_number) {
    return static_cast<UId>(MAX_DOFS_ON_ENTITY - 1) |
           static_cast<UId>(MAX_PROCESSORS_NUMBER - 1) << dof_shift |
           static_cast<UId>(std::numeric_limits<EntityHandle>::max())
               << dof_shift + proc_shift |
           static_cast<UId>(bit_number) << dof_shift + ent_shift + proc_shift;
  }
 
  static inline UId getLoFieldEntityUId(const UId &uid) {
    return ((~static_cast<UId>(MAX_DOFS_ON_ENTITY - 1)) & uid);
  }
 
  static inline UId getHiFieldEntityUId(const UId &uid) {
    return getLoFieldEntityUId(uid) | static_cast<UId>(MAX_DOFS_ON_ENTITY - 1);
  }
 
  template <typename T> void getLoFieldEntityUId(T &uid) = delete;
  template <typename T> void getHiFieldEntityUId(T &uid) = delete;
 
  static inline UId getLoLocalEntityBitNumber(const char bit_number,
                                              const EntityHandle ent) {
    return getLocalUniqueIdCalculate(
 
        bit_number,
 
        ent
 
    );
  }
 
  static inline UId getHiLocalEntityBitNumber(const char bit_number,
                                              const EntityHandle ent) {
    return getLoLocalEntityBitNumber(bit_number, ent) |
           static_cast<UId>(MAX_DOFS_ON_ENTITY - 1);
  }
 
  /**
   * \brief get hash-map relating dof index on entity with its order
   *
   * DOFs of given field are indexed on entity
   * of the same type, same space, approximation base and number of
   * coefficients, are sorted in the way.
   *
   */
  inline const std::array<int, MAX_DOFS_ON_ENTITY> &getDofOrderMap() const {
    return this->getFieldRawPtr()->getDofOrderMap(this->getEntType());
  }
 
  friend std::ostream &operator<<(std::ostream &os, const FieldEntity &e);
 
  mutable boost::weak_ptr<EntityCacheDofs> entityCacheDataDofs;
  mutable boost::weak_ptr<EntityCacheNumeredDofs> entityCacheRowDofs;
  mutable boost::weak_ptr<EntityCacheNumeredDofs> entityCacheColDofs;
 
  /**
   * @brief Get the Weak Storage pointer
   *
   * @return boost::weak_ptr<EntityStorage>&
   */
  template <typename T = EntityStorage>
  inline boost::shared_ptr<T> getSharedStoragePtr() const {
    return boost::dynamic_pointer_cast<T>(weakStoragePtr.lock());
  }
 
  inline boost::weak_ptr<EntityStorage> &getWeakStoragePtr() const {
    return weakStoragePtr;
  }
 
  mutable boost::weak_ptr<EntityStorage> weakStoragePtr;
 
private:
  mutable boost::shared_ptr<const ApproximationOrder> tagMaxOrderPtr;
  mutable boost::shared_ptr<FieldData *const> fieldDataAdaptorPtr;
  static constexpr int dof_shift = 9;   // Maximal number of DOFs on entity
  static constexpr int ent_shift = 64;  // EntityHandle size
  static constexpr int proc_shift = 10; // Maximal number of 1024 processors
};
 
template <>
inline boost::shared_ptr<EntityStorage>
FieldEntity::getSharedStoragePtr<EntityStorage>() const {
  return weakStoragePtr.lock();
}
 
/**
 * \brief Interface to FieldEntity
 * \ingroup ent_multi_indices
 *
 * interface to FieldEntity
 */
template <typename T>
struct interface_FieldEntity : public interface_Field<T, T> {
 
  interface_FieldEntity(const boost::shared_ptr<T> &sptr)
      : interface_Field<T, T>(sptr) {}
 
  /// @return get number of dofs on entity
  inline int getNbDofsOnEnt() const { return this->sPtr->getNbDofsOnEnt(); }
 
  /// @return get field data on entity
  inline VectorAdaptor getEntFieldData() const {
    return this->sPtr->getEntFieldData();
  }
 
  /// @return get number of DOFs for given order
  inline int getOrderNbDofs(ApproximationOrder order) const {
    return this->sPtr->getOrderNbDofs(order);
  }
 
  /// @return get increase of DOFs by increase to this order
  inline int getOrderNbDofsDiff(ApproximationOrder order) const {
    return this->sPtr->getOrderNbDofsDiff(order);
  }
 
  /// @return get maximal order on entity
  inline ApproximationOrder getMaxOrder() const {
    return this->sPtr->getMaxOrder();
  }
 
  /// @return get entity UId
  inline UId getGlobalUniqueId() const {
    return this->sPtr->getGlobalUniqueId();
  }
 
  /// @return get entity UId
  inline UId &getLocalUniqueId() const {
    return this->sPtr->getLocalUniqueId();
  }
 
  /// @return return pointer to reference entity data structure
  inline boost::shared_ptr<RefEntity> &getRefEntityPtr() const {
    return this->sPtr->getRefEntityPtr();
  }
 
  /// @return get pointer to mofem entity data structure
  inline boost::shared_ptr<FieldEntity> &getFieldEntityPtr() const {
    return this->sPtr;
  };
 
  /**
   * \brief get hash-map relating dof index on entity with its order
   *
   * DOFs of given field are indexed on entity
   * of the same type, same space, approximation base and number of
   * coefficients, are sorted in the way.
   *
   */
  inline const std::array<int, MAX_DOFS_ON_ENTITY> &getDofOrderMap() const {
    return this->sPtr->getDofOrderMap();
  }
 
  /// @copydoc FieldEntity::getSharedStoragePtr
  template <typename S = EntityStorage>
  inline boost::shared_ptr<S> getSharedStoragePtr() const {
    return this->sPtr->template getSharedStoragePtr<S>();
  }
 
  inline boost::weak_ptr<EntityStorage> &getWeakStoragePtr() const {
    return this->sPtr->getWeakStoragePtr();
  }
};
 
/**
 * \brief structure to change FieldEntity order
 * \ingroup ent_multi_indices
 */
struct FieldEntity_change_order {
 
  FieldEntity_change_order(const ApproximationOrder order,
                           const bool reduce_tag_size = false)
      : order(order), reduceTagSize(reduce_tag_size) {}
  inline void operator()(boost::shared_ptr<FieldEntity> &e) {
    (*this)(e.get());
  }
  void operator()(FieldEntity *e);
 
private:
  const ApproximationOrder order;
  const bool reduceTagSize;
  std::vector<FieldData> data;
};
 
/**
 * @relates multi_index_container
 * \brief MultiIndex container keeps FieldEntity
 * \ingroup ent_multi_indices
 *
 */
using FieldEntity_multiIndex = multi_index_container<
    boost::shared_ptr<FieldEntity>,
    indexed_by<
        ordered_unique<tag<Unique_mi_tag>,
                       member<FieldEntity, UId, &FieldEntity::localUId>>,
        ordered_non_unique<tag<Ent_mi_tag>,
                           const_mem_fun<FieldEntity::interface_type_RefEntity,
                                         EntityHandle, &FieldEntity::getEnt>>
 
        >>;
 
/** \brief Entity index by field name
 *
 * \ingroup ent_multi_indices
 */
using FieldEntityByUId = FieldEntity_multiIndex::index<Unique_mi_tag>::type;
 
/** \brief multi-index view on DofEntity by uid
  \ingroup dof_multi_indices
*/
using FieldEntity_multiIndex_global_uid_view = multi_index_container<
    boost::shared_ptr<FieldEntity>,
    indexed_by<
 
        ordered_unique<
            tag<Unique_mi_tag>,
            const_mem_fun<FieldEntity, UId, &FieldEntity::getGlobalUniqueId>>
 
        >>;
 
using FieldEntity_multiIndex_ent_view = multi_index_container<
    boost::shared_ptr<FieldEntity>,
    indexed_by<
 
        sequenced<>,
 
        ordered_non_unique<tag<Ent_mi_tag>,
                           const_mem_fun<FieldEntity::interface_type_RefEntity,
                                         EntityHandle, &FieldEntity::getEnt>>
 
        >>;
 
using FieldEntity_multiIndex_spaceType_view = multi_index_container<
    boost::shared_ptr<FieldEntity>,
    indexed_by<
 
        sequenced<>,
 
        ordered_non_unique<
            tag<Composite_EntType_and_Space_mi_tag>,
            composite_key<FieldEntity,
 
                          const_mem_fun<FieldEntity::interface_type_RefEntity,
                                        EntityType, &FieldEntity::getEntType>,
 
                          const_mem_fun<FieldEntity::interface_type_Field,
                                        FieldSpace, &FieldEntity::getSpace>
 
                          >>
 
        >>;
 
typedef std::vector<boost::weak_ptr<FieldEntity>> FieldEntity_vector_view;
 
using FieldEntity_multiIndex = multi_index_container<
    boost::shared_ptr<FieldEntity>,
    indexed_by<
        ordered_unique<tag<Unique_mi_tag>,
                       member<FieldEntity, UId, &FieldEntity::localUId>>,
        ordered_non_unique<tag<Ent_mi_tag>,
                           const_mem_fun<FieldEntity::interface_type_RefEntity,
                                         EntityHandle, &FieldEntity::getEnt>>
 
        >>;
 
} // namespace MoFEM
 
#endif // __FIELD_ENTSMULTIINDICES_HPP__
 
/**
 * \defgroup ent_multi_indices Entities structures and multi-indices
 * \ingroup mofem
 **/