www.mooseframework.org
Functions
INSChorinPredictor.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< INSChorinPredictor > ()
 

Function Documentation

template<>
InputParameters validParams< INSChorinPredictor > ( )

Definition at line 13 of file INSChorinPredictor.C.

14 {
15  InputParameters params = validParams<Kernel>();
16 
17  params.addClassDescription("This class computes the 'Chorin' Predictor equation in "
18  "fully-discrete (both time and space) form.");
19  // Coupled variables
20  params.addRequiredCoupledVar("u", "x-velocity");
21  params.addCoupledVar("v", "y-velocity"); // only required in 2D and 3D
22  params.addCoupledVar("w", "z-velocity"); // only required in 3D
23 
24  // Make star also be required, even though we might not use it?
25  params.addRequiredCoupledVar("u_star", "star x-velocity");
26  params.addCoupledVar("v_star", "star y-velocity"); // only required in 2D and 3D
27  params.addCoupledVar("w_star", "star z-velocity"); // only required in 3D
28 
29  // Required parameters
30  params.addRequiredParam<unsigned>(
31  "component",
32  "0,1,2 depending on if we are solving the x,y,z component of the Predictor equation");
33  params.addRequiredParam<std::string>(
34  "predictor_type",
35  "One of: OLD, NEW, STAR. Indicates which velocity to use in the predictor.");
36 
37  // Optional parameters
38  params.addParam<MaterialPropertyName>("mu_name", "mu", "The name of the dynamic viscosity");
39  params.addParam<MaterialPropertyName>("rho_name", "rho", "The name of the density");
40 
41  return params;
42 }