FEMultiIndices.hpp

Go to the documentation of this file.

/** \file FEMultiIndices.hpp
 * \brief Multi-index contains, data structures for mofem finite elements and
 * other low-level functions
 * 
 * \todo Add proc into feUId to reduce number of keys is multi-index
 */
 
#ifndef __FEMMULTIINDICES_HPP__
#define __FEMMULTIINDICES_HPP__
 
namespace MoFEM {
 
struct EntFiniteElement;
 
/** \brief user adjacency function
 * \ingroup fe_multi_indices
 */
using ElementAdjacencyFunct = boost::function<MoFEMErrorCode(
    Interface &moab, const Field &field, const EntFiniteElement &fe,
    std::vector<EntityHandle> &adjacency)>;
 
/**
 * \brief Finite element definition
 * \ingroup fe_multi_indices
 */
struct FiniteElement {
 
  EntityHandle meshset;                ///< meshset stores FE ents
  BitFEId *tagId;                      ///< ptr to tag storing FE id
  void *tagName;                       ///< ptr to tag storing FE name
  int tagNameSize;                     ///< numer of characters in FE name
  BitFieldId *tag_BitFieldId_col_data; ///< tag stores col id_id for fields
  BitFieldId *tag_BitFieldId_row_data; ///< tag stores row id_id for fields
  BitFieldId *tag_BitFieldId_data;     ///< tag stores data id_id for fields
  UId feUId;
 
  FiniteElement(Interface &moab, const EntityHandle _meshset);
 
  /**
   * @brief Get finite element uid
   *
   * @return const UId&
   */
  inline const UId &getFEUId() const { return feUId; }
 
  /**
   * \brief Get finite element id
   * @return Finite element Id
   */
  inline BitFEId getId() const { return *tagId; }
 
  /**
   * \brief Get meshset containing element entities
   * @return Meshset
   */
  inline EntityHandle getMeshset() const { return meshset; }
 
  /**
   * \brief Get finite element name
   * @return string_ref
   */
  inline boost::string_ref getNameRef() const {
    return boost::string_ref((char *)tagName, tagNameSize);
  }
 
  /**
   * \brief Get finite element name
   * @return string
   */
  inline std::string getName() const {
    return std::string((char *)tagName, tagNameSize);
  }
 
  /**
   * \brief Get field ids on columns
   * @return Bit field ids
   */
  inline BitFieldId getBitFieldIdCol() const {
    return *((BitFieldId *)tag_BitFieldId_col_data);
  }
 
  /**
   * \brief Get field ids on rows
   * @return Bit field ids
   */
  inline BitFieldId getBitFieldIdRow() const {
    return *((BitFieldId *)tag_BitFieldId_row_data);
  }
 
  /**
   * \brief Get field ids on data
   * @return Bit field ids
   */
  inline BitFieldId getBitFieldIdData() const {
    return *((BitFieldId *)tag_BitFieldId_data);
  }
 
  /**
   * \brief Get bit identifying this element
   *
   * Each element like field is identified by bit set. Each element has unique
   * bit set, this function returns number of that bit.
   *
   * @return Bit number
   */
  inline unsigned int getBitNumber() const {
    return ffsl(((BitFieldId *)tagId)->to_ulong());
  }
 
  /**
   * \brief Table of functions retrieving adjacencies for finite element
   * User can alter and change default behavior
   */
  std::array<ElementAdjacencyFunct, MBMAXTYPE> elementAdjacencyTable;
 
  /**
   * \brief print finite element
   */
  friend std::ostream &operator<<(std::ostream &os, const FiniteElement &e);
 
private:
  static constexpr int ent_shift = 64; // EntityHandle size
};
 
/** \brief default adjacency map
 * \ingroup fe_multi_indices
 */
struct DefaultElementAdjacency {
 
