PorousFlowDoubletBreakthroughTerminator

Returns 1 once a target postprocessor deviates from the reservoir initial temperature by more than temperature_tolerance, and 0 otherwise (thermal breakthrough detection)

Description

PorousFlowDoubletBreakthroughTerminator reports a 0/1 indicator of whether thermal breakthrough has been detected at a doublet's production well. On every timestep, the absolute difference between a target postprocessor (typically the produced fluid temperature) and temperature_init is compared against temperature_tolerance; the reported value is 1 once that difference is at or above the tolerance, and 0 otherwise (note that, unlike the other *Terminator postprocessors in FALCON, this indicator is not latched: it can revert to 0 again if the target postprocessor's value moves back within tolerance of temperature_init).

This postprocessor only reports the indicator; it does not stop the simulation by itself. To actually terminate the run once breakthrough is detected, 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"}>>>]
  [target]
    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."}>>> = target_fn
  []
  [breakthrough]
    type = PorousFlowDoubletBreakthroughTerminator<<<{"description": "Returns 1 once a target postprocessor deviates from the reservoir initial temperature by more than temperature_tolerance, and 0 otherwise (thermal breakthrough detection)", "href": "PorousFlowDoubletBreakthroughTerminator.html"}>>>
    targetpostprocessor<<<{"description": "The name of the targetpostprocessor"}>>> = target
    temperature_init<<<{"description": "Reservoir initial temperature"}>>> = 273.15
    temperature_tolerance<<<{"description": "Absolute temperature difference (in the units of temperature_init) from temperature_init at which breakthrough is declared"}>>> = 0.5
  []
  [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"}>>> = 'breakthrough exact'
    expression<<<{"description": "function expression"}>>> = 'abs(breakthrough - 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."}>>> = 'breakthrough >= 1'
  []
[]

Input Parameters

targetpostprocessorThe name of the targetpostprocessor
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the targetpostprocessor

Required Parameters

temperature_init273.15Reservoir initial temperature
Default:273.15
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Reservoir initial temperature
temperature_tolerance0.01Absolute temperature difference (in the units of temperature_init) from temperature_init at which breakthrough is declared
Default:0.01
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Absolute temperature difference (in the units of temperature_init) from temperature_init at which breakthrough is declared

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_doublet_breakthrough_terminator/inp.i)

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

# Analytic verification of PorousFlowDoubletBreakthroughTerminator, paired with a
# [UserObjects] Terminator to demonstrate that it can actually stop a run.
#
# PorousFlowDoubletBreakthroughTerminator::execute() does:
#   keep_constant = 1 if abs(targetpostprocessor - temperature_init) >= temperature_tolerance
#                   else 0
# and getValue() returns keep_constant (a 0/1 breakthrough indicator).
#
# Drive targetpostprocessor(t) = temperature_init + 0.25*t = 273.15 + 0.25*t, with
# temperature_tolerance = 0.5 (dt = 1, integer times t = 1..8):
#
#   diff(t) = abs(0.25*t) = 0.25*t
#   t=1: diff=0.25 <0.5 -> 0
#   t=2: diff=0.50 >=0.5 -> 1   (breakthrough first detected)
#   t=3..8: diff>0.5 -> 1
#
# so exact(t) = if(t < 2, 0, 1).
#
# A [UserObjects] Terminator is paired on 'breakthrough >= 1' with num_steps = 8, well past the
# t=2 flip, so the run hard-stops right after the flip and the gold CSV has only 2 data rows
# (plus the initial row) instead of 8.

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [target_fn]
    type = ParsedFunction
    expression = '273.15 + 0.25*t'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t < 2, 0, 1)'
  []
[]

[Postprocessors]
  [target]
    type = FunctionValuePostprocessor
    function = target_fn
  []
  [breakthrough]
    type = PorousFlowDoubletBreakthroughTerminator
    targetpostprocessor = target
    temperature_init = 273.15
    temperature_tolerance = 0.5
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'breakthrough exact'
    expression = 'abs(breakthrough - exact)'
  []
