MeshGeneratorSystem.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 "MeshGeneratorSystem.h"

#include "MooseApp.h"
#include "MeshGenerator.h"
#include "DependencyResolver.h"

#include "libmesh/mesh_tools.h"

using namespace libMesh;

const std::string MeshGeneratorSystem::data_driven_generator_param = "data_driven_generator";
const std::string MeshGeneratorSystem::allow_data_driven_param =
    "allow_data_driven_mesh_generation";

MeshGeneratorSystem::MeshGeneratorSystem(MooseApp & app)
  : PerfGraphInterface(app.perfGraph(), "MeshGeneratorSystem"),
    ParallelObject(app),
    _app(app),
    _verbose(false),
    _csg_only(false)
{
}

void
MeshGeneratorSystem::addMeshGenerator(const std::string & type,
                                      const std::string & name,
                                      const InputParameters & params)
{
  mooseAssert(!_mesh_generator_params.count(name), "Already exists");
  _mesh_generator_params.emplace(
      std::piecewise_construct, std::forward_as_tuple(name), std::forward_as_tuple(type, params));

  // This should be a sub mesh generator. We can assume this because if we're in the middle of
  // constructing mesh generators (not "adding" them, where we simply store their parameters)
  if (_app.constructingMeshGenerators())
    createMeshGenerator(name);
}

const MeshGenerator &
MeshGeneratorSystem::appendMeshGenerator(const std::string & type,
                                         const std::string & name,
                                         InputParameters params)
{
  if (!appendingMeshGenerators())
    mooseError("Can only call appendMeshGenerator() during the append_mesh_generator task");
  const auto param_name_mg_name_pairs = getMeshGeneratorParamDependencies(params, true);

  // Make sure this mesh generator has one and _only_ one input, in the "input" parameter,
  // Or several, listed in the "inputs" parameter
  if ((param_name_mg_name_pairs.size() == 0) ||
      (param_name_mg_name_pairs.size() == 1 && param_name_mg_name_pairs[0].first != "input" &&
       param_name_mg_name_pairs[0].first != "inputs") ||
      (param_name_mg_name_pairs.size() > 1 && param_name_mg_name_pairs[0].first != "inputs"))
    mooseError("While adding ",
               type,
               " '",
               name,
               "' via appendMeshGenerator():\nCan only append a mesh generator that takes a "
               "single input mesh generator via the parameter named 'input' or 'inputs'.");

  // If no final generator is set, we need to make sure that we have one; we will hit
  // this the first time we add an appended MeshGenerator and only need to do it once.
  // We'll then generate the final ordering within the execution phase. We'll also
  // clear the ordering because it could be invalid if we append any more generators,
  // and we'll be re-ordering within executeMeshgenerators() anyway (where we don't
  // keep track of any state for the sake of simpler logic)
  if (_final_generator_name.empty())
  {
    if (_mesh_generators.empty())
      mooseError("Cannot use appendMeshGenerator() because there is not a generator to append to!");

    createMeshGeneratorOrder();
    _ordered_mesh_generators.clear();
  }

  // Set the final generator as the input if a single generator
  mooseAssert(hasMeshGenerator(_final_generator_name), "Missing final generator");
  if (params.have_parameter<MeshGeneratorName>("input"))
    params.set<MeshGeneratorName>("input") = _final_generator_name;
  // We'll trust the final combiner generator with its list of inputs

  // Keep track of the new final generator
  _final_generator_name = name;

  // Need to add this to the param map so that createMeshGenerator can use it
  mooseAssert(!_mesh_generator_params.count(name), "Already exists");
  _mesh_generator_params.emplace(
      std::piecewise_construct, std::forward_as_tuple(name), std::forward_as_tuple(type, params));

  return *createMeshGenerator(name);
}

