PorousFlowTemperatureDropTerminator

Returns 1 once the produced fluid temperature drops by a set percentage or a maximum time is reached

Description

PorousFlowTemperatureDropTerminator reports a 0/1 indicator of whether a produced fluid's temperature has dropped by a set percentage of the way from the reservoir's initial temperature towards the injection temperature. The produced temperature is reconstructed from a specific enthalpy postprocessor (enthalpypostprocessor, in J) and a mass postprocessor (masspostprocessor, in kg) as T_prod = enthalpypostprocessor/masspostprocessor/fluid_specific_heat + T_enthalpy_ref (fluid_specific_heat defaults to 4186 J/(kg K), an approximate specific heat of water, and T_enthalpy_ref defaults to 273.15 K, i.e. the 0 degrees C enthalpy datum; both are exposed as parameters so a different fluid's approximate specific heat and enthalpy reference can be used). T_inj and T_init are required parameters (there is no sensible default), and masspostprocessor reporting 0 (e.g. before any production has occurred) reports the indicator as 0 rather than dividing by zero. The reported value is 1 once


(T_prod - T_init)/(T_inj - T_init) < P_drop/100

and also 1, unconditionally, once the current simulation time (timepostprocessor) reaches max_time, regardless of the temperature drop; this second condition guarantees the terminator eventually fires even if the reservoir is far from equilibrating with the injection temperature. Otherwise the reported value is 0.

This postprocessor only reports the indicator; it does not stop the simulation by itself. To actually terminate the run once the temperature drop criterion is met, pair it with a Terminator [UserObjects] block whose expression tests this postprocessor's value, as shown in the example below.

Example Input Syntax

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [cur_time]
    type = TimePostprocessor<<<{"description": "Reports the current time", "href": "TimePostprocessor.html"}>>>
  []
  [enthalpy]
    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."}>>> = enthalpy_fn
  []
  [mass]
    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."}>>> = mass_fn
  []
  [computed]
    type = PorousFlowTemperatureDropTerminator<<<{"description": "Returns 1 once the produced fluid temperature drops by a set percentage or a maximum time is reached", "href": "PorousFlowTemperatureDropTerminator.html"}>>>
    enthalpypostprocessor<<<{"description": "The name of the enthalpy postprocessor"}>>> = enthalpy
    masspostprocessor<<<{"description": "The name of the mass postprocessor"}>>> = mass
    timepostprocessor<<<{"description": "The name of the timepostprocessor"}>>> = cur_time
    T_inj<<<{"description": "Injection fluid temperature"}>>> = 100
    T_init<<<{"description": "Reservoir initial temperature"}>>> = 0
    P_drop<<<{"description": "Percent drop"}>>> = 50
    max_time<<<{"description": "The maximum simulation time (s) after which the terminator fires regardless of temperature drop (Default is 315360000, i.e. 10 years)"}>>> = 1e6
    fluid_specific_heat<<<{"description": "Fluid specific heat (J/kg/K), used to convert the enthalpy/mass postprocessor ratio into a temperature (Default is 4186, i.e. water)"}>>> = 4000
  []
  [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)'
  []
[]

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [terminate]
    type = Terminator<<<{"description": "Requests termination of the current solve based on the evaluation of a parsed logical expression of the Postprocessor value(s).", "href": "../userobjects/Terminator.html"}>>>
    expression<<<{"description": "FParser expression to process Postprocessor values into a boolean value. Termination of the simulation occurs when this returns true."}>>> = 'computed >= 1'
  []
[]

Input Parameters

T_initReservoir initial temperature
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Reservoir initial temperature
T_injInjection fluid temperature
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Injection fluid temperature
enthalpypostprocessorThe name of the enthalpy postprocessor
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the enthalpy postprocessor
masspostprocessorThe name of the mass postprocessor
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the mass postprocessor
timepostprocessorThe name of the timepostprocessor
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the timepostprocessor

Required Parameters

P_drop0.01Percent drop
Default:0.01
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Percent drop
T_enthalpy_ref273.15Enthalpy-datum reference temperature (K) used to convert the enthalpy/mass postprocessor ratio into a temperature (Default is 273.15, i.e. 0 degrees C)
Default:273.15
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Enthalpy-datum reference temperature (K) used to convert the enthalpy/mass postprocessor ratio into a temperature (Default is 273.15, i.e. 0 degrees C)
fluid_specific_heat4186Fluid specific heat (J/kg/K), used to convert the enthalpy/mass postprocessor ratio into a temperature (Default is 4186, i.e. water)
Default:4186
C++ Type:Real
Unit:(no unit assumed)
Range:fluid_specific_heat > 0
Controllable:No
Description:Fluid specific heat (J/kg/K), used to convert the enthalpy/mass postprocessor ratio into a temperature (Default is 4186, i.e. water)
max_time3.1536e+08The maximum simulation time (s) after which the terminator fires regardless of temperature drop (Default is 315360000, i.e. 10 years)
Default:3.1536e+08
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:The maximum simulation time (s) after which the terminator fires regardless of temperature drop (Default is 315360000, i.e. 10 years)

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, 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_temperature_drop_terminator/inp.i)
(examples/rtes_stochastic/base_cycle_50.i)

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

