BCMultiIndices.hpp

Go to the documentation of this file.

/** \file BCMultiIndices.hpp
 * \brief Multi-index containers, data boundary data structures and other
 * low-level functions
 * 
 */
 
 
 
#ifndef __BCMULTIINDICES_HPP__
#define __BCMULTIINDICES_HPP__
 
namespace MoFEM {
 
/**
 * \brief this struct keeps basic methods for moab meshset about material and
 * boundary conditions \ingroup mofem_bc
 *
 */
struct CubitMeshSets {
 
  EntityHandle meshset;
  CubitBCType cubitBcType; ///< type of meshset from cubit NodeSet, BlockSet,
                           ///< SideSet and more
  std::vector<Tag>
      tag_handles; ///< vector of tag handles to types of data passed from cubit
  int *msId = nullptr; ///< cubit meshset ID
  char *tagBcData = nullptr;
  int tagBcSize;
  unsigned int *tagBlockHeaderData = nullptr;
  double *tagBlockAttributes = nullptr;
  int tagBlockAttributesSize;
  char *tagName = nullptr;
  // Keep JSON-assigned block attributes alive when MOAB cannot hand back
  // a direct pointer for this meshset/tag combination.
  std::vector<double> blockAttributesStorage;
  const CubitBCType meshsetsMask;
 
  CubitMeshSets(Interface &moab, const EntityHandle meshset);
  CubitMeshSets(Interface &moab, const CubitBCType cubit_bc_type,
                const int msId);
 
  /**
   * \brief get meshset id as it set in preprocessing software
   * @return id of meshset
   */
  inline int getMeshsetId() const { return msId ? *msId : -1; }
 
  // /** \deprecated use getMeshsetId() instead
  // */
  // DEPRECATED inline int get_msId() const { return getMeshsetId(); }
 
  /**
   * \brief get type of meshset
   *
   * See CubitBC for set of types of meshsets.
   *
   * @return meshset type
   */
  inline CubitBCType getBcType() const { return cubitBcType; }
 
  /**
   * \brief get bc meshset
   * @return meshset entity handle
   */
  inline EntityHandle getMeshset() const { return meshset; }
 
  /**
   * \brief get bc meshset type
   * @return return type as unsigned int
   */
  inline unsigned long int getBcTypeULong() const {
    return cubitBcType.to_ulong();
  }
 
  /**
   * \brief get meshset type and mask
   * @return type is returned as unsigned integer
   */
  inline unsigned long int getMaskedBcTypeULong() const {
    return (cubitBcType & meshsetsMask).to_ulong();
  }
 
  /** @deprecated use getMaskedBcTypeULong */
  DEPRECATED unsigned long int getMaksedBcTypeULong() const {
    return (cubitBcType & meshsetsMask).to_ulong();
  }
 
  /**
   * @brief Get the meshset entities dimension
   *
   * \note If dimension is -1, then dimension for meshset ins undetermined.
   *
   * @return unsigned int
   */
  unsigned int getMeshsetEntitiesDimension() const {
    if (tagBlockHeaderData)
      return tagBlockHeaderData[2];
    else
      return -1;
  }
 
  /**
   * \brief get entities form meshset
   * @param  moab      moab instance
   * @param  dimension dimension of entities
   * @param  entities  range of returned entities
   * @param  recursive true if meshset should be searched recursively
   * @return           error code
   */
  MoFEMErrorCode
  getMeshsetIdEntitiesByDimension(Interface &moab, const int dimension,
                                  Range &entities,
                                  const bool recursive = false) const;
 
  /**
   * \brief get entities form meshset
   *
   * Use if meshset have predefined dimension
   *
   * @param  moab      moab instance
   * @param  entities  range of returned entities
   * @param  recursive true if meshset should be searched recursively
   * @return           error code
   *
   */
  MoFEMErrorCode
  getMeshsetIdEntitiesByDimension(Interface &moab, Range &entities,
                                  const bool recursive = false) const;
 
