PorousFlowRecoveryRateSeason

Calculate the seasonal thermal recovery rate (percent) for a doublet system, using explicit injection/production indicator postprocessors to decide which accumulator each timestep contributes to

Description

PorousFlowRecoveryRateSeason computes the seasonal thermal recovery rate (as a percentage) of a doublet system, analogous to PorousFlowRecoveryRate but gated by explicit season indicator postprocessors rather than the sign of the hot-well energy. On every timestep, the sum of the hotwellenergy and coldwellenergy postprocessors is added to an injection accumulator if InjectionIndicator is greater than 0.5, or to a production accumulator if ProductionIndicator is greater than 0.5 (checked only when InjectionIndicator is not). The indicators are compared against 0.5 rather than tested for exact equality with 1 so that a smoothed or transfer-round-tripped indicator still registers. The reported value is 0 until energy has been accumulated on the injection side, and thereafter abs(production)/abs(injection)*100 – the guard is on the denominator.

Example Input Syntax

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [hot]
    type = FunctionValuePostprocessor<<<{"description": "Computes the value of a supplied function at a single point (scalable)", "href": "FunctionValuePostprocessor.html"}>>>
    function<<<{"description": "The function which supplies the postprocessor value."}>>> = hot_fn
  []
  [cold]
    type = FunctionValuePostprocessor<<<{"description": "Computes the value of a supplied function at a single point (scalable)", "href": "FunctionValuePostprocessor.html"}>>>
    function<<<{"description": "The function which supplies the postprocessor value."}>>> = cold_fn
  []
  [inj_indicator]
    type = FunctionValuePostprocessor<<<{"description": "Computes the value of a supplied function at a single point (scalable)", "href": "FunctionValuePostprocessor.html"}>>>
    function<<<{"description": "The function which supplies the postprocessor value."}>>> = inj_fn
  []
  [pro_indicator]
    type = FunctionValuePostprocessor<<<{"description": "Computes the value of a supplied function at a single point (scalable)", "href": "FunctionValuePostprocessor.html"}>>>
    function<<<{"description": "The function which supplies the postprocessor value."}>>> = pro_fn
  []
  [computed]
    type = PorousFlowRecoveryRateSeason<<<{"description": "Calculate the seasonal thermal recovery rate (percent) for a doublet system, using explicit injection/production indicator postprocessors to decide which accumulator each timestep contributes to", "href": "PorousFlowRecoveryRateSeason.html"}>>>
    hotwellenergy<<<{"description": "The name of the enthalpy postprocessor at hot well"}>>> = hot
    coldwellenergy<<<{"description": "The name of the enthalpy postprocessor at cold well"}>>> = cold
    InjectionIndicator<<<{"description": "The name of the postprocessor for injection indication"}>>> = inj_indicator
    ProductionIndicator<<<{"description": "The name of the postprocessor for production indication"}>>> = pro_indicator
  []
  [exact]
    type = FunctionValuePostprocessor<<<{"description": "Computes the value of a supplied function at a single point (scalable)", "href": "FunctionValuePostprocessor.html"}>>>
    function<<<{"description": "The function which supplies the postprocessor value."}>>> = exact_fn
  []
  [residual]
    type = ParsedPostprocessor<<<{"description": "Computes a parsed expression with post-processors", "href": "ParsedPostprocessor.html"}>>>
    pp_names<<<{"description": "Post-processors arguments"}>>> = 'computed exact'
    expression<<<{"description": "function expression"}>>> = 'abs(computed - exact)'
  []
[]

Input Parameters

InjectionIndicatorThe name of the postprocessor for injection indication
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the postprocessor for injection indication
ProductionIndicatorThe name of the postprocessor for production indication
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the postprocessor for production indication
coldwellenergyThe name of the enthalpy postprocessor at cold well
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the enthalpy postprocessor at cold well
hotwellenergyThe name of the enthalpy postprocessor at hot well
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the enthalpy postprocessor at hot well

Required 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, 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, MULTISYSTEM_FIXED_POINT_ITERATION_END, 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.
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
use_displaced_meshFalseWhether 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:False
C++ Type:bool
Controllable:No
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.

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

(test/tests/postprocessors/porous_flow_recovery_rate_season/inp.i)
(examples/rtes_stochastic/base_cycle_50.i)

(test/tests/postprocessors/porous_flow_recovery_rate_season/inp.i)

# Analytic verification of PorousFlowRecoveryRateSeason.
#
# PorousFlowRecoveryRateSeason::execute() does:
#   if (InjectionIndicator > 0.5)
#     accumulator_inj += (hotwellenergy + coldwellenergy)
#   else if (ProductionIndicator > 0.5)
#     accumulator_ext += (hotwellenergy + coldwellenergy)
# and getValue() returns 0 if accumulator_inj == 0, else abs(ext)/abs(inj)*100.
# (the indicators are thresholded at 0.5, not compared for exact equality with 1, and the
# guard is on the denominator.)
#
# Drive hotwellenergy = 2, coldwellenergy = 1 (sum = 3, constant), dt = 1, num_steps = 6,
# InjectionIndicator(t) = 1 for t<=3 (else 0), ProductionIndicator(t) = 1 for t>3 (else 0):
#
#   t=1,2,3: injection season -> inj += 3 each step -> inj = 3,6,9 ; ext stays 0 -> rate=0
#   t=4:     production season -> ext += 3          -> ext = 3  ; inj = 9 (fixed) -> rate = 3/9*100
#   t=5:     production season -> ext += 3          -> ext = 6  ; rate = 6/9*100
#   t=6:     production season -> ext += 3          -> ext = 9  ; rate = 9/9*100
#
# so exact(t) = if(t<=3, 0, (100/3)*(t-3)).

[Mesh/mesh]
  type = GeneratedMeshGenerator
  dim = 1
[]

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [hot_fn]
    type = ParsedFunction
    expression = '2'
  []
  [cold_fn]
    type = ParsedFunction
    expression = '1'
  []
  [inj_fn]
    type = ParsedFunction
    expression = 'if(t <= 3, 1, 0)'
  []
  [pro_fn]
    type = ParsedFunction
    expression = 'if(t <= 3, 0, 1)'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t <= 3, 0, (100/3)*(t - 3))'
  []
[]

[Postprocessors]
  [hot]
    type = FunctionValuePostprocessor
    function = hot_fn
  []
  [cold]
    type = FunctionValuePostprocessor
    function = cold_fn
  []
  [inj_indicator]
    type = FunctionValuePostprocessor
    function = inj_fn
  []
  [pro_indicator]
    type = FunctionValuePostprocessor
    function = pro_fn
  []
  [computed]
    type = PorousFlowRecoveryRateSeason
    hotwellenergy = hot
    coldwellenergy = cold
    InjectionIndicator = inj_indicator
    ProductionIndicator = pro_indicator
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'computed exact'
    expression = 'abs(computed - exact)'
  []
[]

[Executioner]
  type = Transient
  dt = 1
  num_steps = 6
[]

[Outputs]
  csv = true
[]