WriteUtil.hpp

Go to the documentation of this file.

#ifndef MB_WRITE_UTIL_HPP
#define MB_WRITE_UTIL_HPP

#ifndef IS_BUILDING_MB
#error "WriteUtil.hpp isn't supposed to be included into an application"
#endif

#include "moab/WriteUtilIface.hpp"

namespace moab {

class Core;
class Error;

class WriteUtil : public WriteUtilIface
{
private:
  Core* mMB;
  Error* mError;
public:

  WriteUtil(Core* mdb, Error* error_handler);

  ~WriteUtil(){}
  
  virtual ErrorCode check_doesnt_exist( const char* file_name );

  virtual ErrorCode gather_entities(Range &all_ents,
                                    const EntityHandle *ent_sets = NULL, 
                                    const int num_sets = 0
                                    );
  
  ErrorCode get_node_coords(
      const int num_arrays,
      const int num_nodes, 
      const Range& entities,
      Tag node_id_tag,
      const int start_node_id,
      std::vector<double*>& arrays
      );
      
  ErrorCode get_node_coords(
      const int which_array, 
      Range::const_iterator begin,
      const Range::const_iterator end,
      const size_t output_size,
      double* const output_array
      );

  ErrorCode get_element_connect(
      const int num_elements, 
      const int verts_per_element,
      Tag node_id_tag,
      const Range& entities, 
      Tag element_id_tag,
      int start_element_id,
      int* array,
      bool add_sizes = false
      );

  ErrorCode get_element_connect(
      Range::const_iterator begin,
      const Range::const_iterator end,
      const int vertices_per_elem,
      Tag node_id_tag,
      const size_t array_size, 
      int *const element_array,
      bool add_sizes = false
      );

  virtual ErrorCode get_element_connect(
      Range::const_iterator begin,
      const Range::const_iterator end,
      const int vertices_per_elem,
      const size_t array_size, 
      EntityHandle *const element_array
      );

  virtual ErrorCode get_poly_connect_size(
      Range::const_iterator begin,
      const Range::const_iterator end,
      int& connectivity_size 
      );
   
   
  virtual ErrorCode get_poly_connect(
      Range::const_iterator& iter,
      const Range::const_iterator end,
      const Tag node_id_tag,
      size_t& handle_array_len,
      int *const handle_array,
      size_t& index_array_len,
      int *const index_array,
      int& index_offset 
      );
 
  ErrorCode gather_nodes_from_elements(
      const Range& elements,
      const Tag node_bit_mark_tag,
      Range& nodes
      );
  
  ErrorCode assign_ids(Range &elements,
                         Tag id_tag,
                         const int start_id);

  
  ErrorCode get_adjacencies(
      EntityHandle entity,
      Tag id_tag,
      std::vector<int>& adj 
  );
  
  ErrorCode get_adjacencies( EntityHandle entity,
                               const EntityHandle*& adj_array,
                               int& num_adj );


  virtual ErrorCode 
  get_tag_list( std::vector<Tag>& result_list,
                const Tag* user_tag_list = 0, 
                int user_tag_list_length = 0,
                bool include_variable_length_tags = true );

  /*\brief Get pointers to internal storage of entity data
   *
   * Get pointers to element connectivity or set content storage.
   *\param query_begin Start of range of entities for which to return results
   *\param query_end   End of range of entities for which to return results.
   *\param output_pointer_array Result list of pointers.  Points to either
   *          element connectivity or set contents.  Note: set contents
   *          may be in range-compacted format.
   *\param lengths Optional per-entity length of list.  If passed, then
   *          always set, for each entity, to the number of values in the
   *          array passed back in \c output_pointer_array
   *\param relation If entity is entity set, which set data to return
   *          (contents array, parent array, or child array).  If
   *          entity is an element, then CONTENTS for complete connectivity
   *          or TOPOLOGICAL for only corner vertices.  
   *\param flags Optional per-entity flag values.  If passed, then
   *          always set to zero for elements and set to set creation
   *          flags for entity sets.
   *\return MB_STRUCTURED_MESH if one or more input elements are stored as
   *          structured mesh and therefore do not have explicit storage.
   *        MB_TYPE_OUT_OF_RANGE if called for vertices.
   */
  virtual ErrorCode
  get_entity_list_pointers( Range::const_iterator query_begin,
                            Range::const_iterator query_end,
                            EntityHandle const* * output_pointer_array,
                            EntityListType relation = CONTENTS,
                            int* lengths = 0,
                            unsigned char* flags = 0 );

  /*\brief Get pointers to internal storage of entity data
   *
   * Get pointers to element connectivity or set content storage.
   *\param entities Pointer to list of entities for which to return results
   *\param num_entities Number of entities in list
   *\param output_pointer_array Result list of pointers.  Points to either
   *          element connectivity or set contents.  Note: set contents
   *          may be in range-compacted format.
   *\param lengths Optional per-entity length of list.  If passed, then
   *          always set, for each entity, to the number of values in the
   *          array passed back in \c output_pointer_array
   *\param relation If entity is entity set, which set data to return
   *          (contents array, parent array, or child array).  If
   *          entity is an element, then CONTENTS for complete connectivity
   *          or TOPOLOGICAL for only corner vertices.  
   *\param flags Optional per-entity flag values.  If passed, then
   *          always set to zero for elements and set to set creation
   *          flags for entity sets.
   *\return MB_STRUCTURED_MESH if one or more input elements are stored as
   *          structured mesh and therefore do not have explicit storage.
   *        MB_TYPE_OUT_OF_RANGE if called for vertices.
   */
  virtual ErrorCode
  get_entity_list_pointers( EntityHandle const* entities,
                            int num_entities,
                            EntityHandle const* * output_pointer_array,
                            EntityListType relation = CONTENTS,
                            int* lengths = 0,
                            unsigned char* flags = 0 );

  ErrorCode report_error( const std::string& error );

  ErrorCode report_error( const char* error, ... ) MB_PRINTF(1);
};

} // namespace moab

#endif