NSImposedVelocityDirectionBC.h File Reference

Go to the source code of this file.

Classes
class	NSImposedVelocityDirectionBC
	This class imposes a velocity direction component as a Dirichlet condition on the appropriate momentum equation. More...

Functions
template<>
InputParameters	validParams< NSImposedVelocityDirectionBC > ()

Function Documentation

validParams< NSImposedVelocityDirectionBC >()

template<>

InputParameters validParams< NSImposedVelocityDirectionBC >

(

)

Definition at line 22 of file NSImposedVelocityDirectionBC.C.

{
  // Initialize the params object from the base class
  InputParameters params = validParams<NodalBC>();
 
  params.addClassDescription("This class imposes a velocity direction component as a Dirichlet "
                             "condition on the appropriate momentum equation.");
  // Coupled variables
  params.addRequiredCoupledVar(NS::density, "density");
  params.addRequiredCoupledVar(NS::velocity_x, "x-velocity");
  params.addCoupledVar(NS::velocity_y, "y-velocity"); // only required in >= 2D
  params.addCoupledVar(NS::velocity_z, "z-velocity"); // only required in 3D
 
  // Coupled parameters
  params.addRequiredParam<Real>("desired_unit_velocity_component", "");
 
  return params;
}