www.mooseframework.org
NSIntegratedBC.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 // Navier-Stokes includes
11 #include "NS.h"
12 #include "NSIntegratedBC.h"
13 
14 // FluidProperties includes
16 
17 // MOOSE includes
18 #include "MooseMesh.h"
19 
22 {
24 
25  params.addClassDescription("This class couples together all the variables for the compressible "
26  "Navier-Stokes equations to allow them to be used in derived "
27  "IntegratedBC classes.");
28 
29  params.addRequiredCoupledVar(NS::velocity_x, "x-velocity");
30  params.addCoupledVar(NS::velocity_y, "y-velocity"); // only required in >= 2D
31  params.addCoupledVar(NS::velocity_z, "z-velocity"); // only required in 3D
32 
33  params.addRequiredCoupledVar(NS::density, "density");
34  params.addRequiredCoupledVar(NS::momentum_x, "x-momentum");
35  params.addCoupledVar(NS::momentum_y, "y-momentum"); // only required in >= 2D
36  params.addCoupledVar(NS::momentum_z, "z-momentum"); // only required in 3D
37  params.addRequiredCoupledVar(NS::total_energy_density, "total energy");
38  params.addRequiredParam<UserObjectName>("fluid_properties",
39  "The name of the user object for fluid properties");
40  params.addParam<Real>("specified_pressure", 0.0, "The specified pressure for this boundary");
41 
42  return params;
43 }
44 
46  : IntegratedBC(parameters),
47  _u_vel(coupledValue(NS::velocity_x)),
48  _v_vel(_mesh.dimension() >= 2 ? coupledValue(NS::velocity_y) : _zero),
49  _w_vel(_mesh.dimension() == 3 ? coupledValue(NS::velocity_z) : _zero),
50 
51  _rho(coupledValue(NS::density)),
52  _rho_u(coupledValue(NS::momentum_x)),
53  _rho_v(_mesh.dimension() >= 2 ? coupledValue(NS::momentum_y) : _zero),
54  _rho_w(_mesh.dimension() == 3 ? coupledValue(NS::momentum_z) : _zero),
55  _rho_et(coupledValue(NS::total_energy_density)),
56 
57  _grad_rho(coupledGradient(NS::density)),
58  _grad_rho_u(coupledGradient(NS::momentum_x)),
59  _grad_rho_v(_mesh.dimension() >= 2 ? coupledGradient(NS::momentum_y) : _grad_zero),
60  _grad_rho_w(_mesh.dimension() == 3 ? coupledGradient(NS::momentum_z) : _grad_zero),
61  _grad_rho_et(coupledGradient(NS::total_energy_density)),
62 
63  // Variable numberings
64  _rho_var_number(coupled(NS::density)),
65  _rhou_var_number(coupled(NS::momentum_x)),
66  _rhov_var_number(_mesh.dimension() >= 2 ? coupled(NS::momentum_y) : libMesh::invalid_uint),
67  _rhow_var_number(_mesh.dimension() == 3 ? coupled(NS::momentum_z) : libMesh::invalid_uint),
68  _rho_et_var_number(coupled(NS::total_energy_density)),
69 
70  _dynamic_viscosity(getMaterialProperty<Real>("dynamic_viscosity")),
71  _viscous_stress_tensor(getMaterialProperty<RealTensorValue>("viscous_stress_tensor")),
72 
73  // FluidProperties UserObject
74  _fp(getUserObject<IdealGasFluidProperties>("fluid_properties"))
75 {
76 }
77 
78 bool
80 {
81  if (var == _rho_var_number || var == _rhou_var_number || var == _rhov_var_number ||
82  var == _rhow_var_number || var == _rho_et_var_number)
83  return true;
84  else
85  return false;
86 }
87 
88 unsigned
90 {
91  // Convert the Moose numbering to:
92  // 0 for rho
93  // 1 for rho*u
94  // 2 for rho*v
95  // 3 for rho*w
96  // 4 for rho*e
97  // regardless of the problem dimension, etc.
98  unsigned int mapped_var_number;
99 
100  if (var == _rho_var_number)
101  mapped_var_number = 0;
102  else if (var == _rhou_var_number)
103  mapped_var_number = 1;
104  else if (var == _rhov_var_number)
105  mapped_var_number = 2;
106  else if (var == _rhow_var_number)
107  mapped_var_number = 3;
108  else if (var == _rho_et_var_number)
109  mapped_var_number = 4;
110  else
111  mooseError("Invalid var!");
112 
113  return mapped_var_number;
114 }
unsigned _rhov_var_number
static const std::string total_energy_density
Definition: NS.h:63
static const std::string momentum_x
Definition: NS.h:35
bool isNSVariable(unsigned var)
const unsigned int invalid_uint
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
static const std::string velocity_z
Definition: NS.h:48
static const std::string density
Definition: NS.h:33
static InputParameters validParams()
unsigned _rhou_var_number
static const std::string velocity_x
Definition: NS.h:46
The following methods are specializations for using the Parallel::packed_range_* routines for a vecto...
NSIntegratedBC(const InputParameters &parameters)
void addRequiredParam(const std::string &name, const std::string &doc_string)
TensorValue< Real > RealTensorValue
unsigned _rhow_var_number
unsigned _rho_var_number
static const std::string velocity_y
Definition: NS.h:47
void addCoupledVar(const std::string &name, const std::string &doc_string)
static const std::string momentum_y
Definition: NS.h:36
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
unsigned mapVarNumber(unsigned var)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void mooseError(Args &&... args) const
void addClassDescription(const std::string &doc_string)
static const std::string momentum_z
Definition: NS.h:37
Ideal gas fluid properties Default parameters are for air at atmospheric pressure and temperature...
unsigned _rho_et_var_number
static InputParameters validParams()