  static MoFEMErrorCode defaultVertex(Interface &moab, const Field &field,
                                      const EntFiniteElement &fe,
                                      std::vector<EntityHandle> &adjacency);
  static MoFEMErrorCode defaultEdge(Interface &moab, const Field &field,
                                    const EntFiniteElement &fe,
                                    std::vector<EntityHandle> &adjacency);
  static MoFEMErrorCode defaultFace(Interface &moab, const Field &field,
                                    const EntFiniteElement &fe,
                                    std::vector<EntityHandle> &adjacency);
  static MoFEMErrorCode defaultVolume(Interface &moab, const Field &field,
                                      const EntFiniteElement &fe,
                                      std::vector<EntityHandle> &adjacency);
  static MoFEMErrorCode defaultPrism(Interface &moab, const Field &field,
                                     const EntFiniteElement &fe,
                                     std::vector<EntityHandle> &adjacency);
  static MoFEMErrorCode defaultMeshset(Interface &moab, const Field &field,
                                       const EntFiniteElement &fe,
                                       std::vector<EntityHandle> &adjacency);
 
  using DefEntTypeMap = std::array<bool, MBMAXTYPE>;
 
  static constexpr DefEntTypeMap defVertexTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      false, //  MBEDGE
      false, //  MBTRI
      false, //  MBQUAD
      false, //  MBPOLYGON
      false, //  MBTET
      false, //  MBPYRAMID
      false, //  MBPRISM
      false, //  MBKNIFE
      false, //  MBHEX
      false, //  MBPOLYHEDRON
      false //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr DefEntTypeMap defEdgeTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      true, //  MBEDGE
      false, //  MBTRI
      false, //  MBQUAD
      false, //  MBPOLYGON
      false, //  MBTET
      false, //  MBPYRAMID
      false, //  MBPRISM
      false, //  MBKNIFE
      false, //  MBHEX
      false, //  MBPOLYHEDRON
      false //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr DefEntTypeMap defTriTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      true, //  MBEDGE
      true, //  MBTRI
      false, //  MBQUAD
      false, //  MBPOLYGON
      false, //  MBTET
      false, //  MBPYRAMID
      false, //  MBPRISM
      false, //  MBKNIFE
      false, //  MBHEX
      false, //  MBPOLYHEDRON
      false //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr DefEntTypeMap defQuadTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      true, //  MBEDGE
      false, //  MBTRI
      true, //  MBQUAD
      false, //  MBPOLYGON
      false, //  MBTET
      false, //  MBPYRAMID
      false, //  MBPRISM
      false, //  MBKNIFE
      false, //  MBHEX
      false, //  MBPOLYHEDRON
      false //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr DefEntTypeMap defTetTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      true, //  MBEDGE
      true, //  MBTRI
      false, //  MBQUAD
      false, //  MBPOLYGON
      true, //  MBTET
      false, //  MBPYRAMID
      false, //  MBPRISM
      false, //  MBKNIFE
      false, //  MBHEX
      false, //  MBPOLYHEDRON
      false //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr DefEntTypeMap defHexTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      true, //  MBEDGE
      false, //  MBTRI
      true, //  MBQUAD
      false, //  MBPOLYGON
      false, //  MBTET
      false, //  MBPYRAMID
      false, //  MBPRISM
      false, //  MBKNIFE
      true, //  MBHEX
      false, //  MBPOLYHEDRON
      false //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr DefEntTypeMap defPrismTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      true, //  MBEDGE
      true, //  MBTRI
      true, //  MBQUAD
      false, //  MBPOLYGON
      false, //  MBTET
      false, //  MBPYRAMID
      true, //  MBPRISM
      false, //  MBKNIFE
      false, //  MBHEX
      false, //  MBPOLYHEDRON
      false //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr DefEntTypeMap defMeshsetTypeMap = {
      // clang-format off
      true, //  MBVERTEX
      true, //  MBEDGE
      true, //  MBTRI
      true, //  MBQUAD
      true, //  MBPOLYGON
      true, //  MBTET
      true, //  MBPYRAMID
      true, //  MBPRISM
      true, //  MBKNIFE
      true, //  MBHEX
      true, //  MBPOLYHEDRON
      true //  MBENTITYSET
      // clang-format on
  };
 
  static constexpr std::array<const DefEntTypeMap *, MBMAXTYPE> defTypeMap = {
      // clang-format off
      &defVertexTypeMap, //  MBVERTEX
      &defEdgeTypeMap, //  MBEDGE
      &defTriTypeMap, //  MBTRI
      &defQuadTypeMap, //  MBQUAD
      nullptr, //  MBPOLYGON
      &defTetTypeMap, //  MBTET
      nullptr, //  MBPYRAMID
      &defPrismTypeMap, //  MBPRISM
      nullptr, //  MBKNIFE
      &defHexTypeMap, //  MBHEX
      nullptr, //  MBPOLYHEDRON
      &defMeshsetTypeMap //  MBENTITYSET
      // clang-format on
  };
 
