Subdivides a sidesets into smaller patches each of which is going to be a new patch. More...

#include <PatchSidesetGenerator.h>

Inheritance diagram for PatchSidesetGenerator:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PatchSidesetGenerator (const InputParameters &parameters)

std::unique_ptr< MeshBase >	generate () override

unsigned int	nPatches () const

std::unique_ptr< CSG::CSGBase >	generateInternalCSG ()

std::unique_ptr< MeshBase >	generateInternal ()

const std::set< MeshGeneratorName > &	getRequestedMeshGenerators () const

const std::set< MeshGeneratorName > &	getRequestedMeshGeneratorsForSub () const

void	addParentMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)

void	addChildMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)

const std::set< const MeshGenerator *, Comparator > &	getParentMeshGenerators () const

const std::set< const MeshGenerator *, Comparator > &	getChildMeshGenerators () const

const std::set< const MeshGenerator *, Comparator > &	getSubMeshGenerators () const

bool	isParentMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const

bool	isChildMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const

bool	isNullMeshName (const MeshGeneratorName &name) const

bool	hasSaveMesh () const

bool	hasOutput () const

const std::string &	getSavedMeshName () const

bool	hasGenerateData () const

bool	hasGenerateCSG () const

bool	isDataOnly () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static bool	hasGenerateData (const InputParameters &params)

static bool	hasGenerateCSG (const InputParameters &params)

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

static void	setHasGenerateData (InputParameters &params)

static void	setHasGenerateCSG (InputParameters &params)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	data_only_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
std::vector< BoundaryName >	sidesetNameHelper (const std::string &base_name) const
	returns the name of the _n_patches subdivisions derived from _sideset

Elem *	boundaryElementHelper (MeshBase &mesh, libMesh::ElemType type) const

void	partition (MeshBase &mesh)
	a function for implementing custom partitioning

void	checkPartitionAndCompress (MeshBase &mesh)
	Checks partitions and makes sure every partition has at least one elem.

virtual void	generateData ()

virtual std::unique_ptr< CSG::CSGBase >	generateCSG ()

T &	copyMeshProperty (const std::string &target_data_name, const std::string &source_data_name, const std::string &source_mesh)

T &	copyMeshProperty (const std::string &source_data_name, const std::string &source_mesh)

std::unique_ptr< MeshBase > &	getMesh (const std::string &param_name, const bool allow_invalid=false)

std::vector< std::unique_ptr< MeshBase > * >	getMeshes (const std::string &param_name)

std::unique_ptr< MeshBase > &	getMeshByName (const MeshGeneratorName &mesh_generator_name)

std::vector< std::unique_ptr< MeshBase > * >	getMeshesByName (const std::vector< MeshGeneratorName > &mesh_generator_names)

std::unique_ptr< CSG::CSGBase > &	getCSGBase (const std::string &param_name)

std::unique_ptr< CSG::CSGBase > &	getCSGBaseByName (const MeshGeneratorName &mesh_generator_name)

std::vector< std::unique_ptr< CSG::CSGBase > * >	getCSGBases (const std::string &param_name)

std::vector< std::unique_ptr< CSG::CSGBase > * >	getCSGBasesByName (const std::vector< MeshGeneratorName > &mesh_generator_names)

void	declareMeshForSub (const std::string &param_name)

void	declareMeshesForSub (const std::string &param_name)

void	declareMeshForSubByName (const MeshGeneratorName &mesh_generator_name)

void	declareMeshesForSubByName (const std::vector< MeshGeneratorName > &mesh_generator_names)

std::unique_ptr< MeshBase >	buildMeshBaseObject (unsigned int dim=libMesh::invalid_uint)

std::unique_ptr< ReplicatedMesh >	buildReplicatedMesh (unsigned int dim=libMesh::invalid_uint)

std::unique_ptr< DistributedMesh >	buildDistributedMesh (unsigned int dim=libMesh::invalid_uint)

void	addMeshSubgenerator (const std::string &type, const std::string &name, Ts... extra_input_parameters)

void	addMeshSubgenerator (const std::string &type, const std::string &name, InputParameters params)

