#include <SubdomainExtraElementIDGenerator.h>

Inheritance diagram for SubdomainExtraElementIDGenerator:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SubdomainExtraElementIDGenerator (const InputParameters &parameters)

virtual std::unique_ptr< MeshBase >	generate () override

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	isDataOnly () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

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

void	callMooseError (std::string msg, const bool with_prefix) const

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () 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 &	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 &nm) const

void	paramError (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

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

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

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

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

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

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

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

void	mooseInfo (Args &&... args) 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 void	setHasGenerateData (InputParameters &params)

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static const std::string	data_only_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual void	generateData ()

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)

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)

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
	input mesh for adding element IDs More...

const std::vector< SubdomainName > &	_subdomain_names
	subdomains that are to be assigned with element IDs More...

MooseMesh *const	_mesh

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

Detailed Description

Definition at line 14 of file SubdomainExtraElementIDGenerator.h.

Constructor & Destructor Documentation

◆ SubdomainExtraElementIDGenerator()

SubdomainExtraElementIDGenerator::SubdomainExtraElementIDGenerator ( const InputParameters & parameters )

Definition at line 40 of file SubdomainExtraElementIDGenerator.C.

   : MeshGenerator(params),
     _input(getMesh("input")),
     _subdomain_names(getParam<std::vector<SubdomainName>>("subdomains"))
 {
   if (_subdomain_names.size() == 0)
     paramError("subdomains", "Empty subdomain vector provided!");
 }

Member Function Documentation

◆ generate()

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

overridevirtual

Implements MeshGenerator.

Definition at line 50 of file SubdomainExtraElementIDGenerator.C.

 {
   std::unique_ptr<MeshBase> mesh = std::move(_input);
 
   // construct a map from the subdomain ID to the index in 'subdomains'
   auto subdomain_ids = MooseMeshUtils::getSubdomainIDs(*mesh, _subdomain_names);
 
   // check that all subdomains are present
   for (const auto & name : _subdomain_names)
     if (!MooseMeshUtils::hasSubdomainName(*mesh, name))
       paramError("subdomains", "Subdomain " + name + " does not exist in the mesh");
 
   // check to make sure no duplicated subdomain ids
   std::set<SubdomainID> unique_subdomain_ids;
   for (const auto & id : subdomain_ids)
     if (unique_subdomain_ids.count(id) > 0)
       paramError("subdomains", "Cannot have subdomain with ID ", id, " listed more than once!");
     else
       unique_subdomain_ids.insert(id);
 
   std::map<SubdomainID, unsigned int> subdomains;
   for (unsigned int i = 0; i < _subdomain_names.size(); ++i)
     subdomains[subdomain_ids[i]] = i;
 
   auto & element_id_names = getParam<std::vector<std::string>>("extra_element_id_names");
   auto & element_ids = getParam<std::vector<std::vector<dof_id_type>>>("extra_element_ids");
 
   if (element_id_names.size() != element_ids.size())
     paramError("extra_element_ids", "Inconsistent vector size for element IDs");
   for (auto & element_id : element_ids)
   {
     if (_subdomain_names.size() != element_id.size())
       paramError("extra_element_ids", "Inconsistent vector size for element IDs");
   }
 
   // get indices for all extra element integers
   std::vector<unsigned int> extra_id_indices;
   for (auto & element_id_name : element_id_names)
   {
     if (!mesh->has_elem_integer(element_id_name))
       extra_id_indices.push_back(mesh->add_elem_integer(element_id_name));
     else
       extra_id_indices.push_back(mesh->get_elem_integer_index(element_id_name));
   }
 
   if (isParamValid("default_extra_element_ids"))
   {
     auto & default_ids = getParam<std::vector<dof_id_type>>("default_extra_element_ids");
     if (default_ids.size() != element_id_names.size())
       paramError("default_extra_element_ids", "Inconsistent vector size for default element IDs");
 
     for (auto & elem : mesh->element_ptr_range())
       for (unsigned int i = 0; i < element_ids.size(); ++i)
         elem->set_extra_integer(extra_id_indices[i], default_ids[i]);
   }
 
   for (auto & elem : mesh->element_ptr_range())
   {
     SubdomainID id = elem->subdomain_id();
     auto it = subdomains.find(id);
     if (it == subdomains.end())
       continue;
 
     for (unsigned int i = 0; i < element_ids.size(); ++i)
       elem->set_extra_integer(extra_id_indices[i], element_ids[i][it->second]);
   }
 
   return mesh;
 }

◆ validParams()

InputParameters SubdomainExtraElementIDGenerator::validParams ( )

static

Definition at line 19 of file SubdomainExtraElementIDGenerator.C.

 {
   InputParameters params = MeshGenerator::validParams();
   params.addRequiredParam<MeshGeneratorName>(
       "input", "Name of an existing mesh generator to which we assign element IDs");
   params.addRequiredParam<std::vector<SubdomainName>>("subdomains",
                                                       "Subdomain names present in the input mesh");
   params.addRequiredParam<std::vector<std::string>>("extra_element_id_names",
                                                     "List of user-defined extra element ID names");
   params.addRequiredParam<std::vector<std::vector<dof_id_type>>>(
       "extra_element_ids",
       "User-defined extra element IDs corresponding to 'subdomains' in the same order");
 
   params.addParam<std::vector<dof_id_type>>(
       "default_extra_element_ids", "Default extra element IDs for elements not in 'subdomains'");
 
   params.addClassDescription(
       "Assign extra element IDs for elements on a mesh based on mesh subdomains.");
   return params;
 }