# Analytic verification of PorousFlowTemperatureDropTerminator, paired with a [UserObjects]
# Terminator to demonstrate that it can actually stop a run.
#
# PorousFlowTemperatureDropTerminator::getValue() returns:
#   1 if timepostprocessor >= max_time
#   0 if masspostprocessor == 0 or T_inj == T_init (division guard)
#   1 if ((enthalpypostprocessor/masspostprocessor/fluid_specific_heat + T_enthalpy_ref - T_init)
#            / (T_inj - T_init)) < P_drop/100
#   0 otherwise
#
# i.e. writing T_prod = enthalpypostprocessor/masspostprocessor/fluid_specific_heat +
# T_enthalpy_ref (a produced-fluid temperature reconstructed from specific enthalpy) and
# ratio = (T_prod-T_init)/(T_inj-T_init), the postprocessor fires once ratio drops below
# P_drop/100. fluid_specific_heat is deliberately set to 4000 here (not the class default of
# 4186) so the test cannot pass merely because the analytic verification and the implementation
# happen to share the same hard-coded constant.
#
# Drive masspostprocessor = 1 (constant, except at t=0 -- see below), T_init = 0, T_inj = 100,
# P_drop = 50 (so the threshold is 0.5), max_time huge (so the max_time branch never fires here,
# isolating the ratio-threshold branch), and choose the enthalpy function so that
#   T_prod(t) = 100 - 10*t   =>   ratio(t) = T_prod(t)/100 = 1 - 0.1*t
# i.e. enthalpypostprocessor(t) = masspostprocessor * 4000 * (T_prod(t) - 273.15)
#                                = 4000*(100 - 10*t - 273.15), with dt = 1, num_steps = 10:
#
#   t=0:    masspostprocessor's own execute_on default excludes 'initial', so both the mass and
#           enthalpy postprocessors report their zero-initialized value here -- this exercises
#           the masspostprocessor == 0 division guard directly (division by the true, unguarded
#           0/0 would be NaN, and NaN compares false against P_drop/100, which would have
#           masked this guard by accident) -> 0
#   t=1..5: ratio = 1-0.1t >= 0.5   -> 0
#   t=5:    ratio = 1-0.5 = 0.5, NOT < 0.5 (strict inequality)                -> 0
#   t=6:    ratio = 1-0.6 = 0.4 < 0.5                                        -> 1  (first fire)
#   t=7..10: ratio keeps decreasing, still < 0.5                            -> 1
#
# so exact(t) = if(t < 6, 0, 1).
#
# A [UserObjects] Terminator is paired on 'computed >= 1' with num_steps = 10, well past the
# t=6 flip, so the run hard-stops right after the flip and the gold CSV has only 6 data rows
# (plus the initial row) instead of 10.

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [enthalpy_fn]
    type = ParsedFunction
    expression = '4000*(100 - 10*t - 273.15)'
  []
  [mass_fn]
    type = ParsedFunction
    expression = '1'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t < 6, 0, 1)'
  []
[]

[Postprocessors]
  [cur_time]
    type = TimePostprocessor
  []
  [enthalpy]
    type = FunctionValuePostprocessor
    function = enthalpy_fn
  []
  [mass]
    type = FunctionValuePostprocessor
    function = mass_fn
  []
  [computed]
    type = PorousFlowTemperatureDropTerminator
    enthalpypostprocessor = enthalpy
    masspostprocessor = mass
    timepostprocessor = cur_time
    T_inj = 100
    T_init = 0
    P_drop = 50
    max_time = 1e6
    fluid_specific_heat = 4000
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'computed exact'
    expression = 'abs(computed - exact)'
  []
[]

[UserObjects]
  [terminate]
    type = Terminator
    expression = 'computed >= 1'
  []
[]

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

[Outputs]
  csv = true
[]

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