  static inline bool getDefTypeMap(const EntityType fe_type,
                                   const EntityType ent_type) {
    if (auto ptr = defTypeMap[fe_type])
      return (*ptr)[ent_type];
    THROW_MESSAGE("DefTypeMap is not defined by this element. This is propably "
                  "new implementation, and has to be implemented");
    return false;
  }
};
 
/**
 * \brief Inetface for FE
 * \ingroup fe_multi_indices
 */
template <typename FE, typename REFENT>
struct interface_FiniteElementImpl : public interface_RefElement<REFENT> {
 
  interface_FiniteElementImpl(const boost::shared_ptr<FE> fe_ptr,
                              const boost::shared_ptr<REFENT> ref_ents_ptr)
      : interface_RefElement<REFENT>(ref_ents_ptr){};
  virtual ~interface_FiniteElementImpl() = default;
};
 
template <typename FE, typename REFENT>
struct interface_FiniteElement : public interface_RefElement<REFENT> {
  interface_FiniteElement(const boost::shared_ptr<FE> fe_ptr,
                          const boost::shared_ptr<REFENT> ref_ents_ptr)
      : interface_RefElement<REFENT>(ref_ents_ptr), sFiniteElementPtr(fe_ptr){};
 
  virtual ~interface_FiniteElement() = default;
 
