FunctionSideIntegral

under construction:Undocumented Class

The FunctionSideIntegral has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# FunctionSideIntegral

!syntax description /Postprocessors/FunctionSideIntegral

## Overview

!! Replace these lines with information regarding the FunctionSideIntegral object.

## Example Input File Syntax

!! Describe and include an example of how to use the FunctionSideIntegral object.

!syntax parameters /Postprocessors/FunctionSideIntegral

!syntax inputs /Postprocessors/FunctionSideIntegral

!syntax children /Postprocessors/FunctionSideIntegral

!syntax description /Postprocessors/FunctionSideIntegral

Input Parameters

boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies

Required Parameters

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 TRANSFER
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.
function1This postprocessor will return the integral of this function over the boundary
Default:1
C++ Type:FunctionName
Options:
Description:This postprocessor will return the integral of this function over the boundary

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.
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
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/postprocessors/function_sideintegral/function_sideintegral.i

test/tests/postprocessors/function_sideintegral/function_sideintegral.i

# calculates the integral of various functions over
# boundaries of the mesh.  See [Postprocessors] for
# a description of the functions
[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 5
  ny = 5
  nz = 5
  xmin = -1
  xmax = 1
  ymin = -2
  ymax = 2
  zmin = 0
  zmax = 6
[]

[Variables]
  [./u]
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]
[]

[ICs]
  [./u]
    type = ConstantIC
    variable = u
    value = 0
  [../]
[]

[Postprocessors]
  [./zmin]
    # no function is provided, so it should default to 1
    # yielding postprocessor = 8
    type = FunctionSideIntegral
    boundary = back
  [../]
  [./zmax]
    # result should be -6*area_of_zmax_sideset = -48
    type = FunctionSideIntegral
    boundary = front
    function = '-z'
  [../]
  [./ymin]
    # since the integrand is odd in x, the result should be zero
    type = FunctionSideIntegral
    boundary = bottom
    function = 'x*pow(z,4)'
  [../]
  [./ymax]
    # result should be 24
    type = FunctionSideIntegral
    boundary = top
    function = 'y*(1+x)*(z-2)'
  [../]
  [./xmin_and_xmax]
    # here the integral is over two sidesets
    # result should be 432
    type = FunctionSideIntegral
    boundary = 'left right'
    function = '(3+x)*z'
  [../]
[]

[Executioner]
  type = Steady

  solve_type = 'PJFNK'

  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  execute_on = 'timestep_end'
  file_base = function_sideintegral
  [./csv]
    type = CSV
  [../]
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools