https://mooseframework.inl.gov
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ElementIDInterface Class Reference

#include <ElementIDInterface.h>

Inheritance diagram for ElementIDInterface:
[legend]

Public Member Functions

 ElementIDInterface (const MooseObject *moose_object)
 
virtual ~ElementIDInterface ()
 
virtual unsigned int getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const
 Gets index of an element integer with a parameter of the object derived from this interface. More...
 
virtual unsigned int getElementIDIndexByName (const std::string &id_name) const
 Return the accessing integer for an extra element integer with its name. More...
 
virtual const dof_id_typegetElementID (const std::string &id_parameter_name, unsigned int comp=0) const
 Gets an element integer with a parameter of the object derived from this interface. More...
 
virtual const dof_id_typegetElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const
 Gets a neighbor element integer with a parameter of the object derived from this interface. More...
 
virtual const dof_id_typegetElementIDByName (const std::string &id_name) const
 Gets an element integer with the element integer name. More...
 
virtual const dof_id_typegetElementIDNeighborByName (const std::string &id_name) const
 Gets a neighbor element integer with the element integer name. More...
 
bool hasElementID (const std::string &id_name) const
 Whether mesh has an element integer with a given name. More...
 
dof_id_type maxElementID (unsigned int elem_id_index) const
 Return the maximum element ID for an element integer with its index. More...
 
dof_id_type minElementID (unsigned int elem_id_index) const
 Return the minimum element ID for an element integer with its index. More...
 
bool areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const
 Whether two element integers are identical for all elements. More...
 
std::unordered_map< dof_id_type, std::set< dof_id_type > > getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const
 Get the mapping from IDs of one extra element integer to another given the two integer names. More...
 
std::set< dof_id_typegetAllElemIDs (unsigned int elem_id_index) const
 Return all the unique element IDs for an element integer with its index on the entire domain. More...
 
std::set< dof_id_typegetElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const
 Return all the unique element IDs for an extra element integer with its index on a set of subdomains. More...
 
dof_id_type getElementID (const Elem *elem, unsigned int elem_id_index) const
 Get an element integer for an element. More...
 

Static Public Member Functions

static InputParameters validParams ()
 

Private Attributes

const InputParameters_obj_parameters
 Reference to the object's input parameters. More...
 
std::shared_ptr< MooseMesh > & _id_mesh
 References to the mesh and displaced mesh (currently in the ActionWarehouse) More...
 
const std::string & _ei_name
 Name of the object using this interface. More...
 

Detailed Description

Definition at line 23 of file ElementIDInterface.h.

Constructor & Destructor Documentation

◆ ElementIDInterface()

ElementIDInterface::ElementIDInterface ( const MooseObject moose_object)

Definition at line 28 of file ElementIDInterface.C.

29  : _obj_parameters(moose_object->parameters()),
30  _id_mesh(moose_object->getMooseApp().actionWarehouse().mesh()),
31  _ei_name(moose_object->name())
32 {
33 }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)
virtual const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:57
MooseApp & getMooseApp() const
Get the MooseApp this class is associated with.
Definition: MooseBase.h:45
std::shared_ptr< MooseMesh > & mesh()
const std::string & _ei_name
Name of the object using this interface.
ActionWarehouse & actionWarehouse()
Return a writable reference to the ActionWarehouse associated with this app.
Definition: MooseApp.h:237
const InputParameters & _obj_parameters
Reference to the object&#39;s input parameters.
const InputParameters & parameters() const
Get the parameters of the object.

◆ ~ElementIDInterface()

virtual ElementIDInterface::~ElementIDInterface ( )
inlinevirtual

Definition at line 29 of file ElementIDInterface.h.

29 {}

Member Function Documentation

◆ areElemIDsIdentical()

bool ElementIDInterface::areElemIDsIdentical ( const std::string &  id_name1,
const std::string &  id_name2 
) const
inline

Whether two element integers are identical for all elements.

Definition at line 103 of file ElementIDInterface.h.

104  {
105  return _id_mesh->areElemIDsIdentical(id_name1, id_name2);
106  }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)

◆ getAllElemIDs()

std::set<dof_id_type> ElementIDInterface::getAllElemIDs ( unsigned int  elem_id_index) const
inline

Return all the unique element IDs for an element integer with its index on the entire domain.

Definition at line 120 of file ElementIDInterface.h.

121  {
122  return _id_mesh->getAllElemIDs(elem_id_index);
123  }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)

◆ getElementID() [1/2]

const dof_id_type & ElementIDInterface::getElementID ( const std::string &  id_parameter_name,
unsigned int  comp = 0 
) const
virtual

Gets an element integer with a parameter of the object derived from this interface.

Parameters
id_parameter_nameName of object parameter
compComponent number for vector of integer names
Returns
Integer for the current element

