DofsMultiIndices.hpp

Go to the documentation of this file.

/** \file DofsMultiIndices.hpp
 * \ingroup dof_multi_indices
 * \brief Multi-Index contains, data structures for mofem dofs and other
 * low-level functions
 */

/* MoFEM is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.

 * MoFEM 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 Lesser General Public
 * License for more details.

 * You should have received a copy of the GNU Lesser General Public
 * License along with MoFEM. If not, see <http://www.gnu.org/licenses/>
*/

#ifndef __DOFSMULTIINDICES_HPP__
#define __DOFSMULTIINDICES_HPP__

namespace MoFEM {

/**
 * \brief keeps information about DOF on the entity
 * \ingroup dof_multi_indices
 */
struct DofEntity : public interface_FieldEntity<FieldEntity> {

  typedef interface_Field<FieldEntity> interface_type_Field;
  typedef interface_FieldEntity<FieldEntity> interface_type_FieldEntity;
  typedef interface_RefEntity<FieldEntity> interface_type_RefEntity;

  static inline UId getGlobalUniqueIdCalculate(const DofIdx dof,
                                               const UId &ent_uid) {
    // if(dof>=512) THROW_MESSAGE("_dof>=512");
    return static_cast<UId>(dof) | ent_uid;
  }

  /**
   * \brief Calculate UId for DOF
   *
   * UId is constructed such that all DOFs are ordered by processor, entity,
   * field and dof index on entity, On entity dofs index is constructed such
   * that coefficient number and dofs increase with dofs index on entity.
   *
   * @param  dof     dof index on entity
   * @param  ent_ptr pointer to field entity
   * @return         UId
   */
  static inline UId
  getGlobalUniqueIdCalculate(const DofIdx dof,
                             const boost::shared_ptr<FieldEntity> &ent_ptr) {
    return getGlobalUniqueIdCalculate(dof, ent_ptr->getGlobalUniqueId());
  }

  static inline UId getGlobalUniqueIdCalculate_Low_Proc(const int owner_proc) {
    return static_cast<UId>(owner_proc) << 9 + 5 + 8 * sizeof(EntityHandle);
  }

  static inline UId getGlobalUniqueIdCalculate_Hi_Proc(const int owner_proc) {
    return static_cast<UId>(MBMAXTYPE) << 9 |
           static_cast<UId>(BITFIELDID_SIZE - 1)
               << 9 + 8 * sizeof(EntityHandle) |
           static_cast<UId>(owner_proc) << 9 + 5 + 8 * sizeof(EntityHandle);
  }

  static inline ShortId
  getNonNonuniqueShortId(const DofIdx dof,
                         const boost::shared_ptr<FieldEntity> &ent_ptr) {
    // if(sizeof(ShortId) < sizeof(char)+2) THROW_MESSAGE("sizeof(ShortId)<
    // sizeof(char)+2")
    return static_cast<ShortId>(dof) |
           (static_cast<ShortId>(ent_ptr->getBitNumber()) << 9);
  }

  bool active;   ///< true if dof is active
  UId globalUId; ///< global unique id for this dof

  DofEntity(const boost::shared_ptr<FieldEntity> &entity_ptr,
            const ApproximationOrder dof_order,
            const FieldCoefficientsNumber dof_rank, const DofIdx dof,
            const bool is_active = false);

  /// @return get dof index on entity
  inline DofIdx getEntDofIdx() const {
    DofIdx dof;
    memcpy(&dof, &globalUId, 2);
    return DOF_UID_MASK_ON_ENTITY & dof;
  }

  /// @return get field data on dof
  inline FieldData &getFieldData() const {
    return const_cast<FieldData &>(
        this->sPtr->getEntFieldData().data()[getEntDofIdx()]);
  }

  /// @return get unique dof id
  inline UId getGlobalUniqueId() const { return globalUId; }

  /// @return get entity unique dof id
  inline UId getEntGlobalUniqueId() const {
    return this->sPtr->getGlobalUniqueId();
  }

  /** \brief get short uid it is unique in combination with entity handle
   *
   * EntityHandle are controlled by MOAB, which is unique in
   * MOAB instance. However two MOAB instances, can have attached different
   * EntityHandles to the same entity.
   *
   * Relation between MoAB EntityHandle can be handled by saving entity handle
   * data into tag, see MB_TYPE_HANDLE. MOAB at time of file reading or
   * creating new MOAB instance, substitute tag value by approbate entity
   * handle.
   *
   * ShortId is created to handle problems related to saving data series, and
   * reading those data using different MoAB instances.
   *
   */
  inline ShortId getNonNonuniqueShortId() const {
    return getNonNonuniqueShortId(getEntDofIdx(), getFieldEntityPtr());
  }