void	declareNullMeshName (const MeshGeneratorName &name)

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

T &	declareMeshProperty (const std::string &data_name, Args &&... args)

T &	declareMeshProperty (const std::string &data_name, const T &data_value)

T &	declareMeshProperty (const std::string &data_name, Args &&... args)

T &	declareMeshProperty (const std::string &data_name, const T &data_value)

T &	setMeshProperty (const std::string &data_name, Args &&... args)

T &	setMeshProperty (const std::string &data_name, const T &data_value)

T &	setMeshProperty (const std::string &data_name, Args &&... args)

T &	setMeshProperty (const std::string &data_name, const T &data_value)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::unique_ptr< MeshBase > &	_input

unsigned int	_dim
	dimensionality of the sidesets to partition

unsigned int	_n_patches
	the number of patches that this sideset generator divides _sideset into

const BoundaryName &	_sideset_name
	The sideset that will be subdivided.

MooseEnum	_partitioner_name
	the name of the partitioner being used

BoundaryID	_sideset
	The sideset that will be subdivided.

dof_id_type	_n_boundary_mesh_elems
	number of elements of the boundary mesh

MooseMesh *const	_mesh

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const Parallel::Communicator &	_communicator

Private Member Functions
virtual std::string	meshPropertyPrefix (const std::string &) const override final

void	checkGetMesh (const MeshGeneratorName &mesh_generator_name, const std::string &param_name) const

const MeshGeneratorName *	getMeshGeneratorNameFromParam (const std::string &param_name, const bool allow_invalid) const

const std::vector< MeshGeneratorName > &	getMeshGeneratorNamesFromParam (const std::string &param_name) const

RestartableDataValue &	setMeshPropertyHelper (const std::string &data_name)

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
std::set< MeshGeneratorName >	_requested_mesh_generators

std::set< MeshGeneratorName >	_requested_mesh_generators_for_sub

std::vector< std::pair< std::string, std::unique_ptr< MeshBase > * > >	_requested_meshes

std::vector< std::pair< std::string, std::unique_ptr< CSG::CSGBase > * > >	_requested_csg_bases

std::unique_ptr< MeshBase >	_null_mesh

std::unique_ptr< CSG::CSGBase >	_null_csg_base

std::set< const MeshGenerator *, Comparator >	_parent_mesh_generators

std::set< const MeshGenerator *, Comparator >	_child_mesh_generators

std::set< const MeshGenerator *, Comparator >	_sub_mesh_generators

std::set< std::string >	_null_mesh_names

const std::string &	_save_with_name

const bool	_data_only

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

Detailed Description

Subdivides a sidesets into smaller patches each of which is going to be a new patch.

Definition at line 21 of file PatchSidesetGenerator.h.

Constructor & Destructor Documentation

◆ PatchSidesetGenerator()

PatchSidesetGenerator::PatchSidesetGenerator ( const InputParameters & parameters )

Definition at line 64 of file PatchSidesetGenerator.C.

  : MeshGenerator(parameters),
    _input(getMesh("input")),
    _n_patches(getParam<unsigned int>("n_patches")),
    _sideset_name(getParam<BoundaryName>("boundary")),
    _partitioner_name(getParam<MooseEnum>("partitioner"))
{
}

Member Function Documentation

◆ boundaryElementHelper()

Elem * PatchSidesetGenerator::boundaryElementHelper	(	MeshBase &	mesh,
		libMesh::ElemType	type
	)		const

protected

Definition at line 369 of file PatchSidesetGenerator.C.

{
  std::unique_ptr<Elem> elem = libMesh::Elem::build(type);
  if (elem->dim() < 3)
    return mesh.add_elem(std::move(elem));
 
  mooseError("Unsupported element type (libMesh elem_type enum): ", type);
}

Referenced by generate().

◆ checkPartitionAndCompress()

void PatchSidesetGenerator::checkPartitionAndCompress ( MeshBase & mesh )

protected

Checks partitions and makes sure every partition has at least one elem.

If a partition is empty, it's removed and the remaining ones are "renamed"

