PorousFlowRecoveryTime

Computes the elapsed time (in days) since the recorded doublet breakthrough time

Description

PorousFlowRecoveryTime computes the elapsed time, in days, since a doublet breakthrough time recorded by another postprocessor (typically a PorousFlowDoubletBreakthroughTime). It is a purely algebraic postprocessor: once a breakthrough time has been recorded, the reported value is timepostprocessor/3600/24 - breakthroughtime, i.e. the current simulation time converted to days, minus the recorded breakthrough time (also in days), which increases linearly with simulation time. Before breakthrough is recorded, PorousFlowDoubletBreakthroughTime reports 0; taken literally that would make this object report the whole elapsed simulation time as though recovery had already begun, so it instead reports 0 until a positive breakthrough time is available.

Example Input Syntax

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [cur_time]
    type = TimePostprocessor<<<{"description": "Reports the current time", "href": "TimePostprocessor.html"}>>>
  []
  [breakthrough]
    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."}>>> = breakthrough_fn
  []
  [computed]
    type = PorousFlowRecoveryTime<<<{"description": "Computes the elapsed time (in days) since the recorded doublet breakthrough time", "href": "PorousFlowRecoveryTime.html"}>>>
    breakthroughtime<<<{"description": "The name of the targetpostprocessor"}>>> = breakthrough
    timepostprocessor<<<{"description": "The name of the timepostprocessor"}>>> = cur_time
  []
  [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

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

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

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

# Analytic verification of PorousFlowRecoveryTime.
#
# PorousFlowRecoveryTime::getValue() returns (timepostprocessor/3600/24 - breakthroughtime),
# i.e. the elapsed time in days since a recorded breakthrough time.
#
# Drive with dt = 86400 s (1 day), num_steps = 5, timepostprocessor = TimePostprocessor
# (reports t in seconds), and breakthroughtime = a constant postprocessor with value 2 (days):
#
#   day 1 (t=86400):  1 - 2 = -1
#   day 2 (t=172800): 2 - 2 =  0
#   day 3 (t=259200): 3 - 2 =  1
#   day 4 (t=345600): 4 - 2 =  2
#   day 5 (t=432000): 5 - 2 =  3
#
# so exact(t) = t/86400 - 2.

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [breakthrough_fn]
    type = ParsedFunction
    expression = '2'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 't/86400 - 2'
  []
[]

[Postprocessors]
  [cur_time]
    type = TimePostprocessor
  []
  [breakthrough]
    type = FunctionValuePostprocessor
    function = breakthrough_fn
  []
  [computed]
    type = PorousFlowRecoveryTime
    breakthroughtime = breakthrough
    timepostprocessor = cur_time
  []
  [exact]
    type = FunctionValuePostprocessor
    function = exact_fn
  []
  [residual]
    type = ParsedPostprocessor
    pp_names = 'computed exact'
    expression = 'abs(computed - exact)'
  []
[]

[Executioner]
  type = Transient
  dt = 86400
  num_steps = 5
[]

[Outputs]
  csv = true
[]