www.mooseframework.org
Classes | Namespaces | Functions
BoundingBoxIC.h File Reference

Go to the source code of this file.

Classes

class  BoundingBoxIC
 BoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box. More...
 

Namespaces

 libMesh
 The following methods are specializations for using the libMesh::Parallel::packed_range_* routines for std::strings.
 

Functions

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

Function Documentation

template<typename T >
InputParameters validParams ( )

Definition at line 20 of file BoundingBoxIC.C.

21 {
23  params.addRequiredParam<Real>("x1", "The x coordinate of the lower left-hand corner of the box");
24  params.addRequiredParam<Real>("y1", "The y coordinate of the lower left-hand corner of the box");
25  params.addParam<Real>("z1", 0.0, "The z coordinate of the lower left-hand corner of the box");
26 
27  params.addRequiredParam<Real>("x2", "The x coordinate of the upper right-hand corner of the box");
28  params.addRequiredParam<Real>("y2", "The y coordinate of the upper right-hand corner of the box");
29  params.addParam<Real>("z2", 0.0, "The z coordinate of the upper right-hand corner of the box");
30 
31  params.addParam<Real>("inside", 0.0, "The value of the variable inside the box");
32  params.addParam<Real>("outside", 0.0, "The value of the variable outside the box");
33  return params;
34 }
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...
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...
InputParameters validParams< InitialCondition >()