Definition at line 318 of file PatchSidesetGenerator.C.

{
  std::set<processor_id_type> processor_ids;
  for (auto & elem_ptr : mesh.active_element_ptr_range())
    processor_ids.insert(elem_ptr->processor_id());
 
  if (processor_ids.size() == _n_patches)
    return;
 
  // at least one partition does not have an elem assigned to it
  // adjust _n_patches
  _console << "Some partitions for side set " << _sideset
           << " are empty. Adjusting number of patches from " << _n_patches << " to "
           << processor_ids.size() << std::endl;
  _n_patches = processor_ids.size();
 
  // create a vector and sort it
  std::vector<processor_id_type> processor_ids_vec;
  for (auto & p : processor_ids)
    processor_ids_vec.push_back(p);
  std::sort(processor_ids_vec.begin(), processor_ids_vec.end());
 
  // now remap the processor ids
  std::map<processor_id_type, processor_id_type> processor_id_remap;
  for (MooseIndex(processor_ids_vec.size()) j = 0; j < processor_ids_vec.size(); ++j)
    processor_id_remap[processor_ids_vec[j]] = j;
 
  for (auto & elem_ptr : mesh.active_element_ptr_range())
  {
    processor_id_type p = elem_ptr->processor_id();
    const auto & it = processor_id_remap.find(p);
    if (it == processor_id_remap.end())
      mooseError("Parition id ", p, " not in processor_id_remap.");
    elem_ptr->processor_id() = it->second;
  }
}

Referenced by generate().

◆ generate()

std::unique_ptr< MeshBase > PatchSidesetGenerator::generate ( )

overridevirtual

Implements MeshGenerator.

Definition at line 74 of file PatchSidesetGenerator.C.