  /**
   * @copydoc MoFEM::FiniteElement::getFEUId
   */
  inline const UId &getFEUId() const {
    return getFiniteElementPtr()->getFEUId();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getId
   */
  inline BitFEId getId() const { return getFiniteElementPtr()->getId(); }
 
  /**
   * @copydoc MoFEM::FiniteElement::getMeshset
   */
  inline EntityHandle getMeshset() const {
    return getFiniteElementPtr()->getMeshset();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getNameRef
   */
  inline boost::string_ref getNameRef() const {
    return getFiniteElementPtr()->getNameRef();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getName
   */
  inline std::string getName() const {
    return getFiniteElementPtr()->getName();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitFieldIdCol
   */
  inline BitFieldId getBitFieldIdCol() const {
    return getFiniteElementPtr()->getBitFieldIdCol();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitFieldIdRow
   */
  inline BitFieldId getBitFieldIdRow() const {
    return getFiniteElementPtr()->getBitFieldIdRow();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitFieldIdData
   */
  inline BitFieldId getBitFieldIdData() const {
    return getFiniteElementPtr()->getBitFieldIdData();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitNumber
   */
  inline unsigned int getBitNumber() const {
    return getFiniteElementPtr()->getBitNumber();
  }
 
  inline boost::shared_ptr<FE> &getFiniteElementPtr() const {
    return sFiniteElementPtr;
  }
 
private:
  mutable boost::shared_ptr<FE> sFiniteElementPtr;
};
 
template <typename T>
struct interface_FiniteElement<T, T>
    : public interface_FiniteElementImpl<T, T> {
 
  interface_FiniteElement(const boost::shared_ptr<T> fe_ptr,
                          const boost::shared_ptr<T> ref_ents_ptr)
      : interface_FiniteElementImpl<T, T>(fe_ptr, ref_ents_ptr) {}
 
  /**
   * @copydoc MoFEM::FiniteElement::getFEUId
   */
  inline const UId &getFEUId() const {
    return getFiniteElementPtr()->getFEUId();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getId
   */
  inline BitFEId getId() const { return getFiniteElementPtr()->getId(); }
 
  /**
   * @copydoc MoFEM::FiniteElement::getMeshset
   */
  inline EntityHandle getMeshset() const {
    return getFiniteElementPtr()->getMeshset();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getNameRef
   */
  inline boost::string_ref getNameRef() const {
    return getFiniteElementPtr()->getNameRef();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getName
   */
  inline std::string getName() const {
    return getFiniteElementPtr()->getName();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitFieldIdCol
   */
  inline BitFieldId getBitFieldIdCol() const {
    return getFiniteElementPtr()->getBitFieldIdCol();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitFieldIdRow
   */
  inline BitFieldId getBitFieldIdRow() const {
    return getFiniteElementPtr()->getBitFieldIdRow();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitFieldIdData
   */
  inline BitFieldId getBitFieldIdData() const {
    return getFiniteElementPtr()->getBitFieldIdData();
  }
 
  /**
   * @copydoc MoFEM::FiniteElement::getBitNumber
   */
  inline unsigned int getBitNumber() const {
    return getFiniteElementPtr()->getBitNumber();
  }
 
  inline boost::shared_ptr<FiniteElement> &getFiniteElementPtr() const {
    return boost::static_pointer_cast<T>(this->getRefElement())
        ->getFiniteElementPtr();
  };
};
 
struct EntityCacheDofs {
  std::array<DofEntity_multiIndex::iterator, 2> loHi;
};
 
struct EntityCacheNumeredDofs {
  std::array<NumeredDofEntity_multiIndex::iterator, 2> loHi;
};
 
using CacheTuple = std::tuple<
 
    std::vector<EntityCacheDofs>, std::vector<EntityCacheNumeredDofs>,
    std::vector<EntityCacheNumeredDofs>
 
    >;
 
using CacheTupleWeakPtr = boost::weak_ptr<CacheTuple>;
using CacheTupleSharedPtr = boost::shared_ptr<CacheTuple>;
 
/**
 * \brief Finite element data for entity
 * \ingroup fe_multi_indices
 */
struct EntFiniteElement
    : public interface_FiniteElement<FiniteElement, RefElement> {
 
  using interface_type_RefEntity = interface_RefEntity<RefElement>;
  using interface_type_RefElement = interface_RefElement<RefElement>;
  using interface_type_FiniteElement =
      interface_FiniteElement<FiniteElement, RefElement>;
 
  EntFiniteElement(const boost::shared_ptr<RefElement> &ref_finite_element,
                   const boost::shared_ptr<FiniteElement> &fe_ptr);
  virtual ~EntFiniteElement() = default;
 
  /**
   * \brief Get unique UId for finite element entity
   * @return UId
   */
  inline UId getLocalUniqueId() const { return getLocalUniqueIdCalculate(); }
 
  static inline UId getLocalUniqueIdCalculate(const EntityHandle ent,
                                              UId fe_uid) {
    return fe_uid |= ent;
  }
 
  /**
   * \brief Generate UId for finite element entity
   * @return finite element entity unique Id
   */
  inline UId getLocalUniqueIdCalculate() const {
    return getLocalUniqueIdCalculate(getEnt(), getFEUId());
  }
 
  // TODO: [CORE-61] Get FEDofs by entity type
 
  /**
   * @brief Get the Data Dofs Ptr object
   *
   * @return boost::shared_ptr<FEDofEntity_multiIndex>
   */
  boost::shared_ptr<FEDofEntity_multiIndex> getDataDofsPtr() const;
 
  /**
   * \brief Get data data dos multi-index structure
   * @return Reference multi-index FEDofEntity_multiIndex
   */
  boost::shared_ptr<std::vector<boost::shared_ptr<FEDofEntity>>>
  getDataVectorDofsPtr() const;
 
  inline FieldEntity_vector_view &getDataFieldEnts() const {
    return *getDataFieldEntsPtr();
  };
 
  inline boost::shared_ptr<FieldEntity_vector_view> &
  getDataFieldEntsPtr() const {
    RefEntityTmp<0>::refElementPtr = this->getRefElement();
    return dataFieldEnts;
  };
 
  inline FieldEntity_vector_view &getRowFieldEnts() const {
    return *getRowFieldEntsPtr();
  };
 
  inline boost::shared_ptr<FieldEntity_vector_view> &
  getRowFieldEntsPtr() const {
    RefEntityTmp<0>::refElementPtr = this->getRefElement();
    return rowFieldEnts;
  };
 
  inline FieldEntity_vector_view &getColFieldEnts() const {
    return *getColFieldEntsPtr();
  };
 
  inline boost::shared_ptr<FieldEntity_vector_view> &
  getColFieldEntsPtr() const {
    RefEntityTmp<0>::refElementPtr = this->getRefElement();
    return colFieldEnts;
  };
 
  friend std::ostream &operator<<(std::ostream &os, const EntFiniteElement &e);
 
  template <typename FE_ENTS, typename MOFEM_DOFS, typename MOFEM_DOFS_VIEW,
            typename INSERTER>
  static MoFEMErrorCode
  getDofView(const FE_ENTS &fe_ents_view, const MOFEM_DOFS &mofem_dofs,
             MOFEM_DOFS_VIEW &dofs_view, INSERTER &&inserter) {
    MoFEMFunctionBeginHot;
 
    auto hint = dofs_view.end();
    using ValType = typename std::remove_reference<decltype(**hint)>::type;
 
    for (auto &it : fe_ents_view) {
      if (auto e = it.lock()) {
        const auto &uid = e->getLocalUniqueId();
        auto dit = mofem_dofs.lower_bound(uid);
        if (dit != mofem_dofs.end()) {
          const auto hi_dit = mofem_dofs.upper_bound(
              uid | static_cast<UId>(MAX_DOFS_ON_ENTITY - 1));
          for (; dit != hi_dit; ++dit)
            hint = inserter(dofs_view, hint,
                            boost::reinterpret_pointer_cast<ValType>(*dit));
        }
      }
    }
    MoFEMFunctionReturnHot(0);
  }
 
  template <typename MOFEM_DOFS, typename MOFEM_DOFS_VIEW>
  inline MoFEMErrorCode getRowDofView(const MOFEM_DOFS &mofem_dofs,
                                      MOFEM_DOFS_VIEW &dofs_view) {
 
    auto hint = dofs_view.end();
    using ValType = typename std::remove_reference<decltype(**hint)>::type;
    using IndexType = MOFEM_DOFS_VIEW;
 
    struct Inserter {
      using Idx = IndexType;
      using It = typename Idx::iterator;
      It operator()(Idx &dofs_view, It &hint,
                    boost::shared_ptr<ValType> &&dof) {
        return dofs_view.emplace_hint(hint, dof);
      }
    };
 
    return getDofView(getRowFieldEnts(), mofem_dofs, dofs_view, Inserter());
  }
 
  template <typename MOFEM_DOFS, typename MOFEM_DOFS_VIEW>
  inline MoFEMErrorCode
  getColDofView(const MOFEM_DOFS &mofem_dofs, MOFEM_DOFS_VIEW &dofs_view,
                const int operation_type = moab::Interface::UNION) {
 
    auto hint = dofs_view.end();
    using ValType = typename std::remove_reference<decltype(**hint)>::type;
    using IndexType = MOFEM_DOFS_VIEW;
 
    struct Inserter {
      using Idx = IndexType;
      using It = typename Idx::iterator;
      It operator()(Idx &dofs_view, It &hint,
                    boost::shared_ptr<ValType> &&dof) {
        return dofs_view.emplace_hint(hint, dof);
      }
    };
 
    return getDofView(getColFieldEnts(), mofem_dofs, dofs_view, operation_type);
  }
 
  MoFEMErrorCode getElementAdjacency(const boost::shared_ptr<Field> field_ptr,
                                     std::vector<EntityHandle> &adjacency);
 
private:
  mutable boost::shared_ptr<FieldEntity_vector_view> dataFieldEnts;
  mutable boost::shared_ptr<FieldEntity_vector_view> rowFieldEnts;
  mutable boost::shared_ptr<FieldEntity_vector_view> colFieldEnts;
};
 
/**
 * \brief interface to EntFiniteElement
 * \ingroup fe_multi_indices
 */
template <typename T>
struct interface_EntFiniteElement : public interface_FiniteElement<T, T> {
 
  interface_EntFiniteElement(const boost::shared_ptr<T> &sptr)
      : interface_FiniteElement<T, T>(sptr, sptr) {}
  virtual ~interface_EntFiniteElement() = default;
 
  inline auto getDataDofsPtr() const { return this->sPtr->getDataDofsPtr(); }
 
  inline auto getDataVectorDofsPtr() const {
    return this->sPtr->getDataVectorDofsPtr();
  };
 
  inline FieldEntity_vector_view &getDataFieldEnts() const {
    return this->sPtr->getDataFieldEnts();
  };
 
  inline boost::shared_ptr<FieldEntity_vector_view> &getDataFieldEntsPtr() {
    return this->sPtr->getDataFieldEntsPtr();
  };
 
  inline FieldEntity_vector_view &getRowFieldEnts() const {
    return this->sPtr->getRowFieldEnts();
  };
 
  inline boost::shared_ptr<FieldEntity_vector_view> &
  getRowFieldEntsPtr() const {
    return this->sPtr->getRowFieldEntsPtr();
  }
 
  inline FieldEntity_vector_view &getColFieldEnts() const {
    return this->sPtr->getColFieldEnts();
  };
 
  inline boost::shared_ptr<FieldEntity_vector_view> &
  getColFieldEntsPtr() const {
    return this->sPtr->getColFieldEntsPtr();
  };
 
  /**
   * \brief Get unique UId for finite element entity
   * @return UId
   */
  inline UId getLocalUniqueId() const { return this->sPtr->getLocalUniqueId(); }
 
  SideNumber_multiIndex &getSideNumberTable() const {
    return this->sPtr->getSideNumberTable();
  }
 
  inline MoFEMErrorCode getElementAdjacency(const Field *field_ptr,
                                            Range &adjacency) {
    return this->getElementAdjacency(field_ptr, adjacency);
  }
 
  inline const boost::shared_ptr<RefElement> &getRefElement() const {
    return this->sPtr->getRefElement();
  }
};
 
/** \brief Partitioned (Indexed) Finite Element in Problem
 
  * This type of structure is used to compose problem. Problem is build from
  * indexed finite elements. This data structure carry information about
  * partition, which is specific to problem.
 
 
  * \ingroup fe_multi_indices
 */
struct NumeredEntFiniteElement
    : public interface_EntFiniteElement<EntFiniteElement> {
 
  virtual ~NumeredEntFiniteElement() = default;
 
  using interface_type_FiniteElement =
      interface_FiniteElement<EntFiniteElement, EntFiniteElement>;
  using interface_type_EntFiniteElement =
      interface_EntFiniteElement<EntFiniteElement>;
 
  unsigned int part; ///< Partition number
 
  inline boost::shared_ptr<EntFiniteElement> &getEntFiniteElement() const {
    return this->sPtr;
  }
 
  /**
   * \Construct indexed finite element
   */
  NumeredEntFiniteElement(const boost::shared_ptr<EntFiniteElement> &sptr);
 
  /**
   * \brief Get partition number
   * @return [description]
   */
  inline unsigned int getPart() const { return part; };
 
  /** \brief get FE dof on row
   * \ingroup mofem_dofs
   */
  boost::shared_ptr<FENumeredDofEntity_multiIndex> getRowDofsPtr() const;
 
  /** \brief get FE dof on column
   * \ingroup mofem_dofs
   */
  boost::shared_ptr<FENumeredDofEntity_multiIndex> getColDofsPtr() const;
 
  /** \brief get FE dof by petsc index
   * \ingroup mofem_dofs
   */
  boost::weak_ptr<FENumeredDofEntity>
  getRowDofsByPetscGlobalDofIdx(const int idx) const;
 
  /** \brief get FE dof by petsc index
   * \ingroup mofem_dofs
   */
  boost::weak_ptr<FENumeredDofEntity>
  getColDofsByPetscGlobalDofIdx(const int idx) const;
 
  friend std::ostream &operator<<(std::ostream &os,
                                  const NumeredEntFiniteElement &e);
};
 
/**
 * @relates multi_index_container
 * \brief MultiIndex container for EntFiniteElement
 * \ingroup fe_multi_indices
 *
 */
using EntFiniteElement_multiIndex = multi_index_container<
    boost::shared_ptr<EntFiniteElement>,
    indexed_by<
 
        ordered_unique<tag<Unique_mi_tag>,
                       const_mem_fun<EntFiniteElement, UId,
                                     &EntFiniteElement::getLocalUniqueId>>,
 
        ordered_non_unique<
            tag<Ent_mi_tag>,
            const_mem_fun<EntFiniteElement::interface_type_RefEntity,
                          EntityHandle, &EntFiniteElement::getEnt>>
 
        >>;
 
/**
  @relates multi_index_container
  \brief MultiIndex for entities for NumeredEntFiniteElement
  \ingroup fe_multi_indices
 */
using NumeredEntFiniteElement_multiIndex = multi_index_container<
    boost::shared_ptr<NumeredEntFiniteElement>,
    indexed_by<
        ordered_unique<
            tag<Unique_mi_tag>,
            const_mem_fun<
                NumeredEntFiniteElement::interface_type_EntFiniteElement, UId,
                &NumeredEntFiniteElement::getLocalUniqueId>>,
        ordered_non_unique<tag<Part_mi_tag>,
                           member<NumeredEntFiniteElement, unsigned int,
                                  &NumeredEntFiniteElement::part>>,
        ordered_non_unique<
            tag<Ent_mi_tag>,
            const_mem_fun<NumeredEntFiniteElement::interface_type_RefEntity,
                          EntityHandle, &NumeredEntFiniteElement::getEnt>>,
        ordered_non_unique<
            tag<Composite_Name_And_Part_mi_tag>,
            composite_key<
                NumeredEntFiniteElement,
                const_mem_fun<
                    NumeredEntFiniteElement::interface_type_FiniteElement,
                    boost::string_ref, &NumeredEntFiniteElement::getNameRef>,
                member<NumeredEntFiniteElement, unsigned int,
                       &NumeredEntFiniteElement::part>>>>>;
 
/**
  @relates multi_index_container
  \brief MultiIndex for entities for FiniteElement
  \ingroup fe_multi_indices
 */
typedef multi_index_container<
    boost::shared_ptr<FiniteElement>,
    indexed_by<hashed_unique<tag<FiniteElement_Meshset_mi_tag>,
                             member<FiniteElement, EntityHandle,
                                    &FiniteElement::meshset>>,
               hashed_unique<
                   tag<BitFEId_mi_tag>,
                   const_mem_fun<FiniteElement, BitFEId, &FiniteElement::getId>,
                   HashBit<BitFEId>, EqBit<BitFEId>>,
               ordered_unique<tag<FiniteElement_name_mi_tag>,
                              const_mem_fun<FiniteElement, boost::string_ref,
                                            &FiniteElement::getNameRef>>>>
    FiniteElement_multiIndex;
 
// modificators
 
/**
 * \brief Change finite element part
 *
 * \ingroup fe_multi_indices
 */
struct NumeredEntFiniteElement_change_part {
  unsigned int pArt;
  NumeredEntFiniteElement_change_part(unsigned int part) : pArt(part){};
  void operator()(boost::shared_ptr<NumeredEntFiniteElement> &fe) {
    fe->part = pArt;
  }
  void operator()(NumeredEntFiniteElement &fe) { fe.part = pArt; }
};
 
/**
 * \brief Add field to column
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_col_change_bit_add {
  BitFieldId fIdCol;
  FiniteElement_col_change_bit_add(const BitFieldId f_id_col)
      : fIdCol(f_id_col){};
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Add field to row
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_row_change_bit_add {
  BitFieldId fIdRow;
  FiniteElement_row_change_bit_add(const BitFieldId f_id_row)
      : fIdRow(f_id_row){};
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Add field to data
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_change_bit_add {
  BitFieldId fIdData;
  FiniteElement_change_bit_add(const BitFieldId f_id_data)
      : fIdData(f_id_data){};
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Unset field from column
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_col_change_bit_off {
  BitFieldId fIdCol;
  FiniteElement_col_change_bit_off(const BitFieldId f_id_col)
      : fIdCol(f_id_col){};
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Unset field from row
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_row_change_bit_off {
  BitFieldId fIdRow;
  FiniteElement_row_change_bit_off(const BitFieldId f_id_row)
      : fIdRow(f_id_row){};
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Unset field from data
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_change_bit_off {
  BitFieldId fIdData;
  FiniteElement_change_bit_off(const BitFieldId f_id_data)
      : fIdData(f_id_data){};
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Reset field from column
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_col_change_bit_reset {
  FiniteElement_col_change_bit_reset() = default;
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Reset field from row
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_row_change_bit_reset {
  FiniteElement_row_change_bit_reset() = default;
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
/**
 * \brief Reset field from data
 *
 * \ingroup fe_multi_indices
 */
struct FiniteElement_change_bit_reset {
  FiniteElement_change_bit_reset() = default;
  void operator()(boost::shared_ptr<FiniteElement> &fe);
};
 
} // namespace MoFEM
 
#endif // __FEMMULTIINDICES_HPP__
 
/**
 * \defgroup fe_multi_indices Finite elements structures and multi-indices
 * \ingroup mofem
 **/