AddPeriodicRelativeNodalDifference

This Action automatically adds the necessary objects to calculate the relative periodic difference. Relative Difference will be outputted as a Postprocessor named: 'var'_periodic_difference

Overview

The PeriodicRelativeNodalDifference provides the objects necessary to calculate the relative periodic difference of a variable (either in logarithmic or non-logarithmic form).

The relative periodic difference is defined as:

$var element = document.getElementById("moose-equation-ea24dba7-df19-4588-819e-3cfb48e51908");katex.render("\\epsilon = \\sqrt{ \\frac{\\sum_{i=1}^{K}{\\left[ \\left( \\frac{u_{i}}{u_{\\text{avg}}} \\right)_{P} - \\left( \\frac{u_{i}}{u_{\\text{avg}}} \\right)_{P-1} \\right]^{2}} }{K^{2}} }", element, {displayMode:true,throwOnError:false});$

Where:

$var element = document.getElementById("moose-equation-315c9d64-8635-4674-857f-bd469e0ac832");katex.render("u", element, {displayMode:false,throwOnError:false});$ is the variable of interest,
$var element = document.getElementById("moose-equation-8d5f6453-5627-42c6-8426-d882b03c760c");katex.render("u_{\\text{avg}}", element, {displayMode:false,throwOnError:false});$ is the spatial average of the variable,
$var element = document.getElementById("moose-equation-3365e43b-cf28-40c0-b0d5-19483637a36b");katex.render("P", element, {displayMode:false,throwOnError:false});$ is the beginning of the current cycle,
$var element = document.getElementById("moose-equation-f0a066a9-955e-45cc-aff0-8834f68d1455");katex.render("P-1", element, {displayMode:false,throwOnError:false});$ is the beginning of the previous cycle,
$var element = document.getElementById("moose-equation-ec0574b8-80a6-4d59-a74c-ea78ffbd60fb");katex.render("i", element, {displayMode:false,throwOnError:false});$ is the nodal index, and
$var element = document.getElementById("moose-equation-b02823d3-485a-476b-b8ab-0ab5148e280e");katex.render("K", element, {displayMode:false,throwOnError:false});$ is the total number of nodes.

Example Input File Syntax

[PeriodicRelativeNodalDifference<<<{"href": "../../syntax/PeriodicRelativeNodalDifference/index.html"}>>>]
  [Periodic_Y_Diff]
    periodic_variable<<<{"description": "The periodic variables (Not in log form)."}>>> = y
    cycle_frequency<<<{"description": "The cycle's frequency in Hz"}>>> = 1.0
    num_cycles<<<{"description": "The number of cycles this object is active."}>>> = 75
    starting_cycle<<<{"description": "The number of the cycles before starting the difference calculation"}>>> = 25
  []
[]

Input Parameters

cycle_frequencyThe cycle's frequency in Hz
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The cycle's frequency in Hz

Required Parameters

active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified only the blocks named will be visited and made active
blockThe subdomain that this action applies to.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The subdomain that this action applies to.
familyLAGRANGESpecifies the family of FE shape functions to use for this variable
Default:LAGRANGE
C++ Type:MooseEnum
Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS
Controllable:No
Description:Specifies the family of FE shape functions to use for this variable
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
initial_conditionSpecifies a constant initial condition for this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a constant initial condition for this variable
initial_from_file_varGives the name of a variable for which to read an initial condition from a mesh file
C++ Type:std::string
Controllable:No
Description:Gives the name of a variable for which to read an initial condition from a mesh file
num_cycles2000The number of cycles this object is active.
Default:2000
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The number of cycles this object is active.
orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
Default:FIRST
C++ Type:MooseEnum
Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH
Controllable:No
Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
periodic_variableThe periodic variables (Not in log form).
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The periodic variables (Not in log form).
periodic_variable_logThe periodic variables that are in log form.
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The periodic variables that are in log form.
scalingSpecifies a scaling factor to apply to this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to this variable
starting_cycle0The number of the cycles before starting the difference calculation
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The number of the cycles before starting the difference calculation

Optional 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.

Advanced Parameters

(test/tests/PeriodicRelativeNodalDifference/Sample_Periodic_Diffusion.i)

[Mesh]
  [file]
    type = FileMeshGenerator
    file = 'Sample_Periodic_Diffusion.msh'
  []
  [left]
    type = SideSetsFromNormalsGenerator
    normals = '-1 0 0'
    new_boundary = 'left'
    input = file
  []
  [right]
    type = SideSetsFromNormalsGenerator
    normals = '1 0 0'
    new_boundary = 'right'
    input = left
  []
[]

[Problem]
  type = FEProblem
[]

[Variables]
  [y]
  []
[]

[Kernels]
  [Time_Deriv]
    type = TimeDerivative
    variable = y
  []
  [Diff]
    type = ADMatDiffusion
    variable = y
    diffusivity = 'diffy'
  []
  [First_Term]
    type = BodyForce
    variable = y
    function = '0.25 * sin(2.0*pi * t) * sin(2.0*pi * t)'
  []
  [Second_Term]
    type = ReactionFirstOrder
    variable = y
    v = y
    coefficient = -1
    reaction = 'firstorder'
    _v_eq_u = true
  []
  [Thrid_Term]
    type = ReactionSecondOrder
    variable = y
    v = y
    w = y
    coefficient = -1
    reaction = 'secondorder'
    _v_eq_u = true
    _w_eq_u = true
  []
[]

[BCs]
  [Walls]
    type = DirichletBC
    variable = y
    value = 0
    boundary = 'left right'
  []
[]

[Materials]
  [gas_species_0]
    type = ADGenericConstantMaterial
    prop_names = 'diffy'
    prop_values = 0.001
  []
  [firstorder_coefficient]
    type = GenericRateConstant
    reaction = 'firstorder'
    reaction_rate_value = 0.05
  []
  [secondorder_coefficient]
    type = GenericRateConstant
    reaction = 'secondorder'
    reaction_rate_value = 0.015
  []
[]

[PeriodicRelativeNodalDifference]
  [Periodic_Y_Diff]
    periodic_variable = y
    cycle_frequency = 1.0
    num_cycles = 75
    starting_cycle = 25
  []
[]

[Postprocessors]
  [diff_counter]
    type = PeriodicComparisonCounter
    value1 = y_periodic_difference
    value2 = 1e-5
    frequency = 1
    comparison_type = less_than
  []
[]

[UserObjects]
  [End]
    type = Terminator
    expression = '(if(diff_counter>=10,1,0)) = 1'
  []
[]

[Preconditioning]
  active = 'smp'
  [smp]
    type = SMP
    full = true
  []
  [fdp]
    type = FDP
    full = true
  []
[]

[Executioner]
  type = Transient
  end_time = 100

  petsc_options = '-snes_converged_reason -snes_linesearch_monitor'
  solve_type = NEWTON
  petsc_options_iname = '-pc_type -ksp_type'
  petsc_options_value = 'lu gmres'

  dtmin = 1e-14
  scheme = bdf2
  dt = 0.01

[]

[Outputs]
  perf_graph = true
  [out]
    type = Exodus
  []
[]

Overview
Example Input File Syntax
Input Parameters