SlaveConstraint

under construction:Undocumented Class

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


# SlaveConstraint

!syntax description /DiracKernels/SlaveConstraint

## Overview

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

## Example Input File Syntax

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

!syntax parameters /DiracKernels/SlaveConstraint

!syntax inputs /DiracKernels/SlaveConstraint

!syntax children /DiracKernels/SlaveConstraint

!syntax description /DiracKernels/SlaveConstraint

Input Parameters

  • boundaryThe slave boundary

    C++ Type:BoundaryName

    Options:

    Description:The slave 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 master boundary

    C++ Type:BoundaryName

    Options:

    Description:The master boundary

  • nodal_areaThe nodal area

    C++ Type:std::vector

    Options:

    Description:The nodal area

  • variableThe name of the variable that this kernel operates on

    C++ Type:NonlinearVariableName

    Options:

    Description:The name of the variable that this kernel operates on

Required Parameters

  • 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

  • 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

  • modelfrictionlessThe contact model to use

    Default:frictionless

    C++ Type:MooseEnum

    Options:frictionless glued coulomb

    Description:The contact model to use

  • 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

  • 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

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • drop_duplicate_pointsTrueBy default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.

    Default:True

    C++ Type:bool

    Options:

    Description:By default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.

  • 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 Files