www.mooseframework.org
Classes | Functions
OrientedBoxInterface.h File Reference

Go to the source code of this file.

Classes

class  OrientedBoxInterface
 

Functions

template<typename T >
InputParameters validParams ()
 
template<>
InputParameters validParams< OrientedBoxInterface > ()
 

Function Documentation

template<typename T >
InputParameters validParams ( )

Definition at line 25 of file OrientedBoxInterface.C.

Referenced by validParams< OrientedBoxMarker >(), and validParams< OrientedSubdomainBoundingBox >().

26 {
28  params.addRequiredParam<Point>("center",
29  "The center (many people spell this 'center') of the box.");
30  params.addRequiredParam<Real>("width", "The width of the box");
31  params.addRequiredParam<Real>("length", "The length of the box");
32  params.addRequiredParam<Real>("height", "The height of the box");
33  params.addRequiredParam<RealVectorValue>("width_direction",
34  "The direction along which the width is oriented.");
35  params.addRequiredParam<RealVectorValue>("length_direction",
36  "The direction along which the length is oriented (must "
37  "be perpendicular to width_direction).");
38  return params;
39 }
VectorValue< Real > RealVectorValue
Definition: Assembly.h:40
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...
InputParameters emptyInputParameters()