ReportingIDGeneratorUtils Namespace Reference

Enumerations
enum	AssignType { AssignType::cell, AssignType::pattern, AssignType::manual }
	Enum item for reporting id assign types. More...

Functions
std::vector< dof_id_type >	getCellwiseIntegerIDs (const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &meshes, const std::vector< std::vector< unsigned int >> &pattern, const bool use_exclude_id, const std::vector< bool > &exclude_ids)
	assign IDs for each component in pattern in sequential order More...
std::vector< dof_id_type >	getPatternIntegerIDs (const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &meshes, const std::vector< std::vector< unsigned int >> &pattern)
	assign IDs for each input component type More...
std::vector< dof_id_type >	getManualIntegerIDs (const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &meshes, const std::vector< std::vector< unsigned int >> &pattern, const std::vector< std::vector< dof_id_type >> &id_pattern)
	assign IDs based on user-defined mapping defined in id_pattern More...
std::set< SubdomainID >	getCellBlockIDs (const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &meshes, const std::vector< std::vector< unsigned int >> &pattern)
	get list of block IDs in input mesh cells More...
std::map< SubdomainID, unsigned int >	getDuckBlockIDs (const MeshBase &mesh, const bool has_assembly_boundary, const std::set< subdomain_id_type > background_blk_ids, const std::set< SubdomainID > &blks)
	get list of block IDs for the assembly duck regions More...
void	assignReportingIDs (MeshBase &mesh, const unsigned int extra_id_index, const ReportingIDGeneratorUtils::AssignType assign_type, const bool use_exclude_id, const std::vector< bool > &exclude_ids, const bool has_assembly_boundary, const std::set< subdomain_id_type > background_block_ids, const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &input_meshes, const std::vector< std::vector< unsigned int >> &pattern, const std::vector< std::vector< dof_id_type >> &id_pattern)
	assign the reporting IDs to the output mesh from the cartesian or hexagonal patterned mesh generator More...

Enumeration Type Documentation

AssignType

enum ReportingIDGeneratorUtils::AssignType

strong

Enum item for reporting id assign types.

Enumerator
cell	assign unique IDs for each tile in the lattice in sequential order
pattern	assign the same reporting IDs for all tiles in the pattern with same input
manual	assign IDs based on user-defined mapping

Definition at line 22 of file ReportingIDGeneratorUtils.h.

{
  cell,
  pattern,
  manual
};

Function Documentation

assignReportingIDs()

void ReportingIDGeneratorUtils::assignReportingIDs	(	MeshBase &	mesh,
		const unsigned int	extra_id_index,
		const ReportingIDGeneratorUtils::AssignType	assign_type,
		const bool	use_exclude_id,
		const std::vector< bool > &	exclude_ids,
		const bool	has_assembly_boundary,
		const std::set< subdomain_id_type >	background_block_ids,
		const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &	input_meshes,
		const std::vector< std::vector< unsigned int >> &	pattern,
		const std::vector< std::vector< dof_id_type >> &	id_pattern
	)

assign the reporting IDs to the output mesh from the cartesian or hexagonal patterned mesh generator

Parameters

mesh	output mesh from the cartesian or hexagonal patterned mesh generator
extra_id_index	index of extra integer id for assigning the reproting IDs
assign_type	type of integer ID assignment
use_exclude_id	flag to indicate if exclude_id is defined
exclude_ids	flag to indicate if exclude_id is used for each input mesh
has_assembly_boundary	flag to indicate if assembly boundary exists
background_block_ids	list of block ID assigned to background regions
input_meshes	input meshes of the cartesian or hexagonal patterned mesh generator
pattern	2D vector of the mesh pattern
id_pattern	user-defined integer ID for each input pattern cell

Returns

output mesh file having reporting IDs

Referenced by PatternedCartesianMeshGenerator::addReportingIDs(), PatternedHexMeshGenerator::addReportingIDs(), and CartesianIDPatternedMeshGenerator::generate().

getCellBlockIDs()

std::set< SubdomainID > ReportingIDGeneratorUtils::getCellBlockIDs	(	const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &	meshes,
		const std::vector< std::vector< unsigned int >> &	pattern
	)

get list of block IDs in input mesh cells

Parameters

meshes	input meshes of the cartesian or hexagonal patterned mesh generator
pattern	2D vector of the mesh pattern

Returns

list of block IDs in input meshes

Definition at line 74 of file ReportingIDGeneratorUtils.C.

{
  std::set<SubdomainID> blks;
  for (MooseIndex(pattern) i = 0; i < pattern.size(); ++i)
    for (MooseIndex(pattern[i]) j = 0; j < pattern[i].size(); ++j)
    {
      std::set<SubdomainID> mesh_blks;
      meshes[pattern[i][j]]->subdomain_ids(mesh_blks);
      blks.insert(mesh_blks.begin(), mesh_blks.end());
    }
  return blks;
}

getCellwiseIntegerIDs()

