NSFVPumpFunctorMaterial

Computes the effective pump body force.

This is a functor material to set up the effective volume force of a pump. For a forward operating pump, the volume force model reads as follows:

fV=ρgh(Q)ArVr, f_V = \frac{\rho |\vec{g}| h(Q) A_r}{V_r} ,

where:

  • ρ\rho is the fluid density

  • g|\vec{g}| is the norm of the gravity vector

  • ArA_r is the rated area of the pump (typically taken as the area of the upstream volume leading to the pump)

  • VrV_r is the rated volume of the pump (we recommend taking this one as the area of the block leading to the pump)

  • h(Q)h(Q) is the pressure head of the pump in units of {\it length} as a function of the flow rate with units of {\it volume / time}

The scaling of the pressure head of the pump is performed via the non-dimensional rotation speed of the pump defined as follows:

ωs=ωQ12(gh)34, \omega_s = \frac{\omega Q^{\frac{1}{2}}}{\left( g h \right)^{\frac{3}{4}}} ,

For scaling purposes, the user can provide the following parameters:

  • Rated and actual flow rate at the pump. The actual flow rate at the pump must be provided via a post-processor

  • Rated and actual rotation speed of the pump. The actual rotation speed of the pump is a controllable parameter

To allow the pump to operate in reverse flow conditions, the user must set enable_negative_rotation = true. The scaling of the model in the negative rotation condition is the same as the positive one. However, for negative rotation, the user can provide the homologous pressure head curve via the pressure_head_function_negative_rotation function. If the pressure head function for the positive direction should be used for negative rotation, the user should set symmetric_negative_pressure_head = true.

Input Parameters

  • rhoDensity. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Density. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • speedFlow speed. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Flow speed. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

Required Parameters

  • area_rated1Rated area of the pump. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    Default:1

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated area of the pump. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • blockThe list of blocks (ids or names) that this object will be applied

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.

  • enable_negative_rotationFalseFlag to allow negative rotation speeds.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Flag to allow negative rotation speeds.

  • execute_onALWAYSThe 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:ALWAYS

    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, ALWAYS

    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.

  • flow_rate1Flow rate.

    Default:1

    C++ Type:PostprocessorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Flow rate.

  • flow_rate_rated1Rated flow rate.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated flow rate.

  • gravity0 -9.81 0The gravitational acceleration vector.

    Default:0 -9.81 0

    C++ Type:libMesh::VectorValue<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The gravitational acceleration vector.

  • pressure_head_functionPressure Head Function.

    C++ Type:FunctionName

    Unit:(no unit assumed)

    Controllable:No

    Description:Pressure Head Function.

  • pressure_head_function_negative_rotationPressure head function for negative rotation.

    C++ Type:FunctionName

    Unit:(no unit assumed)

    Controllable:No

    Description:Pressure head function for negative rotation.

  • 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.

  • pump_force_namepump_volume_forceName of the pump force functor. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    Default:pump_volume_force

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of the pump force functor. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • rotation_speed1The rotation speed of the pump.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:Yes

    Description:The rotation speed of the pump.

  • rotation_speed_rated1The rated rotation speed of the pump.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The rated rotation speed of the pump.

  • symmetric_negative_pressure_headTrueFlag to use the pressure head function in the negative direction than the one in the positive direction.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Flag to use the pressure head function in the negative direction than the one in the positive direction.

  • 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.

  • volume_rated1Rated volume of the pump. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    Default:1

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Rated volume of the pump. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

Optional Parameters

  • 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.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The seed for the master random number generator

Advanced Parameters

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

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

    Unit:(no unit assumed)

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters