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.

The flag use_displaced_mesh = false is set internally by this Postprocessor, and the parameter cannot be altered by the user, even for simulations with solid-mechanical deformation. The reason is that this postprocessor uses the strain calculated by TensorMechanics to automatically compensate for deformed meshes. Further information may be found here. Therefore:

  • For mechanically-coupled simulations, you must provide a base_name that is identical to that used by the TensorMechanics strain calculator, so that this Postprocessor can retrieve the correct strain. The most common use-case is that you provide no base_name to the TensorMechanics strain calculator and hence no base_name to this Postprocessor.

  • For non-mechanically-coupled simulations, you must not provde a base_name that is used in any TensorMechanics strain calculators. The most common use-case is that you have no TensorMechanics strain calculators, so you needn't worry about providing any base_name to this postprocessor. However, there is a possibility that you have a TensorMechanics strain calculator but you don't want to couple mechanics to PorousFlow. In that case, supply base_name = non_existent, or similar, so that this Postprocessor doesn't retrieve any strain.

Input Parameters

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

    C++ Type:UserObjectName

    Controllable:No

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

Required Parameters

  • base_nameFor non-mechanically-coupled systems with no TensorMechanics strain calculators, base_name need not be set. For mechanically-coupled systems, base_name should be the same base_name as given to the TensorMechanics object that computes strain, so that this Postprocessor can correctly account for changes in mesh volume. For non-mechanically-coupled systems, base_name should not be the base_name of any TensorMechanics strain calculators.

    C++ Type:std::string

    Controllable:No

    Description:For non-mechanically-coupled systems with no TensorMechanics strain calculators, base_name need not be set. For mechanically-coupled systems, base_name should be the same base_name as given to the TensorMechanics object that computes strain, so that this Postprocessor can correctly account for changes in mesh volume. For non-mechanically-coupled systems, base_name should not be the base_name of any TensorMechanics strain calculators.

  • 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

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

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, TRANSFER, ALWAYS

    Controllable:No

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

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

    Default:0

    C++ Type:unsigned int

    Controllable:No

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

  • 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

    Controllable:No

    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

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

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

    Controllable:No

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

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

  • 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

    Controllable:No

    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

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.

  • 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

  • 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

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

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

    Controllable:No

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

  • 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

Input Files