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:

Re+=(Thydraulic+Tdissipation)ωR_e += (T_{hydraulic} + T_{dissipation}) \omega

where ThydraulicT_{hydraulic} is the friction torque, and ω\omega is the rotation speed of the pump.

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

R=ρAAgHArefdout\vec{R} = \dfrac{\rho A}{A} \vec{g} H A_{ref} \vec{d}_{out}

where ρA\rho A is the conserved density, AA the local flow area, ArefA_{ref} is the reference flow area, g\vec{g} is the gravity vector, HH the pump head, and dout\vec{d}_{out} the outlet direction.

The pump head is computed as:

Hpump=((ωωrated)2+(ρuAAρAQrated)2)HfunctionHratedH_{pump} = ( (\dfrac{\omega}{\omega_{rated}})^2 + (\dfrac{\dfrac{\rho u A A}{\rho A}}{Q_{rated}})^2 ) H_{function} H_{rated}

where ωrated\omega_{rated} is the rated rotation speed of the pump, ρ\rho the fluid density, uu the fluid velocity, AA the local area, QratedQ_{rated} is the rated flow rate, HfunctionH_{function} an adimensional pump head function and HratedH_{rated} is the rated head of the pump.

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

  • hydraulic torque

  • friction torque

  • pump head

commentnote

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>

    Unit:(no unit assumed)

    Controllable:No

    Description:Cross-sectional area of connected flow channels

  • A_refReference area [m^2]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Reference area [m^2]

  • KForm loss coefficient [-]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Form loss coefficient [-]

  • boundaryThe list of boundary IDs from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated pump fluid density [kg/m^3]

  • di_outDirection of connected outlet

    C++ Type:libMesh::Point

    Unit:(no unit assumed)

    Controllable:No

    Description:Direction of connected outlet

  • fpFluid properties user object name

    C++ Type:UserObjectName

    Unit:(no unit assumed)

    Controllable:No

    Description:Fluid properties user object name

  • gravity_magnitudeGravity constant, [m/s^2]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Gravity constant, [m/s^2]

  • headFunction to compute data for pump head [-]

    C++ Type:FunctionName

    Unit:(no unit assumed)

    Controllable:No

    Description:Function to compute data for pump head [-]

  • head_ratedRated pump head [m]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated pump head [m]

  • inertia_coeffPump inertia coefficients [kg-m^2]

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Pump inertia coefficients [kg-m^2]

  • inertia_constPump inertia constant [kg-m^2]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Pump inertia constant [kg-m^2]

  • normalsFlow channel outward normals or junction inward normals

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    Controllable:No

    Description:Shaft rotational speed [rad/s]

  • omega_ratedRated pump speed [rad/s]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated pump speed [rad/s]

  • pump_nameName of the instance of this pump component

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of the instance of this pump component

  • rhoArho*A of the connected flow channels

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rho*A of the connected flow channels

  • rhoEArhoE*A of the connected flow channels

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rhoE*A of the connected flow channels

  • rhoEVrho*E*V of the junction

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rho*E*V of the junction

  • rhoVrho*V of the junction

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rho*V of the junction

  • rhouArhou*A of the connected flow channels

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rhou*A of the connected flow channels

  • rhouVrho*u*V of the junction

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rho*u*V of the junction

  • rhovVrho*v*V of the junction

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rho*v*V of the junction

  • rhowVrho*w*V of the junction

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:rho*w*V of the junction

  • speed_cr_IPump speed threshold for inertia [-]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Pump speed threshold for inertia [-]

  • speed_cr_frPump speed threshold for friction [-]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Pump speed threshold for friction [-]

  • tau_fr_coeffFriction coefficients [N-m]

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Friction coefficients [N-m]

  • tau_fr_constPump friction constant [N-m]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Pump friction constant [N-m]

  • torque_hydraulicFunction to compute data for pump torque [-]

    C++ Type:FunctionName

    Unit:(no unit assumed)

    Controllable:No

    Description:Function to compute data for pump torque [-]

  • torque_ratedRated pump torque [N-m]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated pump torque [N-m]

  • volumeVolume of the junction

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Volume of the junction

  • volumetric_ratedRated pump volumetric flow rate [m^3/s]

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated pump volumetric flow rate [m^3/s]

Required Parameters

  • apply_velocity_scalingFalseSet to true to apply the scaling to the normal velocity. See documentation for more information.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set to true to apply the scaling to the normal velocity. See documentation for more information.

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, 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. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • inletPump inlet

    C++ Type:BoundaryName

    Unit:(no unit assumed)

    Controllable:No

    Description:Pump inlet

  • junction_subdomain_id65535Junction subdomain ID (required if 'use_scalar_variables' is 'false')

    Default:65535

    C++ Type:unsigned short

    Unit:(no unit assumed)

    Controllable:No

    Description:Junction subdomain ID (required if 'use_scalar_variables' is 'false')

  • outletPump outlet

    C++ Type:BoundaryName

    Unit:(no unit assumed)

    Controllable:No

    Description:Pump outlet

  • processor_idsProcessor IDs owning each connected flow channel element

    C++ Type:std::vector<unsigned int>

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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.

  • use_scalar_variablesTrueTrue if the junction variables are scalar variables

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:True if the junction variables are scalar variables

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

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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