MultiDContactConstraint

under construction:Undocumented Class

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


# MultiDContactConstraint

!syntax description /Constraints/MultiDContactConstraint

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Constraints/MultiDContactConstraint

!syntax inputs /Constraints/MultiDContactConstraint

!syntax children /Constraints/MultiDContactConstraint

!syntax description /Constraints/MultiDContactConstraint

Input Parameters

  • 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

  • slaveThe boundary ID associated with the slave side

    C++ Type:BoundaryName

    Options:

    Description:The boundary ID associated with the slave side

  • 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

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

  • jacobian_updateFalseWhether or not to update the 'in contact' list every jacobian evaluation (by default it will happen once per timestep

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not to update the 'in contact' list every jacobian evaluation (by default it will happen once per timestep

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

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

  • 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