www.mooseframework.org
BlockDeleter.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "BlockDeleter.h"
11 #include "MooseMesh.h"
12 
13 #include "libmesh/elem.h"
14 
16 
17 template <>
20 {
22  params.addClassDescription(
23  "Mesh modifier which removes elements with the specified subdomain ID");
24  params.addRequiredParam<SubdomainID>("block_id", "The block to be deleted");
25  return params;
26 }
27 
29  : ElementDeleterBase(parameters), _block_id(getParam<SubdomainID>("block_id"))
30 {
31 }
32 
33 bool
34 BlockDeleter::shouldDelete(const Elem * elem)
35 {
36  return elem->subdomain_id() == _block_id;
37 }
InputParameters validParams< BlockDeleter >()
Definition: BlockDeleter.C:19
const SubdomainID _block_id
Defines the block to be removed.
Definition: BlockDeleter.h:29
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
registerMooseObject("MooseApp", BlockDeleter)
subdomain_id_type SubdomainID
virtual bool shouldDelete(const Elem *elem) override
Method that returns a Boolean indicating whether an element should be removed from the mesh...
Definition: BlockDeleter.C:34
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
BlockDeleter(const InputParameters &parameters)
Definition: BlockDeleter.C:28
This class deletes elements from the mesh data structure after it has been generated or read but befo...
InputParameters validParams< ElementDeleterBase >()