Reimplemented in Material.

Definition at line 72 of file ElementIDInterface.C.

Referenced by Material::getElementID().

73 {
74  auto id = getElementIDIndex(id_parameter_name, comp);
75 
76  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");
77 
78  auto tid = _obj_parameters.get<THREAD_ID>("_tid");
79 
80  auto & assembly = _subproblem.assembly(tid, 0);
81 
82  return assembly.extraElemID(id);
83 }
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller...
virtual unsigned int getElementIDIndex(const std::string &id_parameter_name, unsigned int comp=0) const
Gets index of an element integer with a parameter of the object derived from this interface...
const InputParameters & _obj_parameters
Reference to the object&#39;s input parameters.
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:78
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ getElementID() [2/2]

dof_id_type ElementIDInterface::getElementID ( const Elem *  elem,
unsigned int  elem_id_index 
) const
inline

Get an element integer for an element.

Definition at line 138 of file ElementIDInterface.h.

139  {
140  if (elem_id_index == elem->n_extra_integers())
141  return elem->subdomain_id();
142 
143  return elem->get_extra_integer(elem_id_index);
144  }

◆ getElementIDByName()

const dof_id_type & ElementIDInterface::getElementIDByName ( const std::string &  id_name) const
virtual

Gets an element integer with the element integer name.

Parameters
id_nameName of element integer
Returns
Integer for the current element

Reimplemented in Material.

Definition at line 101 of file ElementIDInterface.C.

Referenced by Material::getElementIDByName().

102 {
103  auto id = getElementIDIndexByName(id_name);
104 
105  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");
106 
107  auto tid = _obj_parameters.get<THREAD_ID>("_tid");
108 
109  auto & assembly = _subproblem.assembly(tid, 0);
110 
111  return assembly.extraElemID(id);
112 }
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller...
const InputParameters & _obj_parameters
Reference to the object&#39;s input parameters.
virtual unsigned int getElementIDIndexByName(const std::string &id_name) const
Return the accessing integer for an extra element integer with its name.
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:78
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ getElementIDIndex()

unsigned int ElementIDInterface::getElementIDIndex ( const std::string &  id_parameter_name,
unsigned int  comp = 0 
) const
virtual

Gets index of an element integer with a parameter of the object derived from this interface.

Parameters
id_parameter_nameName of object parameter
compComponent number for vector of integer names
Returns
Index of the element integer

Definition at line 36 of file ElementIDInterface.C.

Referenced by getElementID(), and getElementIDNeighbor().

38 {
39  auto & p = _obj_parameters.get<std::vector<ExtraElementIDName>>(id_parameter_name);
40  if (comp >= p.size())
41  mooseError(id_parameter_name, " does not have enough integer names");
42 
43  return getElementIDIndexByName(p[comp]);
44 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
const InputParameters & _obj_parameters
Reference to the object&#39;s input parameters.
virtual unsigned int getElementIDIndexByName(const std::string &id_name) const
Return the accessing integer for an extra element integer with its name.

◆ getElementIDIndexByName()

unsigned int ElementIDInterface::getElementIDIndexByName ( const std::string &  id_name) const
virtual

Return the accessing integer for an extra element integer with its name.

Parameters
id_nameName of element integer
Returns
Index of the element integer

Definition at line 47 of file ElementIDInterface.C.

Referenced by ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), getElementIDByName(), getElementIDIndex(), and getElementIDNeighborByName().

48 {
49  if (!_id_mesh.get())
50  mooseError("Mesh is not available for getting element integers");
51 
52  auto & mesh_base = _id_mesh->getMesh();
53 
54  if (id_name == "subdomain_id")
55  {
56  if (mesh_base.has_elem_integer(id_name))
57  mooseError("MOOSE does not allow 'subdomain_id' element integer in a mesh. 'subdomain_id' is "
58  "reserved for element subdomain ID");
59  return mesh_base.n_elem_integers();
60  }
61 
62  if (!mesh_base.has_elem_integer(id_name))
63  mooseError(
64  "Mesh does not have an element integer names as ", id_name, " but required by ", _ei_name);
65 
66  auto id = mesh_base.get_elem_integer_index(id_name);
67 
68  return id;
69 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)
const std::string & _ei_name
Name of the object using this interface.

◆ getElementIDNeighbor()

const dof_id_type & ElementIDInterface::getElementIDNeighbor ( const std::string &  id_parameter_name,
unsigned int  comp = 0 
) const
virtual

Gets a neighbor element integer with a parameter of the object derived from this interface.

Parameters
id_parameter_nameName of object parameter
compComponent number for vector of integer names
Returns
Integer for the neighbor element

Reimplemented in Material.

Definition at line 86 of file ElementIDInterface.C.

Referenced by Material::getElementID(), and Material::getElementIDNeighbor().