# Analytic verification of PorousFlowTemperatureDropTerminator, paired with a [UserObjects]
# Terminator to demonstrate that it can actually stop a run.
#
# PorousFlowTemperatureDropTerminator::getValue() returns:
#   1 if timepostprocessor >= max_time
#   0 if masspostprocessor == 0 or T_inj == T_init (division guard)
#   1 if ((enthalpypostprocessor/masspostprocessor/fluid_specific_heat + T_enthalpy_ref - T_init)
#            / (T_inj - T_init)) < P_drop/100
#   0 otherwise
#
# i.e. writing T_prod = enthalpypostprocessor/masspostprocessor/fluid_specific_heat +
# T_enthalpy_ref (a produced-fluid temperature reconstructed from specific enthalpy) and
# ratio = (T_prod-T_init)/(T_inj-T_init), the postprocessor fires once ratio drops below
# P_drop/100. fluid_specific_heat is deliberately set to 4000 here (not the class default of
# 4186) so the test cannot pass merely because the analytic verification and the implementation
# happen to share the same hard-coded constant.
#
# Drive masspostprocessor = 1 (constant, except at t=0 -- see below), T_init = 0, T_inj = 100,
# P_drop = 50 (so the threshold is 0.5), max_time huge (so the max_time branch never fires here,
# isolating the ratio-threshold branch), and choose the enthalpy function so that
#   T_prod(t) = 100 - 10*t   =>   ratio(t) = T_prod(t)/100 = 1 - 0.1*t
# i.e. enthalpypostprocessor(t) = masspostprocessor * 4000 * (T_prod(t) - 273.15)
#                                = 4000*(100 - 10*t - 273.15), with dt = 1, num_steps = 10:
#
#   t=0:    masspostprocessor's own execute_on default excludes 'initial', so both the mass and
#           enthalpy postprocessors report their zero-initialized value here -- this exercises
#           the masspostprocessor == 0 division guard directly (division by the true, unguarded
#           0/0 would be NaN, and NaN compares false against P_drop/100, which would have
#           masked this guard by accident) -> 0
#   t=1..5: ratio = 1-0.1t >= 0.5   -> 0
#   t=5:    ratio = 1-0.5 = 0.5, NOT < 0.5 (strict inequality)                -> 0
#   t=6:    ratio = 1-0.6 = 0.4 < 0.5                                        -> 1  (first fire)
#   t=7..10: ratio keeps decreasing, still < 0.5                            -> 1
#
# so exact(t) = if(t < 6, 0, 1).
#
# A [UserObjects] Terminator is paired on 'computed >= 1' with num_steps = 10, well past the
# t=6 flip, so the run hard-stops right after the flip and the gold CSV has only 6 data rows
# (plus the initial row) instead of 10.

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [enthalpy_fn]
    type = ParsedFunction
    expression = '4000*(100 - 10*t - 273.15)'
  []
  [mass_fn]
    type = ParsedFunction
    expression = '1'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t < 6, 0, 1)'
  []
[]

[Postprocessors]
  [cur_time]
    type = TimePostprocessor
  []
  [enthalpy]
    type = FunctionValuePostprocessor
    function = enthalpy_fn
  []
  [mass]
    type = FunctionValuePostprocessor
    function = mass_fn
  []
  [computed]
    type = PorousFlowTemperatureDropTerminator
    enthalpypostprocessor = enthalpy
    masspostprocessor = mass
    timepostprocessor = cur_time
    T_inj = 100
    T_init = 0
    P_drop = 50
    max_time = 1e6
    fluid_specific_heat = 4000
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'computed exact'
    expression = 'abs(computed - exact)'
  []
[]

[UserObjects]
  [terminate]
    type = Terminator
    expression = 'computed >= 1'
  []
[]

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

[Outputs]
  csv = true
[]

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

