PINSFVSpeedFunctorMaterial

This is the material class used to compute the interstitial velocity norm for the incompressible and weakly compressible primitive superficial finite-volume implementation of porous media equations.

This class defines the interstitial speed and interstitial velocity functors that are often used in pressure drop and heat transfer correlations.

Input Parameters

  • porosityporosity. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:porosity. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

Required Parameters

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

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

    Controllable:No

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

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

  • define_interstitial_velocity_componentsTrueWhether to define the interstitial velocity functors

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to define the interstitial velocity functors

  • 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

    Options:XFEM_MARK, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, 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.

  • speedspeedThe name to give the declared 'speed' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:speed

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name to give the declared 'speed' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • superficial_vel_x0The x component of the fluid superficial velocity variable. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:0

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The x component of the fluid superficial velocity variable. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • superficial_vel_y0The y component of the fluid superficial velocity variable. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:0

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The y component of the fluid superficial velocity variable. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • superficial_vel_z0The z component of the fluid superficial velocity variable. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:0

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The z component of the fluid superficial velocity variable. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • vel_xvel_xThe name to give the declared 'vel_x' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:vel_x

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name to give the declared 'vel_x' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • vel_yvel_yThe name to give the declared 'vel_y' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:vel_y

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name to give the declared 'vel_y' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • vel_zvel_zThe name to give the declared 'vel_z' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:vel_z

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name to give the declared 'vel_z' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • velocityvelocityThe name to give the declared 'velocity' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    Default:velocity

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name to give the declared 'velocity' functor property. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

Optional Parameters

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

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

    Default:True

    C++ Type:bool

    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

    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>

    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>

    Controllable:No

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

Outputs Parameters