SparsityBasedContactConstraint

under construction:Undocumented Class

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


# SparsityBasedContactConstraint

!syntax description /Constraints/SparsityBasedContactConstraint

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Constraints/SparsityBasedContactConstraint

!syntax inputs /Constraints/SparsityBasedContactConstraint

!syntax children /Constraints/SparsityBasedContactConstraint

!syntax description /Constraints/SparsityBasedContactConstraint

Input Parameters

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

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.
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
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_meshFalseWhether 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:False
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

Child Objects

modules/contact/include/constraints/GluedContactConstraint.h

modules/contact/include/constraints/GluedContactConstraint.h

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "SparsityBasedContactConstraint.h"

// Forward Declarations
class GluedContactConstraint;
enum class ContactModel;
enum class ContactFormulation;

template <>
InputParameters validParams<GluedContactConstraint>();

/**
 * A GluedContactConstraint forces the value of a variable to be the same on both sides of an
 * interface.
 */
class GluedContactConstraint : public SparsityBasedContactConstraint
{
public:
  GluedContactConstraint(const InputParameters & parameters);
  virtual ~GluedContactConstraint() {}

  virtual void timestepSetup();
  virtual void jacobianSetup();

  virtual void updateContactSet(bool beginning_of_step = false);

  virtual Real computeQpSlaveValue();

  virtual Real computeQpResidual(Moose::ConstraintType type);

  virtual Real computeQpJacobian(Moose::ConstraintJacobianType type);

  /**
   * Compute off-diagonal Jacobian entries
   * @param type The type of coupling
   * @param jvar The index of the coupled variable
   */
  virtual Real computeQpOffDiagJacobian(Moose::ConstraintJacobianType type, unsigned int jvar);

  bool shouldApply();

protected:
  const unsigned int _component;
  const ContactModel _model;
  const ContactFormulation _formulation;

  const Real _penalty;
  const Real _friction_coefficient;
  const Real _tension_release;
  bool _updateContactSet;

  NumericVector<Number> & _residual_copy;

  unsigned int _x_var;
  unsigned int _y_var;
  unsigned int _z_var;

  std::vector<unsigned int> _vars;

  MooseVariable * _nodal_area_var;
  SystemBase & _aux_system;
  const NumericVector<Number> * _aux_solution;
};

Input Parameters
Child Objects

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools