PorousFlowAccumulator

Accumulate the targeted postprocessor value over time

Description

PorousFlowAccumulator accumulates the value of a target postprocessor over the course of a transient simulation, but only counts a contribution on a timestep if:

the target postprocessor's current value is negative, and
the current simulation time (as reported by a supplied time postprocessor) lies strictly between accumulator_start_time and accumulator_end_time.

The running sum is kept internally, and the postprocessor value reported is the absolute value of that sum. This is typically used to track a cumulative quantity (e.g. injected fluid mass or energy, which is reported as negative by convention) over a specific portion of a simulation, ignoring both the sign convention and any activity outside the time window of interest.

Example Input Syntax

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [cur_time]
    type = TimePostprocessor<<<{"description": "Reports the current time", "href": "TimePostprocessor.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
  []
  [computed]
    type = PorousFlowAccumulator<<<{"description": "Accumulate the targeted postprocessor value over time", "href": "PorousFlowAccumulator.html"}>>>
    targetpostprocessor<<<{"description": "The name of the targetpostprocessor"}>>> = target
    timepostprocessor<<<{"description": "The name of the timepostprocessor"}>>> = cur_time
    accumulator_start_time<<<{"description": "The time at which accumulation starts (Default is 0)"}>>> = 2
    accumulator_end_time<<<{"description": "The time at which accumulation ends (Default is 1e30)"}>>> = 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"}>>> = 'computed exact'
    expression<<<{"description": "function expression"}>>> = 'abs(computed - exact)'
  []
[]

Input Parameters

targetpostprocessorThe 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

accumulator_end_time1e+30The time at which accumulation ends (Default is 1e30)
Default:1e+30
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:The time at which accumulation ends (Default is 1e30)
accumulator_start_time0The time at which accumulation starts (Default is 0)
Default:0
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:The time at which accumulation starts (Default is 0)

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

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

# Analytic verification of PorousFlowAccumulator.
#
# PorousFlowAccumulator::execute() does:
#   if (accumulator_start_time < time < accumulator_end_time)
#     if (targetpostprocessor < 0)
#       accumulator += targetpostprocessor
# and getValue() returns abs(accumulator).
#
# Drive the target postprocessor with target(t) = 3 - t (dt = 1, integer times
# t = 1..6) and restrict accumulation to the open window (2, 5):
#
#   t=1: value= 2  (positive -> skipped)
#   t=2: value= 1  (positive -> skipped)
#   t=3: value= 0  (not < 0  -> skipped, also window edge t=2 is excluded)
#   t=4: value=-1  (window 2<4<5 true, negative -> accumulate: acc=-1)
#   t=5: value=-2  (window 2<5<5 FALSE (upper bound excluded) -> skipped)
#   t=6: value=-3  (window 2<6<5 FALSE -> skipped)
#
# so acc stays at -1 for t>=4 and the postprocessor value (=abs(acc)) is
# exactly 0 for t=1,2,3 and 1 for t=4,5,6, i.e. exact(t) = if(t<4, 0, 1).

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

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Functions]
  [target_fn]
    type = ParsedFunction
    expression = '3 - t'
  []
  [exact_fn]
    type = ParsedFunction
    expression = 'if(t < 4, 0, 1)'
  []
[]

[Postprocessors]
  [cur_time]
    type = TimePostprocessor
  []
  [target]
    type = FunctionValuePostprocessor
    function = target_fn
  []
  [computed]
    type = PorousFlowAccumulator
    targetpostprocessor = target
    timepostprocessor = cur_time
    accumulator_start_time = 2
    accumulator_end_time = 5
  []
  [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
[]