CoupledTiedValueConstraint

construction:Undocumented Class

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


# CoupledTiedValueConstraint

!syntax description /Constraints/CoupledTiedValueConstraint

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Constraints/CoupledTiedValueConstraint

!syntax inputs /Constraints/CoupledTiedValueConstraint

!syntax children /Constraints/CoupledTiedValueConstraint

Requires the value of a variable to be the consistent on both sides of an interface.

Input Parameters

variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Options:
Description:The name of the variable that this residual object operates on

Required Parameters

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 used for projections
Default:FIRST
C++ Type:MooseEnum
Options:FIRST, SECOND, THIRD, FOURTH
Description:The finite element order used for projections
primaryThe boundary ID associated with the primary side
C++ Type:BoundaryName
Options:
Description:The boundary ID associated with the primary side
primary_variableThe variable on the primary side of the domain
C++ Type:std::vector<VariableName>
Options:
Description:The variable on the primary side of the domain
scaling1scaling factor to be applied to constraint equations
Default:1
C++ Type:double
Options:
Description:scaling factor to be applied to constraint equations
secondaryThe boundary ID associated with the secondary side
C++ Type:BoundaryName
Options:
Description:The boundary ID associated with the secondary side
tangential_toleranceTangential distance to extend edges of contact surfaces
C++ Type:double
Options:
Description:Tangential distance to extend edges of contact surfaces

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
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
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

extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Options:
Description:The extra tags for the matrices this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Options:
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Options:nontime, system
Description:The tag for the matrices this Kernel should fill
vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Options:nontime, time
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Input Files

(test/tests/constraints/coupled_tied_value_constraint/coupled_tied_value_constraint.i)
(test/tests/misc/check_error/constraint_with_aux_var.i)

(test/tests/constraints/coupled_tied_value_constraint/coupled_tied_value_constraint.i)

[Mesh]
  type = FileMesh
  file = split_blocks.e
  # NearestNodeLocator, which is needed by CoupledTiedValueConstraint,
  # only works with ReplicatedMesh currently
  parallel_type = replicated
[]

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

[Kernels]
  [./diff_u]
    type = Diffusion
    variable = u
    block = left
  [../]
  [./diff_v]
    type = Diffusion
    variable = v
    block = right
  [../]
[]

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

[Constraints]
  [./value]
    type = CoupledTiedValueConstraint
    variable = u
    secondary = 2
    primary = 3
    primary_variable = v
  [../]
[]

[Preconditioning]
  active = 'SMP'
  [./SMP]
    type = SMP
    full = true
  [../]
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  l_max_its = 100
  nl_max_its = 2
[]

[Outputs]
  file_base = out
  exodus = true
[]

(test/tests/misc/check_error/constraint_with_aux_var.i)

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

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

[AuxVariables]
  [./v]
  [../]
[]

[Constraints]
  [./nope]
    type = CoupledTiedValueConstraint
    variable = v
    secondary = 2
    primary = 3
    primary_variable = u
  [../]
[]

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

  [./right]
    type = DirichletBC
    variable = u
    boundary = 2
    value = 1
  [../]
[]

[Executioner]
  type = Steady
  solve_type = 'NEWTON'
[]

[Outputs]
  file_base = out
  exodus = true
[]

Input Parameters
Input Files

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access