{
  std::unique_ptr<MeshBase> mesh = std::move(_input);
 
  _mesh->errorIfDistributedMesh("PatchSidesetGenerator");
 
  // Get a reference to our BoundaryInfo object for later use
  BoundaryInfo & boundary_info = mesh->get_boundary_info();
 
  // get dimensionality
  _dim = mesh->mesh_dimension() - 1;
 
  // get a list of all sides; vector of tuples (elem, loc_side, side_set)
  auto side_list = boundary_info.build_active_side_list();
 
  if (!MooseMeshUtils::hasBoundaryNameOrID(*mesh, _sideset_name))
    paramError("boundary",
               "The provided boundary name or ID (" + _sideset_name +
                   ") does not exist in the mesh.");
 
  _sideset = MooseMeshUtils::getBoundaryID(_sideset_name, *mesh);
 
  // create a dim - 1 dimensional mesh
  auto boundary_mesh = buildReplicatedMesh(mesh->mesh_dimension() - 1);
  boundary_mesh->set_mesh_dimension(mesh->mesh_dimension() - 1);
  boundary_mesh->set_spatial_dimension(mesh->mesh_dimension());
 
  // nodes in the new mesh by boundary_node_id (index)
  std::vector<Node *> boundary_nodes;
  // a map from the node numbering on the volumetric mesh to the numbering
  // on the boundary_mesh
  std::map<dof_id_type, dof_id_type> mesh_node_id_to_boundary_node_id;
  // a local counter keeping track of how many entries have been added to boundary_nodes
  dof_id_type boundary_node_id = 0;
  // a map from new element id in the boundary mesh to the element id/side/sideset
  // tuple it came from
  std::map<dof_id_type, std::tuple<dof_id_type, unsigned short int, boundary_id_type>>
      boundary_elem_to_mesh_elem;
  for (auto & side : side_list)
  {
    if (std::get<2>(side) == _sideset)
    {
      // the original volumetric mesh element
      const Elem * elem = mesh->elem_ptr(std::get<0>(side));
 
      // the boundary element
      std::unique_ptr<const Elem> boundary_elem = elem->side_ptr(std::get<1>(side));
 
      // an array that saves the boundary node ids of this elem in the right order
      std::vector<dof_id_type> bnd_elem_node_ids(boundary_elem->n_nodes());
 
      // loop through the nodes in boundary_elem
      for (MooseIndex(boundary_elem->n_nodes()) j = 0; j < boundary_elem->n_nodes(); ++j)
      {
        const Node * node = boundary_elem->node_ptr(j);
 
        // Is this node a new node?
        if (mesh_node_id_to_boundary_node_id.find(node->id()) ==
            mesh_node_id_to_boundary_node_id.end())
        {
          // yes, it is new, need to add it to the mesh_node_id_to_boundary_node_id map
          mesh_node_id_to_boundary_node_id.insert(
              std::pair<dof_id_type, dof_id_type>(node->id(), boundary_node_id));
 
          // this adds this node to the boundary mesh and puts it at the right position
          // in the boundary_nodes array
          Point pt(*node);
          boundary_nodes.push_back(boundary_mesh->add_point(pt, boundary_node_id));
 
          // keep track of the boundary node for setting up the element
          bnd_elem_node_ids[j] = boundary_node_id;
 
          // increment the boundary_node_id counter
          ++boundary_node_id;
        }
        else
          bnd_elem_node_ids[j] = mesh_node_id_to_boundary_node_id.find(node->id())->second;
      }
 
      // all nodes for this element have been added, so we can add the element to the
      // boundary mesh
      Elem * new_bnd_elem = boundaryElementHelper(*boundary_mesh, boundary_elem->type());
 
      // keep track of these new boundary elements in boundary_elem_to_mesh_elem
      boundary_elem_to_mesh_elem.insert(
          std::pair<dof_id_type, std::tuple<dof_id_type, unsigned short int, boundary_id_type>>(
              new_bnd_elem->id(), side));
 
      // set the nodes & subdomain_id of the new element by looping over the
      // boundary_elem and then inserting its nodes into new_bnd_elem in the
      // same order
      for (MooseIndex(boundary_elem->n_nodes()) j = 0; j < boundary_elem->n_nodes(); ++j)
      {
        dof_id_type old_node_id = boundary_elem->node_ptr(j)->id();
        if (mesh_node_id_to_boundary_node_id.find(old_node_id) ==
            mesh_node_id_to_boundary_node_id.end())
          mooseError("Node id", old_node_id, " not linked to new node id.");
        dof_id_type new_node_id = mesh_node_id_to_boundary_node_id.find(old_node_id)->second;
        new_bnd_elem->set_node(j, boundary_nodes[new_node_id]);
      }
    }
  }
 
  // partition the boundary mesh
  boundary_mesh->prepare_for_use();
  _n_boundary_mesh_elems = boundary_mesh->n_elem();
  if (_partitioner_name == "grid")
    partition(*boundary_mesh);
  else
  {
    auto partitioner_enum = getParam<MooseEnum>("partitioner");
    MooseMesh::setPartitioner(*boundary_mesh, partitioner_enum, false, _pars, *this);
    boundary_mesh->partition(_n_patches);
  }
 
  // make sure every partition has at least one element; if not rename and adjust _n_patches
  checkPartitionAndCompress(*boundary_mesh);
 
  // prepare sideset names and boundary_ids added to mesh
  std::vector<BoundaryName> sideset_names =
      sidesetNameHelper(boundary_info.get_sideset_name(_sideset));
 
  std::vector<boundary_id_type> boundary_ids =
      MooseMeshUtils::getBoundaryIDs(*mesh, sideset_names, true);
 
  mooseAssert(sideset_names.size() == _n_patches,
              "sideset_names must have as many entries as user-requested number of patches.");
  mooseAssert(boundary_ids.size() == _n_patches,
              "boundary_ids must have as many entries as user-requested number of patches.");
 
  // loop through all elements in the boundary mesh and assign the side of
  // the _original_ element to the new sideset
  for (const auto & elem : boundary_mesh->active_element_ptr_range())
  {
    const auto it = boundary_elem_to_mesh_elem.find(elem->id());
    if (it == boundary_elem_to_mesh_elem.end())
      mooseError("Element in the boundary mesh with id ",
                 elem->id(),
                 " not found in boundary_elem_to_mesh_elem.");
 
    auto side = boundary_elem_to_mesh_elem.find(elem->id())->second;
 
    mooseAssert(elem->processor_id() < boundary_ids.size(),
                "Processor id larger than number of patches.");
    boundary_info.add_side(
        std::get<0>(side), std::get<1>(side), boundary_ids[elem->processor_id()]);
  }
 
  // make sure new boundary names are set
  for (MooseIndex(boundary_ids.size()) j = 0; j < boundary_ids.size(); ++j)
  {
    boundary_info.sideset_name(boundary_ids[j]) = sideset_names[j];
    boundary_info.nodeset_name(boundary_ids[j]) = sideset_names[j];
  }
 
  return mesh;
}