# Analytic verification of PorousFlowTemperatureDropTerminator, paired with a [UserObjects]
# Terminator to demonstrate that it can actually stop a run.
#
# PorousFlowTemperatureDropTerminator::getValue() returns:
#   1 if timepostprocessor >= max_time
#   0 if masspostprocessor == 0 or T_inj == T_init (division guard)
#   1 if ((enthalpypostprocessor/masspostprocessor/fluid_specific_heat + T_enthalpy_ref - T_init)
#            / (T_inj - T_init)) < P_drop/100
#   0 otherwise
#
# i.e. writing T_prod = enthalpypostprocessor/masspostprocessor/fluid_specific_heat +
# T_enthalpy_ref (a produced-fluid temperature reconstructed from specific enthalpy) and
# ratio = (T_prod-T_init)/(T_inj-T_init), the postprocessor fires once ratio drops below
# P_drop/100. fluid_specific_heat is deliberately set to 4000 here (not the class default of
# 4186) so the test cannot pass merely because the analytic verification and the implementation
# happen to share the same hard-coded constant.
#
# Drive masspostprocessor = 1 (constant, except at t=0 -- see below), T_init = 0, T_inj = 100,
# P_drop = 50 (so the threshold is 0.5), max_time huge (so the max_time branch never fires here,
# isolating the ratio-threshold branch), and choose the enthalpy function so that
#   T_prod(t) = 100 - 10*t   =>   ratio(t) = T_prod(t)/100 = 1 - 0.1*t
# i.e. enthalpypostprocessor(t) = masspostprocessor * 4000 * (T_prod(t) - 273.15)
#                                = 4000*(100 - 10*t - 273.15), with dt = 1, num_steps = 10:
#
#   t=0:    masspostprocessor's own execute_on default excludes 'initial', so both the mass and
#           enthalpy postprocessors report their zero-initialized value here -- this exercises
#           the masspostprocessor == 0 division guard directly (division by the true, unguarded
#           0/0 would be NaN, and NaN compares false against P_drop/100, which would have
#           masked this guard by accident) -> 0
#   t=1..5: ratio = 1-0.1t >= 0.5   -> 0
#   t=5:    ratio = 1-0.5 = 0.5, NOT < 0.5 (strict inequality)                -> 0
#   t=6:    ratio = 1-0.6 = 0.4 < 0.5                                        -> 1  (first fire)
#   t=7..10: ratio keeps decreasing, still < 0.5                            -> 1
#
# so exact(t) = if(t < 6, 0, 1).
#
# A [UserObjects] Terminator is paired on 'computed >= 1' with num_steps = 10, well past the
# t=6 flip, so the run hard-stops right after the flip and the gold CSV has only 6 data rows
# (plus the initial row) instead of 10.

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [enthalpy_fn]
    type = ParsedFunction
    expression = '4000*(100 - 10*t - 273.15)'
  []
  [mass_fn]
    type = ParsedFunction
    expression = '1'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t < 6, 0, 1)'
  []
[]

[Postprocessors]
  [cur_time]
    type = TimePostprocessor
  []
  [enthalpy]
    type = FunctionValuePostprocessor
    function = enthalpy_fn
  []
  [mass]
    type = FunctionValuePostprocessor
    function = mass_fn
  []
  [computed]
    type = PorousFlowTemperatureDropTerminator
    enthalpypostprocessor = enthalpy
    masspostprocessor = mass
    timepostprocessor = cur_time
    T_inj = 100
    T_init = 0
    P_drop = 50
    max_time = 1e6
    fluid_specific_heat = 4000
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'computed exact'
    expression = 'abs(computed - exact)'
  []
[]

[UserObjects]
  [terminate]
    type = Terminator
    expression = 'computed >= 1'
  []
[]

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

[Outputs]
  csv = true
[]

(examples/rtes_stochastic/base_cycle_50.i)

#---geothermal battery project - looking for sweet spot
#---Define two scalar variables to sweep consistently

depth =  2000
pp_ini_bc = ${fparse if(depth<=2000, 1000*9.8*depth, 1000*9.8*depth+(depth-2000)*9.8*1000)}
T_ini_bc  = ${fparse (80+3.28084*depth*1.1/100-32)*5/9 + 273.15}

distance_between_wells = 200
pro_well_x = ${fparse 0.1 + distance_between_wells / 2}
inj_well_x  = ${fparse 0.1 - distance_between_wells / 2}
well_length = 50  #fixed number in accordance with the mesh
aquifer_mid= ${fparse 0 + 0}
aquifer_top= ${fparse 0 + well_length/2}
aquifer_bot= ${fparse 0 - well_length/2}
#---Define a scalar variable to sweep
inj_ext_exponent = 1.5
inj_ext_flux= ${fparse 10^inj_ext_exponent / well_length / 2 }

injection_temp = 473.15

#---Define a scalar variable to replace the tensor components
Tcond_aquifer = 2.0
#---Define a scalar variable to replace the tensor components
perm_exponent = -12
perm_aquifer = ${fparse 10^perm_exponent}

[Controls]
  [summer_injection]
    type = ConditionalFunctionEnableControl
    conditional_function = inj_function_summer
    enable_objects  = 'DiracKernel::charge_injection_P DiracKernel::charge_injection_T DiracKernel::charge_production_P DiracKernel::charge_production_T'
  []
  [winter_injection]
    type = ConditionalFunctionEnableControl
    conditional_function = inj_function_winter
    enable_objects  = 'DiracKernel::recover_injection_P DiracKernel::recover_injection_T DiracKernel::recover_production_P DiracKernel::recover_production_T'
  []
  [rest_injection]
    type = ConditionalFunctionEnableControl
    conditional_function = rest_function
    enable_objects  = 'DiracKernel::rest_injection_P DiracKernel::rest_injection_T DiracKernel::rest_production_P DiracKernel::rest_production_T'
  []
