Generates patterned Cartesian meshes with a reporting ID. More...

#include <CartesianIDPatternedMeshGenerator.h>

Inheritance diagram for CartesianIDPatternedMeshGenerator:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	CartesianIDPatternedMeshGenerator (const InputParameters &parameters)

std::unique_ptr< MeshBase >	generate () override

bool	hasGenerateData () const

bool	hasGenerateCSG () 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	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	haveParameter (const std::string &name) 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
void	mergeSubdomainNameMaps (std::map< subdomain_id_type, std::string > &main_subdomain_map, const std::map< subdomain_id_type, std::string > &increment_subdomain_map)

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
const std::string	_element_id_name
	name of integer ID. More...

const ReportingIDGeneratorUtils::AssignType	_assign_type
	integer ID assignment type More...

const bool	_use_exclude_id
	flag to indicate if exclude_id is defined More...

std::vector< bool >	_exclude_ids
	flag to indicate if exclude_id is used for each input More...

std::vector< std::vector< dof_id_type > >	_id_pattern
	hold integer ID for each input pattern cell More...

const std::vector< MeshGeneratorName > &	_input_names

const std::vector< std::unique_ptr< MeshBase > *>	_mesh_ptrs

const std::vector< std::vector< unsigned int > > &	_pattern

std::vector< std::unique_ptr< ReplicatedMesh > >	_meshes

std::vector< std::unique_ptr< ReplicatedMesh > >	_row_meshes

Real	_x_width

Real	_y_width

Real	_z_width

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

Detailed Description

Generates patterned Cartesian meshes with a reporting ID.

Definition at line 19 of file CartesianIDPatternedMeshGenerator.h.

Constructor & Destructor Documentation

◆ CartesianIDPatternedMeshGenerator()

CartesianIDPatternedMeshGenerator::CartesianIDPatternedMeshGenerator ( const InputParameters & parameters )

Definition at line 33 of file CartesianIDPatternedMeshGenerator.C.

   : PatternedMeshGenerator(parameters),
     _element_id_name(getParam<std::string>("id_name")),
     _assign_type(
         getParam<MooseEnum>("assign_type").getEnum<ReportingIDGeneratorUtils::AssignType>()),
     _use_exclude_id(isParamValid("exclude_id"))
 {
   if (_use_exclude_id && _assign_type != ReportingIDGeneratorUtils::AssignType::cell)
     paramError("exclude_id", "works only when \"assign_type\" is equal 'cell'");
   if (!isParamValid("id_pattern") && _assign_type == ReportingIDGeneratorUtils::AssignType::manual)
     paramError("id_pattern", "required when \"assign_type\" is equal to 'manual'");
 
   if (_assign_type == ReportingIDGeneratorUtils::AssignType::manual)
     _id_pattern = getParam<std::vector<std::vector<dof_id_type>>>("id_pattern");
   _exclude_ids.resize(_input_names.size());
   if (_use_exclude_id)
   {
     std::vector<MeshGeneratorName> exclude_id_name =
         getParam<std::vector<MeshGeneratorName>>("exclude_id");
     for (unsigned int i = 0; i < _input_names.size(); ++i)
     {
       _exclude_ids[i] = false;
       for (auto input_name : exclude_id_name)
         if (_input_names[i] == input_name)
         {
           _exclude_ids[i] = true;
           break;
         }
     }
   }
   else
     for (unsigned int i = 0; i < _input_names.size(); ++i)
       _exclude_ids[i] = false;
 }

Member Function Documentation

◆ generate()

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

overridevirtual

Reimplemented from PatternedMeshGenerator.

Definition at line 70 of file CartesianIDPatternedMeshGenerator.C.

 {
   auto mesh = PatternedMeshGenerator::generate();
 
   unsigned int extra_id_index;
   if (!mesh->has_elem_integer(_element_id_name))
     extra_id_index = mesh->add_elem_integer(_element_id_name);
   else
   {
     extra_id_index = mesh->get_elem_integer_index(_element_id_name);
     paramWarning(
         "id_name", "An element integer with the name '", _element_id_name, "' already exists");
   }
 
   // patternedMeshGenerator for Carterisan lattice does not support duct structures
   const bool has_assembly_duct = false;
   const std::set<subdomain_id_type> duct_block_ids;
   // asssign reporting IDs to individual elements
   ReportingIDGeneratorUtils::assignReportingIDs(*mesh,
                                                 extra_id_index,
                                                 _assign_type,
                                                 _use_exclude_id,
                                                 _exclude_ids,
                                                 has_assembly_duct,
                                                 duct_block_ids,
                                                 _meshes,
                                                 _pattern,
                                                 _id_pattern);
 
   return mesh;
 }

◆ validParams()

InputParameters CartesianIDPatternedMeshGenerator::validParams ( )

static

Definition at line 16 of file CartesianIDPatternedMeshGenerator.C.

 {
   InputParameters params = PatternedMeshGenerator::validParams();
   params.addRequiredParam<std::string>("id_name", "Name of integer ID set");
   params.addParam<std::vector<MeshGeneratorName>>(
       "exclude_id", "Name of input meshes to be excluded in ID generation");
   MooseEnum option("cell pattern manual", "cell");
   params.addParam<MooseEnum>("assign_type", option, "Type of integer ID assignment");
   params.addParam<std::vector<std::vector<dof_id_type>>>(
       "id_pattern",
       "User-defined element IDs. A double-indexed array starting with the upper-left corner");
   params.addClassDescription("Generate Certesian lattice meshes with reporting ID assignment that "
                              "indentifies individual components of lattice.");
 
   return params;
 }