StitchMeshGenerator.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "StitchMeshGenerator.h"

#include "CastUniquePointer.h"
#include "MooseUtils.h"
#include "MooseMeshUtils.h"

#include "libmesh/unstructured_mesh.h"

registerMooseObjectRenamed("MooseApp",
                           StitchedMeshGenerator,
                           "06/30/2026 24:00",
                           StitchMeshGenerator);
registerMooseObject("MooseApp", StitchMeshGenerator);

InputParameters
StitchMeshGenerator::validParams()
{
  InputParameters params = StitchMeshGeneratorBase::validParams();
  params.addRequiredParam<std::vector<MeshGeneratorName>>("inputs", "The input MeshGenerators.");
  params.addParam<bool>("prevent_boundary_ids_overlap",
                        true,
                        "Whether to re-number boundaries in stitched meshes to prevent merging of "
                        "unrelated boundaries");
  params.addParam<bool>(
      "merge_boundaries_with_same_name",
      true,
      "If the input meshes have boundaries with the same name (but different IDs), merge them");
  params.addParam<bool>(
      "subdomain_remapping",
      true,
      "Treat input subdomain names as primary, preserving them and remapping IDs as needed");
  params.addParam<bool>(
      "verbose_stitching", false, "Whether mesh stitching should have verbose output.");
  params.addParam<bool>(
      "enforce_all_nodes_match_on_boundaries",
      false,
      "Whether to have the stitcher be very picky about the nodes being stitched.");
  params.addParam<bool>("merge_boundary_nodes_all_or_nothing",
                        false,
                        "Whether the stitcher is set to merge all nodes or none.");
  params.addClassDescription(
      "Allows multiple mesh files to be stitched together to form a single mesh.");

  // This is used for compatibility with TestSubGenerators
  params.addPrivateParam<bool>("_check_inputs", true);
  return params;
}

StitchMeshGenerator::StitchMeshGenerator(const InputParameters & parameters)
  : StitchMeshGeneratorBase(parameters),
    _mesh_ptrs(getMeshes("inputs")),
    _input_names(getParam<std::vector<MeshGeneratorName>>("inputs")),
    _prevent_boundary_ids_overlap(getParam<bool>("prevent_boundary_ids_overlap")),
    _merge_boundaries_with_same_name(getParam<bool>("merge_boundaries_with_same_name"))
{
  // Check inputs
  if (_input_names.size() - 1 != _stitch_boundaries_pairs.size() && getParam<bool>("_check_inputs"))
    paramError("stitch_boundaries_pairs",
               "Can only stitch one pair of boundary per pair of mesh. We have '" +
                   std::to_string(_input_names.size()) +
                   "' meshes specified (=" + std::to_string(_input_names.size() - 1) +
                   " pairs) and " + std::to_string(_stitch_boundaries_pairs.size()) +
                   " pairs of boundaries specified");
  for (const auto & pair : _stitch_boundaries_pairs)
    if (pair.size() != 2)
      paramError("stitch_boundaries_pairs",
                 "Stitched boundary pair '" + Moose::stringify(pair) +
                     "' is not of length 2, but of length: " + std::to_string(pair.size()));
}