[]

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

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

[Outputs]
  csv = true
[]

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

# Analytic verification of PorousFlowDoubletBreakthroughTerminator, paired with a
# [UserObjects] Terminator to demonstrate that it can actually stop a run.
#
# PorousFlowDoubletBreakthroughTerminator::execute() does:
#   keep_constant = 1 if abs(targetpostprocessor - temperature_init) >= temperature_tolerance
#                   else 0
# and getValue() returns keep_constant (a 0/1 breakthrough indicator).
#
# Drive targetpostprocessor(t) = temperature_init + 0.25*t = 273.15 + 0.25*t, with
# temperature_tolerance = 0.5 (dt = 1, integer times t = 1..8):
#
#   diff(t) = abs(0.25*t) = 0.25*t
#   t=1: diff=0.25 <0.5 -> 0
#   t=2: diff=0.50 >=0.5 -> 1   (breakthrough first detected)
#   t=3..8: diff>0.5 -> 1
#
# so exact(t) = if(t < 2, 0, 1).
#
# A [UserObjects] Terminator is paired on 'breakthrough >= 1' with num_steps = 8, well past the
# t=2 flip, so the run hard-stops right after the flip and the gold CSV has only 2 data rows
# (plus the initial row) instead of 8.

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [target_fn]
    type = ParsedFunction
    expression = '273.15 + 0.25*t'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t < 2, 0, 1)'
  []
[]

[Postprocessors]
  [target]
    type = FunctionValuePostprocessor
    function = target_fn
  []
  [breakthrough]
    type = PorousFlowDoubletBreakthroughTerminator
    targetpostprocessor = target
    temperature_init = 273.15
    temperature_tolerance = 0.5
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'breakthrough exact'
    expression = 'abs(breakthrough - exact)'
  []
[]

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

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

[Outputs]
  csv = true
[]

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

# Analytic verification of PorousFlowDoubletBreakthroughTerminator, paired with a
# [UserObjects] Terminator to demonstrate that it can actually stop a run.
#
# PorousFlowDoubletBreakthroughTerminator::execute() does:
#   keep_constant = 1 if abs(targetpostprocessor - temperature_init) >= temperature_tolerance
#                   else 0
# and getValue() returns keep_constant (a 0/1 breakthrough indicator).
#
# Drive targetpostprocessor(t) = temperature_init + 0.25*t = 273.15 + 0.25*t, with
# temperature_tolerance = 0.5 (dt = 1, integer times t = 1..8):
#
#   diff(t) = abs(0.25*t) = 0.25*t
#   t=1: diff=0.25 <0.5 -> 0
#   t=2: diff=0.50 >=0.5 -> 1   (breakthrough first detected)
#   t=3..8: diff>0.5 -> 1
#
# so exact(t) = if(t < 2, 0, 1).
#
# A [UserObjects] Terminator is paired on 'breakthrough >= 1' with num_steps = 8, well past the
# t=2 flip, so the run hard-stops right after the flip and the gold CSV has only 2 data rows
# (plus the initial row) instead of 8.

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [target_fn]
    type = ParsedFunction
    expression = '273.15 + 0.25*t'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t < 2, 0, 1)'
  []
[]

[Postprocessors]
  [target]
    type = FunctionValuePostprocessor
    function = target_fn
  []
  [breakthrough]
    type = PorousFlowDoubletBreakthroughTerminator
    targetpostprocessor = target
    temperature_init = 273.15
    temperature_tolerance = 0.5
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'breakthrough exact'
    expression = 'abs(breakthrough - exact)'
  []
[]

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

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

[Outputs]
  csv = true
[]

Description
Example Input Syntax
Input Parameters
Input Files

Theory

Usage

Development

PorousFlowDoubletBreakthroughTerminator

Description

Example Input Syntax

Input Parameters

Required Parameters

Optional Parameters

Execution Scheduling Parameters

Advanced Parameters

Material Property Retrieval Parameters

Input Files