PorousFlowHeatEnergy

Calculates the sum of heat energy of fluid phase(s) and/or the porous skeleton in a region

This Postprocessor calculates the heat energy of fluid phase(s) using where all variables are defined in nomenclature.

The phases that the heat energy is summed over can be entered in the phase input parameter. Multiple indices can be entered.

By default, the additional heat energy due to the porous material is added to the heat energy of the fluid phase(s). This contribution can be ignored by setting include_porous_skeleton = false.

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 SolidMechanics 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 SolidMechanics 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 SolidMechanics strain calculator and hence no base_name to this Postprocessor.

  • For non-mechanically-coupled simulations, you must not provide a base_name that is used in any SolidMechanics strain calculators. The most common use-case is that you have no SolidMechanics strain calculators, so you needn't worry about providing any base_name to this postprocessor. However, there is a possibility that you have a SolidMechanics 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

  • include_porous_skeletonTrueInclude the heat energy of the porous skeleton

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Include the heat energy of the porous skeleton

  • kernel_variable_number0The PorousFlow variable number (according to the dictatory) of the heat-energy 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 dictatory) of the heat-energy 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(es) 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(es) of the fluid phase that this Postprocessor is restricted to. Multiple indices 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).

  • 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

    Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, 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, TRANSFER

    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.

  • 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

    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

    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

Execution Scheduling 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

  • outputsVector of output names where 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 where 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

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

  • 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

    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.

Material Property Retrieval Parameters

Input Files