std::unique_ptr<MeshBase>
StitchMeshGenerator::generate()
{
  // We put the first mesh in a local pointer
  std::unique_ptr<UnstructuredMesh> mesh = dynamic_pointer_cast<UnstructuredMesh>(*_mesh_ptrs[0]);
  if (!mesh) // This should never happen until libMesh implements on-the-fly-Elem mesh types
    mooseError("StitchMeshGenerator is only implemented for unstructured meshes");

  // Reserve spaces for the other meshes (no need to store the first one another time)
  std::vector<std::unique_ptr<UnstructuredMesh>> meshes(_mesh_ptrs.size() - 1);

  // Read in all of the other meshes
  for (MooseIndex(_mesh_ptrs) i = 1; i < _mesh_ptrs.size(); ++i)
    meshes[i - 1] = dynamic_pointer_cast<UnstructuredMesh>(*_mesh_ptrs[i]);

  // Stitch all the meshes to the first one
  for (MooseIndex(meshes) i = 0; i < meshes.size(); i++)
  {
    const auto boundary_pair = _stitch_boundaries_pairs[i];

    // Check the input boundaries
    const auto first = getBoundaryIdToStitch(
        *mesh,
        (_input_names.size() ? _input_names[0] : "(unknown)") +
            ((i == 0) ? "" : (" (stitched with " + std::to_string(i) + " previous meshes)")),
        boundary_pair[0]);
    auto second = getBoundaryIdToStitch(*meshes[i], name(), boundary_pair[1]);

    const bool use_binary_search = (_algorithm == "BINARY");

    // Meshes must be prepared to get the global boundary ids
    if (!mesh->is_prepared())
      mesh->prepare_for_use();
    if (!meshes[i]->is_prepared())
      meshes[i]->prepare_for_use();

    // Avoid chaotic boundary merging due to overlapping ids in meshes by simply renumbering the
    // boundaries in the meshes we are going to stitch onto the base mesh
    // This is only done if there is an overlap
    if (_prevent_boundary_ids_overlap)
    {
      const auto & base_mesh_bids = mesh->get_boundary_info().get_global_boundary_ids();
      const auto stitched_mesh_bids = meshes[i]->get_boundary_info().get_global_boundary_ids();

      // Check for an overlap
      bool overlap_found = false;
      for (const auto & bid : stitched_mesh_bids)
        if (base_mesh_bids.count(bid))
          overlap_found = true;

      if (overlap_found)
      {
        const auto max_boundary_id =
            std::max(*base_mesh_bids.rbegin(), *stitched_mesh_bids.rbegin());
        BoundaryID new_index = 1;
        for (const auto bid : stitched_mesh_bids)
        {
          const auto new_bid = max_boundary_id + (new_index++);
          meshes[i]->get_boundary_info().renumber_id(bid, new_bid);
          if (bid == second)
            second = new_bid;
        }
      }
    }
    else
    {
      // If we don't have renumbering, we can get into situations where the same boundary ID is
      // associated with different boundary names. In this case when we stitch, we assign the
      // boundary name of the first mesh to the ID everywhere on the domain. We throw a warning
      // here to warn the user if this is the case.
      const auto & base_mesh_bids = mesh->get_boundary_info().get_global_boundary_ids();
      const auto & other_mesh_bids = meshes[i]->get_boundary_info().get_global_boundary_ids();

      // We check if the same ID is present with different names
      std::set<boundary_id_type> bd_id_intersection;
      std::set_intersection(base_mesh_bids.begin(),
                            base_mesh_bids.end(),
                            other_mesh_bids.begin(),
                            other_mesh_bids.end(),
                            std::inserter(bd_id_intersection, bd_id_intersection.begin()));

      for (const auto bid : bd_id_intersection)
      {
        const auto & sideset_name_on_first_mesh = mesh->get_boundary_info().get_sideset_name(bid);
        const auto & sideset_name_on_second_mesh =
            meshes[i]->get_boundary_info().get_sideset_name(bid);

        if (sideset_name_on_first_mesh != sideset_name_on_second_mesh)
          mooseWarning(
              "Boundary ID ",
              bid,
              " corresponds to different boundary names on the input meshes! On the first "
              "mesh it corresponds to `",
              sideset_name_on_first_mesh,
              "` while on the second mesh it corresponds to `",
              sideset_name_on_second_mesh,
              "`. The final mesh will replace boundary `",
              sideset_name_on_second_mesh,
              "` with `",
              sideset_name_on_first_mesh,
              "`. To avoid this situation, use the `prevent_boundary_ids_overlap` parameter!");
      }
    }

    mesh->stitch_meshes(*meshes[i],
                        first,
                        second,
                        getParam<Real>("stitching_hmin_tolerance_factor"),
                        _clear_stitched_boundary_ids,
                        getParam<bool>("verbose_stitching"),
                        use_binary_search,
                        /*enforce_all_nodes_match_on_boundaries=*/
                        getParam<bool>("enforce_all_nodes_match_on_boundaries"),
                        /*merge_boundary_nodes_all_or_nothing=*/
                        getParam<bool>("merge_boundary_nodes_all_or_nothing"),
                        getParam<bool>("subdomain_remapping"));

    if (_merge_boundaries_with_same_name)
      MooseMeshUtils::mergeBoundaryIDsWithSameName(*mesh);
  }

  mesh->unset_is_prepared();
  return dynamic_pointer_cast<MeshBase>(mesh);
}