std::vector<std::pair<std::string, MeshGeneratorName>>
MeshGeneratorSystem::getMeshGeneratorParamDependencies(const InputParameters & params,
                                                       const bool allow_empty /* = false */) const
{
  std::vector<std::pair<std::string, MeshGeneratorName>> dependencies;

  auto add_dependency =
      [&dependencies, &allow_empty](const auto & param_name, const auto & dependency)
  {
    if (dependency.size() || allow_empty)
      dependencies.emplace_back(param_name, dependency);
  };

  for (const auto & [name, param] : params)
    if (const auto dependency =
            dynamic_cast<const Parameters::Parameter<MeshGeneratorName> *>(param.get()))
      add_dependency(name, dependency->get());
    else if (const auto dependencies =
                 dynamic_cast<const Parameters::Parameter<std::vector<MeshGeneratorName>> *>(
                     param.get()))
    {
      if (allow_empty && dependencies->get().empty())
        add_dependency(name, std::string());
      for (const auto & dependency : dependencies->get())
        add_dependency(name, dependency);
    }

  return dependencies;
}

void
MeshGeneratorSystem::createAddedMeshGenerators()
{
  mooseAssert(_app.actionWarehouse().getCurrentTaskName() == "create_added_mesh_generators",
              "Should not run now");

  // No generators were added via addMeshGenerator()
  if (_mesh_generator_params.empty())
    return;

  DependencyResolver<std::string> resolver;

  // Define the dependencies known so far
  for (const auto & [name, type_params_pair] : _mesh_generator_params)
  {
    resolver.addItem(name);
    for (const auto & param_dependency_pair :
         getMeshGeneratorParamDependencies(type_params_pair.second))
      resolver.addEdge(param_dependency_pair.second, name);
  }

  std::vector<std::vector<std::string>> ordered_generators;
  try
  {
    ordered_generators = resolver.getSortedValuesSets();
  }
  catch (CyclicDependencyException<std::string> & e)
  {
    mooseError("Cyclic dependencies detected in mesh generation: ",
               MooseUtils::join(e.getCyclicDependencies(), " <- "));
  }

  const auto & moose_mesh = _app.actionWarehouse().getMesh();

  // If there is no mesh
  if (!moose_mesh.get())
    mooseError("No mesh created. Either add a Mesh, an ActionComponents or a Components block");

  // If we're using data-driven generation, find that requirement now
  mooseAssert(!_data_driven_generator_name, "Should not be set");
  if (moose_mesh->parameters().get<bool>("_mesh_generator_mesh") &&
      moose_mesh->isParamValid(data_driven_generator_param))
  {
    if (!hasDataDrivenAllowed())
      moose_mesh->paramError(
          data_driven_generator_param,
          "This application does not support data-driven mesh generation.\n\nThis generation is an "
          "advanced feature and must be enabled on the application via the '",
          allow_data_driven_param,
          "' parameter.");

    mooseAssert(moose_mesh->type() == "MeshGeneratorMesh",
                "Assumption for mesh type is now invalid");

    _data_driven_generator_name = moose_mesh->getParam<std::string>(data_driven_generator_param);
    if (!_mesh_generator_params.count(*_data_driven_generator_name))
      moose_mesh->paramError(data_driven_generator_param,
                             "The data driven generator '",
                             *_data_driven_generator_name,
                             "' does not exist");
  }

  // Check compatibility for CLI / meshing options with csg_only
  const bool csg_only = getCSGOnly();
  if (csg_only && _data_driven_generator_name)
    moose_mesh->paramError(data_driven_generator_param,
                           "This parameter should not be set in conjunction with --csg-only");

  // Construct all of the mesh generators that we know exist
  for (const auto & generator_names : ordered_generators)
    for (const auto & generator_name : generator_names)
      if (auto it = _mesh_generator_params.find(generator_name); it != _mesh_generator_params.end())
      {
        auto & params = it->second.second;

        // Determine now if we need to run this in data only mode
        const bool data_only =
            (csg_only ||
             (_data_driven_generator_name && getDataDrivenGeneratorName() != generator_name &&
              resolver.dependsOn(getDataDrivenGeneratorName(), generator_name)));
        params.set<bool>(MeshGenerator::data_only_param) = data_only;

        createMeshGenerator(generator_name);

        if (csg_only && !getMeshGenerator(generator_name).hasGenerateCSG())
          mooseError("Mesh generator ",
                     generator_name,
                     " cannot be used in csg-only mode since it does not have a generateCSG "
                     "implementation");

        mooseAssert(data_only == getMeshGenerator(generator_name).isDataOnly(),
                    "Inconsistent data only");
      }

  mooseAssert(_mesh_generator_params.empty(), "Should be empty");
  mooseAssert(_final_generator_name.empty(), "Should be unset at this point");

  // Set the final generator if we have one set by the user
  // and if so make sure it also exists
  if (moose_mesh->parameters().get<bool>("_mesh_generator_mesh") &&
      moose_mesh->isParamValid("final_generator"))
  {
    mooseAssert(moose_mesh->type() == "MeshGeneratorMesh",
                "Assumption for mesh type is now invalid");

    _final_generator_name = moose_mesh->getParam<std::string>("final_generator");
    if (!hasMeshGenerator(_final_generator_name))
      moose_mesh->paramError("final_generator",
                             "The forced final MeshGenerator '",
                             _final_generator_name,
                             "' does not exist");
  }
}

