INSChorinPredictor.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("NavierStokesApp", INSChorinPredictor)
template<>
InputParameters	validParams< INSChorinPredictor > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"NavierStokesApp"	,
		INSChorinPredictor
	)

validParams< INSChorinPredictor >()

template<>

InputParameters validParams< INSChorinPredictor >

(

)

Definition at line 17 of file INSChorinPredictor.C.

{
  InputParameters params = validParams<Kernel>();
 
  params.addClassDescription("This class computes the 'Chorin' Predictor equation in "
                             "fully-discrete (both time and space) form.");
  // Coupled variables
  params.addRequiredCoupledVar("u", "x-velocity");
  params.addCoupledVar("v", "y-velocity"); // only required in 2D and 3D
  params.addCoupledVar("w", "z-velocity"); // only required in 3D
 
  // Make star also be required, even though we might not use it?
  params.addRequiredCoupledVar("u_star", "star x-velocity");
  params.addCoupledVar("v_star", "star y-velocity"); // only required in 2D and 3D
  params.addCoupledVar("w_star", "star z-velocity"); // only required in 3D
 
  // Required parameters
  params.addRequiredRangeCheckedParam<unsigned>(
      "component",
      "component>=0 & component<=2",
      "0,1,2 depending on if we are solving the x,y,z component of the Predictor equation");
  MooseEnum predictor_type("OLD NEW STAR");
  params.addRequiredParam<MooseEnum>(
      "predictor_type",
      predictor_type,
      "One of: OLD, NEW, STAR.  Indicates which velocity to use in the predictor.");
 
  // Optional parameters
  params.addParam<MaterialPropertyName>("mu_name", "mu", "The name of the dynamic viscosity");
  params.addParam<MaterialPropertyName>("rho_name", "rho", "The name of the density");
 
  return params;
}