◆ nPatches()

unsigned int PatchSidesetGenerator::nPatches ( ) const

inline

Definition at line 30 of file PatchSidesetGenerator.h.

30{ return _n_patches; }

Referenced by RadiationTransferAction::nPatch().

◆ partition()

void PatchSidesetGenerator::partition ( MeshBase & mesh )

protected

a function for implementing custom partitioning

Definition at line 233 of file PatchSidesetGenerator.C.

{
  if (_partitioner_name == "grid")
  {
    // Figure out the physical bounds of the given mesh
    auto bounding_box = MeshTools::create_bounding_box(mesh);
    const auto & min = bounding_box.min();
    const auto & max = bounding_box.max();
    const auto & delta = max - min;
 
    // set number of elements
    std::vector<unsigned int> nelems(3);
    if (_dim == 1)
    {
      // find the largest component in delta
      unsigned int largest_id = 0;
      Real largest = delta(0);
      for (unsigned int j = 1; j < 3; ++j)
        if (largest < delta(j))
        {
          largest = delta(j);
          largest_id = j;
        }
 
      // set nelems now
      nelems = {1, 1, 1};
      nelems[largest_id] = _n_patches;
    }
    else
    {
      // find the smallest component in delta
      unsigned int smallest_id = 0;
      Real smallest = delta(0);
      for (unsigned int j = 1; j < 3; ++j)
        if (smallest > delta(j))
        {
          smallest = delta(j);
          smallest_id = j;
        }
 
      // store the ids for the two larger dimensions
      unsigned int id1 = 1, id2 = 2;
      if (smallest_id == 1)
        id1 = 0;
      else if (smallest_id == 2)
        id2 = 0;
 
      // set number of elements
      nelems[smallest_id] = 1;
      nelems[id1] = std::round(std::sqrt(delta(id1) / delta(id2) * _n_patches));
      nelems[id2] = std::round(std::sqrt(delta(id2) / delta(id1) * _n_patches));
      const std::size_t final_n_patches = nelems[id1] * nelems[id2];
      // We need to check if the number of requested patches and the number of
      // actually created patches matches. If the two do not match, then a warning
      // is printed.
      if (_n_patches != final_n_patches)
      {
        _console << "Note: For creating radiation patches for boundary " << _sideset
                 << " using grid partitioner number of patches was changed from " << _n_patches
                 << " to " << final_n_patches << std::endl;
        _n_patches = final_n_patches;
      }
    }
 
    const Point delem(delta(0) / nelems[0], delta(1) / nelems[1], delta(2) / nelems[2]);
    for (auto & elem_ptr : mesh.active_element_ptr_range())
    {
      const Point centroid = elem_ptr->vertex_average();
      std::array<unsigned int, 3> ielem;
      for (const auto i : make_range(LIBMESH_DIM))
      {
        const auto dist = centroid(i) - min(i);
        ielem[i] = (std::abs(dist) < (libMesh::TOLERANCE * libMesh::TOLERANCE))
                       ? 0
                       : std::floor(dist / delem(i));
      }
      elem_ptr->processor_id() = ielem[0] + nelems[0] * (ielem[1] + ielem[2] * nelems[1]);
      mooseAssert(elem_ptr->processor_id() < _n_patches, "Invalid processor id");
    }
  }
  else
    mooseError("Partitioner ", _partitioner_name, " not recognized.");
}

Referenced by generate().

◆ sidesetNameHelper()