[]

[Functions]
  [./inj_function_summer]
    type = ParsedFunction
    expression = '(t/24/3600/365.25-floor(t/24/3600/365.25))>0 & (t/24/3600/365.25-floor(t/24/3600/365.25))<=0.25'
  [../]
  [./inj_function_winter]
    type = ParsedFunction
    symbol_values = 'termination'
    symbol_names = 'b_switch'
    expression = '((t/24/3600/365.25-floor(t/24/3600/365.25))>0.5 & (t/24/3600/365.25-floor(t/24/3600/365.25)) <=0.75) & b_switch <= 0'
  [../]
  [./rest_function]
    type = ParsedFunction
    symbol_values = 'termination'
    symbol_names = 'b_switch'
    expression = '(((t/24/3600/365.25-floor(t/24/3600/365.25))>0.25 & (t/24/3600/365.25-floor(t/24/3600/365.25)) <=0.5) | ((t/24/3600/365.25-floor(t/24/3600/365.25))>0.75 & (t/24/3600/365.25-floor(t/24/3600/365.25)) <=1)) | (((t/24/3600/365.25-floor(t/24/3600/365.25))>0.5 & (t/24/3600/365.25-floor(t/24/3600/365.25)) <=0.75) & b_switch >=1)'
  [../]
  [./Fiss_Function]
    type = PiecewiseLinear
    x ='0.            7889400.      15778800.     23668200.
      31557600.     39447000.     47336400.     55225800.
      63115200.     71004600.     78894000.     86783400.
      94672800.     102562200.    110451600.    118341000.
      126230400.    134119800.    142009200.    149898600.
      157788000.    165677400.    173566800.    181456200.
      189345600.    197235000.    205124400.    213013800.
      220903200.    228792600.    236682000.    244571400.
      252460800.    260350200.    268239600.    276129000.
      284018400.    291907800.    299797200.    307686600.
      315576000.'
    y = '0 1  2  3  4
        1 2 3 4
        1 2 3 4
        1 2 3 4
        1 2 3 4
        1 2 3 4
        1 2 3 4
        1 2 3 4
        1 2 3 4
        1 2 3 4'
  [../]
[]

# Darcy flow with heat advection and conduction
[Mesh]
  # The original base_final_50.e had one or more element-block IDs that overflowed the
  # unsigned-short block-ID field the current libMesh ExodusII_IO reader uses
  # ("restrict_int failed: <id> does not fit in type t"). base_final_50_blockid_fix.e is that
  # same mesh with its element-block IDs renumbered to fit (geometry, coordinates, connectivity,
  # and block/nodeset/sideset NAMES -- which is what this input and its Materials blocks
  # reference by name, not by numeric ID -- are unchanged by a renumbering).
  #
  # The original base_final_50.e is not present in this repository (on this branch or on
  # devel), so the renumbering is not independently auditable from git history alone. The
  # renumbered file's own embedded NetCDF metadata is the audit trail instead: its `title`
  # global attribute reads
  #   cubit(s/jinw-mac/projects/falcon/Applied_Energy/base_final_50.e): 10/02/2020: 22
  # (i.e. it was produced by Cubit from a file of that name), and its current eb_prop1/eb_names
  # (`ncdump -v eb_prop1,eb_names base_final_50_blockid_fix.e`) are:
  #   caps_HEX8=1, caps_WEDGE=3, aquifer_HEX8=2, aquifer_WEDGE=4
  # all comfortably within the unsigned-short range, consistent with a renumbering rather than a
  # from-scratch remesh.
  [./fmg]
    type = FileMeshGenerator
    file = base_final_50_blockid_fix.e
  []
[]
#############################################################
[GlobalParams]
  PorousFlowDictator = dictator
[]
############################################################
[PorousFlowUnsaturated]
  relative_permeability_type = COREY
  relative_permeability_exponent = 0
  add_darcy_aux = true
  coupling_type = ThermoHydro
  gravity = '0 0 -9.8'
  porepressure = porepressure
  temperature = temperature
  fp = tabulated_water
  use_displaced_mesh = false
[]
###########################################################
[Variables]
  [./porepressure]
  [../]
  [./temperature]
    scaling = 1E-6
  [../]
[]
###########################################################
[AuxVariables]
  [./density]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]
##############################################################
[AuxKernels]
  [./density]
    type = MaterialRealAux
    variable = density
    property = PorousFlow_fluid_phase_density_qp0
    execute_on = TIMESTEP_END
  [../]
