www.mooseframework.org
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
BoundaryRestrictable Class Reference

/class BoundaryRestrictable /brief Provides functionality for limiting the object to certain boundary ids The is class the inheriting class with methods useful for limiting an object to certain boundaries. More...

#include <BoundaryRestrictable.h>

Inheritance diagram for BoundaryRestrictable:
[legend]

Public Types

enum  TEST_TYPE { ALL, ANY }
 A flag changing the behavior of hasBoundary. More...
 

Public Member Functions

 BoundaryRestrictable (const MooseObject *moose_object, bool nodal)
 Class constructor Populates the _bnd_ids for the given boundary names supplied with the 'boundary' input parameter. More...
 
 BoundaryRestrictable (const MooseObject *moose_object, const std::set< SubdomainID > &block_ids, bool nodal)
 Class constructor Populates the 'block' input parameters when an object is also block restricted, see the general class documentation for details. More...
 
virtual ~BoundaryRestrictable ()
 Empty class destructor. More...
 
virtual const std::set< BoundaryID > & boundaryIDs () const
 Return the boundary IDs for this object. More...
 
const std::vector< BoundaryName > & boundaryNames () const
 Return the boundary names for this object. More...
 
unsigned int numBoundaryIDs () const
 Return the number of boundaries for this object. More...
 
bool hasBoundary (const BoundaryName &name) const
 Test if the supplied boundary name is valid for this object. More...
 
bool hasBoundary (const std::vector< BoundaryName > &names) const
 Test if the supplied vector of boundary names are valid for this object. More...
 
bool hasBoundary (const BoundaryID &id) const
 Test if the supplied boundary ids are valid for this object. More...
 
bool hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 Test if the supplied vector boundary ids are valid for this object. More...
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
 Test if the supplied set of boundary ids are valid for this object. More...
 
bool isBoundarySubset (const std::set< BoundaryID > &ids) const
 Test if the class boundary ids are a subset of the supplied objects. More...
 
bool isBoundarySubset (const std::vector< BoundaryID > &ids) const
 
template<typename T , bool is_ad = false>
bool hasBoundaryMaterialProperty (const std::string &prop_name) const
 Check if a material property is valid for all boundaries of this object. More...
 
virtual bool boundaryRestricted () const
 Returns true if this object has been restricted to a boundary. More...
 
const std::set< BoundaryID > & meshBoundaryIDs () const
 Returns the set of all boundary ids for the entire mesh. More...
 
virtual bool checkVariableBoundaryIntegrity () const
 Whether integrity/coverage checking should be conducted for moose variables used in this object. More...
 

Static Public Member Functions

static InputParameters validParams ()
 
static bool restricted (const std::set< BoundaryID > &ids)
 Helper for determining if the object is boundary restricted. More...
 

Protected Member Functions

bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 A helper method to avoid circular #include problems. More...
 

Private Member Functions

void initializeBoundaryRestrictable ()
 An initialization routine needed for dual constructors. More...
 

Private Attributes

FEProblemBase_bnd_feproblem
 Pointer to FEProblemBase. More...
 
MooseMesh_bnd_mesh
 Point to mesh. More...
 
std::set< BoundaryID_bnd_ids
 Set of the boundary ids. More...
 
std::vector< BoundaryID_vec_ids
 Vector of the boundary ids. More...
 
std::vector< BoundaryName > _boundary_names
 Vector the the boundary names. More...
 
const bool _bnd_dual_restrictable
 Flag for allowing dual restriction with BlockRestrictable. More...
 
const std::set< SubdomainID_empty_block_ids
 An empty set for referencing when block_ids is not included. More...
 
const std::set< SubdomainID > & _block_ids
 Reference to the block_ids, defaults to an empty set if not provided. More...
 
THREAD_ID _bnd_tid
 Thread id for this object. More...
 