std::vector< dof_id_type > ReportingIDGeneratorUtils::getCellwiseIntegerIDs	(	const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &	meshes,
		const std::vector< std::vector< unsigned int >> &	pattern,
		const bool	use_exclude_id,
		const std::vector< bool > &	exclude_ids
	)

assign IDs for each component in pattern in sequential order

Parameters

meshes	input meshes of the cartesian or hexagonal patterned mesh generator
pattern	2D vector of the mesh pattern
use_exclude_id	flag to indicate if exclude_id is defined
exclude_ids	flag to indicate if exclude_id is used for each input mesh

Returns

list of reporting IDs for individual mesh elements

Definition at line 15 of file ReportingIDGeneratorUtils.C.

{
  dof_id_type n = 0;
  for (MooseIndex(pattern) i = 0; i < pattern.size(); ++i)
    for (MooseIndex(pattern[i]) j = 0; j < pattern[i].size(); ++j)
      n += meshes[pattern[i][j]]->n_elem();
  std::vector<dof_id_type> integer_ids;
  integer_ids.reserve(n);
  dof_id_type id = 0;
  for (MooseIndex(pattern) i = 0; i < pattern.size(); ++i)
    for (MooseIndex(pattern[i]) j = 0; j < pattern[i].size(); ++j)
    {
      const auto value =
          (use_exclude_id && exclude_ids[pattern[i][j]]) ? DofObject::invalid_id : id++;
      integer_ids.insert(integer_ids.end(), meshes[pattern[i][j]]->n_elem(), value);
    }
  return integer_ids;
}

getDuckBlockIDs()

std::map<SubdomainID, unsigned int> ReportingIDGeneratorUtils::getDuckBlockIDs	(	const MeshBase &	mesh,
		const bool	has_assembly_boundary,
		const std::set< subdomain_id_type >	background_blk_ids,
		const std::set< SubdomainID > &	blks
	)

get list of block IDs for the assembly duck regions

Parameters

mesh	output mesh from the cartesian or hexagonal patterned mesh generator
has_assembly_boundary	flag to indicate if assembly boundary exists
background_blk_ids	list of block ID assigned to background regions
blks	list of block defined in the input meshes of the cartesian or hexagonal patterned mesh generator

Returns

list of block ids in the assembly duct region

getManualIntegerIDs()

std::vector< dof_id_type > ReportingIDGeneratorUtils::getManualIntegerIDs	(	const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &	meshes,
		const std::vector< std::vector< unsigned int >> &	pattern,
		const std::vector< std::vector< dof_id_type >> &	id_pattern
	)

assign IDs based on user-defined mapping defined in id_pattern

Parameters

meshes	input meshes of the cartesian or hexagonal patterned mesh generator
pattern	2D vector of the mesh pattern
id_pattern	user-defined integer ID for each input pattern cell

Returns

list of reporting IDs for individual mesh elements

Definition at line 56 of file ReportingIDGeneratorUtils.C.

{
  dof_id_type n = 0;
  for (MooseIndex(pattern) i = 0; i < pattern.size(); ++i)
    for (MooseIndex(pattern[i]) j = 0; j < pattern[i].size(); ++j)
      n += meshes[pattern[i][j]]->n_elem();
  std::vector<dof_id_type> integer_ids;
  integer_ids.reserve(n);
  for (MooseIndex(pattern) i = 0; i < pattern.size(); ++i)
    for (MooseIndex(pattern[i]) j = 0; j < pattern[i].size(); ++j)
      integer_ids.insert(integer_ids.end(), meshes[pattern[i][j]]->n_elem(), id_pattern[i][j]);
  return integer_ids;
}

getPatternIntegerIDs()

std::vector< dof_id_type > ReportingIDGeneratorUtils::getPatternIntegerIDs	(	const std::vector< std::unique_ptr< libMesh::ReplicatedMesh >> &	meshes,
		const std::vector< std::vector< unsigned int >> &	pattern
	)

assign IDs for each input component type

Parameters

meshes	input meshes of the cartesian or hexagonal patterned mesh generator
pattern	2D vector of the mesh pattern

Returns

list of reporting IDs for individual mesh elements

Definition at line 39 of file ReportingIDGeneratorUtils.C.

{
  dof_id_type n = 0;
  for (MooseIndex(pattern) i = 0; i < pattern.size(); ++i)
    for (MooseIndex(pattern[i]) j = 0; j < pattern[i].size(); ++j)
      n += meshes[pattern[i][j]]->n_elem();
  std::vector<dof_id_type> integer_ids;
  integer_ids.reserve(n);
  for (MooseIndex(pattern) i = 0; i < pattern.size(); ++i)
    for (MooseIndex(pattern[i]) j = 0; j < pattern[i].size(); ++j)
      integer_ids.insert(integer_ids.end(), meshes[pattern[i][j]]->n_elem(), pattern[i][j]);
  return integer_ids;
}