XFEMSingleVariableConstraint

under construction:Undocumented Class

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


# XFEMSingleVariableConstraint

!syntax description /Constraints/XFEMSingleVariableConstraint

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Constraints/XFEMSingleVariableConstraint

!syntax inputs /Constraints/XFEMSingleVariableConstraint

!syntax children /Constraints/XFEMSingleVariableConstraint

!syntax description /Constraints/XFEMSingleVariableConstraint

Input Parameters

  • 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

  • alpha100Stabilization parameter in Nitsche's formulation and penalty factor in the Penalty Method. In Nitsche's formulation this should be as small as possible while the method is still stable; while in the Penalty Method you want this to be quite large (e.g. 1e6).

    Default:100

    C++ Type:double

    Options:

    Description:Stabilization parameter in Nitsche's formulation and penalty factor in the Penalty Method. In Nitsche's formulation this should be as small as possible while the method is still stable; while in the Penalty Method you want this to be quite large (e.g. 1e6).

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

  • geometric_cut_userobjectName of GeometricCutUserObject associated with this constraint.

    C++ Type:UserObjectName

    Options:

    Description:Name of GeometricCutUserObject associated with this constraint.

  • interface_id0The id of the interface.

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The id of the interface.

  • jump0Jump at the interface. Can be a Real or FunctionName.

    Default:0

    C++ Type:FunctionName

    Options:

    Description:Jump at the interface. Can be a Real or FunctionName.

  • jump_flux0Flux jump at the interface. Can be a Real or FunctionName.

    Default:0

    C++ Type:FunctionName

    Options:

    Description:Flux jump at the interface. Can be a Real or FunctionName.

  • use_penaltyFalseUse the Penalty instead of Nitsche (Nitsche only works for simple diffusion problems).

    Default:False

    C++ Type:bool

    Options:

    Description:Use the Penalty instead of Nitsche (Nitsche only works for simple diffusion problems).

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

Input Files