ADShaftConnectedPump1PhaseUserObject

Computes and caches flux and residual vectors for a 1-phase pump. Also computes pump torque and head which is passed to the connected shaft

A pump is a type of volume junction, a ADVolumeJunction1PhaseUserObject. As such its base contribution to the residual and Jacobian is set by this class. An additional contribution to the residual (and Jacobian) is described below:

The additional contribution to the residual of the energy equation is simply the power of the pump:

var element = document.getElementById("moose-equation-227ba717-6dfd-47cf-9fef-15b7ea3a90cd");katex.render("R_e += (T_{hydraulic} + T_{dissipation}) \\omega", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});

where $var element = document.getElementById("moose-equation-04ed6290-e57a-48ab-8ed0-9ea021412000");katex.render("T_{hydraulic}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the friction torque, and $var element = document.getElementById("moose-equation-df483499-1586-434b-898a-f5e48aaf9265");katex.render("\\omega", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the rotation speed of the pump.

The additional contribution to the residual of the momentum equation is:

var element = document.getElementById("moose-equation-c7f6ba70-f4b8-4a1b-9510-0e3b3a7de492");katex.render("\\vec{R} = \\dfrac{\\rho A}{A} \\vec{g} H A_{ref} \\vec{d}_{out}", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});

where $var element = document.getElementById("moose-equation-b4491d5e-353d-4670-b744-78f593a044eb");katex.render("\\rho A", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the conserved density, $var element = document.getElementById("moose-equation-30d12c43-d15c-4a02-85ef-0420c6d45479");katex.render("A", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ the local flow area, $var element = document.getElementById("moose-equation-891805a4-66d6-41fd-b057-a135d6ffd71f");katex.render("A_{ref}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the reference flow area, $var element = document.getElementById("moose-equation-41462f32-03aa-4756-88ed-27469262e101");katex.render("\\vec{g}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the gravity vector, $var element = document.getElementById("moose-equation-07238140-3941-4ba1-af86-7bd03729500a");katex.render("H", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ the pump head, and $var element = document.getElementById("moose-equation-5bb9be2c-7a16-4e3c-b669-719e9a41a0f4");katex.render("\\vec{d}_{out}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ the outlet direction.

The pump head is computed as:

var element = document.getElementById("moose-equation-9e7e2d46-8610-4eb2-9417-013e9e41993b");katex.render("H_{pump} = ( (\\dfrac{\\omega}{\\omega_{rated}})^2 + (\\dfrac{\\dfrac{\\rho u A A}{\\rho A}}{Q_{rated}})^2 ) H_{function} H_{rated}", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});

where $var element = document.getElementById("moose-equation-b355066f-f0a7-410d-b865-6ce1f7d05176");katex.render("\\omega_{rated}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the rated rotation speed of the pump, $var element = document.getElementById("moose-equation-0fa0f07b-57d1-4f45-b83b-f6edfb6c370c");katex.render("\\rho", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ the fluid density, $var element = document.getElementById("moose-equation-9d842e68-29c0-4628-a2f9-6ece6720004e");katex.render("u", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ the fluid velocity, $var element = document.getElementById("moose-equation-859eef95-877b-4722-a0e1-2b203878b0f1");katex.render("A", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ the local area, $var element = document.getElementById("moose-equation-3b68c5dd-ead2-4109-9f77-5ec6a6678541");katex.render("Q_{rated}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the rated flow rate, $var element = document.getElementById("moose-equation-700ee73c-42fb-45bb-b39e-cdb1e443d071");katex.render("H_{function}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ an adimensional pump head function and $var element = document.getElementById("moose-equation-9d9c844a-12e6-43ae-a448-c55d7a2ee512");katex.render("H_{rated}", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the rated head of the pump.

The user object also provides APIs to retrieve the pump's:

hydraulic torque
friction torque
pump head

note

This user object is created automatically by the ShaftConnectedPump1Phase component, users do not need to add it to an input file.

Input Parameters

ACross-sectional area of connected flow channels
C++ Type:std::vector<VariableName>
Controllable:No
Description:Cross-sectional area of connected flow channels
A_refReference area [m^2]
C++ Type:double
Controllable:No
Description:Reference area [m^2]
KForm loss coefficient [-]
C++ Type:double
Controllable:Yes
Description:Form loss coefficient [-]
boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
density_ratedRated pump fluid density [kg/m^3]
C++ Type:double
Controllable:No
Description:Rated pump fluid density [kg/m^3]
di_outDirection of connected outlet
C++ Type:libMesh::Point
Controllable:No
Description:Direction of connected outlet
fpFluid properties user object name
C++ Type:UserObjectName
Controllable:No
Description:Fluid properties user object name
gravity_magnitudeGravity constant, [m/s^2]
C++ Type:double
Controllable:No
Description:Gravity constant, [m/s^2]
headFunction to compute data for pump head [-]
C++ Type:FunctionName
Controllable:No
Description:Function to compute data for pump head [-]
head_ratedRated pump head [m]
C++ Type:double
Controllable:No
Description:Rated pump head [m]
inertia_coeffPump inertia coefficients [kg-m^2]
C++ Type:std::vector<double>
Controllable:No
Description:Pump inertia coefficients [kg-m^2]
inertia_constPump inertia constant [kg-m^2]
C++ Type:double
Controllable:No
Description:Pump inertia constant [kg-m^2]
normalsFlow channel outward normals or junction inward normals
C++ Type:std::vector<double>
Controllable:No
Description:Flow channel outward normals or junction inward normals
numerical_flux_namesThe names of the user objects that compute the numerical flux at each flow channel.
C++ Type:std::vector<UserObjectName>
Controllable:No
Description:The names of the user objects that compute the numerical flux at each flow channel.
omegaShaft rotational speed [rad/s]
C++ Type:std::vector<VariableName>
Controllable:No
Description:Shaft rotational speed [rad/s]
omega_ratedRated pump speed [rad/s]
C++ Type:double
Controllable:No
Description:Rated pump speed [rad/s]
pump_nameName of the instance of this pump component
C++ Type:std::string
Controllable:No
Description:Name of the instance of this pump component
rhoArho*A of the connected flow channels
C++ Type:std::vector<VariableName>
Controllable:No
Description:rho*A of the connected flow channels
rhoEArhoE*A of the connected flow channels
C++ Type:std::vector<VariableName>
Controllable:No
Description:rhoE*A of the connected flow channels
rhoEVrho*E*V of the junction
C++ Type:std::vector<VariableName>
Controllable:No
Description:rho*E*V of the junction
rhoVrho*V of the junction
C++ Type:std::vector<VariableName>
Controllable:No
Description:rho*V of the junction
rhouArhou*A of the connected flow channels
C++ Type:std::vector<VariableName>
Controllable:No
Description:rhou*A of the connected flow channels
rhouVrho*u*V of the junction
C++ Type:std::vector<VariableName>
Controllable:No
Description:rho*u*V of the junction
rhovVrho*v*V of the junction
C++ Type:std::vector<VariableName>
Controllable:No
Description:rho*v*V of the junction
rhowVrho*w*V of the junction
C++ Type:std::vector<VariableName>
Controllable:No
Description:rho*w*V of the junction
speed_cr_IPump speed threshold for inertia [-]
C++ Type:double
Controllable:No
Description:Pump speed threshold for inertia [-]
speed_cr_frPump speed threshold for friction [-]
C++ Type:double
Controllable:No
Description:Pump speed threshold for friction [-]
tau_fr_coeffFriction coefficients [N-m]
C++ Type:std::vector<double>
Controllable:No
Description:Friction coefficients [N-m]
tau_fr_constPump friction constant [N-m]
C++ Type:double
Controllable:No
Description:Pump friction constant [N-m]
torque_hydraulicFunction to compute data for pump torque [-]
C++ Type:FunctionName
Controllable:No
Description:Function to compute data for pump torque [-]
torque_ratedRated pump torque [N-m]
C++ Type:double
Controllable:No
Description:Rated pump torque [N-m]
volumeVolume of the junction
C++ Type:double
Controllable:No
Description:Volume of the junction
volumetric_ratedRated pump volumetric flow rate [m^3/s]
C++ Type:double
Controllable:No
Description:Rated pump volumetric flow rate [m^3/s]

Required Parameters

execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
inletPump inlet
C++ Type:BoundaryName
Controllable:No
Description:Pump inlet
outletPump outlet
C++ Type:BoundaryName
Controllable:No
Description:Pump outlet
processor_idsProcessor IDs owning each connected flow channel element
C++ Type:std::vector<unsigned int>
Controllable:No
Description:Processor IDs owning each connected flow channel element
prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
transition_width0.001Transition width for sign of the frictional torque at 0 speed over rated speed ratio.
Default:0.001
C++ Type:double
Controllable:No
Description:Transition width for sign of the frictional torque at 0 speed over rated speed ratio.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Parameters