RampIC.h File Reference

Go to the source code of this file.

Classes
class	RampIC
	Makes initial condition which creates a linear ramp of the given variable on the x-axis with specified side values. More...

Functions
template<>
InputParameters	validParams< RampIC > ()

Function Documentation

validParams< RampIC >()

template<>

InputParameters validParams< RampIC >

(

)

Definition at line 18 of file RampIC.C.

{
  InputParameters params = validParams<InitialCondition>();
  params.addClassDescription(
      "Linear ramp along the x-axis with given values at the left and right extreme points.");
  params.addRequiredParam<Real>("value_left", "The value on left (xmin) boundary.");
  params.addRequiredParam<Real>("value_right", "The value on right (xmax) boundary.");
  return params;
}