  /**
   * \brief get entities by type
   * @param  moab      moab instance
   * @param  type      type of entity
   * @param  entities  returned entities
   * @param  recursive true if meshset should be searched recursively
   * @return           error code
   */
  MoFEMErrorCode getMeshsetIdEntitiesByType(Interface &moab,
                                            const EntityType type,
                                            Range &entities,
                                            const bool recursive = false) const;
 
  /**
   *  \brief Function that returns the CubitBCType type of the contents of
   * bc_data
   */
  MoFEMErrorCode getTypeFromBcData(const std::vector<char> &bc_data,
                                   CubitBCType &type) const;
 
  /**
   *  \brief Function that returns the CubitBCType type of the contents of
   * bc_data
   */
  MoFEMErrorCode getTypeFromBcData(CubitBCType &type) const;
 
  /**
   * \brief get bc_data vector from MoFEM database
   *
   * \param bc_data is the in/out vector were bc_data will be stored
   */
  MoFEMErrorCode getBcData(std::vector<char> &bc_data) const;
 
  /**
   * \brief get block_headers vector from MoFEM database
   *
   * \param material_data is the in/out vector were the material data will be
   * stored
   */
  MoFEMErrorCode
  getBlockHeaderData(std::vector<unsigned int> &material_data) const;
 
  /**
   * \brief print material_data int stream given by os
   *
   * f.e. it->print_Cubit_material_data(cout), i.e. printing to standard output
   * f.e. it->print_Cubit_material_data(std::cerr), i.e. printing to standard
   * error output
   */
  MoFEMErrorCode printBlockHeaderData(std::ostream &os) const;
 
  /**
   * \brief print bc_data int stream given by os
   *
   * f.e. it->printBcData(cout), i.e. printing to standard output
   * f.e. it->printBcData(std::cerr), i.e. printing to standard error output
   */
  MoFEMErrorCode printBcData(std::ostream &os) const;
 
  /**
   *  \brief Function that returns the CubitBCType type of the block name,
   * sideset name etc.
   */
  MoFEMErrorCode getTypeFromName(const std::string &name,
                                 CubitBCType &type) const;
 
  /**
   *  \brief Function that returns the CubitBCType type of the block name,
   * sideset name etc.
   */
  MoFEMErrorCode getTypeFromName(CubitBCType &type) const;
 
  /**
   * \brief get Cubit block attributes
   *
   * \param attributes is the vector where the block attribute data will be
   * stored
   */
  MoFEMErrorCode getAttributes(std::vector<double> &attributes) const;
 
  /**
   * \brief cet Cubit block attributes
   *
   * \param attributes is the vector where the block attribute data will be
   * stored
   */
  MoFEMErrorCode setAttributes(moab::Interface &moab,
                               const std::vector<double> &attributes);
 
  /**
   * \brief print the attributes vector
   *
   * f.e. it->printAttributes(cout), i.e. printing to standard output
   * f.e. it->printAttributes(std::cerr), i.e. printing to standard error output
   */
  MoFEMErrorCode printAttributes(std::ostream &os) const;
 
  /**
   * \brief get name of block, sideset etc. (this is set in Cubit block
   properties)
   *
   * Block Name Conventions:
 
   * Materials are defined with block names starting with MAT_
   * e.g. MAT_ELASTIC_abcd.
   *
   * List of materials/solution procedures
 
   * Block name /  Number of attributes  / (1) Attribute 1, (2) Attribute 2 etc.
   *
   * MAT_ELASTIC / 10 /  (1) Young's  modulus
   *                    (2) Poisson's ratio
   *                    (3) User attribute 8
   *                    ...
   *                    (10) User attribute 8
   *
   * MAT_ELASTIC_TRANSISO / 5 / (1) Young's modulus in xy plane (Ep)
   *                    (2) Young's modulus in z-direction (Ez)
   *                    (3) Poisson's ratio in xy plane (vp)
   *                    (4) Poisson's ratio in z-direction (vpz)
   *                    (5) Shear modulus in z-direction (Gzp)
   *
   * MAT_INTERF / 1 /   (1) Elastic modulus multiplier
   *
   * To be extended as appropriate
   */
  std::string getName() const;
 