  /// @return get dof entity handle
  inline EntityHandle getEnt() const { return this->sPtr->getEnt(); }

  /// @return get dof approximation order
  inline ApproximationOrder getDofOrder() const {
    return getDofOrderMap()[getEntDofIdx()];
  }

  /// @return get dof coefficient index
  inline FieldCoefficientsNumber getDofCoeffIdx() const {
    return getEntDofIdx() % getNbOfCoeffs();
  }

  /// @return return true if dof us active
  inline char getActive() const { return active ? 1 : 0; }

  friend std::ostream &operator<<(std::ostream &os, const DofEntity &e);
};

/**
 * \brief Interface to DofEntity
 *
 * In MoFEM DOFs classes (and Ent and Finite Element classes) are derived by
 * interface, i.e. not class is derived but interface to it.
 *
 * \ingroup dof_multi_indices
 */
template <typename T>
struct interface_DofEntity : public interface_FieldEntity<T> {

  interface_DofEntity(const boost::shared_ptr<T> &sptr)
      : interface_FieldEntity<T>(sptr) {}

  /// @return return dof unique id
  inline const UId getGlobalUniqueId() const {
    return this->sPtr->getGlobalUniqueId();
  }

  /// @return return entity unique id
  inline const UId getEntGlobalUniqueId() const {
    return this->sPtr->getEntGlobalUniqueId();
  }

  /// @return return short id (used by data recorder)
  inline ShortId getNonNonuniqueShortId() const {
    return this->sPtr->getNonNonuniqueShortId();
  }

  /// @return return index of dof on the entity
  inline DofIdx getEntDofIdx() const { return this->sPtr->getEntDofIdx(); }

  /// @return return data on dof
  inline FieldData &getFieldData() const { return this->sPtr->getFieldData(); }

  /// @return return entity handle
  inline EntityHandle getEnt() const { return this->sPtr->getEnt(); }

  /// @return get dof approximation order
  inline ApproximationOrder getDofOrder() const {
    return this->sPtr->getDofOrder();
  }

  /// @return get dof coefficient index
  inline FieldCoefficientsNumber getDofCoeffIdx() const {
    return this->sPtr->getDofCoeffIdx();
  }

  /// @return return true if dof is active
  inline char getActive() const { return this->sPtr->getActive(); }

  /// @return get pointer to dof data structure
  inline boost::shared_ptr<DofEntity> &getDofEntityPtr() const {
    return this->sPtr;
  }

  /// @return get pioneer do dof's entity data structure
  inline boost::shared_ptr<FieldEntity> &getFieldEntityPtr() const {
    return this->sPtr->getFieldEntityPtr();
  }

  // /// \deprecated use getFieldEntityPtr instead
  // DEPRECATED inline boost::shared_ptr<FieldEntity>& getMoFEMEntityPtr() const
  // {
  //   return getFieldEntityPtr();
  // }
};

/**
 * \brief keeps information about indexed dofs for the problem
 * \ingroup dof_multi_indices
 *
 * FIXME: Is too many iterator, this has to be manage more efficiently, some
 * iterators could be moved to multi_indices views.
 *
 */
struct NumeredDofEntity : public interface_DofEntity<DofEntity> {

  typedef interface_Field<DofEntity> interface_type_Field;
  typedef interface_FieldEntity<DofEntity> interface_type_FieldEntity;
  typedef interface_DofEntity<DofEntity> interface_type_DofEntity;
  DofIdx dofIdx;
  DofIdx petscGloablDofIdx;
  DofIdx petscLocalDofIdx;
  unsigned int pArt;

  /// @return MoFEM DoF index
  inline DofIdx getDofIdx() const { return dofIdx; }

  /// @return PETSc global DoF index
  inline DofIdx getPetscGlobalDofIdx() const { return petscGloablDofIdx; }

  /// @return PETSc local DoF index
  inline DofIdx getPetscLocalDofIdx() const { return petscLocalDofIdx; }

  /// @return Owning partition (i.e. process/processor)
  inline unsigned int getPart() const { return pArt; }

  /// @return True if local index is set
  inline bool getHasLocalIndex() const {
    return !std::signbit(petscLocalDofIdx);
  }

