GapValueAux

under construction:Undocumented Class

The GapValueAux 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.


# GapValueAux

!syntax description /AuxKernels/GapValueAux

## Overview

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

## Example Input File Syntax

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

!syntax parameters /AuxKernels/GapValueAux

!syntax inputs /AuxKernels/GapValueAux

!syntax children /AuxKernels/GapValueAux

!syntax description /AuxKernels/GapValueAux

Input Parameters

paired_boundaryThe boundary on the other side of a gap.
C++ Type:BoundaryName
Options:
Description:The boundary on the other side of a gap.
paired_variableThe variable to get the value of.
C++ Type:VariableName
Options:
Description:The variable to get the value of.
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Options:
Description:The name of the variable that this object applies to

Required Parameters

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
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
execute_onLINEAR TIMESTEP_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, PRE_DISPLACE.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE
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, PRE_DISPLACE.
normal_smoothing_distanceDistance from edge in parametric coordinates over which to smooth contact normal
C++ Type:double
Options:
Description:Distance from edge in parametric coordinates over which to smooth contact normal
normal_smoothing_methodMethod to use to smooth normals (edge_based|nodal_normal_based)
C++ Type:std::string
Options:
Description:Method to use to smooth normals (edge_based|nodal_normal_based)
orderFIRSTThe finite element order
Default:FIRST
C++ Type:MooseEnum
Options:FIRST SECOND THIRD FOURTH
Description:The finite element order
tangential_toleranceTangential distance to extend edges of contact surfaces
C++ Type:double
Options:
Description:Tangential distance to extend edges of contact surfaces
warningsFalseWhether to output warning messages concerning nodes not being found
Default:False
C++ Type:bool
Options:
Description:Whether to output warning messages concerning nodes not being found

Optional Parameters

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.
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_meshTrueWhether 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:True
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/geomsearch/patch_update_strategy/never.i
test/tests/auxkernels/gap_value/gap_value.i
test/tests/auxkernels/gap_value/gap_value_subdomain_restricted.i
test/tests/geomsearch/patch_update_strategy/auto.i
test/tests/geomsearch/patch_update_strategy/always.i
test/tests/geomsearch/2d_interior_boundary_penetration_locator/2d_interior_boundary_penetration_locator.i
test/tests/geomsearch/patch_update_strategy/always-grid-sequence.i

test/tests/geomsearch/patch_update_strategy/never.i

[Mesh]
  type = FileMesh
  file = long_range.e
  dim = 2
  patch_update_strategy = never
  displacements = 'disp_x disp_y'
[]

[Variables]
  [./u]
    block = right
  [../]
[]

[AuxVariables]
  [./linear_field]
  [../]
  [./receiver]
    # The field to transfer into
  [../]
  [./disp_x]
  [../]
  [./disp_y]
  [../]
  [./elemental_reciever]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Kernels]
  [./diff]
    type = CoefDiffusion
    variable = u
    coef = 1
  [../]
  [./time]
    type = TimeDerivative
    variable = u
  [../]
[]

[AuxKernels]
  [./linear_in_y]
    # This just gives us something to transfer that varies in y so we can ensure the transfer is working properly...
    type = FunctionAux
    variable = linear_field
    function = y
    execute_on = initial
  [../]
  [./right_to_left]
    type = GapValueAux
    variable = receiver
    paired_variable = linear_field
    paired_boundary = rightleft
    execute_on = timestep_end
    boundary = leftright
  [../]
  [./y_displacement]
    type = FunctionAux
    variable = disp_y
    function = t
    execute_on = 'linear timestep_begin'
    block = left
  [../]
  [./elemental_right_to_left]
    type = GapValueAux
    variable = elemental_reciever
    paired_variable = linear_field
    paired_boundary = rightleft
    boundary = leftright
  [../]
[]

[BCs]
  [./top]
    type = DirichletBC
    variable = u
    boundary = righttop
    value = 1
  [../]
  [./bottom]
    type = DirichletBC
    variable = u
    boundary = rightbottom
    value = 0
  [../]
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 30
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

test/tests/auxkernels/gap_value/gap_value.i