  /**
   * \brief print name of block, sideset etc. (this is set in Cubit setting
   * properties)
   *
   * e.g. it->printName(cout), i.e. printing to standard output
   * e.g it->printName(std::cerr), i.e. printing to standard error output
   */
  MoFEMErrorCode printName(std::ostream &os) const;
 
  /**
   * \brief fill data structure with data saved on meshset
   */
  template <class ATTRIBUTE_TYPE>
  MoFEMErrorCode getAttributeDataStructure(ATTRIBUTE_TYPE &data) const {
    MoFEMFunctionBegin;
    if ((cubitBcType & data.getType()).none()) {
      SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
              "attributes are not for ATTRIBUTE_TYPE structure");
    }
    std::vector<double> attributes;
    CHKERR getAttributes(attributes);
    CHKERR data.fill_data(attributes);
    MoFEMFunctionReturn(0);
  }
 
  /**
   * \brief fill meshset data with data on structure
   */
  template <class ATTRIBUTE_TYPE>
  MoFEMErrorCode setAttributeDataStructure(const ATTRIBUTE_TYPE &data) {
    MoFEMFunctionBegin;
    if ((cubitBcType & data.getType()).none()) {
      SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
              "attributes are not for ATTRIBUTE_TYPE structure");
    }
    double *ptr = const_cast<double *>(tagBlockAttributes);
    CHKERR data.set_data(ptr, 8 * tagBlockAttributesSize);
    MoFEMFunctionReturn(0);
  }
 
  template <class CUBIT_BC_DATA_TYPE>
  MoFEMErrorCode getBcDataStructure(CUBIT_BC_DATA_TYPE &data) const {
    MoFEMFunctionBeginHot;
 
    if ((cubitBcType & data.tYpe).none()) {
      SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
              "bc_data are not for CUBIT_BC_DATA_TYPE structure");
    }
    std::vector<char> bc_data;
    getBcData(bc_data);
    ierr = data.fill_data(bc_data);
    CHKERRG(ierr);
    MoFEMFunctionReturnHot(0);
  }
 
  template <class CUBIT_BC_DATA_TYPE>
  MoFEMErrorCode setBcDataStructure(CUBIT_BC_DATA_TYPE &data) {
    MoFEMFunctionBeginHot;
 
    char *ptr = const_cast<char *>(tagBcData);
    ierr = data.set_data(ptr, tagBcSize);
    CHKERRG(ierr);
    MoFEMFunctionReturnHot(0);
  }
 
  friend std::ostream &operator<<(std::ostream &os, const CubitMeshSets &e);
 
  Tag nsTag, ssTag, nsTag_data, ssTag_data, bhTag, bhTag_header, thBlockAttribs,
      entityNameTag;
 
  MoFEMErrorCode getTagsHandlers(Interface &moab);
};
 
/**
 * \typedef CubitMeshSet_multiIndex
 * \brief Stores data about meshsets (see CubitMeshSets) storing data about
 * boundary conditions, interfaces, sidesets, nodests, blocksets
 *
 * \param Meshset_mi_tag  index by meshset handle
 * \param CubitMeshsetType_mi_tag index by bc type, see CubitBC
 * \param CubitMeshsetMaskedType_mi_tag index by NODESET, SIDESET, BLOCKSET
 * only
 *
 * \param CubitMeshsets_name index by meshset name
 *
 * \param Composite_Cubit_msId_And_MeshsetType_mi_tag index by meshset id and
 * type NODESET, SIDESET or BLOCKSET
 *
 *  Example:
 *  \code
 *   MeshsetsManager *m_mng;
 *   CHKERR m_field.getInterface(m_mng);
 *   auto &index = m_mng->getMeshsetsMultindex();
 *
 *
 *   auto mit =
 * index.get<CubitMeshsetMaskedType_mi_tag>().lower_bound(BLOCKSET); auto
 * hi_mit =
 * index.get<CubitMeshsetMaskedType_mi_tag>().upper_bound(BLOCKSET);
 *
 *   // Make a loop over all BLOCKSET
 *   for(;mit!=hi_mit;mit++) {
 *     int id = mit->getMeshsetId();            // get blockset id
 *     EntityHandle handle = mit->getMeshset(); // get block meshset
 *     std::vector< double > attributes;
 *     // get block attributes
 *     auto mit->getAttributes(attributes);
 *     // do something
 *   }
 *  \endcode
 *
 */