void
MeshGeneratorSystem::createMeshGeneratorOrder()
{
  mooseAssert(_app.constructingMeshGenerators() ||
                  _app.actionWarehouse().getCurrentTaskName() == "execute_mesh_generators",
              "Incorrect call time");
  mooseAssert(_ordered_mesh_generators.empty(), "Already ordered");
  mooseAssert(_mesh_generators.size(), "No mesh generators to order");

  TIME_SECTION("createMeshGeneratorOrder", 1, "Ordering Mesh Generators");

  // We dare not sort these based on address!
  DependencyResolver<MeshGenerator *, MeshGenerator::Comparator> resolver;

  // The mesh generators that must be called
  // This is needed to mark the generators that could be cut due to a
  // final generator being set, but should still be called because they're
  // either being saved in memory or as output
  std::vector<std::string> required_generators;
  for (const auto & it : _mesh_generators)
    if (it.second->hasSaveMesh() || it.second->hasOutput())
      required_generators.push_back(it.second->name());

  // The mesh generator tree should have all the mesh generators that
  // The final generator depends on and all the mesh generators
  // with 'save in' flag. Here we loop over all the mesh generators
  // and conditionally add all of the dependencies into the resolver
  for (const auto & it : _mesh_generators)
  {
    MeshGenerator * mg = it.second.get();

    // The mesh generator has to meet one of the following conditions:
    // Final mesh generator is not set, so we build the whole tree
    if (_final_generator_name.empty() ||
        // This mesh generator is the final generator
        mg->name() == _final_generator_name ||
        // This needs to be saved or output
        mg->hasSaveMesh() || mg->hasOutput() ||
        // Final mesh generator set and is a child of this generator
        (_final_generator_name.size() && mg->isChildMeshGenerator(_final_generator_name, false)) ||
        // This is a dependency of a generator that needs to be saved or output
        std::find_if(required_generators.begin(),
                     required_generators.end(),
                     [&mg](const auto & name) { return mg->isChildMeshGenerator(name, false); }) !=
            required_generators.end())
    {
      resolver.addItem(mg);
      for (const auto & dep_mg : mg->getParentMeshGenerators())
        resolver.addEdge(&getMeshGeneratorInternal(dep_mg->name()), mg);
    }
  }

  // ...and sort them
  try
  {
    _ordered_mesh_generators = resolver.getSortedValuesSets();
  }
  // It is _quite_ hard to trigger this to test it. I've tried to no avail.
  // Now that we...
  // - check and sort up front
  // - know if dependencies exist at the time of requesting them
  // - require that sub generators depend only on other sub generators in an object's
  //   tree + input dependencies that we explicitly declare
  // I don't think it's possible. But we'll leave it here anyway and it
  // definitely will not be covered
  catch (CyclicDependencyException<MeshGenerator *, MeshGenerator::Comparator> & e)
  {
    const auto & cycle = e.getCyclicDependencies();
    std::vector<std::string> names(cycle.size());
    for (const auto i : index_range(cycle))
      names[i] = cycle[i]->name();

    mooseError("Cyclic dependencies detected in mesh generation: ",
               MooseUtils::join(names, " <- "));
  }

  mooseAssert(_ordered_mesh_generators.size(), "No mesh generators found");

  const auto & final_generators = _ordered_mesh_generators.back();

  // We haven't forced a final generator yet
  if (_final_generator_name.empty())
  {
    mooseAssert(final_generators.size(), "Empty vector");

    // See if we have multiple independent trees of generators
    const auto ancestor_list = resolver.getAncestors(final_generators.back());
    if (ancestor_list.size() != resolver.size() && _final_generator_name.empty())
    {
      // Need to remove duplicates and possibly perform a difference so we'll import our list
      // into a set for these operations.
      std::set<MeshGenerator *, MeshGenerator::Comparator> ancestors(ancestor_list.begin(),
                                                                     ancestor_list.end());
      // Get all of the items from the resolver so we can compare against the tree from the
      // final generator we just pulled.
      const auto & allValues = resolver.getSortedValues();
      decltype(ancestors) all(allValues.begin(), allValues.end());

      decltype(ancestors) ind_tree;
      std::set_difference(all.begin(),
                          all.end(),
                          ancestors.begin(),
                          ancestors.end(),
                          std::inserter(ind_tree, ind_tree.end()));

      std::ostringstream oss;
      oss << "Your MeshGenerator tree contains multiple possible generator outputs :\n\""
          << final_generators.back()->name()
          << "\" and one or more of the following from an independent set: \"";
      bool first = true;
      for (const auto & gen : ind_tree)
      {
        if (!first)
          oss << ", ";
        else
          first = false;

        oss << gen->name();
      }
      oss << "\"\n\nThis may be due to a missing dependency or may be intentional. Please either\n"
             "- check that all the mesh generators are connected as a tree and culminate in a "
             "single final mesh. Having one wrong 'input=mg' parameter is the most common error\n"
             "- add additional dependencies to remove the ambiguity if you are using a user-built "
             "MeshGenerator\n"
             "- if you intend to execute a subset of the defined generators (uncommon), select the"
             " final MeshGenerator in the [Mesh] block with the \"final_generator\" parameter.";
      mooseError(oss.str());
    }

    _final_generator_name = final_generators.back()->name();
  }
  else
    mooseAssert(hasMeshGenerator(_final_generator_name), "Missing the preset final generator");
}