[]
############################################################
[UserObjects]
  [./fluid_mass_in_inc]
    type = PorousFlowSumQuantity
  [../]
  [./fluid_mass_out_inc]
    type = PorousFlowSumQuantity
  [../]
  [./heat_enthalpy_in_inc]
    type = PorousFlowSumQuantity
  [../]
  [./heat_enthalpy_out_inc]
    type = PorousFlowSumQuantity
  [../]
[]

############################################################
[ICs]
  [./init_pp]
    type = FunctionIC
    function = ${pp_ini_bc}
    variable = porepressure
  [../]
  [./init_temp]
    type = ConstantIC
    value = ${T_ini_bc}
    variable = temperature
  [../]
[]
###############################################################
[BCs]
  [./P_drained]
    type = DirichletBC
    variable = porepressure
    boundary = 'east west north'
    value = ${pp_ini_bc}
  [../]
  [./T_cont]
    type = DirichletBC
    variable = temperature
    boundary = 'east west north'
    value = ${T_ini_bc}
  [../]
[]

############################################################
[DiracKernels]
  [./charge_injection_P]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = porepressure
    SumQuantityUO = fluid_mass_in_inc
    line_base = '1 ${inj_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    p_or_t_vals = '-1e9 1e9'
    fluxes = '-${inj_ext_flux} -${inj_ext_flux}'  # ~5 kg/s over length of 10(injection_length)/2
  [../]
  [./charge_injection_T]
    type = EnthalpySink
    fluid_phase = 0
    variable = temperature
    SumQuantityUO = heat_enthalpy_in_inc
    line_base = '1 ${inj_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    pressure = porepressure
    T_in = ${injection_temp}
    fp = tabulated_water
    p_or_t_vals = '-1e9 1e9'
    fluxes = '-${inj_ext_flux} -${inj_ext_flux}'
  [../]
  [./charge_production_P]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = porepressure
    SumQuantityUO = fluid_mass_out_inc
    line_base = '1 ${pro_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    p_or_t_vals = '-1e9 1e9'
    fluxes = '${inj_ext_flux} ${inj_ext_flux}'
  [../]
  [./charge_production_T]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = temperature
    SumQuantityUO = heat_enthalpy_out_inc
    line_base = '1 ${pro_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    use_enthalpy = true
    p_or_t_vals = '-1e9 1e9'
    fluxes = '${inj_ext_flux} ${inj_ext_flux}'
  [../]

  [./recover_production_P]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = porepressure
    SumQuantityUO = fluid_mass_in_inc
    line_base = '1 ${inj_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    p_or_t_vals = '-1e9 1e9'
    fluxes = '${inj_ext_flux} ${inj_ext_flux}'  # ~5 kg/s over length of 10(injection_length)/2
  [../]
  [./recover_production_T]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = temperature
    SumQuantityUO = heat_enthalpy_in_inc
    line_base = '1 ${inj_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    use_enthalpy = true
    p_or_t_vals = '-1e9 1e9'
    fluxes = '${inj_ext_flux} ${inj_ext_flux}'
  [../]
  [./recover_injection_P]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = porepressure
    SumQuantityUO = fluid_mass_out_inc
    line_base = '1 ${pro_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    p_or_t_vals = '-1e9 1e9'
    fluxes = '-${inj_ext_flux} -${inj_ext_flux}'
  [../]
  [./recover_injection_T]
    type = EnthalpySink
    fluid_phase = 0
    variable = temperature
    SumQuantityUO = heat_enthalpy_out_inc
    line_base = '1 ${pro_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    pressure = porepressure
    T_in = ${T_ini_bc}
    fp = tabulated_water
    p_or_t_vals = '-1e9 1e9'
    fluxes = '-${inj_ext_flux} -${inj_ext_flux}'
  [../]

[./rest_production_P]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = porepressure
    SumQuantityUO = fluid_mass_in_inc
    line_base = '1 ${inj_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    p_or_t_vals = '-1e9 1e9'
    fluxes = '0 0'  # ~5 kg/s over length of 10(injection_length)/2
  [../]
  [./rest_production_T]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = temperature
    SumQuantityUO = heat_enthalpy_in_inc
    line_base = '1 ${inj_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    use_enthalpy = true
    p_or_t_vals = '-1e9 1e9'
    fluxes = '0 0'
  [../]
  [./rest_injection_P]
    type = PorousFlowPolyLineSink
    fluid_phase = 0
    variable = porepressure
    SumQuantityUO = fluid_mass_out_inc
    line_base = '1 ${pro_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    p_or_t_vals = '-1e9 1e9'
    fluxes = '0 0'
  [../]
  [./rest_injection_T]
    type = EnthalpySink
    fluid_phase = 0
    variable = temperature
    SumQuantityUO = heat_enthalpy_out_inc
    line_base = '1 ${pro_well_x} 0 ${aquifer_bot}'
    line_length = ${well_length}
    line_direction = '0 0 1'
    pressure = porepressure
    T_in = ${T_ini_bc}
    fp = tabulated_water
    p_or_t_vals = '-1e9 1e9'
    fluxes = '0 0'
  [../]