typedef multi_index_container<
    CubitMeshSets,
    indexed_by<
        hashed_unique<tag<Meshset_mi_tag>, member<CubitMeshSets, EntityHandle,
                                                  &CubitMeshSets::meshset>>,
        ordered_non_unique<tag<CubitMeshsetType_mi_tag>,
                           const_mem_fun<CubitMeshSets, unsigned long int,
                                         &CubitMeshSets::getBcTypeULong>>,
        ordered_non_unique<tag<CubitMeshsetMaskedType_mi_tag>,
                           const_mem_fun<CubitMeshSets, unsigned long int,
                                         &CubitMeshSets::getMaskedBcTypeULong>>,
        ordered_non_unique<
            tag<CubitMeshsets_name>,
            const_mem_fun<CubitMeshSets, std::string, &CubitMeshSets::getName>>,
        hashed_unique<
            tag<Composite_Cubit_msId_And_MeshsetType_mi_tag>,
            composite_key<
                CubitMeshSets,
                const_mem_fun<CubitMeshSets, int, &CubitMeshSets::getMeshsetId>,
                const_mem_fun<CubitMeshSets, unsigned long int,
                              &CubitMeshSets::getMaskedBcTypeULong>>>>>
    CubitMeshSet_multiIndex;
 
/** \brief change meshset type
 */
struct CubitMeshSets_change_add_bit_to_cubit_bc_type {
  CubitBCType bIt;
  CubitMeshSets_change_add_bit_to_cubit_bc_type(const CubitBCType &bit)
      : bIt(bit){};
  void operator()(CubitMeshSets &e);
};
 
/**
 * \brief change meshset name
 */
struct CubitMeshSets_change_name {
  Interface &mOab;
  std::string nAme;
  CubitMeshSets_change_name(Interface &moab, const std::string &name)
      : mOab(moab), nAme(name){};
  void operator()(CubitMeshSets &e);
};
 
/**
 * change meshset attributes
 */
struct CubitMeshSets_change_attributes {
  Interface &mOab;
  const std::vector<double> &aTtr;
  CubitMeshSets_change_attributes(Interface &moab,
                                  const std::vector<double> &attr)
      : mOab(moab), aTtr(attr) {}
  void operator()(CubitMeshSets &e);
};
 
/**
 * change meshset attributes for material data structure
 */
struct CubitMeshSets_change_attributes_data_structure {
  Interface &mOab;
  const GenericAttributeData &aTtr;
  CubitMeshSets_change_attributes_data_structure(
      Interface &moab, const GenericAttributeData &attr)
      : mOab(moab), aTtr(attr) {}
  void operator()(CubitMeshSets &e);
};
 
/**
 * change meshset attributes for material data structure
 */
struct CubitMeshSets_change_bc_data_structure {
  Interface &mOab;
  const GenericCubitBcData &bcData;
  CubitMeshSets_change_bc_data_structure(Interface &moab,
                                         const GenericCubitBcData &bc_data)
      : mOab(moab), bcData(bc_data) {}
  void operator()(CubitMeshSets &e);
};
 
} // namespace MoFEM
 
#endif // __BCMULTIINDICES_HPP__
 
/**
 * \defgroup mofem_bc Boundary conditions
 * \ingroup mofem
 */