PeriodicTimeIntegratedPostprocessor

PeriodicTimeIntegratedPostprocessor provides the same functionationlity as MultipliedTimeIntegratedPostprocessor except this integrals value will periodically be set to 0 in order to integrate values over a single period.

$var element = document.getElementById("moose-equation-c494b000-1869-4c10-a821-586dd444226c");katex.render(" I \\approx C \\int_0^t f(t) dt \\:\\: \\text{mod} \\left( \\text{T} \\right)", element, {displayMode:true,throwOnError:false});$

Where $var element = document.getElementById("moose-equation-1d3c0047-e2c7-4c19-bcb9-67ca8856a4c7");katex.render("f(t)", element, {displayMode:false,throwOnError:false});$ is a time dependent function and $var element = document.getElementById("moose-equation-9d5d3052-2223-4a9b-b35f-6aa7b3a095e8");katex.render("\\text{T}", element, {displayMode:false,throwOnError:false});$ is the period of the cycle.

note:Proper Usage Hint

MultipliedTimeIntegratedPostprocessor uses the trapezoid rule for time integration and since this object inherits from the MultipliedTimeIntegratedPostprocessor this integration is also performed by trapezoid rule. The integration is also reset after the next time which is appoximately greater than or equal to the next period start. Users should also take care to ensure that the period they want to integrate over is sufficiently resolved. Additionally, if users would like to ensure that the time time steps hit the start of each period the AddPeriodicControllers action can be used in the following manner. The parameter num_contoller_set should be set to a number of periods that is greater than or equal to the number of periods you are simulating.


[PeriodicControllers]
  [enforcer]
    name = enforcer
    starting_cycle = 0
    cycles_between_controls = 0
    num_controller_set = 2000
  []
[]

Example Input File Syntax

In this example, the variable v is integrated over the spatial domain using ElementIntegralVariablePostprocessor, resulting in the variable a, and then periodically integrated over time using PeriodicTimeIntegratedPostprocessor.

[Postprocessors]
  [a]
    type = ElementIntegralVariablePostprocessor
    variable = v
    execute_on = 'initial timestep_end'
  []

  [periodic]
    type = PeriodicTimeIntegratedPostprocessor
    value = a
    cycle_frequency = 0.1
    execute_on = 'initial timestep_end'
  []
[]

Input Parameters

coefficient1The value to multiply the postprocessor by when integrating
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The value to multiply the postprocessor by when integrating
cycle_frequencyThe frequency of the process. Used to calculate the period over which you are integrating.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The frequency of the process. Used to calculate the period over which you are integrating.
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
Unit:(no unit assumed)
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, 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.
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
Unit:(no unit assumed)
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.
valueThe name of the postprocessor you are integrating over time
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the postprocessor you are integrating over time

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
Unit:(no unit assumed)
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).
control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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

Input Files

(test/tests/postprocessors/multi_period_averaging/multi_period_averager.i)
(test/tests/postprocessors/periodic_amplitude_regulator/periodic_modifier.i)
(test/tests/postprocessors/periodic_integration/periodic_integral.i)

(test/tests/postprocessors/periodic_integration/periodic_integral.i)

[Mesh]
  [generator]
    type = GeneratedMeshGenerator
    dim = 1
    xmax = 1
    nx = 100
  []
[]

[Problem]
  type = FEProblem
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [null_kernel]
    type = NullKernel
    variable = u
  []
[]

[AuxVariables]
  [v]
  []
[]

[AuxKernels]
  [func_kernel]
    type = FunctionAux
    variable = v
    function = ic
  []
[]

[Functions]
  [ic]
    type = ParsedFunction
    expression = '-4 * x * (x-1)'
  []
[]

[Postprocessors]
  [a]
    type = ElementIntegralVariablePostprocessor
    variable = v
    execute_on = 'initial timestep_end'
  []

  [periodic]
    type = PeriodicTimeIntegratedPostprocessor
    value = a
    cycle_frequency = 0.1
    execute_on = 'initial timestep_end'
  []
[]

[Executioner]
  type = Transient
  end_time = 11
  dt = 0.5
[]

