CylindricalAverage

Compute a cylindrical average of a variableas a function of radius throughout the simulation domain.

Description

CylindricalAverage computes the average of multiple variables over cylindrical shells. The cylinder is defined by the midpoint and a vector along the cylinder axis. The cylindrical shells are defined by a maxiumum radius and the number of desired shells.

Input Parameters

cylinder_axisVector along cylinder coordinate axis
C++ Type:libMesh::Point
Options:
Description:Vector along cylinder coordinate axis
radiusRadius to average out to
C++ Type:double
Options:
Description:Radius to average out to

Required Parameters

bin_number50Number of histogram bins
Default:50
C++ Type:unsigned int
Options:
Description:Number of histogram bins
blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
Default:False
C++ Type:bool
Options:
Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
empty_bin_value0Value to assign to bins into which no datapoints fall
Default:0
C++ Type:double
Options:
Description:Value to assign to bins into which no datapoints fall
execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
origin0 0 0Origin of the cylinder
Default:0 0 0
C++ Type:libMesh::Point
Options:
Description:Origin of the cylinder
variableVariables to average radially
C++ Type:std::vector
Options:
Description:Variables to average radially

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
Options:
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
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Options:
Description:Determines whether this object is calculated using an implicit or explicit form
outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector
Options:
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Options:
Description:The seed for the master random number generator
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
Options:
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/vectorpostprocessors/cylindrical_average/cylindrical_average.i

test/tests/vectorpostprocessors/cylindrical_average/cylindrical_average.i

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 10
  ny = 10
  nz = 1
  xmin = -5
  xmax = 5
  ymin = -5
  ymax = 5
  zmin = 0
  zmax = 1
[]

[Problem]
  kernel_coverage_check = false
[]

[Variables]
  [./c]
  [../]
[]

[AuxVariables]
  [./d]
  [../]
[]

[AuxKernels]
  [./d]
    type = FunctionAux
    variable = d
    function = set_d
    execute_on = initial
  [../]
[]

[Functions]
  [./set_d]
    type = ParsedFunction
    value = 'r := sqrt(x * x + y * y); r'
  [../]
[]

[VectorPostprocessors]
  [./average]
    type = CylindricalAverage
    variable = d
    radius = 5
    bin_number = 10
    origin = '0 0 0'
    cylinder_axis = '0 0 1'
    execute_on = 'initial timestep_end'
  [../]
[]

[Executioner]
  type = Steady
[]

[Outputs]
  execute_on = 'initial timestep_end'
  csv = true
[]

References

Description
Input Parameters
Input Files
References

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools