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 std::vector< BoundaryName > &boundary_names)
bool	isBoundaryRestricted () const
	Returns a bool indicating if the object is restricted to a subset of boundaries. More...
const mfem::ParMesh &	getMesh ()
const mfem::Array< int > &	getBoundaryAttributes ()
mfem::Array< int > &	getBoundaryMarkers ()

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(_boundary_names.size())
{
  _boundary_attributes = boundariesToAttributes(_boundary_names);
  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

(

const std::vector< BoundaryName > &

boundary_names

)

Definition at line 40 of file MFEMBoundaryRestrictable.C.

Referenced by MFEMBoundaryRestrictable().

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

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 MFEMScalarDirichletBC::ApplyBC(), MFEMVectorDirichletBC::ApplyBC(), MFEMVectorNormalDirichletBC::ApplyBC(), and MFEMVectorTangentialDirichletBC::ApplyBC().

{ return _boundary_markers; }

getMesh()

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

inline

Definition at line 38 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 33 of file MFEMBoundaryRestrictable.h.

  {
    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(), and MFEMBoundarySubMesh::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 48 of file MFEMBoundaryRestrictable.h.

Referenced by 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 50 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 46 of file MFEMBoundaryRestrictable.h.

Referenced by MFEMBoundaryRestrictable().

_mfem_mesh

const mfem::ParMesh& MFEMBoundaryRestrictable::_mfem_mesh

protected

Stores the names of the boundaries.

Definition at line 44 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