[]
############################################################
[FluidProperties]
  [./true_water]
    type = Water97FluidProperties
  [../]
  [./tabulated_water]
    type = TabulatedFluidProperties
    fp = true_water
    allow_fp_and_tabulation = true
    temperature_min = 275
    temperature_max = 600
    pressure_max = 1E8
    interpolated_properties = 'density viscosity enthalpy internal_energy'
    fluid_property_file = water97_tabulated.csv
  [../]
[]
############################################################
[Materials]
  [./internal_energy_aquifer]
    type = PorousFlowMatrixInternalEnergy
    specific_heat_capacity = 930.0
    density = 2650.0
    block = 'aquifer_HEX8 aquifer_WEDGE'
  [../]
  [./thermal_conductivity_aquifer]
    type = PorousFlowThermalConductivityIdeal
    dry_thermal_conductivity = '${Tcond_aquifer} 0 0  0 ${Tcond_aquifer} 0  0 0 ${Tcond_aquifer}'
    block = 'aquifer_HEX8 aquifer_WEDGE'
  [../]
  [./porosity_aquifer]
    type = PorousFlowPorosityConst
    block = 'aquifer_HEX8 aquifer_WEDGE'
    porosity = 0.01
  [../]
  [./permeability_aquifer]
    type = PorousFlowPermeabilityConst
    block = 'aquifer_HEX8 aquifer_WEDGE'
    permeability = '${perm_aquifer} 0 0   0 ${perm_aquifer} 0   0 0 ${perm_aquifer}'
  [../]
  [./internal_energy_caps]
    type = PorousFlowMatrixInternalEnergy
    specific_heat_capacity = 1000.0
    density = 2500.0
    block = 'caps_HEX8 caps_WEDGE'
  [../]
  [./thermal_conductivity_caps]
    type = PorousFlowThermalConductivityIdeal
    dry_thermal_conductivity = '2.5 0 0  0 2.5 0  0 0 2.5'
    block = 'caps_HEX8 caps_WEDGE'
  [../]
  [./porosity_caps]
    type = PorousFlowPorosityConst
    block = 'caps_HEX8 caps_WEDGE'
    porosity = 0.01
  [../]
  [./permeability_caps]
    type = PorousFlowPermeabilityConst
    block = 'caps_HEX8 caps_WEDGE'
    permeability = '1E-18 0 0   0 1E-18 0   0 0 1E-18'
  [../]
[]
############################################################
[Preconditioning]
active = 'ilu_may_use_less_mem'
#active = 'superlu'

[./ilu_may_use_less_mem]
type = SMP
full = true
petsc_options = '-ksp_diagonal_scale -ksp_diagonal_scale_fix'
petsc_options_iname = '-ksp_type -pc_type -sub_pc_type -sub_pc_factor_shift_type -sub_pc_factor_levels'
petsc_options_value = 'gmres asm ilu NONZERO 2'
[../]

[./original]
type = SMP
full = true
petsc_options = '-ksp_diagonal_scale -ksp_diagonal_scale_fix'
petsc_options_iname = '-ksp_type -pc_type -sub_pc_type -sub_pc_factor_shift_type'
petsc_options_value = 'gmres asm lu NONZERO'
[../]

[./superlu]
type = SMP
full = true
petsc_options = '-ksp_diagonal_scale -ksp_diagonal_scale_fix'
petsc_options_iname = '-ksp_type -pc_type -pc_factor_mat_solver_package'
petsc_options_value = 'gmres lu superlu_dist'
[../]

[./sub_pc_superlu]
type = SMP
full = true
petsc_options = '-ksp_diagonal_scale -ksp_diagonal_scale_fix'
petsc_options_iname = '-ksp_type -pc_type -sub_pc_type -sub_pc_factor_shift_type -sub_pc_factor_mat_solver_package'
petsc_options_value = 'gmres asm lu NONZERO superlu_dist'
[../]

[./preferred]
#per Andy
type = SMP
full = true
petsc_options_iname = '-pc_type -pc_factor_mat_solver_package'
petsc_options_value = ' lu       mumps'
[../]

