refine.h

// Copyright (C) 2010-2024 Garth N. Wells and Paul T. Kühner
//
// This file is part of DOLFINx (https://www.fenicsproject.org)
//
// SPDX-License-Identifier:    LGPL-3.0-or-later
 
#pragma once
 
#include "dolfinx/common/MPI.h"
#include "dolfinx/graph/AdjacencyList.h"
#include "dolfinx/graph/partitioners.h"
#include "dolfinx/mesh/Mesh.h"
#include "dolfinx/mesh/Topology.h"
#include "dolfinx/mesh/cell_types.h"
#include "dolfinx/mesh/utils.h"
#include "interval.h"
#include "plaza.h"
#include <algorithm>
#include <concepts>
#include <mpi.h>
#include <optional>
#include <spdlog/spdlog.h>
#include <stdexcept>
#include <utility>
#include <variant>
 
namespace dolfinx::refinement
{

template <std::floating_point T>
graph::partition_fn
create_identity_partitioner(const mesh::Mesh<T>& parent_mesh,
                            std::span<std::int32_t> parent_cell)
{
  // TODO: optimize for non ghosted mesh?
 
  return [&parent_mesh, parent_cell](
             MPI_Comm comm, int /*nparts*/,
             const graph::AdjacencyList<std::int64_t>& dual_graph,
             std::optional<std::span<const std::int32_t>> /* cell_weights */,
             std::optional<std::span<const std::int32_t>> /* edge_weights */,
             bool /* ghosting */) -> graph::AdjacencyList<std::int32_t>
  {
    auto parent_cell_im
        = parent_mesh.topology()->index_map(parent_mesh.topology()->dim());
    std::int32_t parent_num_cells = parent_cell_im->size_local();
    std::span parent_cell_owners = parent_cell_im->owners();
 
    std::int32_t num_cells = dual_graph.num_nodes();
    std::vector<std::int32_t> destinations(num_cells);
 
    int rank = dolfinx::MPI::rank(comm);
    for (std::size_t i = 0; i < destinations.size(); i++)
    {
      bool parent_is_ghost_cell = parent_cell[i] > parent_num_cells;
      if (parent_is_ghost_cell)
        destinations[i] = parent_cell_owners[parent_cell[i] - parent_num_cells];
      else
        destinations[i] = rank;
    }
 
    if (comm == MPI_COMM_NULL)
      return graph::regular_adjacency_list(std::move(destinations), 1);
 
    std::vector<std::int32_t> node_disp(MPI::size(comm) + 1, 0);
    std::int32_t local_size = dual_graph.num_nodes();
    MPI_Allgather(&local_size, 1, dolfinx::MPI::mpi_t<std::int32_t>,
                  node_disp.data() + 1, 1, dolfinx::MPI::mpi_t<std::int32_t>,
                  comm);
    std::partial_sum(node_disp.begin(), node_disp.end(), node_disp.begin());
    return compute_destination_ranks(comm, dual_graph, node_disp, destinations);
  };
}

struct IdentityPartitionerPlaceholder
{
};

template <std::floating_point T>
std::tuple<mesh::Mesh<T>, std::optional<std::vector<std::int32_t>>,
           std::optional<std::vector<std::int8_t>>>
refine(const mesh::Mesh<T>& mesh,
       std::optional<std::span<const std::int32_t>> edges,
       std::variant<IdentityPartitionerPlaceholder, graph::partition_fn>
           partitioner = IdentityPartitionerPlaceholder(),
       Option option = Option::parent_cell,
       mesh::GhostMode ghost_mode = mesh::GhostMode::none)
{
  auto topology = mesh.topology();
  assert(topology);
  if (!mesh::is_simplex(topology->cell_type()))
    throw std::runtime_error("Refinement only defined for simplices");
 
  auto [cell_adj, new_vertex_coords, xshape, parent_cell, parent_facet]
      = (topology->cell_type() == mesh::CellType::interval)
            ? interval::compute_refinement_data(mesh, edges, option)
            : plaza::compute_refinement_data(mesh, edges, option);
 
  if (std::holds_alternative<IdentityPartitionerPlaceholder>(partitioner))
  {
    if (!parent_cell)
    {
      throw std::runtime_error(
          "Identity partitioner relies on parent cell computation");
    }
    assert(parent_cell);
    partitioner = create_identity_partitioner(mesh, parent_cell.value());
  }
 
  assert(std::holds_alternative<graph::partition_fn>(partitioner));
 
  mesh::Mesh<T> mesh1 = mesh::create_mesh(
      mesh.comm(), mesh.comm(), cell_adj.array(),
      mesh.geometry().cmaps().front(), mesh.comm(), new_vertex_coords, xshape,
      graph::Partitioner{.fn = std::get<graph::partition_fn>(partitioner)},
      ghost_mode, 2, 1);
 
  // Report the number of refined cells
  const int D = topology->dim();
  const std::int64_t n0 = topology->index_map(D)->size_global();
  const std::int64_t n1 = mesh1.topology()->index_map(D)->size_global();
  spdlog::info(
      "Number of cells increased from {} to {} ({}% increase).", n0, n1,
      100.0 * (static_cast<double>(n1) / static_cast<double>(n0) - 1.0));
 
  return {std::move(mesh1), std::move(parent_cell), std::move(parent_facet)};
}
 
} // namespace dolfinx::refinement