mesh_base.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library 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 2.1 of the License, or (at your option) any later version.

// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_MESH_BASE_H
#define LIBMESH_MESH_BASE_H



// Local Includes -----------------------------------
#include "libmesh/auto_ptr.h"
#include "libmesh/boundary_info.h"
#include "libmesh/dof_object.h" // for invalid_processor_id
#include "libmesh/enum_elem_type.h"
#include "libmesh/libmesh_common.h"
#include "libmesh/multi_predicates.h"
#include "libmesh/partitioner.h" // UniquePtr needs a real declaration
#include "libmesh/point_locator_base.h"
#include "libmesh/variant_filter_iterator.h"
#include "libmesh/parallel_object.h"

// C++ Includes   -----------------------------------
#include <cstddef>
#include <string>

namespace libMesh
{

// forward declarations
class Elem;
class Node;
class Point;
class MeshData;

template <class MT>
class MeshInput;


// ------------------------------------------------------------
// MeshBase class definition
class MeshBase : public ParallelObject
{
public:

  MeshBase (const Parallel::Communicator &comm_in,
            unsigned char dim=1);

#ifndef LIBMESH_DISABLE_COMMWORLD

  MeshBase (unsigned char dim=1);
#endif

  MeshBase (const MeshBase& other_mesh);

  virtual UniquePtr<MeshBase> clone() const = 0;

  virtual ~MeshBase ();

  virtual UniquePtr<Partitioner> &partitioner() { return _partitioner; }

  const BoundaryInfo& get_boundary_info() const { return *boundary_info; }

  BoundaryInfo& get_boundary_info() { return *boundary_info; }

  virtual void clear ();

  bool is_prepared () const
  { return _is_prepared; }

  virtual bool is_serial () const
  { return true; }

  virtual void allgather () {}

  virtual void delete_remote_elements () {}

  unsigned int mesh_dimension () const;

  void set_mesh_dimension (unsigned char d)
  { _elem_dims.clear(); _elem_dims.insert(d); }

  const std::set<unsigned char>& elem_dimensions() const
  { return _elem_dims; }

  unsigned int spatial_dimension () const
  { return cast_int<unsigned int>(LIBMESH_DIM); }

  virtual dof_id_type n_nodes () const = 0;

  virtual dof_id_type parallel_n_nodes () const = 0;

  dof_id_type n_nodes_on_proc (const processor_id_type proc) const;

  dof_id_type n_local_nodes () const
  { return this->n_nodes_on_proc (this->processor_id()); }

  dof_id_type n_unpartitioned_nodes () const
  { return this->n_nodes_on_proc (DofObject::invalid_processor_id); }

  virtual dof_id_type max_node_id () const = 0;

#ifdef LIBMESH_ENABLE_UNIQUE_ID

  unique_id_type next_unique_id() { return _next_unique_id; }

  void set_next_unique_id(unique_id_type id) { _next_unique_id = id; }
#endif

  virtual void reserve_nodes (const dof_id_type nn) = 0;

  virtual dof_id_type n_elem () const = 0;

  virtual dof_id_type parallel_n_elem () const = 0;

  virtual dof_id_type max_elem_id () const = 0;

  virtual void reserve_elem (const dof_id_type ne) = 0;

  virtual void update_parallel_id_counts () = 0;

  virtual dof_id_type n_active_elem () const = 0;

  dof_id_type n_elem_on_proc (const processor_id_type proc) const;

  dof_id_type n_local_elem () const
  { return this->n_elem_on_proc (this->processor_id()); }

  dof_id_type n_unpartitioned_elem () const
  { return this->n_elem_on_proc (DofObject::invalid_processor_id); }

  dof_id_type n_active_elem_on_proc (const processor_id_type proc) const;

  dof_id_type n_active_local_elem () const
  { return this->n_active_elem_on_proc (this->processor_id()); }

  dof_id_type n_sub_elem () const;

  dof_id_type n_active_sub_elem () const;

  virtual const Point& point (const dof_id_type i) const = 0;

  virtual const Node& node (const dof_id_type i) const = 0;

  virtual Node& node (const dof_id_type i) = 0;

