mesh_generation.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 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_GENERATION_H
#define LIBMESH_MESH_GENERATION_H

// Local Includes
#include "libmesh/libmesh.h"
#include "libmesh/enum_elem_type.h" // INVALID_ELEM
#include "libmesh/vector_value.h"
#ifdef LIBMESH_HAVE_TRIANGLE
#include "libmesh/mesh_triangle_interface.h"
#endif

// C++ Includes
#include <cstddef>
#include <vector>

namespace libMesh
{

// forward declarations
class MeshBase;
class UnstructuredMesh;
class Elem;


// ------------------------------------------------------------
// MeshTools::Generation namespace
namespace MeshTools
{
namespace Generation
{

// forward declaration
class QueryElemSubdomainIDBase;

void build_cube (UnstructuredMesh & mesh,
                 const unsigned int nx=0,
                 const unsigned int ny=0,
                 const unsigned int nz=0,
                 const Real xmin=0., const Real xmax=1.,
                 const Real ymin=0., const Real ymax=1.,
                 const Real zmin=0., const Real zmax=1.,
                 const ElemType type=INVALID_ELEM,
                 const bool gauss_lobatto_grid=false);

void build_point (UnstructuredMesh & mesh,
                  const ElemType type=INVALID_ELEM,
                  const bool gauss_lobatto_grid=false);

void build_line (UnstructuredMesh & mesh,
                 const unsigned int nx,
                 const Real xmin=0., const Real xmax=1.,
                 const ElemType type=INVALID_ELEM,
                 const bool gauss_lobatto_grid=false);

void build_square (UnstructuredMesh & mesh,
                   const unsigned int nx,
                   const unsigned int ny,
                   const Real xmin=0., const Real xmax=1.,
                   const Real ymin=0., const Real ymax=1.,
                   const ElemType type=INVALID_ELEM,
                   const bool gauss_lobatto_grid=false);

void build_sphere (UnstructuredMesh & mesh,
                   const Real rad=1,
                   const unsigned int nr=2,
                   const ElemType type=INVALID_ELEM,
                   const unsigned int n_smooth=2,
                   const bool flat=true);

void build_extrusion (UnstructuredMesh & mesh,
                      const MeshBase & cross_section,
                      const unsigned int nz,
                      RealVectorValue extrusion_vector,
                      QueryElemSubdomainIDBase * elem_subdomain = nullptr);

#if defined(LIBMESH_HAVE_TRIANGLE) && LIBMESH_DIM > 1

void build_delaunay_square(UnstructuredMesh & mesh,
                           const unsigned int nx, // num. of elements in x-dir
                           const unsigned int ny, // num. of elements in y-dir
                           const Real xmin, const Real xmax,
                           const Real ymin, const Real ymax,
                           const ElemType type,
                           const std::vector<TriangleInterface::Hole*> * holes=nullptr);
#endif // LIBMESH_HAVE_TRIANGLE && LIBMESH_DIM > 1

void surface_octahedron (UnstructuredMesh & mesh,
                         Real xmin, Real xmax,
                         Real ymin, Real ymax,
                         Real zmin, Real zmax,
                         bool flip_tris = false);

class QueryElemSubdomainIDBase
{
public:
  virtual ~QueryElemSubdomainIDBase() = default;

  virtual subdomain_id_type get_subdomain_for_layer(const Elem * old_elem, unsigned int layer) = 0;
};

} // end namespace Meshtools::Generation
} // end namespace MeshTools


} // namespace libMesh

#endif // LIBMESH_MESH_GENERATION_H