void
MeshGeneratorSystem::executeMeshGenerators()
{
  libmesh_parallel_only(comm());

  // we do not need to do this when there are no mesh generators
  if (_mesh_generators.empty())
    return;

  // Order the generators
  createMeshGeneratorOrder();

  // Save all meshes marked to to_save_in_meshes and save in error checking
  std::map<std::string, std::unique_ptr<MeshBase> *> to_save_in_meshes;
  for (const auto & generator_set : _ordered_mesh_generators)
    for (const auto & generator : generator_set)
      if (generator->hasSaveMesh())
      {
        if (_final_generator_name == generator->name())
          generator->paramError("save_with_name",
                                "Cannot use the save in capability with the final mesh generator");
        if (getCSGOnly())
          generator->paramError("save_with_name", "Cannot use in conjunction with --csg-only");
        to_save_in_meshes.emplace(generator->getSavedMeshName(),
                                  &getMeshGeneratorOutput(generator->name()));
      }
  // Grab the outputs from the final generator so MeshGeneratorMesh can pick it up
  to_save_in_meshes.emplace(mainMeshGeneratorName(),
                            &getMeshGeneratorOutput(_final_generator_name));

  // Run the MeshGenerators in the proper order
  for (const auto & generator_set : _ordered_mesh_generators)
  {
    for (const auto & generator : generator_set)
    {
      const auto & name = generator->name();
      if (_verbose)
        _app._console << " [DBG] Executing mesh generator (" << COLOR_GREEN << std::setw(20) << name
                      << COLOR_DEFAULT << ") in type (" << COLOR_GREEN << generator->type()
                      << COLOR_DEFAULT << ")" << std::endl;
      auto current_mesh = generator->generateInternal();

      // Only generating data for this generator
      if (generator->isDataOnly())
      {
        mooseAssert(!current_mesh, "Should not have a mesh");
        continue;
      }

#ifdef DEBUG
      // Assert that the mesh is either marked as not prepared or if it is marked as prepared,
      // that it's *actually* prepared.
      //
      // In newer version of libMesh, this also asserts that a mesh
      // marked as partially prepared is indeed prepared in (at least)
      // the aspects which are so marked.
      if (!MeshTools::valid_is_prepared(*current_mesh))
        generator->mooseError(
            "The generated mesh is marked as (at least partially) prepared but is not "
            "prepared in the marked sense(s). Please edit the '",
            generator->type(),
            "' class to call 'unset_is_prepared()', or more fine-grained "
            "alternatives as appropriate.");
#endif

      // Now we need to possibly give this mesh to downstream generators
      auto & outputs = _mesh_generator_outputs[name];

      if (outputs.size())
      {
        auto & first_output = *outputs.begin();

        first_output = std::move(current_mesh);

        const auto & copy_from = *first_output;

        auto output_it = ++outputs.begin();

        // For all of the rest we need to make a copy
        for (; output_it != outputs.end(); ++output_it)
          (*output_it) = copy_from.clone();
      }
    }
  }

  // No save in meshes exist in csg only mode
  if (getCSGOnly())
    return;

  // Grab all the valid save in meshes from the temporary map to_save_in_meshes
  // and store them in _save_in_meshes
  for (auto & [name, mesh_ptr] : to_save_in_meshes)
  {
    mooseAssert(mesh_ptr, "Invalid pointer");
    mooseAssert(*mesh_ptr, "Invalid pointer");
    if (name != mainMeshGeneratorName())
      mooseAssert(_save_in_meshes.count(name), "Mesh has not been requested for save");
    _save_in_meshes[name] = std::move(*mesh_ptr);
  }
}