  virtual const Node* node_ptr (const dof_id_type i) const = 0;

  virtual Node* node_ptr (const dof_id_type i) = 0;

  virtual const Node* query_node_ptr (const dof_id_type i) const = 0;

  virtual Node* query_node_ptr (const dof_id_type i) = 0;

  virtual const Elem* elem (const dof_id_type i) const = 0;

  virtual Elem* elem (const dof_id_type i) = 0;

  virtual const Elem* query_elem (const dof_id_type i) const = 0;

  virtual Elem* query_elem (const dof_id_type i) = 0;

  virtual Node* add_point (const Point& p,
                           const dof_id_type id = DofObject::invalid_id,
                           const processor_id_type proc_id =
                           DofObject::invalid_processor_id) = 0;

  virtual Node* add_node (Node* n) = 0;

  virtual Node* insert_node(Node* n) = 0;

  virtual void delete_node (Node* n) = 0;

  virtual void renumber_node (dof_id_type old_id, dof_id_type new_id) = 0;

  virtual Elem* add_elem (Elem* e) = 0;

  virtual Elem* insert_elem (Elem* e) = 0;

  virtual void delete_elem (Elem* e) = 0;

  virtual void renumber_elem (dof_id_type old_id, dof_id_type new_id) = 0;

  virtual void find_neighbors (const bool reset_remote_elements = false,
                               const bool reset_current_list    = true) = 0;

  virtual void renumber_nodes_and_elements () = 0;

  virtual void fix_broken_node_and_element_numbering () = 0;


#ifdef LIBMESH_ENABLE_AMR

  virtual bool contract () = 0;
#endif

  void prepare_for_use (const bool skip_renumber_nodes_and_elements=false, const bool skip_find_neighbors=false);

  virtual void partition (const unsigned int n_parts);

  void partition ()
  { this->partition(this->n_processors()); }

  virtual void redistribute () {}

  virtual void update_post_partitioning () {}

  void allow_renumbering(bool allow) { _skip_renumber_nodes_and_elements = !allow; }
  bool allow_renumbering() const { return !_skip_renumber_nodes_and_elements; }

  void skip_partitioning(bool skip) { _skip_partitioning = skip; }
  bool skip_partitioning() const { return _skip_partitioning; }

  void subdomain_ids (std::set<subdomain_id_type> &ids) const;

  subdomain_id_type n_subdomains () const;

  unsigned int n_partitions () const
  { return _n_parts; }

  std::string get_info () const;

  void print_info (std::ostream& os=libMesh::out) const;

  friend std::ostream& operator << (std::ostream& os, const MeshBase& m);

  virtual void read  (const std::string& name, MeshData* mesh_data=NULL,
                      bool skip_renumber_nodes_and_elements=false) = 0;
  virtual void write (const std::string& name, MeshData* mesh_data=NULL) = 0;

  virtual void all_first_order () = 0;

  virtual void all_second_order (const bool full_ordered=true) = 0;

  typedef Predicates::multi_predicate Predicate;

  struct element_iterator;
  struct const_element_iterator;

  struct node_iterator;
  struct const_node_iterator;

  unsigned int recalculate_n_partitions();

  const PointLocatorBase& point_locator () const;

  UniquePtr<PointLocatorBase> sub_point_locator () const;

  void clear_point_locator ();

  virtual void libmesh_assert_valid_parallel_ids() const {}

  std::string& subdomain_name(subdomain_id_type id);
  const std::string& subdomain_name(subdomain_id_type id) const;

  subdomain_id_type get_id_by_name(const std::string& name) const;

