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 ()
std::vector< std::string >	boundariesToStrings ()
bool	isBoundaryRestricted () const
	Returns a bool indicating if the object is restricted to a subset of boundaries. More...
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. More...
std::vector< BoundaryName >	_boundary_names
	Stores the names of the boundaries. More...
mfem::Array< int >	_boundary_attributes
	Array storing boundary attribute IDs for this object. More...
mfem::Array< int >	_boundary_markers
	Boolean array indicating which boundaries are active in this object. More...

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())
{
  if (!_boundary_attributes.IsEmpty())
    mfem::common::AttrToMarker(
        _mfem_mesh.bdr_attributes.Max(), _boundary_attributes, _boundary_markers);
}

Member Function Documentation

boundariesToAttributes()

mfem::Array< int > MFEMBoundaryRestrictable::boundariesToAttributes

(

)

Definition at line 39 of file MFEMBoundaryRestrictable.C.

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

boundariesToStrings()

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

(

)

Definition at line 68 of file MFEMBoundaryRestrictable.C.

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

{
  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;
}

getBoundaryAttributes()

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

inline

Definition at line 39 of file MFEMBoundaryRestrictable.h.

Referenced by MFEMBoundarySubMesh::buildSubMesh().

{ return _boundary_attributes; }

getBoundaryMarkers()

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

inline

Definition at line 40 of file MFEMBoundaryRestrictable.h.

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

{ return _boundary_markers; }

getMesh()

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

inline

Definition at line 41 of file MFEMBoundaryRestrictable.h.

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

{ return _mfem_mesh; }

isBoundaryRestricted()

bool MFEMBoundaryRestrictable::isBoundaryRestricted ( ) const

inline

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

Definition at line 34 of file MFEMBoundaryRestrictable.h.

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

  {
    return !(_boundary_attributes.Size() == 1 && _boundary_attributes[0] == -1);
  }

validParams()

InputParameters MFEMBoundaryRestrictable::validParams ( )

static

Definition at line 15 of file MFEMBoundaryRestrictable.C.

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

{
  // Create InputParameters object that will be appended to the parameters for the inheriting object
  InputParameters params = emptyInputParameters();
  params.addParam<std::vector<BoundaryName>>(
      "boundary",
      {"-1"},
      "The list of boundaries (ids or names) from the mesh where this object applies. "
      "Defaults to all boundaries.");
  return params;
}

Member Data Documentation

_boundary_attributes

mfem::Array<int> MFEMBoundaryRestrictable::_boundary_attributes

protected

Array storing boundary attribute IDs for this object.

Definition at line 49 of file MFEMBoundaryRestrictable.h.

Referenced by boundariesToStrings(), getBoundaryAttributes(), isBoundaryRestricted(), and MFEMBoundaryRestrictable().

_boundary_markers

mfem::Array<int> MFEMBoundaryRestrictable::_boundary_markers

protected

Boolean array indicating which boundaries are active in this object.

Definition at line 51 of file MFEMBoundaryRestrictable.h.

Referenced by getBoundaryMarkers(), and MFEMBoundaryRestrictable().

_boundary_names

std::vector<BoundaryName> MFEMBoundaryRestrictable::_boundary_names

protected

Stores the names of the boundaries.

Definition at line 47 of file MFEMBoundaryRestrictable.h.

Referenced by boundariesToAttributes().

_mfem_mesh

const mfem::ParMesh& MFEMBoundaryRestrictable::_mfem_mesh

protected

Stores the names of the boundaries.

Definition at line 45 of file MFEMBoundaryRestrictable.h.

Referenced by getMesh(), and MFEMBoundaryRestrictable().

---

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

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