[Outputs]
  exodus = false
  csv = true
[]

(test/tests/postprocessors/multi_period_averaging/multi_period_averager.i)

[Mesh]
  [generator]
    type = GeneratedMeshGenerator
    dim = 1
    xmax = 1
    nx = 100
  []
[]

[Problem]
  type = FEProblem
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [null_kernel]
    type = NullKernel
    variable = u
  []
[]

[AuxVariables]
  [v]
  []
[]

[AuxKernels]
  [func_kernel]
    type = FunctionAux
    variable = v
    function = ic
  []
[]

[Functions]
  [ic]
    type = ParsedFunction
    expression = '-4 * x * (x-1) * t'
  []
[]

[GlobalParams]
  cycle_frequency = 0.1
[]

[Postprocessors]
  [a]
    type = ElementIntegralVariablePostprocessor
    variable = v
    execute_on = 'initial timestep_end'
  []

  [periodic]
    type = PeriodicTimeIntegratedPostprocessor
    value = a
    execute_on =  'initial timestep_end'
  []

  [multi_period]
    type = MultiPeriodAverager
    value = periodic
    number_of_periods = 2
  []
[]

[Executioner]
  type = Transient
  end_time = 41
  dt = 0.5
[]

[Outputs]
  exodus = false
  csv = true
[]

(test/tests/postprocessors/periodic_amplitude_regulator/periodic_modifier.i)

[Mesh]
  [generator]
    type = GeneratedMeshGenerator
    dim = 1
    xmax = 1
    nx = 100
  []
[]

[Problem]
  type = FEProblem
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [null_kernel]
    type = NullKernel
    variable = u
  []
[]

[AuxVariables]
  [v]
  []
[]

[AuxKernels]
  [func_kernel]
    type = FunctionAux
    variable = v
    function = func
  []
[]

[Functions]
  [func]
    type = ParsedFunction
    symbol_names = 'mag'
    symbol_values = 'mag'
    expression = 'mag * x * (x-1)'
  []
[]

[Postprocessors]
  [a]
    type = ElementIntegralVariablePostprocessor
    variable = v
    execute_on = 'initial timestep_end'
  []

  [periodic_a]
    type = PeriodicTimeIntegratedPostprocessor
    value = a
    cycle_frequency = 0.1
    coefficient = 0.1
    execute_on = 'initial timestep_end'
  []

  [multi_period]
    type = MultiPeriodAverager
    value = periodic_a
    cycle_frequency = 0.1
    number_of_periods = 2
    execute_on = 'initial timestep_begin'
  []

  [mag]
    type = PeriodicAmplitudeRegulator
    value = multi_period
    cycle_frequency = 0.1
    initial_value = -4
    reference_value = 10
    start_cycle = 2
    cycles_between_modification = 2
    execute_on = 'initial timestep_end'
  []

[]

[Executioner]
  type = Transient
  end_time = 200
  dt = 0.5
[]

[Outputs]
  csv = true
[]

(test/tests/postprocessors/periodic_integration/periodic_integral.i)

[Mesh]
  [generator]
    type = GeneratedMeshGenerator
    dim = 1
    xmax = 1
    nx = 100
  []
[]

[Problem]
  type = FEProblem
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [null_kernel]
    type = NullKernel
    variable = u
  []
[]

[AuxVariables]
  [v]
  []
[]

[AuxKernels]
  [func_kernel]
    type = FunctionAux
    variable = v
    function = ic
  []
[]

[Functions]
  [ic]
    type = ParsedFunction
    expression = '-4 * x * (x-1)'
  []
[]

[Postprocessors]
  [a]
    type = ElementIntegralVariablePostprocessor
    variable = v
    execute_on = 'initial timestep_end'
  []

  [periodic]
    type = PeriodicTimeIntegratedPostprocessor
    value = a
    cycle_frequency = 0.1
    execute_on = 'initial timestep_end'
  []
[]

[Executioner]
  type = Transient
  end_time = 11
  dt = 0.5
[]

[Outputs]
  exodus = false
  csv = true
[]

Example Input File Syntax
Input Parameters
Input Files