  virtual element_iterator elements_begin                   () = 0;
  virtual element_iterator elements_end                     () = 0;
  virtual element_iterator active_elements_begin            () = 0;
  virtual element_iterator active_elements_end              () = 0;
  virtual element_iterator ancestor_elements_begin          () = 0;
  virtual element_iterator ancestor_elements_end            () = 0;
  virtual element_iterator subactive_elements_begin         () = 0;
  virtual element_iterator subactive_elements_end           () = 0;
  virtual element_iterator not_active_elements_begin        () = 0;
  virtual element_iterator not_active_elements_end          () = 0;
  virtual element_iterator not_ancestor_elements_begin      () = 0;
  virtual element_iterator not_ancestor_elements_end        () = 0;
  virtual element_iterator not_subactive_elements_begin     () = 0;
  virtual element_iterator not_subactive_elements_end       () = 0;
  virtual element_iterator local_elements_begin             () = 0;
  virtual element_iterator local_elements_end               () = 0;
  virtual element_iterator semilocal_elements_begin         () = 0;
  virtual element_iterator semilocal_elements_end           () = 0;
  virtual element_iterator facelocal_elements_begin         () = 0;
  virtual element_iterator facelocal_elements_end           () = 0;
  virtual element_iterator not_local_elements_begin         () = 0;
  virtual element_iterator not_local_elements_end           () = 0;
  virtual element_iterator active_local_elements_begin      () = 0;
  virtual element_iterator active_local_elements_end        () = 0;
  virtual element_iterator active_not_local_elements_begin  () = 0;
  virtual element_iterator active_not_local_elements_end    () = 0;
  virtual element_iterator level_elements_begin             (const unsigned int level  ) = 0;
  virtual element_iterator level_elements_end               (const unsigned int level  ) = 0;
  virtual element_iterator not_level_elements_begin         (const unsigned int level  ) = 0;
  virtual element_iterator not_level_elements_end           (const unsigned int level  ) = 0;
  virtual element_iterator local_level_elements_begin       (const unsigned int level  ) = 0;
  virtual element_iterator local_level_elements_end         (const unsigned int level  ) = 0;
  virtual element_iterator local_not_level_elements_begin   (const unsigned int level  ) = 0;
  virtual element_iterator local_not_level_elements_end     (const unsigned int level  ) = 0;
  virtual element_iterator pid_elements_begin               (const processor_id_type proc_id) = 0;
  virtual element_iterator pid_elements_end                 (const processor_id_type proc_id) = 0;
  virtual element_iterator type_elements_begin              (const ElemType type       ) = 0;
  virtual element_iterator type_elements_end                (const ElemType type       ) = 0;
  virtual element_iterator active_type_elements_begin       (const ElemType type       ) = 0;
  virtual element_iterator active_type_elements_end         (const ElemType type       ) = 0;
  virtual element_iterator active_pid_elements_begin        (const processor_id_type proc_id) = 0;
  virtual element_iterator active_pid_elements_end          (const processor_id_type proc_id) = 0;
  virtual element_iterator unpartitioned_elements_begin     () = 0;
  virtual element_iterator unpartitioned_elements_end       () = 0;
  virtual element_iterator active_local_subdomain_elements_begin (const subdomain_id_type subdomain_id) = 0;
  virtual element_iterator active_local_subdomain_elements_end   (const subdomain_id_type subdomain_id) = 0;
  virtual element_iterator active_subdomain_elements_begin       (const subdomain_id_type subdomain_id) = 0;
  virtual element_iterator active_subdomain_elements_end         (const subdomain_id_type subdomain_id) = 0;




