MFEMBlockRestrictable Class Reference

Base class for construction of an object that is restricted to a subset of subdomains of the problem mesh. More...

#include <MFEMBlockRestrictable.h>

Inheritance diagram for MFEMBlockRestrictable:

Public Member Functions
	MFEMBlockRestrictable (const InputParameters &parameters, const mfem::ParMesh &mfem_mesh)
mfem::Array< int >	subdomainsToAttributes (const std::vector< SubdomainName > &subdomain_names)
std::vector< std::string >	subdomainsToStrings (const std::vector< SubdomainName > &subdomain_names)
bool	isSubdomainRestricted ()
	Returns a bool indicating if the object is restricted to a subset of subdomains. More...
const mfem::Array< int > &	getSubdomainAttributes ()
mfem::Array< int > &	getSubdomainMarkers ()
const mfem::ParMesh &	getMesh () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const mfem::ParMesh &	_mfem_mesh
	Stores the names of the subdomains. More...
std::vector< SubdomainName >	_subdomain_names
	Stores the names of the subdomains. More...
mfem::Array< int >	_subdomain_attributes
	Array storing subdomain attribute IDs for this object. More...
mfem::Array< int >	_subdomain_markers
	Boolean array indicating which subdomains are active in this object. More...

Detailed Description

Base class for construction of an object that is restricted to a subset of subdomains of the problem mesh.

Definition at line 23 of file MFEMBlockRestrictable.h.

Constructor & Destructor Documentation

MFEMBlockRestrictable()

MFEMBlockRestrictable::MFEMBlockRestrictable	(	const InputParameters &	parameters,
		const mfem::ParMesh &	mfem_mesh
	)

Definition at line 29 of file MFEMBlockRestrictable.C.

  : _mfem_mesh(mfem_mesh),
    _subdomain_names(parameters.get<std::vector<SubdomainName>>("block")),
    _subdomain_attributes(_subdomain_names.size())
{
  _subdomain_attributes = subdomainsToAttributes(_subdomain_names);
  if (!_subdomain_attributes.IsEmpty())
    mfem::common::AttrToMarker(
        _mfem_mesh.attributes.Max(), _subdomain_attributes, _subdomain_markers);
}

Member Function Documentation

getMesh()

const mfem::ParMesh& MFEMBlockRestrictable::getMesh ( ) const

inline

Definition at line 38 of file MFEMBlockRestrictable.h.

Referenced by MFEMDomainSubMesh::buildSubMesh(), and subdomainsToAttributes().

{ return _mfem_mesh; }

getSubdomainAttributes()

const mfem::Array<int>& MFEMBlockRestrictable::getSubdomainAttributes ( )

inline

Definition at line 36 of file MFEMBlockRestrictable.h.

Referenced by MFEMDomainSubMesh::buildSubMesh().

{ return _subdomain_attributes; }

getSubdomainMarkers()

mfem::Array<int>& MFEMBlockRestrictable::getSubdomainMarkers ( )

inline

Definition at line 37 of file MFEMBlockRestrictable.h.

{ return _subdomain_markers; }

isSubdomainRestricted()

bool MFEMBlockRestrictable::isSubdomainRestricted ( )

inline

Returns a bool indicating if the object is restricted to a subset of subdomains.

Definition at line 34 of file MFEMBlockRestrictable.h.

{ return _subdomain_names.size(); }

subdomainsToAttributes()

mfem::Array< int > MFEMBlockRestrictable::subdomainsToAttributes

(

const std::vector< SubdomainName > &

subdomain_names

)

Definition at line 42 of file MFEMBlockRestrictable.C.

Referenced by MFEMBlockRestrictable(), and subdomainsToStrings().

{
  mfem::Array<int> attributes(subdomain_names.size());
  auto & mesh = getMesh();
  std::transform(
      subdomain_names.begin(),
      subdomain_names.end(),
      attributes.begin(),
      [&mesh](const SubdomainName & subdomain) -> int
      {
        try
        {
          // Is this a block ID?
          return std::stoi(subdomain);
        }
        catch (...)
        {
          // It was not
          auto & subdomain_ids = mesh.attribute_sets.GetAttributeSet(subdomain);
          if (subdomain_ids.Size() != 1)
            mooseError(
                "There should be a 1-to-1 correspondence between subdomain name and subdomain ID");
          return subdomain_ids[0];
        }
      });
  return attributes;
}

subdomainsToStrings()

std::vector< std::string > MFEMBlockRestrictable::subdomainsToStrings

(

const std::vector< SubdomainName > &

subdomain_names

)

Definition at line 71 of file MFEMBlockRestrictable.C.

Referenced by MFEMGenericFunctorMaterial::MFEMGenericFunctorMaterial(), and MFEMGenericFunctorVectorMaterial::MFEMGenericFunctorVectorMaterial().

{
  auto attributes = subdomainsToAttributes(subdomain_names);
  std::vector<std::string> subdomain_attr_strings(subdomain_names.size());
  for (const auto i : index_range(subdomain_names))
    subdomain_attr_strings[i] = std::to_string(attributes[i]);
  return subdomain_attr_strings;
}

validParams()

InputParameters MFEMBlockRestrictable::validParams ( )

static

Definition at line 15 of file MFEMBlockRestrictable.C.

Referenced by MFEMFunctorMaterial::validParams(), MFEMDomainSubMesh::validParams(), and MFEMKernel::validParams().

{
  // Create InputParameters object that will be appended to the parameters for the inheriting object
  InputParameters params = emptyInputParameters();
  // Create user-facing 'boundary' input for restricting inheriting object to boundaries
  // MFEM uses the boundary -1 to signify every sideset
  params.addParam<std::vector<SubdomainName>>("block",
                                              {},
                                              "The list of subdomains (names or ids) that this "
                                              "object will be restricted to. Leave empty to apply "
                                              "to all subdomains.");
  return params;
}

Member Data Documentation

_mfem_mesh

const mfem::ParMesh& MFEMBlockRestrictable::_mfem_mesh

protected

Stores the names of the subdomains.

Definition at line 42 of file MFEMBlockRestrictable.h.

Referenced by getMesh(), and MFEMBlockRestrictable().

_subdomain_attributes

mfem::Array<int> MFEMBlockRestrictable::_subdomain_attributes

protected

Array storing subdomain attribute IDs for this object.

Definition at line 46 of file MFEMBlockRestrictable.h.

Referenced by getSubdomainAttributes(), and MFEMBlockRestrictable().

_subdomain_markers

mfem::Array<int> MFEMBlockRestrictable::_subdomain_markers

protected

Boolean array indicating which subdomains are active in this object.

Definition at line 48 of file MFEMBlockRestrictable.h.

Referenced by getSubdomainMarkers(), and MFEMBlockRestrictable().

_subdomain_names

std::vector<SubdomainName> MFEMBlockRestrictable::_subdomain_names

protected

Stores the names of the subdomains.

Definition at line 44 of file MFEMBlockRestrictable.h.

Referenced by isSubdomainRestricted(), MFEMBlockRestrictable(), MFEMGenericFunctorMaterial::MFEMGenericFunctorMaterial(), and MFEMGenericFunctorVectorMaterial::MFEMGenericFunctorVectorMaterial().

---

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

• include/mfem/interfaces/MFEMBlockRestrictable.h
• src/mfem/interfaces/MFEMBlockRestrictable.C