MFEMBoundaryRestrictable Class Reference

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

#include <MFEMBoundaryRestrictable.h>

Inheritance diagram for MFEMBoundaryRestrictable:

Public Member Functions
	MFEMBoundaryRestrictable (const InputParameters &parameters, const mfem::ParMesh &mfem_mesh)
mfem::Array< int >	boundariesToAttributes (const InputParameters &parameters)
	Converts the boundary names and IDs to mesh attributes, checking that the mesh has them.
std::vector< std::string >	boundariesToStrings ()
bool	isBoundaryRestricted () const
	Returns a bool indicating if the object is restricted to a subset of boundaries.
const mfem::Array< int > &	getBoundaryAttributes ()
mfem::Array< int > &	getBoundaryMarkers ()
const mfem::ParMesh &	getMesh ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const mfem::ParMesh &	_mfem_mesh
	Stores the names of the boundaries.
std::vector< BoundaryName >	_boundary_names
	Stores the names of the boundaries.
mfem::Array< int >	_boundary_attributes
	Array storing boundary attribute IDs for this object.
mfem::Array< int >	_boundary_markers
	Boolean array indicating which boundaries are active in this object.

Detailed Description

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

Definition at line 23 of file MFEMBoundaryRestrictable.h.

Constructor & Destructor Documentation

MFEMBoundaryRestrictable()

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

Definition at line 27 of file MFEMBoundaryRestrictable.C.

  : _mfem_mesh(mfem_mesh),
    _boundary_names(parameters.get<std::vector<BoundaryName>>("boundary")),
    _boundary_attributes(boundariesToAttributes(parameters)),
    _boundary_markers(_mfem_mesh.bdr_attributes.IsEmpty()
                          ? mfem::Array<int>()
                          : mfem::AttributeSets::AttrToMarker(_mfem_mesh.bdr_attributes.Max(),
                                                              _boundary_attributes.IsEmpty()
                                                                  ? _mfem_mesh.bdr_attributes
                                                                  : _boundary_attributes))
{
}

Member Function Documentation

boundariesToAttributes()

mfem::Array< int > MFEMBoundaryRestrictable::boundariesToAttributes

(

const InputParameters &

parameters

)

Converts the boundary names and IDs to mesh attributes, checking that the mesh has them.

Definition at line 42 of file MFEMBoundaryRestrictable.C.

{
  mfem::Array<int> attributes;
  auto & mesh = getMesh();
 
  for (const BoundaryName & boundary_name : _boundary_names)
  {
    try
    {
      // Is this a boundary ID?
      const int attribute_id = std::stoi(boundary_name);
      attributes.Append(attribute_id);
    }
    catch (...)
    {
      // It was not
      if (!mesh.bdr_attribute_sets.AttributeSetExists(boundary_name))
        parameters.paramError("boundary", "the mesh has no boundary named '", boundary_name, "'.");
      auto & subdomain_ids = mesh.bdr_attribute_sets.GetAttributeSet(boundary_name);
      for (const auto & subdomain_id : subdomain_ids)
        attributes.Append(subdomain_id);
    }
  }
 
  for (const auto attribute : attributes)
    if (mesh.bdr_attributes.Find(attribute) == -1)
      parameters.paramError("boundary", "the mesh has no boundary with ID ", attribute, ".");
  return attributes;
}

boundariesToStrings()

std::vector< std::string > MFEMBoundaryRestrictable::boundariesToStrings

(

)

Definition at line 73 of file MFEMBoundaryRestrictable.C.

{
  const auto & attrs = _boundary_attributes;
  std::vector<std::string> strs(attrs.Size());
  std::transform(attrs.begin(), attrs.end(), strs.begin(), [](int n) { return std::to_string(n); });
  return strs;
}

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

getBoundaryAttributes()

const mfem::Array< int > & MFEMBoundaryRestrictable::getBoundaryAttributes ( )

inline

Definition at line 37 of file MFEMBoundaryRestrictable.h.

{ return _boundary_attributes; }

Referenced by MFEMBoundarySubMesh::buildSubMesh().

getBoundaryMarkers()

mfem::Array< int > & MFEMBoundaryRestrictable::getBoundaryMarkers ( )

inline

Definition at line 38 of file MFEMBoundaryRestrictable.h.

{ return _boundary_markers; }

Referenced by MFEMScalarDirichletBC::ApplyBC(), MFEMVectorDirichletBC::ApplyBC(), MFEMVectorNormalDirichletBC::ApplyBC(), MFEMVectorTangentialDirichletBC::ApplyBC(), MFEMComplexScalarDirichletBC::ApplyBC(), MFEMComplexVectorNormalDirichletBC::ApplyBC(), MFEMComplexVectorTangentialDirichletBC::ApplyBC(), MFEMComplexScalarBoundaryIC::execute(), MFEMScalarBoundaryIC::execute(), MFEMVectorBoundaryFluxIntegralPostprocessor::execute(), and MFEMVectorBoundaryFluxIntegralPostprocessor::MFEMVectorBoundaryFluxIntegralPostprocessor().

getMesh()

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

inline

Definition at line 39 of file MFEMBoundaryRestrictable.h.

{ return _mfem_mesh; }

Referenced by boundariesToAttributes(), and MFEMBoundarySubMesh::buildSubMesh().

isBoundaryRestricted()

bool MFEMBoundaryRestrictable::isBoundaryRestricted ( ) const

inline

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

Definition at line 35 of file MFEMBoundaryRestrictable.h.

{ return _boundary_names.size(); }

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

validParams()

InputParameters MFEMBoundaryRestrictable::validParams ( )

static

Definition at line 15 of file MFEMBoundaryRestrictable.C.

{
  // Create InputParameters object that will be appended to the parameters for the inheriting object
  InputParameters params = emptyInputParameters();
  params.addParam<std::vector<BoundaryName>>(
      "boundary",
      {},
      "The list of boundaries (names or ids) that this object will be restricted to. "
      "Leave empty to apply to all boundaries.");
  return params;
}

Referenced by MFEMBoundaryCondition::validParams(), MFEMFunctorMaterial::validParams(), MFEMComplexScalarBoundaryIC::validParams(), MFEMScalarBoundaryIC::validParams(), MFEMVectorBoundaryFluxIntegralPostprocessor::validParams(), and MFEMBoundarySubMesh::validParams().

Member Data Documentation

_boundary_attributes

mfem::Array<int> MFEMBoundaryRestrictable::_boundary_attributes

protected

Array storing boundary attribute IDs for this object.

Definition at line 47 of file MFEMBoundaryRestrictable.h.

Referenced by boundariesToStrings(), and getBoundaryAttributes().

_boundary_markers

mfem::Array<int> MFEMBoundaryRestrictable::_boundary_markers

protected

Boolean array indicating which boundaries are active in this object.

Definition at line 49 of file MFEMBoundaryRestrictable.h.

Referenced by getBoundaryMarkers().

_boundary_names

std::vector<BoundaryName> MFEMBoundaryRestrictable::_boundary_names

protected

Stores the names of the boundaries.

Definition at line 45 of file MFEMBoundaryRestrictable.h.

Referenced by boundariesToAttributes(), and isBoundaryRestricted().

_mfem_mesh

const mfem::ParMesh& MFEMBoundaryRestrictable::_mfem_mesh

protected

Stores the names of the boundaries.

Definition at line 43 of file MFEMBoundaryRestrictable.h.

Referenced by getMesh().

---

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

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