  virtual const_element_iterator elements_begin                   () const = 0;
  virtual const_element_iterator elements_end                     () const = 0;
  virtual const_element_iterator active_elements_begin            () const = 0;
  virtual const_element_iterator active_elements_end              () const = 0;
  virtual const_element_iterator ancestor_elements_begin          () const = 0;
  virtual const_element_iterator ancestor_elements_end            () const = 0;
  virtual const_element_iterator subactive_elements_begin         () const = 0;
  virtual const_element_iterator subactive_elements_end           () const = 0;
  virtual const_element_iterator not_active_elements_begin        () const = 0;
  virtual const_element_iterator not_active_elements_end          () const = 0;
  virtual const_element_iterator not_ancestor_elements_begin      () const = 0;
  virtual const_element_iterator not_ancestor_elements_end        () const = 0;
  virtual const_element_iterator not_subactive_elements_begin     () const = 0;
  virtual const_element_iterator not_subactive_elements_end       () const = 0;
  virtual const_element_iterator local_elements_begin             () const = 0;
  virtual const_element_iterator local_elements_end               () const = 0;
  virtual const_element_iterator semilocal_elements_begin         () const = 0;
  virtual const_element_iterator semilocal_elements_end           () const = 0;
  virtual const_element_iterator facelocal_elements_begin         () const = 0;
  virtual const_element_iterator facelocal_elements_end           () const = 0;
  virtual const_element_iterator not_local_elements_begin         () const = 0;
  virtual const_element_iterator not_local_elements_end           () const = 0;
  virtual const_element_iterator active_local_elements_begin      () const = 0;
  virtual const_element_iterator active_local_elements_end        () const = 0;
  virtual const_element_iterator active_not_local_elements_begin  () const = 0;
  virtual const_element_iterator active_not_local_elements_end    () const = 0;
  virtual const_element_iterator level_elements_begin             (const unsigned int level)   const = 0;
  virtual const_element_iterator level_elements_end               (const unsigned int level)   const = 0;
  virtual const_element_iterator not_level_elements_begin         (const unsigned int level)   const = 0;
  virtual const_element_iterator not_level_elements_end           (const unsigned int level)   const = 0;
  virtual const_element_iterator local_level_elements_begin       (const unsigned int level)   const = 0;
  virtual const_element_iterator local_level_elements_end         (const unsigned int level)   const = 0;
  virtual const_element_iterator local_not_level_elements_begin   (const unsigned int level)   const = 0;
  virtual const_element_iterator local_not_level_elements_end     (const unsigned int level)   const = 0;
  virtual const_element_iterator pid_elements_begin               (const processor_id_type proc_id) const = 0;
  virtual const_element_iterator pid_elements_end                 (const processor_id_type proc_id) const = 0;
  virtual const_element_iterator type_elements_begin              (const ElemType type)        const = 0;
  virtual const_element_iterator type_elements_end                (const ElemType type)        const = 0;
  virtual const_element_iterator active_type_elements_begin       (const ElemType type)        const = 0;
  virtual const_element_iterator active_type_elements_end         (const ElemType type)        const = 0;
  virtual const_element_iterator active_pid_elements_begin        (const processor_id_type proc_id) const = 0;
  virtual const_element_iterator active_pid_elements_end          (const processor_id_type proc_id) const = 0;
  virtual const_element_iterator unpartitioned_elements_begin     () const = 0;
  virtual const_element_iterator unpartitioned_elements_end       () const = 0;
  virtual const_element_iterator active_local_subdomain_elements_begin (const subdomain_id_type subdomain_id) const = 0;
  virtual const_element_iterator active_local_subdomain_elements_end   (const subdomain_id_type subdomain_id) const = 0;
  virtual const_element_iterator active_subdomain_elements_begin       (const subdomain_id_type subdomain_id) const = 0;
  virtual const_element_iterator active_subdomain_elements_end         (const subdomain_id_type subdomain_id) const = 0;


  virtual node_iterator nodes_begin        () = 0;
  virtual node_iterator nodes_end          () = 0;
  virtual node_iterator active_nodes_begin () = 0;
  virtual node_iterator active_nodes_end   () = 0;
  virtual node_iterator local_nodes_begin  () = 0;
  virtual node_iterator local_nodes_end    () = 0;
  virtual node_iterator pid_nodes_begin    (const processor_id_type proc_id) = 0;
  virtual node_iterator pid_nodes_end      (const processor_id_type proc_id) = 0;


  virtual const_node_iterator nodes_begin        () const = 0;
  virtual const_node_iterator nodes_end          () const = 0;
  virtual const_node_iterator active_nodes_begin () const = 0;
  virtual const_node_iterator active_nodes_end   () const = 0;
  virtual const_node_iterator local_nodes_begin  () const = 0;
  virtual const_node_iterator local_nodes_end    () const = 0;
  virtual const_node_iterator pid_nodes_begin    (const processor_id_type proc_id) const = 0;
  virtual const_node_iterator pid_nodes_end      (const processor_id_type proc_id) const = 0;