  NumeredDofEntity(const boost::shared_ptr<DofEntity> &dof_entity_ptr,
                   const int dof_idx = -1, const int petsc_gloabl_dof_idx = -1,
                   const int petsc_local_dof_idx = -1, const int part = -1);
  friend std::ostream &operator<<(std::ostream &os, const NumeredDofEntity &e);
};

/**
 * \brief interface to NumeredDofEntity
 * \ingroup dof_multi_indices
 */
template <typename T>
struct interface_NumeredDofEntity : public interface_DofEntity<T> {

  interface_NumeredDofEntity(const boost::shared_ptr<T> &sptr)
      : interface_DofEntity<T>(sptr){};

  /// @return get dof index on entity
  inline DofIdx getDofIdx() const { return this->sPtr->getDofIdx(); }

  /// @return get petsc global index on entity
  inline DofIdx getPetscGlobalDofIdx() const {
    return this->sPtr->getPetscGlobalDofIdx();
  }

  /// @return get pe
  inline DofIdx getPetscLocalDofIdx() const {
    return this->sPtr->getPetscLocalDofIdx();
  }

  inline unsigned int getPart() const { return this->sPtr->getPart(); }

  inline bool getHasLocalIndex() const {
    return this->sPtr->getHasLocalIndex();
  }

