# PorousFlowFluidMass

Calculates the mass of a fluid component in a region

This Postprocessor calculates the mass of a fluid component using where all variables are defined in nomenclature.

The fluid component is specified in the input parameter fluid_component. By default, the mass of fluid component is summed over all fluid phases. The sum can be restricted to only a subset of fluid phases by entering the phase indexes in the phase input parameter.

This Postprocessor also provides the option to only calculate fluid mass below a certain saturation, which can be invoked using the saturation_threshold parameter.

note

The flag use_displaced_mesh = true must be used in simulations experiencing solid-mechanical deformation.

## Input Parameters

• PorousFlowDictatorThe UserObject that holds the list of PorousFlow variable names.

C++ Type:UserObjectName

Options:

Description:The UserObject that holds the list of PorousFlow variable names.

### Required Parameters

• saturation_threshold1The saturation threshold below which the mass is calculated for a specific phase. Default is 1.0. Note: only one phase_index can be entered

Default:1

C++ Type:double

Options:

Description:The saturation threshold below which the mass is calculated for a specific phase. Default is 1.0. Note: only one phase_index can be entered

• fluid_component0The index corresponding to the fluid component that this Postprocessor acts on

Default:0

C++ Type:unsigned int

Options:

Description:The index corresponding to the fluid component that this Postprocessor acts on

• phaseThe index of the fluid phase that this Postprocessor is restricted to. Multiple indices can be entered

C++ Type:std::vector

Options:

Description:The index of the fluid phase that this Postprocessor is restricted to. Multiple indices can be entered

• execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

Default:TIMESTEP_END

C++ Type:ExecFlagEnum

Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

• kernel_variable_number0The PorousFlow variable number (according to the dictator) of the fluid-mass kernel. This is required only in the unusual situation where a variety of different finite-element interpolation schemes are employed in the simulation

Default:0

C++ Type:unsigned int

Options:

Description:The PorousFlow variable number (according to the dictator) of the fluid-mass kernel. This is required only in the unusual situation where a variety of different finite-element interpolation schemes are employed in the simulation

• blockThe list of block ids (SubdomainID) that this object will be applied

C++ Type:std::vector

Options:

Description:The list of block ids (SubdomainID) that this object will be applied

### Optional Parameters

• enableTrueSet the enabled status of the MooseObject.

Default:True

C++ Type:bool

Options:

Description:Set the enabled status of the MooseObject.

• use_displaced_meshTrueWhether 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:True

C++ Type:bool

Options:

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.

• outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

C++ Type:std::vector

Options:

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

• control_tagsAdds user-defined labels for accessing object parameters via control logic.

C++ Type:std::vector

Options:

Description:Adds user-defined labels for accessing object parameters via control logic.

• 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

Options:

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

• seed0The seed for the master random number generator

Default:0

C++ Type:unsigned int

Options:

Description:The seed for the master random number generator

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

Default:True

C++ Type:bool

Options:

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