[./basic]
type = SMP
full = true
petsc_options = '-ksp_diagonal_scale -ksp_diagonal_scale_fix'
petsc_options_iname = '-pc_type -sub_pc_type -sub_pc_factor_shift_type -pc_asm_overlap'
petsc_options_value = ' asm      lu           NONZERO                   2'
[../]

[]

############################################################

[Postprocessors]
  [./hotwell_mass_kg]
    type = PorousFlowPlotQuantity
    uo = fluid_mass_in_inc
  [../]
  [./hotwell_enthalpy_J]
    type = PorousFlowPlotQuantity
    uo = heat_enthalpy_in_inc
  [../]
  [./coldwell_mass_kg]
    type = PorousFlowPlotQuantity
    uo = fluid_mass_out_inc
  [../]
  [./coldwell_enthalpy_J]
    type = PorousFlowPlotQuantity
    uo = heat_enthalpy_out_inc
  [../]

  [./time]
    type = TimePostprocessor
    execute_on = 'timestep_end'
  []
  [./step_dt]
    type = TimestepSize
  [../]

  [./is_winter]
    type = FunctionValuePostprocessor
    function = inj_function_winter
  [../]
  [./is_summer]
    type = FunctionValuePostprocessor
    function = inj_function_summer
  [../]


  [./total_recovery_time]
    type = PorousFlowRecoveryTimeAccumulator
    targetpostprocessor = is_winter
    dtpostprocessor = step_dt
  [../]

  [./termination]
    type = PorousFlowTemperatureDropTerminator
    enthalpypostprocessor = hotwell_enthalpy_J
    masspostprocessor = hotwell_mass_kg
    T_inj = ${injection_temp}
    T_init = ${T_ini_bc}
    P_drop = 80
    timepostprocessor = time
  [../]

  [./recovery_rate]
    type = PorousFlowRecoveryRateSeason
    hotwellenergy = hotwell_enthalpy_J
    coldwellenergy = coldwell_enthalpy_J
    InjectionIndicator = is_summer
    ProductionIndicator = is_winter
  [../]

  [./total_energy]
    type = PorousFlowEnergyAccumulator
    hotwellenergy = hotwell_enthalpy_J
    coldwellenergy = coldwell_enthalpy_J
    ProductionIndicator = is_winter
  [../]

  [./inj_P_mid]
    type = PointValue
    execute_on = 'initial timestep_end'
    point = '${inj_well_x} 0 ${aquifer_mid}'
    variable = porepressure
  [../]
  [./inj_T_mid]
    type = PointValue
    execute_on = 'initial timestep_end'
    point = '${inj_well_x} 0 ${aquifer_mid}'
    variable = temperature
  [../]
  [./pro_P_mid]
    type = PointValue
    execute_on = 'initial timestep_end'
    point = '${pro_well_x} 0 ${aquifer_mid}'
    variable = porepressure
  [../]
  [./pro_T_mid]
    type = PointValue
    execute_on = 'initial timestep_end'
    point = '${pro_well_x} 0 ${aquifer_mid}'
    variable = temperature
  [../]
[]

##########################################################
[Executioner]
  type = Transient
  solve_type = NEWTON
  end_time = 315576000
#  steady_state_detection = true
#  steady_state_start_time = 864000 # 10 days
#  steady_state_tolerance = 1e-6
  dtmax = 864000 # 10 days
  dtmin = 100
 [./TimeStepper]
   type = IterationAdaptiveDT
   dt = 1000.0
   optimal_iterations = 10
   force_step_every_function_point =  true
   timestep_limiting_function = Fiss_Function
#  timestep_limiting_postprocessor = timestep_pp
 [../]
# controls for linear iterations
  l_max_its = 50
  l_tol = 1e-3
# controls for nonlinear iterations
  nl_max_its = 20
  nl_rel_tol = 1e-5
  nl_abs_tol = 1e-4
[]
###########################################################
[Outputs]



#[./exodus]
#    type = Exodus
#    file_base = sequence_out_1
#    elemental_as_nodal = true
#    overwrite = true
#    sequence = true
#     time_step_interval = 2
#[../]

#[./Console]
#  type = Console
#  #perf_log = false
#  #output_linear = true
#  output_nonlinear = true
#  time_step_interval = 1
#[../]

[./CSV]
  type = CSV
  time_step_interval = 1
[../]
[]
###########################################################

Description
Example Input Syntax
Input Parameters
Input Files

Theory

Usage

Development

PorousFlowTemperatureDropTerminator

Description

Example Input Syntax

Input Parameters

Required Parameters

Optional Parameters

Execution Scheduling Parameters

Advanced Parameters

Material Property Retrieval Parameters

Input Files