  inline boost::shared_ptr<NumeredDofEntity> &getNumeredDofEntityPtr() const {
    return this->sPtr;
  };
};

/**
 * \brief keeps basic information about indexed dofs for the finite element
 */
struct BaseFEDofEntity {
  BaseFEDofEntity(const boost::shared_ptr<SideNumber> &side_number_ptr)
      : sideNumberPtr(side_number_ptr){};
  boost::shared_ptr<SideNumber> sideNumberPtr;
  inline int getSideNumber() { return sideNumberPtr->side_number; }
};

/**
 * \brief keeps information about indexed dofs for the finite element
 * \ingroup dof_multi_indices
 */
struct FEDofEntity : public BaseFEDofEntity, interface_DofEntity<DofEntity> {
  typedef interface_Field<DofEntity> interface_type_Field;
  typedef interface_DofEntity<DofEntity> interface_type_DofEntity;
  typedef interface_RefEntity<DofEntity> interface_type_RefEntity;
  FEDofEntity(const boost::shared_ptr<SideNumber> &side_number_ptr,
              const boost::shared_ptr<DofEntity> &dof_ptr);
  FEDofEntity(const boost::tuple<const boost::shared_ptr<SideNumber> &,
                                 const boost::shared_ptr<DofEntity> &> &t);
  friend std::ostream &operator<<(std::ostream &os, const FEDofEntity &e);
};

/**
 * \brief keeps information about indexed dofs for the finite element
 * \ingroup dof_multi_indices
 */
struct FENumeredDofEntity : public BaseFEDofEntity,
                            interface_NumeredDofEntity<NumeredDofEntity> {
  typedef interface_Field<NumeredDofEntity> interface_type_Field;
  typedef interface_DofEntity<NumeredDofEntity> interface_type_DofEntity;
  typedef interface_RefEntity<NumeredDofEntity> interface_type_RefEntity;
  typedef interface_NumeredDofEntity<NumeredDofEntity>
      interface_type_NumeredDofEntity;
  FENumeredDofEntity(const boost::shared_ptr<SideNumber> &side_number_ptr,
                     const boost::shared_ptr<NumeredDofEntity> &dof_ptr);
  FENumeredDofEntity(
      const boost::tuple<const boost::shared_ptr<SideNumber> &,
                         const boost::shared_ptr<NumeredDofEntity> &> &t);
  friend std::ostream &operator<<(std::ostream &os,
                                  const FENumeredDofEntity &e);
};

/**
 * @relates multi_index_container
 * \brief MultiIndex container keeps DofEntity
 * \ingroup dof_multi_indices
 */
typedef multi_index_container<
    boost::shared_ptr<DofEntity>,
    indexed_by<
        // unique
        ordered_unique<
            tag<Unique_mi_tag>,
            const_mem_fun<DofEntity, UId, &DofEntity::getGlobalUniqueId> >,
        // non_unique
        ordered_non_unique<
            tag<Composite_Ent_and_ShortId_mi_tag>,
            composite_key<
                DofEntity,
                const_mem_fun<DofEntity, EntityHandle, &DofEntity::getEnt>,
                const_mem_fun<DofEntity, ShortId,
                              &DofEntity::getNonNonuniqueShortId> > >,
        ordered_non_unique<
            tag<Composite_Name_And_Ent_And_EntDofIdx_mi_tag>,
            composite_key<
                DofEntity,
                const_mem_fun<DofEntity::interface_type_Field,
                              boost::string_ref, &DofEntity::getNameRef>,
                const_mem_fun<DofEntity, EntityHandle, &DofEntity::getEnt>,
                const_mem_fun<DofEntity, DofIdx, &DofEntity::getEntDofIdx> > >,
        ordered_non_unique<
            tag<Unique_Ent_mi_tag>,
            const_mem_fun<DofEntity, UId, &DofEntity::getEntGlobalUniqueId> >,
        ordered_non_unique<
            tag<FieldName_mi_tag>,
            const_mem_fun<DofEntity::interface_type_Field, boost::string_ref,
                          &DofEntity::getNameRef> >,
        ordered_non_unique<
            tag<Ent_mi_tag>,
            const_mem_fun<DofEntity, EntityHandle, &DofEntity::getEnt> >,
        ordered_non_unique<
            tag<Composite_Name_And_Ent_mi_tag>,
            composite_key<
                DofEntity,
                const_mem_fun<DofEntity::interface_type_Field,
                              boost::string_ref, &DofEntity::getNameRef>,
                const_mem_fun<DofEntity, EntityHandle, &DofEntity::getEnt> > >,
        ordered_non_unique<
            tag<Composite_Name_And_Type_mi_tag>,
            composite_key<
                DofEntity,
                const_mem_fun<DofEntity::interface_type_Field,
                              boost::string_ref, &DofEntity::getNameRef>,
                const_mem_fun<DofEntity::interface_type_RefEntity, EntityType,
                              &DofEntity::getEntType> > >,
        ordered_non_unique<
            tag<Composite_Name_Ent_Order_And_CoeffIdx_mi_tag>,
            composite_key<
                DofEntity,
                const_mem_fun<DofEntity::interface_type_Field,
                              boost::string_ref, &DofEntity::getNameRef>,
                const_mem_fun<DofEntity, EntityHandle, &DofEntity::getEnt>,
                const_mem_fun<DofEntity, ApproximationOrder,
                              &DofEntity::getDofOrder>,
                const_mem_fun<DofEntity, FieldCoefficientsNumber,
                              &DofEntity::getDofCoeffIdx> > > > >
    DofEntity_multiIndex;

/** \brief Dof multi-index by field name
 *
 * \ingroup dof_multi_indices
 */
typedef DofEntity_multiIndex::index<FieldName_mi_tag>::type
    DofEntityByFieldName;

/** \brief Dof multi-index by entity
 *
 * \ingroup dof_multi_indices
 */
typedef DofEntity_multiIndex::index<Ent_mi_tag>::type DofEntityByEnt;

/** \brief Dof multi-index by field name and entity
 *
 * \ingroup dof_multi_indices
 */
typedef DofEntity_multiIndex::index<Composite_Name_And_Ent_mi_tag>::type
    DofEntityByNameAndEnt;

/** \brief Dof multi-index by field name and entity type
 *
 * \ingroup dof_multi_indices
 */
typedef DofEntity_multiIndex::index<Composite_Name_And_Type_mi_tag>::type
    DofEntityByNameAndType;

/** \brief multi-index view on DofEntity by uid
  \ingroup dof_multi_indices
*/
typedef multi_index_container<
    boost::shared_ptr<DofEntity>,
    indexed_by<ordered_unique<
        const_mem_fun<DofEntity, UId, &DofEntity::getGlobalUniqueId> > > >
    DofEntity_multiIndex_uid_view;

/** \brief multi-index view on DofEntity activity
  \ingroup dof_multi_indices
*/
typedef multi_index_container<
    boost::shared_ptr<DofEntity>,
    indexed_by<ordered_unique<const_mem_fun<DofEntity, UId,
                                            &DofEntity::getGlobalUniqueId> >,
               ordered_non_unique<
                   const_mem_fun<DofEntity, char, &DofEntity::getActive> > > >
    DofEntity_multiIndex_active_view;

/**
 * @relates multi_index_container
 * \brief MultiIndex container keeps FEDofEntity
 * \ingroup dof_multi_indices

 */
typedef multi_index_container<
    boost::shared_ptr<FEDofEntity>,
    indexed_by<
        ordered_unique<
            tag<Unique_mi_tag>,
            const_mem_fun<FEDofEntity::interface_type_DofEntity, const UId,
                          &FEDofEntity::getGlobalUniqueId> >,
        ordered_non_unique<tag<Ent_mi_tag>,
                           const_mem_fun<FEDofEntity::interface_type_DofEntity,
                                         EntityHandle, &FEDofEntity::getEnt> >,
        ordered_non_unique<
            tag<FieldName_mi_tag>,
            const_mem_fun<FEDofEntity::interface_type_Field, boost::string_ref,
                          &FEDofEntity::getNameRef> >,
        ordered_non_unique<
            tag<EntType_mi_tag>,
            const_mem_fun<FEDofEntity::interface_type_RefEntity, EntityType,
                          &FEDofEntity::getEntType> >,
        ordered_non_unique<
            tag<Composite_Name_And_Type_mi_tag>,
            composite_key<
                FEDofEntity,
                const_mem_fun<FEDofEntity::interface_type_Field,
                              boost::string_ref, &FEDofEntity::getNameRef>,
                const_mem_fun<FEDofEntity::interface_type_RefEntity, EntityType,
                              &FEDofEntity::getEntType> > >,
        ordered_non_unique<
            tag<Composite_Name_And_Ent_mi_tag>,
            composite_key<
                FEDofEntity,
                const_mem_fun<FEDofEntity::interface_type_Field,
                              boost::string_ref, &FEDofEntity::getNameRef>,
                const_mem_fun<FEDofEntity::interface_type_DofEntity,
                              EntityHandle, &FEDofEntity::getEnt> > >,
        // This is only useed by obsolete modules, should be removed with 
        // brother of cephs, i.e. Pawel.                              
        ordered_non_unique<
            tag<Composite_Name_Type_And_Side_Number_mi_tag>,
            composite_key<
                FEDofEntity,
                const_mem_fun<FEDofEntity::interface_type_Field,
                              boost::string_ref, &FEDofEntity::getNameRef>,
                const_mem_fun<FEDofEntity::interface_type_RefEntity, EntityType,
                              &FEDofEntity::getEntType>,
                KeyFromKey<member<SideNumber, char, &SideNumber::side_number>,
                           member<FEDofEntity::BaseFEDofEntity,
                                  boost::shared_ptr<SideNumber>,
                                  &FEDofEntity::sideNumberPtr> > > >,
        ordered_non_unique<
            tag<Composite_EntType_and_Space_mi_tag>,
            composite_key<
                FEDofEntity,
                const_mem_fun<FEDofEntity::interface_type_RefEntity, EntityType,
                              &FEDofEntity::getEntType>,
                const_mem_fun<FEDofEntity::interface_type_Field, FieldSpace,
                              &FEDofEntity::getSpace> > > > >
    FEDofEntity_multiIndex;

/** \brief Finite element DoF multi-index by field name
 *
 * \ingroup dof_multi_indices
 */
typedef FEDofEntity_multiIndex::index<FieldName_mi_tag>::type
    FEDofEntityByFieldName;

/** \brief Dof entity multi-index by field name and entity
 *
 * \ingroup dof_multi_indices
 */
typedef FEDofEntity_multiIndex::index<Composite_Name_And_Ent_mi_tag>::type
    FEDofEntityByNameAndEnt;

/** \brief Dof entity multi-index by field name and entity type
 *
 * \ingroup dof_multi_indices
 */
typedef FEDofEntity_multiIndex::index<Composite_Name_And_Type_mi_tag>::type
    FEDofEntityByNameAndType;

/**
 * @relates multi_index_container
 * \brief MultiIndex container keeps FENumeredDofEntity

 * \ingroup dof_multi_indices
 */
typedef multi_index_container<
    boost::shared_ptr<FENumeredDofEntity>,
    indexed_by<
        ordered_unique<
            tag<Unique_mi_tag>,
            const_mem_fun<FENumeredDofEntity::interface_type_DofEntity,
                          const UId, &FENumeredDofEntity::getGlobalUniqueId> >,
        ordered_non_unique<
            tag<Ent_mi_tag>,
            const_mem_fun<FENumeredDofEntity::interface_type_DofEntity,
                          EntityHandle, &FENumeredDofEntity::getEnt> >,
        ordered_non_unique<
            tag<FieldName_mi_tag>,
            const_mem_fun<FENumeredDofEntity::interface_type_Field,
                          boost::string_ref, &FENumeredDofEntity::getNameRef> >,
        ordered_non_unique<
            tag<PetscGlobalIdx_mi_tag>,
            const_mem_fun<FENumeredDofEntity::interface_type_NumeredDofEntity,
                          DofIdx, &FENumeredDofEntity::getPetscGlobalDofIdx> >,
        ordered_non_unique<
            tag<Composite_Name_Type_And_Side_Number_mi_tag>,
            composite_key<
                FENumeredDofEntity,
                const_mem_fun<FENumeredDofEntity::interface_type_Field,
                              boost::string_ref,
                              &FENumeredDofEntity::getNameRef>,
                const_mem_fun<FENumeredDofEntity::interface_type_RefEntity,
                              EntityType, &FENumeredDofEntity::getEntType>,
                KeyFromKey<member<SideNumber, char, &SideNumber::side_number>,
                           member<FENumeredDofEntity::BaseFEDofEntity,
                                  boost::shared_ptr<SideNumber>,
                                  &FENumeredDofEntity::sideNumberPtr> > > >,
        ordered_non_unique<
            tag<Composite_Name_And_Type_mi_tag>,
            composite_key<
                FENumeredDofEntity,
                const_mem_fun<FENumeredDofEntity::interface_type_Field,
                              boost::string_ref,
                              &FENumeredDofEntity::getNameRef>,
                const_mem_fun<FENumeredDofEntity::interface_type_RefEntity,
                              EntityType, &FENumeredDofEntity::getEntType> > >,
        ordered_non_unique<
            tag<Composite_Name_And_Ent_mi_tag>,
            composite_key<
                FENumeredDofEntity,
                const_mem_fun<FENumeredDofEntity::interface_type_Field,
                              boost::string_ref,
                              &FENumeredDofEntity::getNameRef>,
                const_mem_fun<FENumeredDofEntity::interface_type_DofEntity,
                              EntityHandle, &FENumeredDofEntity::getEnt> > > > >
    FENumeredDofEntity_multiIndex;

/** \brief Finite element numbered DoF multi-index by field name
 *
 * \ingroup dof_multi_indices
 */
typedef FENumeredDofEntity_multiIndex::index<FieldName_mi_tag>::type
    FENumeredDofEntityByFieldName;

/** \brief Dof entity multi-index by field name and entity
 *
 * \ingroup dof_multi_indices
 */
typedef FENumeredDofEntity_multiIndex::index<
    Composite_Name_And_Ent_mi_tag>::type FENumeredDofEntityByNameAndEnt;

/** \brief Dof entity multi-index by field name and entity type
 *
 * \ingroup dof_multi_indices
 */
typedef FENumeredDofEntity_multiIndex::index<
    Composite_Name_And_Type_mi_tag>::type FENumeredDofEntityByNameAndType;

/** \brief Dof entity multi-index by UId
 *
 * \ingroup dof_multi_indices
 */
typedef FENumeredDofEntity_multiIndex::index<Unique_mi_tag>::type
    FENumeredDofEntityByUId;

/** \brief Numbered DoF multi-index by entity
 *
 * \ingroup dof_multi_indices
 */
typedef FENumeredDofEntity_multiIndex::index<Ent_mi_tag>::type
    FENumeredDofEntityByEnt;

/**
 * @relates multi_index_container
 * \brief MultiIndex container keeps NumeredDofEntity
 * \ingroup dof_multi_indices
 */
typedef multi_index_container<
    boost::shared_ptr<NumeredDofEntity>,
    // unique
    indexed_by<
        ordered_unique<
            tag<Unique_mi_tag>,
            const_mem_fun<NumeredDofEntity::interface_type_DofEntity, const UId,
                          &NumeredDofEntity::getGlobalUniqueId> >,
        // non unique
        ordered_non_unique<
            tag<Composite_Name_And_Ent_And_EntDofIdx_mi_tag>,
            composite_key<
                NumeredDofEntity,
                const_mem_fun<NumeredDofEntity::interface_type_Field,
                              boost::string_ref, &NumeredDofEntity::getNameRef>,
                const_mem_fun<NumeredDofEntity::interface_type_DofEntity,
                              EntityHandle, &NumeredDofEntity::getEnt>,
                const_mem_fun<NumeredDofEntity::interface_type_DofEntity,
                              DofIdx, &NumeredDofEntity::getEntDofIdx> > >,
        // ordered_non_unique<
        //   tag<EntDofIdx_mi_tag>,
        //   const_mem_fun<NumeredDofEntity::interface_type_DofEntity,DofIdx,&NumeredDofEntity::getEntDofIdx>
        //   >,
        ordered_non_unique<tag<Idx_mi_tag>, member<NumeredDofEntity, DofIdx,
                                                   &NumeredDofEntity::dofIdx> >,
        ordered_non_unique<
            tag<FieldName_mi_tag>,
            const_mem_fun<NumeredDofEntity::interface_type_Field,
                          boost::string_ref, &NumeredDofEntity::getNameRef> >,
        ordered_non_unique<tag<PetscGlobalIdx_mi_tag>,
                           member<NumeredDofEntity, DofIdx,
                                  &NumeredDofEntity::petscGloablDofIdx> >,
        ordered_non_unique<tag<PetscLocalIdx_mi_tag>,
                           member<NumeredDofEntity, DofIdx,
                                  &NumeredDofEntity::petscLocalDofIdx> >,
        ordered_non_unique<
            tag<Ent_mi_tag>,
            const_mem_fun<NumeredDofEntity::interface_type_DofEntity,
                          EntityHandle, &NumeredDofEntity::getEnt> >,
        ordered_non_unique<
            tag<Order_mi_tag>,
            const_mem_fun<NumeredDofEntity::interface_type_DofEntity,
                          ApproximationOrder, &NumeredDofEntity::getDofOrder> >,
        ordered_non_unique<
            tag<Composite_Part_And_Order_mi_tag>,
            composite_key<
                NumeredDofEntity,
                member<NumeredDofEntity, unsigned int, &NumeredDofEntity::pArt>,
                const_mem_fun<NumeredDofEntity::interface_type_DofEntity,
                              ApproximationOrder,
                              &NumeredDofEntity::getDofOrder> > >,
        ordered_non_unique<
            tag<Composite_Name_And_Part_mi_tag>,
            composite_key<
                NumeredDofEntity,
                const_mem_fun<NumeredDofEntity::interface_type_Field,
                              boost::string_ref, &NumeredDofEntity::getNameRef>,
                member<NumeredDofEntity, unsigned int,
                       &NumeredDofEntity::pArt> > >,
        ordered_non_unique<
            tag<Composite_Name_Ent_And_Part_mi_tag>,
            composite_key<
                NumeredDofEntity,
                const_mem_fun<NumeredDofEntity::interface_type_Field,
                              boost::string_ref, &NumeredDofEntity::getNameRef>,
                const_mem_fun<NumeredDofEntity::interface_type_DofEntity,
                              EntityHandle, &NumeredDofEntity::getEnt>,
                member<NumeredDofEntity, unsigned int,
                       &NumeredDofEntity::pArt> > > > >
    NumeredDofEntity_multiIndex;

/** \brief Numbered DoF multi-index by field name
 *
 * \ingroup dof_multi_indices
 */
typedef NumeredDofEntity_multiIndex::index<FieldName_mi_tag>::type
    NumeredDofEntityByFieldName;

/** \brief Numbered DoF multi-index by UId
 *
 * \ingroup dof_multi_indices
 */
typedef NumeredDofEntity_multiIndex::index<Unique_mi_tag>::type
    NumeredDofEntityByUId;

/** \brief Numbered DoF multi-index by local index
 *
 * \ingroup dof_multi_indices
 */
typedef NumeredDofEntity_multiIndex::index<PetscLocalIdx_mi_tag>::type
    NumeredDofEntityByLocalIdx;

/** \brief Numbered DoF multi-index by entity
 *
 * \ingroup dof_multi_indices
 */
typedef NumeredDofEntity_multiIndex::index<Ent_mi_tag>::type
    NumeredDofEntityByEnt;

/** \brief Numbered DoF multi-index by name entity and partition
 *
 * \ingroup dof_multi_indices
 */
typedef NumeredDofEntity_multiIndex::index<
    Composite_Name_Ent_And_Part_mi_tag>::type NumeredDofEntityByNameEntAndPart;

typedef multi_index_container<
    boost::shared_ptr<NumeredDofEntity>,
    indexed_by<ordered_unique<
        const_mem_fun<NumeredDofEntity::interface_type_DofEntity, const UId,
                      &NumeredDofEntity::getGlobalUniqueId> > > >
    NumeredDofEntity_multiIndex_uid_view_ordered;

typedef multi_index_container<
    boost::shared_ptr<NumeredDofEntity>,
    indexed_by<hashed_unique<const_mem_fun<NumeredDofEntity, DofIdx,
                                           &NumeredDofEntity::getDofIdx> > > >
    NumeredDofEntity_multiIndex_idx_view_hashed;

typedef multi_index_container<
    boost::shared_ptr<NumeredDofEntity>,
    indexed_by<ordered_non_unique<const_mem_fun<
        NumeredDofEntity, DofIdx, &NumeredDofEntity::getPetscLocalDofIdx> > > >
    NumeredDofEntity_multiIndex_petsc_local_dof_view_ordered_non_unique;

typedef multi_index_container<
    boost::shared_ptr<NumeredDofEntity>,
    indexed_by<ordered_non_unique<const_mem_fun<
        NumeredDofEntity, DofIdx, &NumeredDofEntity::getPetscGlobalDofIdx> > > >
    NumeredDofEntity_multiIndex_petsc_global_dof_view_ordered_non_unique;

typedef multi_index_container<
    boost::shared_ptr<NumeredDofEntity>,
    indexed_by<ordered_non_unique<const_mem_fun<
        NumeredDofEntity::interface_type_DofEntity, FieldCoefficientsNumber,
        &NumeredDofEntity::getDofCoeffIdx> > > >
    NumeredDofEntity_multiIndex_coeff_idx_ordered_non_unique;

/**
 * Activate or deactivate dofs (multi-index modifier)
 * \ingroup dof_multi_indices
 */
struct DofEntity_active_change {
  bool aCtive;
  DofEntity_active_change(bool active);
  void operator()(boost::shared_ptr<DofEntity> &dof);
};

/**
 * Change part and global pestc index (multi-index modifier)
 * \ingroup dof_multi_indices
 */
struct NumeredDofEntity_part_change {
  unsigned int pArt;
  DofIdx petscGloablDofIdx;
  NumeredDofEntity_part_change(const unsigned int part,
                               const DofIdx petsc_gloabl_dof_idx)
      : pArt(part), petscGloablDofIdx(petsc_gloabl_dof_idx){};
  inline void operator()(boost::shared_ptr<NumeredDofEntity> &dof) {
    dof->pArt = pArt;
    dof->petscGloablDofIdx = petscGloablDofIdx;
  }
};

/**
 * Change part and local pestc index (multi-index modifier)
 * \ingroup dof_multi_indices
 */
struct NumeredDofEntity_local_idx_change {
  DofIdx petscLocalDofIdx;
  NumeredDofEntity_local_idx_change(const DofIdx petsc_local_dof_idx)
      : petscLocalDofIdx(petsc_local_dof_idx){};
  inline void operator()(boost::shared_ptr<NumeredDofEntity> &dof) {
    dof->petscLocalDofIdx = petscLocalDofIdx;
  }
};

/**
 * Change part and mofem index (multi-index modifier)
 * \ingroup dof_multi_indices
 */
struct NumeredDofEntity_mofem_index_change {
  DofIdx mofemIdx;
  NumeredDofEntity_mofem_index_change(const DofIdx mofem_idx)
      : mofemIdx(mofem_idx){};
  inline void operator()(boost::shared_ptr<NumeredDofEntity> &dof) {
    dof->dofIdx = mofemIdx;
  }
};

/**
 * Change part and mofem/pestc global and local index (multi-index modifier)
 * \ingroup dof_multi_indices
 */
struct NumeredDofEntity_mofem_part_and_all_index_change {
  unsigned int pArt;
  DofIdx mofemIdx;
  DofIdx petscGloablDofIdx;
  DofIdx petscLocalDofIdx;
  NumeredDofEntity_mofem_part_and_all_index_change(
      const unsigned int part, const DofIdx mofem_idx,
      const DofIdx petsc_gloabl_dof_idx, const DofIdx petsc_local_dof_idx)
      : pArt(part), mofemIdx(mofem_idx),
        petscGloablDofIdx(petsc_gloabl_dof_idx),
        petscLocalDofIdx(petsc_local_dof_idx){};
  inline void operator()(boost::shared_ptr<NumeredDofEntity> &dof) {
    dof->pArt = pArt;
    dof->dofIdx = mofemIdx;
    dof->petscGloablDofIdx = petscGloablDofIdx;
    dof->petscLocalDofIdx = petscLocalDofIdx;
  }
};

/**
 * Replace dofs shared_ptr
 *
 * DOFs on entities are stored by sequences. If DOFs to entities are added,
 * whole entity sequence is change to preserve continuity in memory
 *
 * \ingroup dof_multi_indices
 */
template <class T> struct Dof_shared_ptr_change {
  boost::shared_ptr<T> &dofPtr;
  Dof_shared_ptr_change(boost::shared_ptr<T> &dof_ptr) : dofPtr(dof_ptr){};
  inline void operator()(boost::shared_ptr<T> &dof) { dof = dofPtr; }
};

} // namespace MoFEM
#endif // __DOFSMULTIINDICES_HPP__

/***************************************************************************/ /**
 * \defgroup dof_multi_indices Dofs structures and multi-indices
 * \ingroup mofem
******************************************************************************/