const MaterialData_bnd_material_data
 Pointer to MaterialData for boundary (. More...
 
bool _bnd_nodal
 Whether or not this object is restricted to nodesets. More...
 
const MooseObject_moose_object
 The moose object that this is an interface for. More...
 

Detailed Description

/class BoundaryRestrictable /brief Provides functionality for limiting the object to certain boundary ids The is class the inheriting class with methods useful for limiting an object to certain boundaries.

The parameters "_boundary_id" and "boundary", which are created with BoundaryRestrictable::validParams() are used the framework.

Definition at line 25 of file BoundaryRestrictable.h.

Member Enumeration Documentation

◆ TEST_TYPE

A flag changing the behavior of hasBoundary.

Enumerator
ALL 
ANY 

Definition at line 29 of file BoundaryRestrictable.h.

Constructor & Destructor Documentation

◆ BoundaryRestrictable() [1/2]

BoundaryRestrictable::BoundaryRestrictable ( const MooseObject moose_object,
bool  nodal 
)

Class constructor Populates the _bnd_ids for the given boundary names supplied with the 'boundary' input parameter.

Parameters
parametersThe input parameters
nodalTrue indicates that the object is operating on nodesets, false for sidesets

Definition at line 36 of file BoundaryRestrictable.C.

37  : _bnd_feproblem(moose_object->isParamValid("_fe_problem_base")
38  ? moose_object->getParam<FEProblemBase *>("_fe_problem_base")
39  : NULL),
40  _bnd_mesh(moose_object->isParamValid("_mesh") ? moose_object->getParam<MooseMesh *>("_mesh")
41  : NULL),
42  _bnd_dual_restrictable(moose_object->getParam<bool>("_dual_restrictable")),
44  _bnd_tid(moose_object->isParamValid("_tid") ? moose_object->getParam<THREAD_ID>("_tid") : 0),
46  _bnd_nodal(nodal),
47  _moose_object(*moose_object)
48 {
50 }
void initializeBoundaryRestrictable()
An initialization routine needed for dual constructors.
MaterialData & getMaterialData(Moose::MaterialDataType type, const THREAD_ID tid=0)
MooseMesh * _bnd_mesh
Point to mesh.
const bool _bnd_dual_restrictable
Flag for allowing dual restriction with BlockRestrictable.
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
THREAD_ID _bnd_tid
Thread id for this object.
const std::set< SubdomainID > _empty_block_ids
An empty set for referencing when block_ids is not included.
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:88
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
bool _bnd_nodal
Whether or not this object is restricted to nodesets.
const MooseObject & _moose_object
The moose object that this is an interface for.
const MaterialData & _bnd_material_data
Pointer to MaterialData for boundary (.
const std::set< SubdomainID > & _block_ids
Reference to the block_ids, defaults to an empty set if not provided.
FEProblemBase * _bnd_feproblem
Pointer to FEProblemBase.
unsigned int THREAD_ID
Definition: MooseTypes.h:198

◆ BoundaryRestrictable() [2/2]

BoundaryRestrictable::BoundaryRestrictable ( const MooseObject moose_object,
const std::set< SubdomainID > &  block_ids,
bool  nodal 
)

Class constructor Populates the 'block' input parameters when an object is also block restricted, see the general class documentation for details.

Parameters
parametersThe input parameters (see the detailed help for additional information)
block_idsThe block ids that the object is restricted to
nodalTrue indicates that the object is operating on nodesets, false for sidesets

Definition at line 53 of file BoundaryRestrictable.C.

56  : _bnd_feproblem(moose_object->isParamValid("_fe_problem_base")
57  ? moose_object->getParam<FEProblemBase *>("_fe_problem_base")
58  : NULL),
59  _bnd_mesh(moose_object->isParamValid("_mesh") ? moose_object->getParam<MooseMesh *>("_mesh")
60  : NULL),
61  _bnd_dual_restrictable(moose_object->getParam<bool>("_dual_restrictable")),
62  _block_ids(block_ids),
63  _bnd_tid(moose_object->isParamValid("_tid") ? moose_object->getParam<THREAD_ID>("_tid") : 0),
65  _bnd_nodal(nodal),
66  _moose_object(*moose_object)
67 {
69 }
void initializeBoundaryRestrictable()
An initialization routine needed for dual constructors.
MaterialData & getMaterialData(Moose::MaterialDataType type, const THREAD_ID tid=0)
MooseMesh * _bnd_mesh
Point to mesh.
const bool _bnd_dual_restrictable
Flag for allowing dual restriction with BlockRestrictable.
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
THREAD_ID _bnd_tid
Thread id for this object.
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:88
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
bool _bnd_nodal
Whether or not this object is restricted to nodesets.
const MooseObject & _moose_object
The moose object that this is an interface for.
const MaterialData & _bnd_material_data
Pointer to MaterialData for boundary (.
const std::set< SubdomainID > & _block_ids
Reference to the block_ids, defaults to an empty set if not provided.
FEProblemBase * _bnd_feproblem
Pointer to FEProblemBase.
unsigned int THREAD_ID
Definition: MooseTypes.h:198

◆ ~BoundaryRestrictable()

BoundaryRestrictable::~BoundaryRestrictable ( )
virtual

Empty class destructor.

Definition at line 177 of file BoundaryRestrictable.C.

177 {}

Member Function Documentation

◆ boundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::boundaryIDs ( ) const
virtual

Return the boundary IDs for this object.

Returns
A set of all boundary ids for which the object is restricted

Definition at line 180 of file BoundaryRestrictable.C.

Referenced by MaterialBase::getGenericZeroMaterialPropertyByName(), hasBoundaryMaterialPropertyHelper(), SidesetInfoVectorPostprocessor::initialize(), InterfaceQpUserObjectBase::initialSetup(), and MaterialBase::registerPropName().

181 {
182  return _bnd_ids;
183 }
std::set< BoundaryID > _bnd_ids
Set of the boundary ids.

◆ boundaryNames()

const std::vector< BoundaryName > & BoundaryRestrictable::boundaryNames ( ) const

Return the boundary names for this object.

Returns
A set of all boundary names for which the object is restricted

Definition at line 186 of file BoundaryRestrictable.C.

Referenced by MaterialOutputAction::getParams(), NearestNodeDistanceAux::NearestNodeDistanceAux(), and NearestNodeValueAux::NearestNodeValueAux().

187 {
188  return _boundary_names;
189 }
std::vector< BoundaryName > _boundary_names
Vector the the boundary names.

◆ boundaryRestricted()

bool BoundaryRestrictable::boundaryRestricted ( ) const
virtual

Returns true if this object has been restricted to a boundary.

See also
MooseObject

Definition at line 198 of file BoundaryRestrictable.C.

Referenced by Material::checkMaterialProperty(), MaterialOutputAction::getParams(), and DerivativeMaterialInterface< MortarScalarBase >::haveMaterialProperty().

199 {
201 }
static bool restricted(const std::set< BoundaryID > &ids)
Helper for determining if the object is boundary restricted.
std::set< BoundaryID > _bnd_ids
Set of the boundary ids.

◆ checkVariableBoundaryIntegrity()

virtual bool BoundaryRestrictable::checkVariableBoundaryIntegrity ( ) const
inlinevirtual

Whether integrity/coverage checking should be conducted for moose variables used in this object.

This should return true if variables are only evaluated locally, e.g. on the current node or element. This should return false if evaluation of this object entails non-local variable evaluations

Definition at line 179 of file BoundaryRestrictable.h.

179 { return true; }

◆ hasBoundary() [1/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryName &  name) const

Test if the supplied boundary name is valid for this object.

Parameters
nameA BoundaryName to check
Returns
True if the given id is valid for this object

Definition at line 210 of file BoundaryRestrictable.C.

Referenced by AuxKernelTempl< Real >::AuxKernelTempl(), hasBoundary(), and hasBoundaryMaterialPropertyHelper().

211 {
212  // Create a vector and utilize the getBoundaryIDs function, which
213  // handles the ANY_BOUNDARY_ID (getBoundaryID does not)
214  return hasBoundary(_bnd_mesh->getBoundaryIDs({name}));
215 }
MooseMesh * _bnd_mesh
Point to mesh.
bool hasBoundary(const BoundaryName &name) const
Test if the supplied boundary name is valid for this object.
std::vector< BoundaryID > getBoundaryIDs(const Elem *const elem, const unsigned short int side) const
Returns a vector of boundary IDs for the requested element on the requested side. ...
Definition: MooseMesh.C:2720

◆ hasBoundary() [2/5]

bool BoundaryRestrictable::hasBoundary ( const std::vector< BoundaryName > &  names) const

Test if the supplied vector of boundary names are valid for this object.

Parameters
namesA vector of BoundaryNames to check
Returns
True if the given ids are valid for this object

Definition at line 218 of file BoundaryRestrictable.C.

219 {
220  return hasBoundary(_bnd_mesh->getBoundaryIDs(names));
221 }
MooseMesh * _bnd_mesh
Point to mesh.
bool hasBoundary(const BoundaryName &name) const
Test if the supplied boundary name is valid for this object.
std::vector< BoundaryID > getBoundaryIDs(const Elem *const elem, const unsigned short int side) const
Returns a vector of boundary IDs for the requested element on the requested side. ...
Definition: MooseMesh.C:2720

◆ hasBoundary() [3/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryID id) const

Test if the supplied boundary ids are valid for this object.

Parameters
idA BoundaryID to check
Returns
True if the given id is valid for this object

Definition at line 224 of file BoundaryRestrictable.C.

225 {
226  if (_bnd_ids.empty() || _bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
227  return true;
228  else
229  return _bnd_ids.find(id) != _bnd_ids.end();
230 }
std::set< BoundaryID > _bnd_ids
Set of the boundary ids.
const BoundaryID ANY_BOUNDARY_ID
Definition: MooseTypes.C:23

◆ hasBoundary() [4/5]

bool BoundaryRestrictable::hasBoundary ( const std::vector< BoundaryID > &  ids,
TEST_TYPE  type = ALL 
) const

Test if the supplied vector boundary ids are valid for this object.

Parameters
idsA vector of BoundaryIDs ids to check
typeA flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object
Returns
True if the all of the given ids are found within the ids for this object

Definition at line 233 of file BoundaryRestrictable.C.

234 {
235  std::set<BoundaryID> ids_set(ids.begin(), ids.end());
236  return hasBoundary(ids_set, type);
237 }
bool hasBoundary(const BoundaryName &name) const
Test if the supplied boundary name is valid for this object.

◆ hasBoundary() [5/5]

bool BoundaryRestrictable::hasBoundary ( const std::set< BoundaryID > &  ids,
TEST_TYPE  type = ALL 
) const

Test if the supplied set of boundary ids are valid for this object.

Parameters
idsA std::set of BoundaryIDs to check
typeA flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object
Returns
True if the all of the given ids are found within the ids for this object
See also
isSubset

Definition at line 240 of file BoundaryRestrictable.C.

241 {
242  // An empty input is assumed to be ANY_BOUNDARY_ID
243  if (ids.empty() || ids.find(Moose::ANY_BOUNDARY_ID) != ids.end())
244  return true;
245 
246  // All supplied IDs must match those of the object
247  else if (type == ALL)
248  {
249  if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
250  return true;
251  else
252  return std::includes(_bnd_ids.begin(), _bnd_ids.end(), ids.begin(), ids.end());
253  }
254  // Any of the supplied IDs must match those of the object
255  else
256  {
257  // Loop through the supplied ids
258  for (const auto & id : ids)
259  {
260  // Test the current supplied id
261  bool test = hasBoundary(id);
262 
263  // If the id exists in the stored ids, then return true, otherwise
264  if (test)
265  return true;
266  }
267  return false;
268  }
269 }
std::set< BoundaryID > _bnd_ids
Set of the boundary ids.
bool hasBoundary(const BoundaryName &name) const
Test if the supplied boundary name is valid for this object.
const BoundaryID ANY_BOUNDARY_ID
Definition: MooseTypes.C:23

◆ hasBoundaryMaterialProperty()

template<typename T , bool is_ad>
bool BoundaryRestrictable::hasBoundaryMaterialProperty ( const std::string &  prop_name) const

Check if a material property is valid for all boundaries of this object.

This method returns true if the supplied property name has been declared in a Material object on the boundary ids for this object.

Template Parameters
TThe type of material property
Parameters
prop_namethe name of the property to query
Returns
true if the property exists for all boundary ids of the object, otherwise false

Definition at line 233 of file BoundaryRestrictable.h.

234 {
235  // If you get here the supplied property is defined on all boundaries, but is still subject
236  // existence in the MateialData class
237  return hasBoundaryMaterialPropertyHelper(prop_name) &&
238  _bnd_material_data.haveGenericProperty<T, is_ad>(prop_name);
239 }
bool haveGenericProperty(const std::string &prop_name) const
Definition: MaterialData.h:253
bool hasBoundaryMaterialPropertyHelper(const std::string &prop_name) const
A helper method to avoid circular #include problems.
const MaterialData & _bnd_material_data
Pointer to MaterialData for boundary (.

◆ hasBoundaryMaterialPropertyHelper()

bool BoundaryRestrictable::hasBoundaryMaterialPropertyHelper ( const std::string &  prop_name) const
protected

A helper method to avoid circular #include problems.

See also
hasBoundaryMaterialProperty

Definition at line 301 of file BoundaryRestrictable.C.

Referenced by hasBoundaryMaterialProperty().

302 {
303  // Reference to MaterialWarehouse for testing and retrieving boundary ids
305 
306  // Complete set of BoundaryIDs that this object is defined
307  const std::set<BoundaryID> & ids =
309 
310  // Loop over each BoundaryID for this object
311  for (const auto & id : ids)
312  {
313  // Storage of material properties that have been DECLARED on this BoundaryID
314  std::set<std::string> declared_props;
315 
316  // If boundary materials exist, populated the set of properties that were declared
317  if (warehouse.hasActiveBoundaryObjects(id))
318  {
319  const std::vector<std::shared_ptr<MaterialBase>> & mats =
320  warehouse.getActiveBoundaryObjects(id);
321  for (const auto & mat : mats)
322  {
323  const std::set<std::string> & mat_props = mat->getSuppliedItems();
324  declared_props.insert(mat_props.begin(), mat_props.end());
325  }
326  }
327 
328  // If the supplied property is not in the list of properties on the current id, return false
329  if (declared_props.find(prop_name) == declared_props.end())
330  return false;
331  }
332 
333  // If you get here the supplied property is defined on all boundaries
334  return true;
335 }
MaterialBase objects are special in that they have additional objects created automatically (see FEPr...
const MaterialWarehouse & getMaterialWarehouse() const
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
const std::set< BoundaryID > & meshBoundaryIDs() const
Returns the set of all boundary ids for the entire mesh.
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const
bool hasBoundary(const BoundaryName &name) const
Test if the supplied boundary name is valid for this object.
FEProblemBase * _bnd_feproblem
Pointer to FEProblemBase.
virtual const std::set< BoundaryID > & boundaryIDs() const
Return the boundary IDs for this object.
const BoundaryID ANY_BOUNDARY_ID
Definition: MooseTypes.C:23

◆ initializeBoundaryRestrictable()

void BoundaryRestrictable::initializeBoundaryRestrictable ( )
private

An initialization routine needed for dual constructors.

Definition at line 72 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable().

73 {
74  // The name and id of the object
75  const std::string & name = _moose_object.getParam<std::string>("_object_name");
76 
77  // If the mesh pointer is not defined, but FEProblemBase is, get it from there
78  if (_bnd_feproblem != NULL && _bnd_mesh == NULL)
80 
81  // Check that the mesh pointer was defined, it is required for this class to operate
82  if (_bnd_mesh == NULL)
83  mooseError("The input parameters must contain a pointer to FEProblemBase via '_fe_problem' or "
84  "a pointer to the MooseMesh via '_mesh'");
85 
86  // If the user supplies boundary IDs
87  if (_moose_object.isParamValid("boundary"))
88  {
89  // Extract the blocks from the input
90  _boundary_names = _moose_object.getParam<std::vector<BoundaryName>>("boundary");
91 
92  // Get the IDs from the supplied names
94 
95  // Store the IDs, handling ANY_BOUNDARY_ID if supplied
96  if (std::find(_boundary_names.begin(), _boundary_names.end(), "ANY_BOUNDARY_ID") !=
97  _boundary_names.end())
99  else
100  _bnd_ids.insert(_vec_ids.begin(), _vec_ids.end());
101  }
102 
103  // Produce error if the object is not allowed to be both block and boundary restricted
104  if (!_bnd_dual_restrictable && !_bnd_ids.empty() && !_block_ids.empty())
105  if (!_block_ids.empty() && _block_ids.find(Moose::ANY_BLOCK_ID) == _block_ids.end())
106  _moose_object.paramError("boundary",
107  "Attempted to restrict the object '",
108  name,
109  "' to a boundary, but the object is already restricted by block(s)");
110 
111  // Store ANY_BOUNDARY_ID if empty
112  if (_bnd_ids.empty())
113  {
115  _boundary_names = {"ANY_BOUNDARY_ID"};
116  }
117 
118  // If this object is block restricted, check that defined blocks exist on the mesh
119  if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) == _bnd_ids.end())
120  {
121  const std::set<BoundaryID> * valid_ids;
122  const char * message_ptr = nullptr;
123 
124  if (_bnd_nodal)
125  {
126  valid_ids = &_bnd_mesh->meshNodesetIds();
127  message_ptr = "node sets";
128  }
129  else
130  {
131  valid_ids = &_bnd_mesh->meshSidesetIds();
132  message_ptr = "side sets";
133  }
134 
135  std::vector<BoundaryID> diff;
136 
137  std::set_difference(_bnd_ids.begin(),
138  _bnd_ids.end(),
139  valid_ids->begin(),
140  valid_ids->end(),
141  std::back_inserter(diff));
142 
143  if (!diff.empty())
144  {
145  std::ostringstream msg;
146  auto sep = " ";
147  msg << "the following " << message_ptr << " (ids) do not exist on the mesh:";
148  for (const auto & id : diff)
149  {
150  if (_boundary_names.size() > 0)
151  {
152  auto & name = _boundary_names.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) -
153  _vec_ids.begin());
154  if (std::to_string(id) != name)
155  msg << sep << name << " (" << id << ")";
156  else
157  msg << sep << id;
158  }
159  else
160  msg << sep << id;
161  sep = ", ";
162  }
163  if (!_bnd_nodal)
164  // Diagnostic message
165  msg << "\n\nMOOSE distinguishes between \"node sets\" and \"side sets\" depending on "
166  "whether \nyou are using \"Nodal\" or \"Integrated\" BCs respectively. Node sets "
167  "corresponding \nto your side sets are constructed for you by default.\n\n"
168  "Try setting \"Mesh/construct_side_list_from_node_list=true\" if you see this "
169  "error.\n"
170  "Note: If you are running with adaptivity you should prefer using side sets.";
171 
172  _moose_object.paramError("boundary", msg.str());
173  }
174  }
175 }
std::string name(const ElemQuality q)
const std::set< BoundaryID > & meshNodesetIds() const
Returns a read-only reference to the set of nodesets currently present in the Mesh.
Definition: MooseMesh.C:2940
const std::set< BoundaryID > & meshSidesetIds() const
Returns a read-only reference to the set of sidesets currently present in the Mesh.
Definition: MooseMesh.C:2934
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:299
MooseMesh * _bnd_mesh
Point to mesh.
const bool _bnd_dual_restrictable
Flag for allowing dual restriction with BlockRestrictable.
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
std::set< BoundaryID > _bnd_ids
Set of the boundary ids.
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
bool _bnd_nodal
Whether or not this object is restricted to nodesets.
void paramError(const std::string &param, Args... args) const
Emits an error prefixed with the file and line number of the given param (from the input file) along ...
std::vector< BoundaryID > _vec_ids
Vector of the boundary ids.
const MooseObject & _moose_object
The moose object that this is an interface for.
const SubdomainID ANY_BLOCK_ID
Definition: MooseTypes.C:19
std::vector< BoundaryName > _boundary_names
Vector the the boundary names.
virtual MooseMesh & mesh() override
std::vector< BoundaryID > getBoundaryIDs(const Elem *const elem, const unsigned short int side) const
Returns a vector of boundary IDs for the requested element on the requested side. ...
Definition: MooseMesh.C:2720
const std::set< SubdomainID > & _block_ids
Reference to the block_ids, defaults to an empty set if not provided.
FEProblemBase * _bnd_feproblem
Pointer to FEProblemBase.
const BoundaryID ANY_BOUNDARY_ID
Definition: MooseTypes.C:23

◆ isBoundarySubset() [1/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::set< BoundaryID > &  ids) const

Test if the class boundary ids are a subset of the supplied objects.

Parameters
idsA std::set of boundaries to check
Returns
True if all of the boundary ids for this class are found within the given ids (opposite of hasBoundary)
See also
hasBoundary

Definition at line 272 of file BoundaryRestrictable.C.

Referenced by isBoundarySubset().

273 {
274  // An empty input is assumed to be ANY_BOUNDARY_ID
275  if (ids.empty() || ids.find(Moose::ANY_BOUNDARY_ID) != ids.end())
276  return true;
277 
278  if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
279  return std::includes(ids.begin(),
280  ids.end(),
281  _bnd_mesh->meshBoundaryIds().begin(),
282  _bnd_mesh->meshBoundaryIds().end());
283  else
284  return std::includes(ids.begin(), ids.end(), _bnd_ids.begin(), _bnd_ids.end());
285 }
MooseMesh * _bnd_mesh
Point to mesh.
const std::set< BoundaryID > & meshBoundaryIds() const
Returns a read-only reference to the set of boundary IDs currently present in the Mesh...
Definition: MooseMesh.C:2928
std::set< BoundaryID > _bnd_ids
Set of the boundary ids.
const BoundaryID ANY_BOUNDARY_ID
Definition: MooseTypes.C:23

◆ isBoundarySubset() [2/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::vector< BoundaryID > &  ids) const

Definition at line 288 of file BoundaryRestrictable.C.

289 {
290  std::set<BoundaryID> ids_set(ids.begin(), ids.end());
291  return isBoundarySubset(ids_set);
292 }
bool isBoundarySubset(const std::set< BoundaryID > &ids) const
Test if the class boundary ids are a subset of the supplied objects.

◆ meshBoundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::meshBoundaryIDs ( ) const

Returns the set of all boundary ids for the entire mesh.

Returns
A const reference the the boundary ids for the entire mesh

Definition at line 295 of file BoundaryRestrictable.C.

Referenced by hasBoundaryMaterialPropertyHelper().

296 {
297  return _bnd_mesh->getBoundaryIDs();
298 }
MooseMesh * _bnd_mesh
Point to mesh.
std::vector< BoundaryID > getBoundaryIDs(const Elem *const elem, const unsigned short int side) const
Returns a vector of boundary IDs for the requested element on the requested side. ...
Definition: MooseMesh.C:2720

◆ numBoundaryIDs()

unsigned int BoundaryRestrictable::numBoundaryIDs ( ) const

Return the number of boundaries for this object.

Returns
The number of boundary ids

Definition at line 192 of file BoundaryRestrictable.C.

Referenced by SidesetInfoVectorPostprocessor::initialize().

193 {
194  return (unsigned int)_bnd_ids.size();
195 }
std::set< BoundaryID > _bnd_ids
Set of the boundary ids.

◆ restricted()

bool BoundaryRestrictable::restricted ( const std::set< BoundaryID > &  ids)
static

Helper for determining if the object is boundary restricted.

This is needed for the MaterialPropertyInterface.

Definition at line 204 of file BoundaryRestrictable.C.

Referenced by moose::internal::boundaryRestricted(), and boundaryRestricted().

205 {
206  return ids.find(Moose::ANY_BOUNDARY_ID) == ids.end();
207 }
const BoundaryID ANY_BOUNDARY_ID
Definition: MooseTypes.C:23

◆ validParams()

InputParameters BoundaryRestrictable::validParams ( )
static

Definition at line 17 of file BoundaryRestrictable.C.

Referenced by InterfaceKernelBase::validParams(), NodalUserObject::validParams(), NodalKernelBase::validParams(), DGKernelBase::validParams(), InitialConditionBase::validParams(), AuxKernelTempl< Real >::validParams(), and MaterialBase::validParams().

18 {
19 
20  // Create instance of InputParameters
22 
23  // Create user-facing 'boundary' input for restricting inheriting object to boundaries
24  params.addParam<std::vector<BoundaryName>>(
25  "boundary", "The list of boundaries (ids or names) from the mesh where this object applies");
26 
27  // A parameter for disabling error message for objects restrictable by boundary and block,
28  // if the parameter is valid it was already set so don't do anything
29  if (!params.isParamValid("_dual_restrictable"))
30  params.addPrivateParam<bool>("_dual_restrictable", false);
31 
32  return params;
33 }
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters emptyInputParameters()
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.

Member Data Documentation

◆ _block_ids

const std::set<SubdomainID>& BoundaryRestrictable::_block_ids
private

Reference to the block_ids, defaults to an empty set if not provided.

Definition at line 204 of file BoundaryRestrictable.h.

Referenced by initializeBoundaryRestrictable().

◆ _bnd_dual_restrictable

const bool BoundaryRestrictable::_bnd_dual_restrictable
private

Flag for allowing dual restriction with BlockRestrictable.

Definition at line 198 of file BoundaryRestrictable.h.

Referenced by initializeBoundaryRestrictable().

◆ _bnd_feproblem

FEProblemBase* BoundaryRestrictable::_bnd_feproblem
private

◆ _bnd_ids

std::set<BoundaryID> BoundaryRestrictable::_bnd_ids
private

◆ _bnd_material_data

const MaterialData& BoundaryRestrictable::_bnd_material_data
private

Pointer to MaterialData for boundary (.

See also
hasBoundaryMaterialProperty)

Definition at line 210 of file BoundaryRestrictable.h.

Referenced by hasBoundaryMaterialProperty().

◆ _bnd_mesh

MooseMesh* BoundaryRestrictable::_bnd_mesh
private

Point to mesh.

Definition at line 186 of file BoundaryRestrictable.h.

Referenced by hasBoundary(), initializeBoundaryRestrictable(), isBoundarySubset(), and meshBoundaryIDs().

◆ _bnd_nodal

bool BoundaryRestrictable::_bnd_nodal
private

Whether or not this object is restricted to nodesets.

Definition at line 213 of file BoundaryRestrictable.h.

Referenced by initializeBoundaryRestrictable().

◆ _bnd_tid

THREAD_ID BoundaryRestrictable::_bnd_tid
private

Thread id for this object.

Definition at line 207 of file BoundaryRestrictable.h.

◆ _boundary_names

std::vector<BoundaryName> BoundaryRestrictable::_boundary_names
private

Vector the the boundary names.

Definition at line 195 of file BoundaryRestrictable.h.

Referenced by boundaryNames(), and initializeBoundaryRestrictable().

◆ _empty_block_ids

const std::set<SubdomainID> BoundaryRestrictable::_empty_block_ids
private

An empty set for referencing when block_ids is not included.

Definition at line 201 of file BoundaryRestrictable.h.

◆ _moose_object

const MooseObject& BoundaryRestrictable::_moose_object
private

The moose object that this is an interface for.

Definition at line 216 of file BoundaryRestrictable.h.

Referenced by initializeBoundaryRestrictable().

◆ _vec_ids

std::vector<BoundaryID> BoundaryRestrictable::_vec_ids
private

Vector of the boundary ids.

Definition at line 192 of file BoundaryRestrictable.h.

Referenced by initializeBoundaryRestrictable().


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