mesh_tools.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_TOOLS_H
#define LIBMESH_MESH_TOOLS_H



// Local Includes -----------------------------------
#include "libmesh/libmesh.h"
#include "libmesh/enum_elem_type.h"
#include "libmesh/id_types.h"
#include "libmesh/mesh_base.h"
#include "libmesh/point.h" // some compilers want the full definition - I think so they can do
// return-value-optimization for BoundingBox'es - BSK

// C++ Includes   -----------------------------------
#include <vector>
#include <set>
#include <limits>

namespace libMesh
{

// forward declarations
class SerialMesh;
class ParallelMesh;
class Sphere;
class Elem;

// ------------------------------------------------------------
// MeshTools namespace
namespace MeshTools
{
class BoundingBox : public std::pair<Point, Point>
{
public:

  BoundingBox (const Point &new_min, const Point &new_max) :
    std::pair<Point, Point>(new_min, new_max)
  {}

  BoundingBox (const std::pair<Point, Point> &bbox) :
    std::pair<Point, Point> (bbox)
  {}

  BoundingBox ()
  {
    this->invalidate();
  }

  void invalidate ()
  {
    for (unsigned int i=0; i<LIBMESH_DIM; i++)
      {
        this->first(i)  =  std::numeric_limits<Real>::max();
        this->second(i) = -std::numeric_limits<Real>::max();
      }
  }

  const Point & min() const
  { return this->first; }

  Point & min()
  { return this->first; }

  const Point & max() const
  { return this->second; }

  Point & max()
  { return this->second; }

  BoundingBox & expand()
  { return *this; }

  bool intersect (const BoundingBox &) const;

  bool contains_point (const Point &) const;

private:
};

dof_id_type total_weight (const MeshBase &mesh);

dof_id_type weight (const MeshBase &mesh, const processor_id_type pid);

inline
dof_id_type weight (const MeshBase &mesh)
{ return MeshTools::weight (mesh, mesh.processor_id()); }

void build_nodes_to_elem_map (const MeshBase &mesh,
                              std::vector<std::vector<dof_id_type> > &nodes_to_elem_map);

void build_nodes_to_elem_map (const MeshBase &mesh,
                              std::vector<std::vector<const Elem*> >&nodes_to_elem_map);


//   /**
//    * Calling this function on a 2D mesh will convert all the elements
//    * to triangles.  \p QUAD4s will be converted to \p TRI3s, \p QUAD8s
//    * and \p QUAD9s will be converted to \p TRI6s.
//    */
//   void all_tri (MeshBase &mesh);

void find_boundary_nodes (const MeshBase &mesh,
                          std::vector<bool> &on_boundary);

BoundingBox
bounding_box (const MeshBase &mesh);

Sphere
bounding_sphere (const MeshBase &mesh);

BoundingBox
processor_bounding_box (const MeshBase &mesh,
                        const processor_id_type pid);

Sphere
processor_bounding_sphere (const MeshBase &mesh,
                           const processor_id_type pid);

BoundingBox
subdomain_bounding_box (const MeshBase &mesh,
                        const subdomain_id_type sid);

Sphere
subdomain_bounding_sphere (const MeshBase &mesh,
                           const subdomain_id_type sid);


void elem_types (const MeshBase &mesh,
                 std::vector<ElemType> &et);

dof_id_type n_elem_of_type (const MeshBase &mesh,
                            const ElemType type);

dof_id_type n_active_elem_of_type (const MeshBase &mesh,
                                   const ElemType type);

dof_id_type n_non_subactive_elem_of_type_at_level(const MeshBase &mesh,
                                                  const ElemType type,
                                                  const unsigned int level);

unsigned int n_levels(const MeshBase &mesh);

unsigned int n_local_levels(const MeshBase &mesh);

unsigned int n_active_levels(const MeshBase &mesh);

unsigned int n_active_local_levels(const MeshBase &mesh);

unsigned int n_p_levels (const MeshBase &mesh);

void get_not_subactive_node_ids(const MeshBase &mesh,
                                std::set<dof_id_type> &not_subactive_node_ids);

dof_id_type n_elem (const MeshBase::const_element_iterator &begin,
                    const MeshBase::const_element_iterator &end);


dof_id_type n_nodes (const MeshBase::const_node_iterator &begin,
                     const MeshBase::const_node_iterator &end);


unsigned int max_level (const MeshBase &mesh);


void find_nodal_neighbors(const MeshBase &mesh, const Node &n,
                          std::vector<std::vector<const Elem*> > &nodes_to_elem_map,
                          std::vector<const Node*> &neighbors);

void find_hanging_nodes_and_parents(const MeshBase &mesh, std::map<dof_id_type, std::vector<dof_id_type> > &hanging_nodes);

void correct_node_proc_ids(MeshBase &);


#ifdef DEBUG

void libmesh_assert_no_links_to_elem(const MeshBase &mesh,
                                     const Elem *bad_elem);

void libmesh_assert_equal_n_systems (const MeshBase &mesh);

void libmesh_assert_old_dof_objects (const MeshBase &mesh);

void libmesh_assert_valid_node_pointers (const MeshBase &mesh);

void libmesh_assert_valid_remote_elems (const MeshBase &mesh);

void libmesh_assert_valid_elem_ids (const MeshBase &mesh);

void libmesh_assert_valid_amr_elem_ids (const MeshBase &mesh);

void libmesh_assert_connected_nodes (const MeshBase &mesh);

void libmesh_assert_valid_dof_ids (const MeshBase &mesh);

template <typename DofObjectSubclass>
void libmesh_assert_valid_procids (const MeshBase &mesh);

void libmesh_assert_valid_refinement_flags (const MeshBase &mesh);

void libmesh_assert_valid_refinement_tree (const MeshBase &mesh);

void libmesh_assert_valid_neighbors (const MeshBase &mesh);
#endif

// There is no reason for users to call functions in the MeshTools::Private namespace.
namespace Private {
void globally_renumber_nodes_and_elements (MeshBase &);
} // end namespace Private

} // end namespace MeshTools

} // namespace libMesh


#endif // LIBMESH_MESH_TOOLS_H