[Mesh]
  file = nonmatching.e
  dim = 2
  # This test will not work in parallel with DistributedMesh enabled
  # due to a bug in the GeometricSearch system.  See #2121 for more
  # information.
  parallel_type = replicated
[]

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

[AuxVariables]
  [./gap_value]
    block = left
  [../]
[]

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

[BCs]
  [./bottom]
    type = DirichletBC
    variable = u
    boundary = 'leftbottom rightbottom'
    value = 0
  [../]
  [./top]
    type = DirichletBC
    variable = u
    boundary = 'lefttop righttop'
    value = 1
  [../]
[]

[AuxKernels]
  [./gap_value_aux]
    type = GapValueAux
    variable = gap_value
    boundary = leftright
    paired_variable = u
    paired_boundary = rightleft
  [../]
[]

[Executioner]
  type = Steady

  solve_type = 'PJFNK'

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

[Outputs]
  exodus = true
[]

test/tests/auxkernels/gap_value/gap_value_subdomain_restricted.i

[Mesh]
  file = nonmatching.e
  dim = 2
  # This test will not work in parallel with DistributedMesh enabled
  # due to a bug in the GeometricSearch system.  See #2121 for more
  # information.
  parallel_type = replicated
[]

[Variables]
  [./u]
    block = 'left right'
  [../]
[]

[AuxVariables]
  [./gap_value]
    block = left
  [../]
[]

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

[BCs]
  [./bottom]
    type = DirichletBC
    variable = u
    boundary = 'leftbottom rightbottom'
    value = 0
  [../]
  [./top]
    type = DirichletBC
    variable = u
    boundary = 'lefttop righttop'
    value = 1
  [../]
[]

[AuxKernels]
  [./gap_value_aux]
    type = GapValueAux
    variable = gap_value
    boundary = leftright
    paired_variable = u
    paired_boundary = rightleft
  [../]
[]

[Executioner]
  type = Steady

  solve_type = 'PJFNK'

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

[Outputs]
  exodus = true
[]

test/tests/geomsearch/patch_update_strategy/auto.i

[Mesh]
  type = FileMesh
  file = long_range.e
  dim = 2
  patch_update_strategy = auto
  displacements = 'disp_x disp_y'
[]

[Variables]
  [./u]
    block = right
  [../]
[]

[AuxVariables]
  [./linear_field]
  [../]
  [./receiver]
    # The field to transfer into
  [../]
  [./disp_x]
  [../]
  [./disp_y]
  [../]
  [./elemental_reciever]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Kernels]
  [./diff]
    type = CoefDiffusion
    variable = u
    coef = 1
  [../]
  [./time]
    type = TimeDerivative
    variable = u
  [../]
[]

[AuxKernels]
  [./linear_in_y]
    # This just gives us something to transfer that varies in y so we can ensure the transfer is working properly...
    type = FunctionAux
    variable = linear_field
    function = y
    execute_on = initial
  [../]
  [./right_to_left]
    type = GapValueAux
    variable = receiver
    paired_variable = linear_field
    paired_boundary = rightleft
    execute_on = timestep_end
    boundary = leftright
  [../]
  [./y_displacement]
    type = FunctionAux
    variable = disp_y
    function = t
    execute_on = 'linear timestep_begin'
    block = left
  [../]
  [./elemental_right_to_left]
    type = GapValueAux
    variable = elemental_reciever
    paired_variable = linear_field
    paired_boundary = rightleft
    boundary = leftright
  [../]
[]

[BCs]
  [./top]
    type = DirichletBC
    variable = u
    boundary = righttop
    value = 1
  [../]
  [./bottom]
    type = DirichletBC
    variable = u
    boundary = rightbottom
    value = 0
  [../]
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 30
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

test/tests/geomsearch/patch_update_strategy/always.i

[Mesh]
  type = FileMesh
  file = long_range.e
  dim = 2
  patch_update_strategy = always
  displacements = 'disp_x disp_y'
[]

[Variables]
  [./u]
    block = right
  [../]
[]

