https://mooseframework.inl.gov
MaskedBodyForce.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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 "MaskedBodyForce.h"
11 
12 registerMooseObject("PhaseFieldApp", MaskedBodyForce);
13 
16 {
18  params.addClassDescription("Customization of MatBodForce which uses a material property, scalar, "
19  "and/or postprocessor to provide a source term PDE contribution.");
20  params.renameParam("material_property", "mask", "Material property defining the mask.");
21  return params;
22 }
void renameParam(const std::string &old_name, const std::string &new_name, const std::string &new_docstring)
static InputParameters validParams()
registerMooseObject("PhaseFieldApp", MaskedBodyForce)
static InputParameters validParams()
void addClassDescription(const std::string &doc_string)
This kernel creates a body force that is modified by a mask defined as a material.