MechanicalContactConstraint

under construction:Undocumented Class

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


# MechanicalContactConstraint

!syntax description /Constraints/MechanicalContactConstraint

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Constraints/MechanicalContactConstraint

!syntax inputs /Constraints/MechanicalContactConstraint

!syntax children /Constraints/MechanicalContactConstraint

!syntax description /Constraints/MechanicalContactConstraint

Input Parameters

boundaryThe master boundary
C++ Type:BoundaryName
Options:
Description:The master boundary
componentAn integer corresponding to the direction the variable this kernel acts in. (0 for x, 1 for y, 2 for z)
C++ Type:unsigned int
Options:
Description:An integer corresponding to the direction the variable this kernel acts in. (0 for x, 1 for y, 2 for z)
masterThe boundary ID associated with the master side
C++ Type:BoundaryName
Options:
Description:The boundary ID associated with the master side
master_variableThe variable on the master side of the domain
C++ Type:std::vector
Options:
Description:The variable on the master side of the domain
nodal_areaThe nodal area
C++ Type:std::vector
Options:
Description:The nodal area
slaveThe slave boundary
C++ Type:BoundaryName
Options:
Description:The slave boundary
variableThe name of the variable that this constraint is applied to.
C++ Type:NonlinearVariableName
Options:
Description:The name of the variable that this constraint is applied to.

Required Parameters

al_frictional_force_toleranceThe tolerance of the frictional force for augmented Lagrangian method.
C++ Type:double
Options:
Description:The tolerance of the frictional force for augmented Lagrangian method.
al_incremental_slip_toleranceThe tolerance of the incremental slip for augmented Lagrangian method.
C++ Type:double
Options:
Description:The tolerance of the incremental slip for augmented Lagrangian method.
al_penetration_toleranceThe tolerance of the penetration for augmented Lagrangian method.
C++ Type:double
Options:
Description:The tolerance of the penetration for augmented Lagrangian method.
capture_tolerance0Normal distance from surface within which nodes are captured
Default:0
C++ Type:double
Options:
Description:Normal distance from surface within which nodes are captured
connected_slave_nodes_jacobianTrueWhether to include jacobian entries coupling nodes connected to slave nodes.
Default:True
C++ Type:bool
Options:
Description:Whether to include jacobian entries coupling nodes connected to slave nodes.
disp_xThe x displacement
C++ Type:std::vector
Options:
Description:The x displacement
disp_yThe y displacement
C++ Type:std::vector
Options:
Description:The y displacement
disp_zThe z displacement
C++ Type:std::vector
Options:
Description:The z displacement
displacementsThe displacements appropriate for the simulation geometry and coordinate system
C++ Type:std::vector
Options:
Description:The displacements appropriate for the simulation geometry and coordinate system
execute_onLINEARThe 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:LINEAR
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.
formulationkinematicThe contact formulation
Default:kinematic
C++ Type:MooseEnum
Options:kinematic penalty augmented_lagrange tangential_penalty mortar
Description:The contact formulation
friction_coefficient0The friction coefficient
Default:0
C++ Type:double
Options:
Description:The friction coefficient
master_slave_jacobianTrueWhether to include jacobian entries coupling master and slave nodes.
Default:True
C++ Type:bool
Options:
Description:Whether to include jacobian entries coupling master and slave nodes.
modelfrictionlessThe contact model to use
Default:frictionless
C++ Type:MooseEnum
Options:frictionless glued coulomb
Description:The contact model to use
non_displacement_variables_jacobianTrueWhether to include jacobian entries coupling with variables that are not displacement variables.
Default:True
C++ Type:bool
Options:
Description:Whether to include jacobian entries coupling with variables that are not displacement variables.
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
C++ Type:MooseEnum
Options:edge_based nodal_normal_based
Description:Method to use to smooth normals
normalize_penaltyFalseWhether to normalize the penalty parameter with the nodal area for penalty contact.
Default:False
C++ Type:bool
Options:
Description:Whether to normalize the penalty parameter with the nodal area for penalty contact.
orderFIRSTThe finite element order: FIRST, SECOND, etc.
Default:FIRST
C++ Type:MooseEnum
Options:CONSTANT FIRST SECOND THIRD FOURTH
Description:The finite element order: FIRST, SECOND, etc.
penalty1e+08The penalty to apply. This can vary depending on the stiffness of your materials
Default:1e+08
C++ Type:double
Options:
Description:The penalty to apply. This can vary depending on the stiffness of your materials
print_contact_nodesFalseWhether to print the number of nodes in contact.
Default:False
C++ Type:bool
Options:
Description:Whether to print the number of nodes in contact.
stick_lock_iterations4294967295Number of times permitted to switch between sticking and slipping in a solution before locking node in a sticked state.
Default:4294967295
C++ Type:unsigned int
Options:
Description:Number of times permitted to switch between sticking and slipping in a solution before locking node in a sticked state.
stick_unlock_factor1.5Factor by which frictional capacity must be exceeded to permit stick-locked node to slip again.
Default:1.5
C++ Type:double
Options:
Description:Factor by which frictional capacity must be exceeded to permit stick-locked node to slip again.
tangential_toleranceTangential distance to extend edges of contact surfaces
C++ Type:double
Options:
Description:Tangential distance to extend edges of contact surfaces
tension_release0Tension release threshold. A node in contact will not be released if its tensile load is below this value. No tension release if negative.
Default:0
C++ Type:double
Options:
Description:Tension release threshold. A node in contact will not be released if its tensile load is below this value. No tension release if negative.

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.
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
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
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 Parameters

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools