www.mooseframework.org
BlockDeletionGenerator.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 "BlockDeletionGenerator.h"
11 
12 #include "libmesh/elem.h"
13 
15 
16 template <>
19 {
21 
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 
26  return params;
27 }
28 
30  : ElementDeletionGeneratorBase(parameters), _block_id(getParam<SubdomainID>("block_id"))
31 {
32 }
33 
34 bool
36 {
37  return elem->subdomain_id() == _block_id;
38 }
InputParameters validParams< ElementDeletionGeneratorBase >()
virtual bool shouldDelete(const Elem *elem) override
Method that returns a Boolean indicating whether an element should be removed from the mesh...
This class deletes elements from the mesh data structure after it has been generated or read but befo...
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...
subdomain_id_type SubdomainID
InputParameters validParams< BlockDeletionGenerator >()
const SubdomainID _block_id
Defines the block to be removed.
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...
registerMooseObject("MooseApp", BlockDeletionGenerator)
BlockDeletionGenerator(const InputParameters &parameters)