  std::map<subdomain_id_type, std::string>& set_subdomain_name_map ()
  { return _block_id_to_name; }
  const std::map<subdomain_id_type, std::string>& get_subdomain_name_map () const
  { return _block_id_to_name; }


  void cache_elem_dims();


  UniquePtr<BoundaryInfo> boundary_info;


protected:

#ifdef LIBMESH_ENABLE_UNIQUE_ID
  virtual void assign_unique_ids() = 0;
#endif

  unsigned int& set_n_partitions ()
  { return _n_parts; }

  unsigned int _n_parts;

  bool _is_prepared;

  mutable UniquePtr<PointLocatorBase> _point_locator;

  UniquePtr<Partitioner> _partitioner;

#ifdef LIBMESH_ENABLE_UNIQUE_ID

  unique_id_type _next_unique_id;
#endif

  bool _skip_partitioning;

  bool _skip_renumber_nodes_and_elements;

  std::map<subdomain_id_type, std::string> _block_id_to_name;

  std::set<unsigned char> _elem_dims;

  friend class Partitioner;

  friend class MeshInput<MeshBase>;

  friend class BoundaryInfo;

private:
  MeshBase& operator= (const MeshBase& other);
};











struct
MeshBase::element_iterator :
variant_filter_iterator<MeshBase::Predicate,
                        Elem*>
{
  // Templated forwarding ctor -- forwards to appropriate variant_filter_iterator ctor
  template <typename PredType, typename IterType>
  element_iterator (const IterType& d,
                    const IterType& e,
                    const PredType& p ) :
    variant_filter_iterator<MeshBase::Predicate,
    Elem*>(d,e,p) {}
};




struct
MeshBase::const_element_iterator :
variant_filter_iterator<MeshBase::Predicate,
                        Elem* const,
                        Elem* const&,
                        Elem* const*>
{
  // Templated forwarding ctor -- forwards to appropriate variant_filter_iterator ctor
  template <typename PredType, typename IterType>
  const_element_iterator (const IterType& d,
                          const IterType& e,
                          const PredType& p ) :
    variant_filter_iterator<MeshBase::Predicate,
    Elem* const,
    Elem* const&,
    Elem* const*>(d,e,p)  {}


  // The conversion-to-const ctor.  Takes a regular iterator and calls the appropriate
  // variant_filter_iterator copy constructor.  Note that this one is *not* templated!
  const_element_iterator (const MeshBase::element_iterator& rhs) :
    variant_filter_iterator<Predicate,
    Elem* const,
    Elem* const&,
    Elem* const*>(rhs)
  {
    // libMesh::out << "Called element_iterator conversion-to-const ctor." << std::endl;
  }
};







struct
MeshBase::node_iterator :
variant_filter_iterator<MeshBase::Predicate,
                        Node*>
{
  // Templated forwarding ctor -- forwards to appropriate variant_filter_iterator ctor
  template <typename PredType, typename IterType>
  node_iterator (const IterType& d,
                 const IterType& e,
                 const PredType& p ) :
    variant_filter_iterator<MeshBase::Predicate,
    Node*>(d,e,p) {}
};




struct
MeshBase::const_node_iterator :
variant_filter_iterator<MeshBase::Predicate,
                        Node* const,
                        Node* const &,
                        Node* const *>
{
  // Templated forwarding ctor -- forwards to appropriate variant_filter_iterator ctor
  template <typename PredType, typename IterType>
  const_node_iterator (const IterType& d,
                       const IterType& e,
                       const PredType& p ) :
    variant_filter_iterator<MeshBase::Predicate,
    Node* const,
    Node* const &,
    Node* const *>(d,e,p)  {}


  // The conversion-to-const ctor.  Takes a regular iterator and calls the appropriate
  // variant_filter_iterator copy constructor.  Note that this one is *not* templated!
  const_node_iterator (const MeshBase::node_iterator& rhs) :
    variant_filter_iterator<Predicate,
    Node* const,
    Node* const &,
    Node* const *>(rhs)
  {
    // libMesh::out << "Called node_iterator conversion-to-const ctor." << std::endl;
  }
};


} // namespace libMesh

#endif // LIBMESH_MESH_BASE_H