std::vector< BoundaryName > PatchSidesetGenerator::sidesetNameHelper ( const std::string & base_name ) const

protected

returns the name of the _n_patches subdivisions derived from _sideset

Definition at line 356 of file PatchSidesetGenerator.C.

{
  std::vector<BoundaryName> rv;
  for (unsigned int j = 0; j < _n_patches; ++j)
  {
    std::stringstream ss;
    ss << base_name << "_" << j;
    rv.push_back(ss.str());
  }
  return rv;
}

Referenced by generate().

◆ validParams()

InputParameters PatchSidesetGenerator::validParams ( )

static

Definition at line 33 of file PatchSidesetGenerator.C.

{
  InputParameters params = MeshGenerator::validParams();
 
  params.addRequiredParam<MeshGeneratorName>("input", "The mesh we want to modify");
  params.addRequiredParam<BoundaryName>("boundary",
                                        "The boundary that will be divided into patches");
  params.addRequiredRangeCheckedParam<unsigned int>(
      "n_patches", "n_patches>0", "Number of patches");
 
  MooseEnum partitioning = MooseMesh::partitioning(); // default MOOSE partitioning
  partitioning += "grid";                             // ...but also add our own
  params.addParam<MooseEnum>(
      "partitioner",
      partitioning,
      "Specifies a mesh partitioner to use when splitting the mesh for a parallel computation.");
 
  MooseEnum direction("x y z radial");
  params.addParam<MooseEnum>("centroid_partitioner_direction",
                             direction,
                             "Specifies the sort direction if using the centroid partitioner. "
                             "Available options: x, y, z, radial");
 
  params.addParamNamesToGroup("partitioner centroid_partitioner_direction", "Partitioning");
 
  params.addClassDescription(
      "Divides the given sideset into smaller patches of roughly equal size.");
 
  return params;
}

Member Data Documentation

◆ _dim

unsigned int PatchSidesetGenerator::_dim

protected

dimensionality of the sidesets to partition

Definition at line 50 of file PatchSidesetGenerator.h.

Referenced by generate(), and partition().

◆ _input

std::unique_ptr<MeshBase>& PatchSidesetGenerator::_input

protected

Definition at line 47 of file PatchSidesetGenerator.h.

Referenced by generate().

◆ _n_boundary_mesh_elems

dof_id_type PatchSidesetGenerator::_n_boundary_mesh_elems

protected

number of elements of the boundary mesh

Definition at line 65 of file PatchSidesetGenerator.h.

Referenced by generate().

◆ _n_patches

unsigned int PatchSidesetGenerator::_n_patches

protected

the number of patches that this sideset generator divides _sideset into

Definition at line 53 of file PatchSidesetGenerator.h.

Referenced by checkPartitionAndCompress(), generate(), nPatches(), partition(), and sidesetNameHelper().

◆ _partitioner_name

MooseEnum PatchSidesetGenerator::_partitioner_name

protected

the name of the partitioner being used

Definition at line 59 of file PatchSidesetGenerator.h.

Referenced by generate(), and partition().

◆ _sideset

BoundaryID PatchSidesetGenerator::_sideset

protected

The sideset that will be subdivided.

Definition at line 62 of file PatchSidesetGenerator.h.

Referenced by checkPartitionAndCompress(), generate(), and partition().

◆ _sideset_name

const BoundaryName& PatchSidesetGenerator::_sideset_name

protected

The sideset that will be subdivided.

Definition at line 56 of file PatchSidesetGenerator.h.

Referenced by generate().

The documentation for this class was generated from the following files:

heat_transfer/include/meshgenerators/PatchSidesetGenerator.h
heat_transfer/src/meshgenerators/PatchSidesetGenerator.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PatchSidesetGenerator()

Member Function Documentation

◆ boundaryElementHelper()

◆ checkPartitionAndCompress()

◆ generate()

◆ nPatches()

◆ partition()

◆ sidesetNameHelper()

◆ validParams()

Member Data Documentation

◆ _dim

◆ _input

◆ _n_boundary_mesh_elems

◆ _n_patches

◆ _partitioner_name

◆ _sideset

◆ _sideset_name