std::shared_ptr<MeshGenerator>
MeshGeneratorSystem::createMeshGenerator(const std::string & generator_name)
{
  libmesh_parallel_only(comm());
  mooseAssert(_app.constructingMeshGenerators(), "Should not run now");

  const auto find_params = _mesh_generator_params.find(generator_name);
  mooseAssert(find_params != _mesh_generator_params.end(), "Not added");
  const auto & [type, params] = find_params->second;
  mooseAssert(comm().verify(type + generator_name), "Inconsistent construction order");

  std::shared_ptr<MeshGenerator> mg =
      _app.getFactory().create<MeshGenerator>(type, generator_name, params);

  if (mg->hasSaveMesh())
  {
    if (_save_in_meshes.count(mg->getSavedMeshName()))
      mg->paramError("save_with_name",
                     "The save with name '",
                     mg->getSavedMeshName(),
                     "' has already been used");
    _save_in_meshes.emplace(mg->getSavedMeshName(), nullptr);
  }

  // Setup the children and parents
  for (const auto & dependency : mg->getRequestedMeshGenerators())
  {
    // We _shouldn't_ hit this; now that we enforce construction ordering we do
    // all of this error checking at construction time because the info is available
    mooseAssert(hasMeshGenerator(dependency), "Missing dependency");

    auto & dependency_mg = getMeshGeneratorInternal(dependency);
    mg->addParentMeshGenerator(dependency_mg, MeshGenerator::AddParentChildKey());
    dependency_mg.addChildMeshGenerator(*mg, MeshGenerator::AddParentChildKey());
  }

  // Loop through all of the MeshGeneratorName and std::vector<MeshGeneratorName>
  // parameters (meshes that we should depend on), and make sure that either:
  // - We directly depend on them and requested a mesh from them
  // - We created a sub generator that depends on them and we declared it
  for (const auto & param_dependency_pair : getMeshGeneratorParamDependencies(mg->parameters()))
  {
    const auto & param_name = param_dependency_pair.first;
    const auto & dependency_name = param_dependency_pair.second;

    if (mg->isNullMeshName(dependency_name))
      continue;

    // True if this dependency was requested and is a parent
    if (mg->isParentMeshGenerator(dependency_name))
    {
      mooseAssert(mg->getRequestedMeshGenerators().count(dependency_name), "Wasn't requested");
      continue;
    }

    // Whether or not this is a dependency of at least one SubGenerator
    auto find_sub_dependency = std::find_if(mg->getSubMeshGenerators().begin(),
                                            mg->getSubMeshGenerators().end(),
                                            [&dependency_name](const auto & mg)
                                            { return mg->isParentMeshGenerator(dependency_name); });
    const auto is_sub_dependency = find_sub_dependency != mg->getSubMeshGenerators().end();

    // This should be used by a sub generator
    if (mg->getRequestedMeshGeneratorsForSub().count(dependency_name))
    {
      if (!is_sub_dependency)
        mg->mooseError("The sub generator dependency declared from MeshGenerator '",
                       dependency_name,
                       "' from the parameter '",
                       param_name,
                       "' was not used.\n\nDependencies that are declared by declareMeshForSub() "
                       "must be used as an input to a sub generator created by this object.");
    }
    // This was used by a sub generator but wasn't declared
    else if (is_sub_dependency)
      mg->mooseError(
          "The MeshGenerator '",
          dependency_name,
          "' was referenced in the parameter '",
          param_name,
          "' and used in the sub generator ",
          (*find_sub_dependency)->type(),
          " '",
          (*find_sub_dependency)->name(),
          "', but was not declared as a sub dependency.\n\nTo correct this, modify the code of ",
          mg->type(),
          " to include a call to declareMesh(es)ForSub(\"",
          param_name,
          "\") in the constructor.");
    // Isn't used at all
    else
      mg->mooseError(
          "You failed to request the generated mesh(es) for the parameter '",
          param_name,
          "'.\n\nIn specific, the mesh from MeshGenerator '",
          dependency_name,
          "' was not requested.\n\nTo correct this, you should remove the parameter if the "
          "mesh(es)\nare not needed, or request the mesh(es) with getMesh()/getMeshes().");
  }

  mooseAssert(!_mesh_generators.count(generator_name), "Already created");
  _mesh_generators.emplace(generator_name, mg);
  mooseAssert(!_mesh_generator_outputs.count(generator_name), "Already exists");
  _mesh_generator_outputs[generator_name];
  if (getCSGOnly())
  {
    mooseAssert(!_csg_base_outputs.count(generator_name), "CSG already exists");
    _csg_base_outputs[generator_name];
  }
  _mesh_generator_params.erase(find_params);

  return mg;
}