[AuxVariables]
  [./linear_field]
  [../]
  [./receiver]
    # The field to transfer into
  [../]
  [./disp_x]
  [../]
  [./disp_y]
  [../]
  [./elemental_reciever]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Kernels]
  [./diff]
    type = CoefDiffusion
    variable = u
    coef = 1
  [../]
  [./time]
    type = TimeDerivative
    variable = u
  [../]
[]

[AuxKernels]
  [./linear_in_y]
    # This just gives us something to transfer that varies in y so we can ensure the transfer is working properly...
    type = FunctionAux
    variable = linear_field
    function = y
    execute_on = initial
  [../]
  [./right_to_left]
    type = GapValueAux
    variable = receiver
    paired_variable = linear_field
    paired_boundary = rightleft
    execute_on = timestep_end
    boundary = leftright
  [../]
  [./y_displacement]
    type = FunctionAux
    variable = disp_y
    function = t
    execute_on = 'linear timestep_begin'
    block = left
  [../]
  [./elemental_right_to_left]
    type = GapValueAux
    variable = elemental_reciever
    paired_variable = linear_field
    paired_boundary = rightleft
    boundary = leftright
  [../]
[]

[BCs]
  [./top]
    type = DirichletBC
    variable = u
    boundary = righttop
    value = 1
  [../]
  [./bottom]
    type = DirichletBC
    variable = u
    boundary = rightbottom
    value = 0
  [../]
[]

[Problem]
  type = FEProblem
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 30
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

test/tests/geomsearch/2d_interior_boundary_penetration_locator/2d_interior_boundary_penetration_locator.i

[Mesh]
  type = FileMesh
  file = meshed_gap.e
  dim = 2
[]

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

[AuxVariables]
  [./gap_distance]
  [../]
  [./gap_value]
  [../]
[]

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

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

[AuxKernels]
  [./penetration]
    type = PenetrationAux
    variable = gap_distance
    boundary = 2
    paired_boundary = 3
  [../]
  [./gap_value]
    type = GapValueAux
    variable = gap_value
    boundary = 2
    paired_variable = u
    paired_boundary = 3
  [../]
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

test/tests/geomsearch/patch_update_strategy/always-grid-sequence.i

[Mesh]
  type = FileMesh
  file = long_range_coarse.e
  dim = 2
  patch_update_strategy = always
  displacements = 'disp_x disp_y'
[]

[Problem]
  type = ReferenceResidualProblem
  extra_tag_vectors = 'ref'
  reference_vector = 'ref'
  solution_variables = 'u'
[]

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

[AuxVariables]
  [./linear_field]
  [../]
  [./receiver]
    # The field to transfer into
  [../]
  [./disp_x]
  [../]
  [./disp_y]
  [../]
  [./elemental_reciever]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Kernels]
  [./diff]
    type = CoefDiffusion
    variable = u
    coef = 1
    extra_vector_tags = 'ref'
  [../]
[]

[AuxKernels]
  [./linear_in_y]
    # This just gives us something to transfer that varies in y so we can ensure the transfer is working properly...
    type = FunctionAux
    variable = linear_field
    function = y
    execute_on = initial
  [../]
  [./right_to_left]
    type = GapValueAux
    variable = receiver
    paired_variable = linear_field
    paired_boundary = rightleft
    execute_on = timestep_end
    boundary = leftright
  [../]
  [./y_displacement]
    type = FunctionAux
    variable = disp_y
    function = t
    execute_on = 'linear timestep_begin'
    block = left
  [../]
  [./elemental_right_to_left]
    type = GapValueAux
    variable = elemental_reciever
    paired_variable = linear_field
    paired_boundary = rightleft
    boundary = leftright
  [../]
[]

[BCs]
  [./top]
    type = FunctionDirichletBC
    variable = u
    boundary = 'lefttop righttop'
    function = 't'
  [../]
  [./bottom]
    type = DirichletBC
    variable = u
    boundary = 'leftbottom rightbottom'
    value = 0
  [../]
[]

[Executioner]
  type = Transient
  num_steps = 3
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
  num_grids = 2
[]

[Outputs]
  exodus = true
[]

[Postprocessors]
  [num_nl]
    type = NumNonlinearIterations
  []
  [total_nl]
    type = CumulativeValuePostprocessor
    postprocessor = num_nl
  []
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools