www.mooseframework.org
Functions
ParsedAddSideset.C File Reference

Go to the source code of this file.

Functions

 registerMooseObjectReplaced ("MooseApp", ParsedAddSideset, "11/30/2019 00:00", ParsedGenerateSideset)
 
template<>
InputParameters validParams< ParsedAddSideset > ()
 

Function Documentation

◆ registerMooseObjectReplaced()

registerMooseObjectReplaced ( "MooseApp"  ,
ParsedAddSideset  ,
"11/30/2019 00:00"  ,
ParsedGenerateSideset   
)

◆ validParams< ParsedAddSideset >()

Definition at line 26 of file ParsedAddSideset.C.

27 {
30  params.addRequiredParam<std::string>("combinatorial_geometry",
31  "Function expression encoding a combinatorial geometry");
32  params.addRequiredParam<BoundaryName>("new_sideset_name", "The name of the new sideset");
33  params.addParam<std::vector<SubdomainID>>(
34  "included_subdomain_ids",
35  "A set of subdomain ids whose sides will be included in the new sidesets");
36  params.addParam<Point>(
37  "normal",
38  Point(),
39  "If provided specifies the normal vector on sides that are added to the new ");
40  params.addParam<std::vector<std::string>>(
41  "constant_names", "Vector of constants used in the parsed function (use this for kB etc.)");
42  params.addParam<std::vector<std::string>>(
43  "constant_expressions",
44  "Vector of values for the constants in constant_names (can be an FParser expression)");
45  params.addClassDescription("A MeshModifier that adds element's sides to a sideset if the "
46  "centroid satisfies the combinatorial_geometry expression, (and "
47  "optionally) "
48  "if one of the side's elements is in included_subdomain_ids and if it "
49  "features the correct normal.");
50  return params;
51 }
InputParameters::addParam
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object.
Definition: InputParameters.h:1198
validParams< AddSideSetsBase >
InputParameters validParams< AddSideSetsBase >()
Definition: AddSideSetsBase.C:25
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
InputParameters::addClassDescription
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.
Definition: InputParameters.C:70
validParams< FunctionParserUtils >
InputParameters validParams< FunctionParserUtils >()
InputParameters::addRequiredParam
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...
Definition: InputParameters.h:1176