std::unique_ptr<MeshBase> &
MeshGeneratorSystem::getMeshGeneratorOutput(const MeshGeneratorName & name)
{
  mooseAssert(_app.constructingMeshGenerators() ||
                  _app.actionWarehouse().getCurrentTaskName() == "execute_mesh_generators",
              "Incorrect call time");

  auto it = _mesh_generator_outputs.find(name);
  mooseAssert(it != _mesh_generator_outputs.end(), "Not initialized");
  it->second.push_back(nullptr);
  return it->second.back();
}

bool
MeshGeneratorSystem::hasMeshGenerator(const MeshGeneratorName & name) const
{
  return _mesh_generators.count(name);
}

bool
MeshGeneratorSystem::hasMeshGeneratorParams(const MeshGeneratorName & name) const
{
  return _mesh_generator_params.count(name);
}

const MeshGenerator &
MeshGeneratorSystem::getMeshGenerator(const std::string & name) const
{
  const auto it = _mesh_generators.find(name);
  if (it == _mesh_generators.end())
    mooseError("Failed to find a MeshGenerator with the name '", name, "'");
  mooseAssert(it->second, "Invalid shared pointer");
  return *it->second;
}

std::vector<std::string>
MeshGeneratorSystem::getMeshGeneratorNames() const
{
  std::vector<std::string> names;
  for (auto & pair : _mesh_generators)
    names.push_back(pair.first);
  return names;
}