88 {
89  auto id = getElementIDIndex(id_parameter_name, comp);
90 
91  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");
92 
93  auto tid = _obj_parameters.get<THREAD_ID>("_tid");
94 
95  auto & assembly = _subproblem.assembly(tid, 0);
96 
97  return assembly.extraElemIDNeighbor(id);
98 }
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller...
virtual unsigned int getElementIDIndex(const std::string &id_parameter_name, unsigned int comp=0) const
Gets index of an element integer with a parameter of the object derived from this interface...
const InputParameters & _obj_parameters
Reference to the object&#39;s input parameters.
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:78
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ getElementIDNeighborByName()

const dof_id_type & ElementIDInterface::getElementIDNeighborByName ( const std::string &  id_name) const
virtual

Gets a neighbor element integer with the element integer name.

Parameters
id_nameName of element integer
Returns
Integer for the neighbor element

Reimplemented in Material.

Definition at line 115 of file ElementIDInterface.C.

Referenced by Material::getElementIDByName(), and Material::getElementIDNeighborByName().

116 {
117  auto id = getElementIDIndexByName(id_name);
118 
119  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");
120 
121  auto tid = _obj_parameters.get<THREAD_ID>("_tid");
122 
123  auto & assembly = _subproblem.assembly(tid, 0);
124 
125  return assembly.extraElemIDNeighbor(id);
126 }
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller...
const InputParameters & _obj_parameters
Reference to the object&#39;s input parameters.
virtual unsigned int getElementIDIndexByName(const std::string &id_name) const
Return the accessing integer for an extra element integer with its name.
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:78
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ getElemIDMapping()

std::unordered_map<dof_id_type, std::set<dof_id_type> > ElementIDInterface::getElemIDMapping ( const std::string &  id_name1,
const std::string &  id_name2 
) const
inline

Get the mapping from IDs of one extra element integer to another given the two integer names.

Definition at line 112 of file ElementIDInterface.h.

113  {
114  return _id_mesh->getElemIDMapping(id_name1, id_name2);
115  }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)

◆ getElemIDsOnBlocks()

std::set<dof_id_type> ElementIDInterface::getElemIDsOnBlocks ( unsigned int  elem_id_index,
const std::set< SubdomainID > &  blks 
) const
inline

Return all the unique element IDs for an extra element integer with its index on a set of subdomains.

Definition at line 129 of file ElementIDInterface.h.

131  {
132  return _id_mesh->getElemIDsOnBlocks(elem_id_index, blks);
133  }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)

◆ hasElementID()

bool ElementIDInterface::hasElementID ( const std::string &  id_name) const
inline

Whether mesh has an element integer with a given name.

Definition at line 82 of file ElementIDInterface.h.

82 { return _id_mesh->hasElementID(id_name); }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)

◆ maxElementID()

dof_id_type ElementIDInterface::maxElementID ( unsigned int  elem_id_index) const
inline

Return the maximum element ID for an element integer with its index.

Definition at line 87 of file ElementIDInterface.h.

88  {
89  return _id_mesh->maxElementID(elem_id_index);
90  }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)

◆ minElementID()

dof_id_type ElementIDInterface::minElementID ( unsigned int  elem_id_index) const
inline

Return the minimum element ID for an element integer with its index.

Definition at line 95 of file ElementIDInterface.h.

96  {
97  return _id_mesh->minElementID(elem_id_index);
98  }
std::shared_ptr< MooseMesh > & _id_mesh
References to the mesh and displaced mesh (currently in the ActionWarehouse)

◆ validParams()

InputParameters ElementIDInterface::validParams ( )
static

Definition at line 23 of file ElementIDInterface.C.

24 {
25  return emptyInputParameters();
26 }
InputParameters emptyInputParameters()

Member Data Documentation

◆ _ei_name

const std::string& ElementIDInterface::_ei_name
private

Name of the object using this interface.

Definition at line 154 of file ElementIDInterface.h.

Referenced by getElementIDIndexByName().

◆ _id_mesh

std::shared_ptr<MooseMesh>& ElementIDInterface::_id_mesh
private

References to the mesh and displaced mesh (currently in the ActionWarehouse)

Definition at line 151 of file ElementIDInterface.h.

Referenced by areElemIDsIdentical(), getAllElemIDs(), getElementIDIndexByName(), getElemIDMapping(), getElemIDsOnBlocks(), hasElementID(), maxElementID(), and minElementID().

◆ _obj_parameters

const InputParameters& ElementIDInterface::_obj_parameters
private

Reference to the object's input parameters.

Definition at line 148 of file ElementIDInterface.h.

Referenced by getElementID(), getElementIDByName(), getElementIDIndex(), getElementIDNeighbor(), and getElementIDNeighborByName().


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