GradientJumpIndicator

Compute the jump of the solution gradient across element boundaries.

Description

The GradientJumpIndicator object computes the error as computed by the change in the gradient of a variable across element interfaces.

Example Input File Syntax

The following code snippet demonstrates the use of the GradientJumpIndicator object within a typical input file.

[Adaptivity]
  [Indicators]
    [error]
      type = GradientJumpIndicator
      variable = u
    []
  []
[]

Input Parameters

variableThe name of the variable that this side indicator applies to
C++ Type:VariableName
Controllable:No
Description:The name of the variable that this side indicator applies to

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
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
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.
scale_by_flux_facesFalseWhether or not to scale the error values by the number of flux faces. This attempts to not penalize elements on boundaries for having less neighbors.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to scale the error values by the number of flux faces. This attempts to not penalize elements on boundaries for having less neighbors.

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.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
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

(../moose/test/tests/indicators/gradient_jump_indicator/gradient_jump_indicator_test.i)

###########################################################
# This is a test of the Mesh Indicator System. It computes
# a user-defined "error" for each element in the Mesh.
#
# This test has been verified to give the same error
# calculation as the libMesh kelly_error_estimator.  If
# this test is diffing... the diff is wrong!
#
# @Requirement F2.40
###########################################################

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  nz = 10
[]

[Variables]
  [./u]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Functions]
  [./solution]
    type = ParsedFunction
    expression = (exp(x)-1)/(exp(1)-1)
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]
  [./conv]
    type = Convection
    variable = u
    velocity = '1 0 0'
  [../]
[]

[BCs]
  [./left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  [../]
  [./right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  [../]
[]

# Mesh Indicator System
[Adaptivity]
  [Indicators]
    [error]
      type = GradientJumpIndicator
      variable = u
    []
  []
[]

[Executioner]
  type = Steady

  solve_type = 'PJFNK'
[]

[Outputs]
  exodus = true
[]