std::vector<std::string>
MeshGeneratorSystem::getSavedMeshNames() const
{
  std::vector<std::string> names;
  for (auto & pair : _save_in_meshes)
    names.push_back(pair.first);
  return names;
}

std::unique_ptr<MeshBase>
MeshGeneratorSystem::getSavedMesh(const std::string & name)
{
  auto find_mesh = _save_in_meshes.find(name);
  if (find_mesh == _save_in_meshes.end())
    mooseError("Failed to find a saved mesh with the name '", name, "'");

  auto & mesh_unique_ptr = find_mesh->second;
  if (!mesh_unique_ptr)
    mooseError("While getting the saved mesh generator '",
               name,
               "', said mesh has already been retrieved");

  return std::move(mesh_unique_ptr);
}

bool
MeshGeneratorSystem::appendingMeshGenerators() const
{
  return _app.actionWarehouse().getCurrentTaskName() == "append_mesh_generator";
}

bool
MeshGeneratorSystem::hasDataDrivenAllowed() const
{
  return _app.parameters().get<bool>(allow_data_driven_param);
}

const std::string &
MeshGeneratorSystem::getDataDrivenGeneratorName() const
{
  mooseAssert(_data_driven_generator_name, "Not set");
  return *_data_driven_generator_name;
}

void
MeshGeneratorSystem::dataDrivenError(const MeshGenerator & generator,
                                     const std::string & message) const
{
  const auto & moose_mesh = _app.actionWarehouse().getMesh();
  moose_mesh->paramError(data_driven_generator_param,
                         "The generator '",
                         getDataDrivenGeneratorName(),
                         "' cannot be used in data-driven mode because the parent ",
                         generator.typeAndName(),
                         " ",
                         message);
}

void
MeshGeneratorSystem::setCSGOnly()
{
  _csg_only = true;
}

void
MeshGeneratorSystem::saveOutputCSGBase(const MeshGeneratorName generator_name,
                                       std::unique_ptr<CSG::CSGBase> & csg_base)
{
  auto & outputs = _csg_base_outputs[generator_name];

  // Store CSGBase instance for any downstream MG's that request it, creating copies
  // as needed
  if (outputs.size())
  {
    // Set first output to csg_base
    auto & first_output = *outputs.begin();
    first_output = std::move(csg_base);
    const auto & copy_from = *first_output;
    auto output_it = ++outputs.begin();
    // For all of the rest we create a clone of csg_base
    for (; output_it != outputs.end(); ++output_it)
      (*output_it) = copy_from.clone();
  }
}

std::unique_ptr<CSG::CSGBase> &
MeshGeneratorSystem::getCSGBaseGeneratorOutput(const MeshGeneratorName & name)
{
  mooseAssert(_app.constructingMeshGenerators() ||
                  _app.actionWarehouse().getCurrentTaskName() == "execute_mesh_generators",
              "Incorrect call time");

  auto it = _csg_base_outputs.find(name);
  mooseAssert(it != _csg_base_outputs.end(), "CSG mesh not initialized");
  it->second.push_back(nullptr);
  return it->second.back();
}