GeneralizedPlaneStrainAction

Set up the GeneralizedPlaneStrain environment

Description

This action simplifies the input syntax for creating a generalized plane strain model. It creates the objects associated with the scalar out-of-plane strain variable and the out-of-plane equilibrium equation. Use "use_automatic_differentiation" to select the AD construction path.

Constructed Objects

In legacy mode, the action creates the same UserObject, ScalarKernel, and off-diagonal Kernel objects used by existing generalized plane strain inputs.

Table 1: Legacy objects created by GeneralizedPlaneStrainAction

Object	Purpose
Generalized Plane Strain Off Diagonal	Couples the in-plane displacement variables and the scalar out-of-plane strain variable in the off-diagonal Jacobian.
Generalized Plane Strain Scalar Kernel	Assembles the scalar out-of-plane equilibrium residual.
Generalized Plane Strain User Object	Computes the residual and diagonal Jacobian data used by the scalar kernel.

In AD mode, the action creates exactly one ADGeneralizedPlaneStrain object. The legacy UserObject, ScalarKernel, and off-diagonal Kernel objects are not created because ADKernelScalarBase assembles the scalar residual and its couplings through automatic differentiation. When "use_displaced_mesh" is true, the AD kernel uses displaced-mesh quadrature weights for that scalar assembly.

Table 2: AD objects created by GeneralizedPlaneStrainAction

Object	Purpose
ADGeneralizedPlaneStrain	Assembles the scalar out-of-plane equilibrium residual and AD couplings.

The action also creates the scalar out-of-plane strain variable when it is missing. The automatically created scalar variable is a FIRST order nonlinear scalar variable in nonlinear system nl0. If the named scalar variable already exists in nl0, the action reuses it. A field variable or a scalar variable in a different nonlinear system with the same name is rejected.

Out-of-Plane Pressure

The residual assembled for the scalar out-of-plane strain is $var element = document.getElementById("moose-equation-9dc72e16-8556-42c4-9f85-3fa36bbf4ef4");katex.render(" R_s = \\int_A \\left( \\sigma_{oo} + p_o \\right) dA = 0,", element, {displayMode:true,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ where $var element = document.getElementById("moose-equation-6677cff7-6277-4671-876d-2d700a448893");katex.render("p_o", element, {displayMode:false,throwOnError:false,macros:{"\\eqc":"\\,,","\\eqp":"\\,.","\\pd":"\\frac{\\partial #1}{\\partial #2}","\\pr":"\\left(#1\\right)","\\ddt":"\\frac{d #1}{d t}"}});$ is the out-of-plane pressure. Positive pressure is applied toward the body. The pressure may be supplied with "out_of_plane_pressure_function" or with "out_of_plane_pressure_material". In AD mode, the pressure material is read as a regular Real material property, so it does not add derivatives to the scalar equation.

Generalized Plane Strain and Reference Residual

Generalized plane strain problems may use ReferenceResidualProblem. In this case, a reference scalar variable is needed to correspond with the scalar strain variable.

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  type = ReferenceResidualProblem
  extra_tag_vectors = 'ref'
  reference_vector = 'ref'
[]

The reference scalar variable is set using the AuxScalarKernel Generalized Plane Strain Reference Residual using the Generalized Plane Strain UserObject.

[AuxScalarKernels<<<{"href": "../../syntax/AuxScalarKernels/index.html"}>>>]
  [./gps_ref_res]
    type = GeneralizedPlaneStrainReferenceResidual<<<{"description": "Generalized Plane Strain Reference Residual Scalar Kernel", "href": "../auxkernels/GeneralizedPlaneStrainReferenceResidual.html"}>>>
    variable<<<{"description": "The name of the variable that this kernel operates on"}>>> = saved_zz
    generalized_plane_strain<<<{"description": "The name of the GeneralizedPlaneStrainUserObject"}>>> = gps_GeneralizedPlaneStrainUserObject
  [../]
[]

Example Input Syntax

The following test-spec block shows a modern QuasiStatic generalized plane strain input run in AD mode.

  [generalized_plane_strain_small_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_small.i'
    exodiff = 'generalized_plane_strain_small_out.e'
    custom_cmp = 'generalized.exodiff'
    prereq = generalized_plane_strain_small
    cli_args = 'Physics/SolidMechanics/QuasiStatic/all/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall support an automatic-differentiation generalized plane strain mechanics solution'
    design = 'ADComputePlaneSmallStrain.md'
  []

The following input shows a standalone [Physics/SolidMechanics/GeneralizedPlaneStrain] action block. The action creates the missing scalar out-of-plane strain variable in AD mode.

[Physics<<<{"href": "../../syntax/Physics/index.html"}>>>]
  [SolidMechanics<<<{"href": "../../syntax/Physics/SolidMechanics/index.html"}>>>]
    [GeneralizedPlaneStrain<<<{"href": "../../syntax/Physics/SolidMechanics/GeneralizedPlaneStrain/index.html"}>>>]
      [gps]
        use_automatic_differentiation<<<{"description": "Use automatic differentiation to assemble the generalized plane strain equation and its coupling terms"}>>> = true
        use_displaced_mesh<<<{"description": "Whether to use displaced mesh"}>>> = true
        displacements<<<{"description": "The displacement variables"}>>> = 'disp_x disp_y'
        scalar_out_of_plane_strain<<<{"description": "Scalar variable for the out-of-plane strain (in y direction for 1D Axisymmetric or in z direction for 2D Cartesian problems)"}>>> = scalar_strain_zz
        out_of_plane_pressure_function<<<{"description": "Function used to prescribe pressure (applied toward the body) in the out-of-plane direction (y for 1D Axisymmetric or z for 2D Cartesian problems)"}>>> = traction_function
        pressure_factor<<<{"description": "Scale factor applied to prescribed out-of-plane pressure (both material and function)"}>>> = 1e5
      []
    []
  []
[]

Input Parameters

displacementsThe displacement variables
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacement variables
scalar_out_of_plane_strainScalar variable for the out-of-plane strain (in y direction for 1D Axisymmetric or in z direction for 2D Cartesian problems)
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Scalar variable for the out-of-plane strain (in y direction for 1D Axisymmetric or in z direction for 2D Cartesian problems)

Required Parameters

absolute_value_vector_tagsThe tag names for extra vectors that the absolute value of the residual should be accumulated into
C++ Type:std::vector<TagName>
Controllable:No
Description:The tag names for extra vectors that the absolute value of the residual should be accumulated into
active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified only the blocks named will be visited and made active
base_nameMaterial property base name
C++ Type:std::string
Controllable:No
Description:Material property base name
blockThe list of ids of the blocks (subdomain) that the GeneralizedPlaneStrain kernels will be applied to
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of ids of the blocks (subdomain) that the GeneralizedPlaneStrain kernels will be applied to
extra_vector_tagsThe tag names for extra vectors that residual data should be saved into
C++ Type:std::vector<TagName>
Controllable:No
Description:The tag names for extra vectors that residual data should be saved into
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
out_of_plane_directionzThe direction of the out-of-plane strain.
Default:z
C++ Type:MooseEnum
Options:x, y, z
Controllable:No
Description:The direction of the out-of-plane strain.
out_of_plane_pressure_functionFunction used to prescribe pressure (applied toward the body) in the out-of-plane direction (y for 1D Axisymmetric or z for 2D Cartesian problems)
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Function used to prescribe pressure (applied toward the body) in the out-of-plane direction (y for 1D Axisymmetric or z for 2D Cartesian problems)
out_of_plane_pressure_material0Material used to prescribe pressure (applied toward the body) in the out-of-plane direction
Default:0
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Material used to prescribe pressure (applied toward the body) in the out-of-plane direction
pressure_factorScale factor applied to prescribed out-of-plane pressure (both material and function)
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Scale factor applied to prescribed out-of-plane pressure (both material and function)
temperatureThe temperature variable
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The temperature variable
use_automatic_differentiationFalseUse automatic differentiation to assemble the generalized plane strain equation and its coupling terms
Default:False
C++ Type:bool
Controllable:No
Description:Use automatic differentiation to assemble the generalized plane strain equation and its coupling terms
use_displaced_meshFalseWhether to use displaced mesh
Default:False
C++ Type:bool
Controllable:No
Description:Whether to use displaced mesh

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.

Advanced Parameters

(modules/combined/test/tests/generalized_plane_strain_tm_contact/out_of_plane_pressure.i)

# Tests for application of out-of-plane pressure in generalized plane strain.

[Mesh]
  type = GeneratedMesh
  nx = 2
  ny = 2
  dim = 2
  xmin = 0.0
  xmax = 1.0
  ymin = 0.0
  ymax = 1.0
  displacements = 'disp_x disp_y'
[]

[Problem]
  type = ReferenceResidualProblem
  extra_tag_vectors = 'ref'
  reference_vector = 'ref'
[]

[Variables]
  [./disp_x]
  [../]
  [./disp_y]
  [../]
  [./scalar_strain_zz]
    order = FIRST
    family = SCALAR
  [../]
[]

[AuxVariables]
  [./saved_x]
    order = FIRST
    family = LAGRANGE
  [../]
  [./saved_y]
    order = FIRST
    family = LAGRANGE
  [../]
  [./saved_zz]
    order = FIRST
    family = SCALAR
  [../]

  [./stress_xx]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./stress_xy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./stress_yy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./stress_zz]
    order = CONSTANT
    family = MONOMIAL
  [../]

  [./strain_xx]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./strain_xy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./strain_yy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./strain_zz]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Postprocessors]
  [./react_z]
    type = MaterialTensorIntegral
    rank_two_tensor = stress
    index_i = 2
    index_j = 2
  [../]
[]

[Physics]
  [./SolidMechanics]
    [./GeneralizedPlaneStrain]
      [./gps]
        displacements = 'disp_x disp_y'
        scalar_out_of_plane_strain = scalar_strain_zz
        out_of_plane_pressure = traction_function
        factor = 1e5
      [../]
    [../]
  [../]
[]

[Kernels]
  [./TensorMechanics]
    use_displaced_mesh = true
    displacements = 'disp_x disp_y'
    save_in = 'saved_x saved_y'
    extra_vector_tags = 'ref'
  [../]
[]

[AuxScalarKernels]
  [./gps_ref_res]
    type = GeneralizedPlaneStrainReferenceResidual
    variable = saved_zz
    generalized_plane_strain = gps_GeneralizedPlaneStrainUserObject
  [../]
[]

[AuxKernels]
  [./stress_xx]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_xx
    index_i = 0
    index_j = 0
  [../]
  [./stress_xy]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_xy
    index_i = 0
    index_j = 1
  [../]
  [./stress_yy]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_yy
    index_i = 1
    index_j = 1
  [../]
  [./stress_zz]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_zz
    index_i = 2
    index_j = 2
  [../]

  [./strain_xx]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_xx
    index_i = 0
    index_j = 0
  [../]
  [./strain_xy]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_xy
    index_i = 0
    index_j = 1
  [../]
  [./strain_yy]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_yy
    index_i = 1
    index_j = 1
  [../]
  [./strain_zz]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_zz
    index_i = 2
    index_j = 2
  [../]
[]

[Functions]
  [./traction_function]
    type = PiecewiseLinear
    x = '0  2'
    y = '0  1'
  [../]
[]

[BCs]
  [./leftx]
    type = DirichletBC
    boundary = left
    variable = disp_x
    value = 0.0
  [../]
  [./bottomy]
    type = DirichletBC
    boundary = bottom
    variable = disp_y
    value = 0.0
  [../]
[]

[Materials]
  [./elastic_tensor]
    type = ComputeIsotropicElasticityTensor
    poissons_ratio = 0.3
    youngs_modulus = 1e6
  [../]
  [./strain]
    type = ComputePlaneSmallStrain
    displacements = 'disp_x disp_y'
    scalar_out_of_plane_strain = scalar_strain_zz
  [../]
  [./stress]
    type = ComputeLinearElasticStress
  [../]
[]

[Executioner]
  type = Transient

  solve_type = PJFNK
  line_search = none

# controls for linear iterations
  l_max_its = 100
  l_tol = 1e-4

# controls for nonlinear iterations
  nl_max_its = 15
  nl_rel_tol = 1e-14
  nl_abs_tol = 1e-11

# time control
  start_time = 0.0
  dt = 1.0
  dtmin = 1.0
  end_time = 2.0
  num_steps = 5000
[]

[Outputs]
  exodus = true
[]

(modules/combined/test/tests/generalized_plane_strain_tm_contact/out_of_plane_pressure.i)

# Tests for application of out-of-plane pressure in generalized plane strain.

[Mesh]
  type = GeneratedMesh
  nx = 2
  ny = 2
  dim = 2
  xmin = 0.0
  xmax = 1.0
  ymin = 0.0
  ymax = 1.0
  displacements = 'disp_x disp_y'
[]

[Problem]
  type = ReferenceResidualProblem
  extra_tag_vectors = 'ref'
  reference_vector = 'ref'
[]

[Variables]
  [./disp_x]
  [../]
  [./disp_y]
  [../]
  [./scalar_strain_zz]
    order = FIRST
    family = SCALAR
  [../]
[]

[AuxVariables]
  [./saved_x]
    order = FIRST
    family = LAGRANGE
  [../]
  [./saved_y]
    order = FIRST
    family = LAGRANGE
  [../]
  [./saved_zz]
    order = FIRST
    family = SCALAR
  [../]

  [./stress_xx]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./stress_xy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./stress_yy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./stress_zz]
    order = CONSTANT
    family = MONOMIAL
  [../]

  [./strain_xx]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./strain_xy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./strain_yy]
    order = CONSTANT
    family = MONOMIAL
  [../]
  [./strain_zz]
    order = CONSTANT
    family = MONOMIAL
  [../]
[]

[Postprocessors]
  [./react_z]
    type = MaterialTensorIntegral
    rank_two_tensor = stress
    index_i = 2
    index_j = 2
  [../]
[]

[Physics]
  [./SolidMechanics]
    [./GeneralizedPlaneStrain]
      [./gps]
        displacements = 'disp_x disp_y'
        scalar_out_of_plane_strain = scalar_strain_zz
        out_of_plane_pressure = traction_function
        factor = 1e5
      [../]
    [../]
  [../]
[]

[Kernels]
  [./TensorMechanics]
    use_displaced_mesh = true
    displacements = 'disp_x disp_y'
    save_in = 'saved_x saved_y'
    extra_vector_tags = 'ref'
  [../]
[]

[AuxScalarKernels]
  [./gps_ref_res]
    type = GeneralizedPlaneStrainReferenceResidual
    variable = saved_zz
    generalized_plane_strain = gps_GeneralizedPlaneStrainUserObject
  [../]
[]

[AuxKernels]
  [./stress_xx]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_xx
    index_i = 0
    index_j = 0
  [../]
  [./stress_xy]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_xy
    index_i = 0
    index_j = 1
  [../]
  [./stress_yy]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_yy
    index_i = 1
    index_j = 1
  [../]
  [./stress_zz]
    type = RankTwoAux
    rank_two_tensor = stress
    variable = stress_zz
    index_i = 2
    index_j = 2
  [../]

  [./strain_xx]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_xx
    index_i = 0
    index_j = 0
  [../]
  [./strain_xy]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_xy
    index_i = 0
    index_j = 1
  [../]
  [./strain_yy]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_yy
    index_i = 1
    index_j = 1
  [../]
  [./strain_zz]
    type = RankTwoAux
    rank_two_tensor = total_strain
    variable = strain_zz
    index_i = 2
    index_j = 2
  [../]
[]

[Functions]
  [./traction_function]
    type = PiecewiseLinear
    x = '0  2'
    y = '0  1'
  [../]
[]

[BCs]
  [./leftx]
    type = DirichletBC
    boundary = left
    variable = disp_x
    value = 0.0
  [../]
  [./bottomy]
    type = DirichletBC
    boundary = bottom
    variable = disp_y
    value = 0.0
  [../]
[]

[Materials]
  [./elastic_tensor]
    type = ComputeIsotropicElasticityTensor
    poissons_ratio = 0.3
    youngs_modulus = 1e6
  [../]
  [./strain]
    type = ComputePlaneSmallStrain
    displacements = 'disp_x disp_y'
    scalar_out_of_plane_strain = scalar_strain_zz
  [../]
  [./stress]
    type = ComputeLinearElasticStress
  [../]
[]

[Executioner]
  type = Transient

  solve_type = PJFNK
  line_search = none

# controls for linear iterations
  l_max_its = 100
  l_tol = 1e-4

# controls for nonlinear iterations
  nl_max_its = 15
  nl_rel_tol = 1e-14
  nl_abs_tol = 1e-11

# time control
  start_time = 0.0
  dt = 1.0
  dtmin = 1.0
  end_time = 2.0
  num_steps = 5000
[]

[Outputs]
  exodus = true
[]

(modules/solid_mechanics/test/tests/generalized_plane_strain/tests)

[Tests]
  issues = '#5042'
  parallel_scheduling = true
  [plane_strain]
    type = 'Exodiff'
    input = 'plane_strain.i'
    exodiff = 'plane_strain_out.e'
    custom_cmp = 'plane_strain.exodiff'
    requirement = 'The system shall support a traditional plane strain mechanics solution'
    design = 'ComputePlaneSmallStrain.md'
  []
  [plane_strain_prescribed]
    type = 'Exodiff'
    input = 'plane_strain_prescribed.i'
    exodiff = 'plane_strain_prescribed_out.e'
    custom_cmp = 'plane_strain.exodiff'
    requirement = 'The system shall support a traditional plane strain mechanics solution where the out-of-plane strain is prescribed'
    design = 'ComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_small]
    type = 'Exodiff'
    input = 'generalized_plane_strain_small.i'
    exodiff = 'generalized_plane_strain_small_out.e'
    custom_cmp = 'generalized.exodiff'
    requirement = 'The system shall support a generalized plane strain mechanics solution'
    design = 'ComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_small_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_small.i'
    exodiff = 'generalized_plane_strain_small_out.e'
    custom_cmp = 'generalized.exodiff'
    prereq = generalized_plane_strain_small
    cli_args = 'Physics/SolidMechanics/QuasiStatic/all/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall support an automatic-differentiation generalized plane strain mechanics solution'
    design = 'ADComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_small_ad_jacobian]
    type = 'PetscJacobianTester'
    input = 'generalized_plane_strain_small.i'
    run_sim = 'True'
    ratio_tol = 1e-7
    difference_tol = 1e-2
    cli_args = 'Physics/SolidMechanics/QuasiStatic/all/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall compute the Jacobian for an automatic-differentiation generalized plane strain mechanics solution'
    design = 'ADComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_ref_resid_absolute_value_vector_tags]
    type = 'Exodiff'
    input = 'generalized_plane_strain_ref_resid.i'
    exodiff = 'generalized_plane_strain_ref_resid_out.e'
    custom_cmp = 'generalized.exodiff'
    requirement = 'The system shall support a generalized plane strain mechanics solution using the reference residual approach to check solution convergence of the field and scalar variables when the reference vector is constructed using absolute value vector tags.'
    design = 'ComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_ref_resid_absolute_value_vector_tags_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_ref_resid.i'
    exodiff = 'generalized_plane_strain_ref_resid_out.e'
    custom_cmp = 'generalized.exodiff'
    prereq = generalized_plane_strain_ref_resid_absolute_value_vector_tags
    cli_args = 'Physics/SolidMechanics/QuasiStatic/all/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall support an automatic-differentiation generalized plane strain mechanics solution using the reference residual approach to check solution convergence of the field and scalar variables when the reference vector is constructed using absolute value vector tags.'
    design = 'ADComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_ref_resid_extra_vector_tags]
    prereq = generalized_plane_strain_ref_resid_absolute_value_vector_tags
    type = 'Exodiff'
    input = 'generalized_plane_strain_ref_resid.i'
    cli_args = "Physics/SolidMechanics/QuasiStatic/all/absolute_value_vector_tags='' "
               "Physics/SolidMechanics/QuasiStatic/all/extra_vector_tags='ref' "
               "Outputs/file_base=generalized_plane_strain_ref_resid_extra_vector_tags_out"
    exodiff = 'generalized_plane_strain_ref_resid_extra_vector_tags_out.e'
    custom_cmp = 'generalized.exodiff'
    requirement = 'The system shall support a generalized plane strain mechanics solution using the reference residual approach to check solution convergence of the field and scalar variables when the reference vector is constructed using unbalanced kernel contributions.'
    design = 'ComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_ref_resid_extra_vector_tags_ad]
    prereq = 'generalized_plane_strain_ref_resid_extra_vector_tags generalized_plane_strain_ref_resid_absolute_value_vector_tags_ad'
    type = 'Exodiff'
    input = 'generalized_plane_strain_ref_resid.i'
    cli_args = "Physics/SolidMechanics/QuasiStatic/all/use_automatic_differentiation=true "
               "Physics/SolidMechanics/QuasiStatic/all/absolute_value_vector_tags='' "
               "Physics/SolidMechanics/QuasiStatic/all/extra_vector_tags='ref' "
               "Postprocessors/react_z/type=ADMaterialTensorIntegral "
               "Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor "
               "Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain "
               "Materials/stress/type=ADComputeLinearElasticStress "
               "Outputs/file_base=generalized_plane_strain_ref_resid_extra_vector_tags_out"
    exodiff = 'generalized_plane_strain_ref_resid_extra_vector_tags_out.e'
    custom_cmp = 'generalized.exodiff'
    requirement = 'The system shall support an automatic-differentiation generalized plane strain mechanics solution using the reference residual approach to check solution convergence of the field and scalar variables when the reference vector is constructed using unbalanced kernel contributions.'
    design = 'ADComputePlaneSmallStrain.md'
  []
  [generalized_plane_strain_increment]
    type = 'Exodiff'
    input = 'generalized_plane_strain_increment.i'
    exodiff = 'generalized_plane_strain_increment_out.e'
    custom_cmp = 'generalized.exodiff'
    requirement = 'The system shall support a generalized plane strain mechanics solution with incremental strain'
    design = 'ComputePlaneIncrementalStrain.md'
  []
  [generalized_plane_strain_increment_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_increment.i'
    exodiff = 'generalized_plane_strain_increment_out.e'
    custom_cmp = 'generalized.exodiff'
    prereq = generalized_plane_strain_increment
    cli_args = 'Physics/SolidMechanics/QuasiStatic/all/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeStrainIncrementBasedStress'
    requirement = 'The system shall support an automatic-differentiation generalized plane strain mechanics solution with incremental strain'
    design = 'ADComputePlaneIncrementalStrain.md'
  []
  [generalized_plane_strain_finite]
    type = 'Exodiff'
    input = 'generalized_plane_strain_finite.i'
    exodiff = 'generalized_plane_strain_finite_out.e'
    custom_cmp = 'generalized.exodiff'
    requirement = 'The system shall support a generalized plane strain mechanics solution with finite strain'
    design = 'ComputePlaneFiniteStrain.md'
  []
  [generalized_plane_strain_finite_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_finite.i'
    exodiff = 'generalized_plane_strain_finite_out.e'
    custom_cmp = 'generalized.exodiff'
    prereq = generalized_plane_strain_finite
    cli_args = 'Physics/SolidMechanics/QuasiStatic/all/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeFiniteStrainElasticStress'
    requirement = 'The system shall support an automatic-differentiation generalized plane strain mechanics solution with finite strain'
    design = 'ADComputePlaneFiniteStrain.md'
  []
  [generalized_plane_strain_squares]
    type = 'Exodiff'
    input = 'generalized_plane_strain_squares.i'
    exodiff = 'generalized_plane_strain_squares_out.e'
    abs_zero = 1e-7
    requirement = 'The system shall support setting up a generalized plane strain problem through an action'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [generalized_plane_strain_squares_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_squares.i'
    exodiff = 'generalized_plane_strain_squares_out.e'
    prereq = generalized_plane_strain_squares
    abs_zero = 1e-7
    cli_args = 'Physics/SolidMechanics/GeneralizedPlaneStrain/gps1/use_automatic_differentiation=true '
               'Physics/SolidMechanics/GeneralizedPlaneStrain/gps2/use_automatic_differentiation=true '
               'Kernels/SolidMechanics/use_automatic_differentiation=true '
               'Postprocessors/react_z1/type=ADMaterialTensorIntegral '
               'Postprocessors/react_z2/type=ADMaterialTensorIntegral '
               'AuxKernels/stress_xx/type=ADRankTwoAux AuxKernels/stress_xy/type=ADRankTwoAux '
               'AuxKernels/stress_yy/type=ADRankTwoAux AuxKernels/stress_zz/type=ADRankTwoAux '
               'AuxKernels/strain_xx/type=ADRankTwoAux AuxKernels/strain_xy/type=ADRankTwoAux '
               'AuxKernels/strain_yy/type=ADRankTwoAux AuxKernels/aux_strain_zz/type=ADRankTwoAux '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/strain1/type=ADComputePlaneSmallStrain '
               'Materials/strain2/type=ADComputePlaneSmallStrain '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall support setting up an automatic-differentiation generalized plane strain problem through an action'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [generalized_plane_strain_squares_ad_jacobian]
    type = 'PetscJacobianTester'
    input = 'generalized_plane_strain_squares.i'
    run_sim = 'True'
    ratio_tol = 1e-7
    difference_tol = 1e0
    cli_args = 'Physics/SolidMechanics/GeneralizedPlaneStrain/gps1/use_automatic_differentiation=true '
               'Physics/SolidMechanics/GeneralizedPlaneStrain/gps2/use_automatic_differentiation=true '
               'Kernels/SolidMechanics/use_automatic_differentiation=true '
               'Postprocessors/react_z1/type=ADMaterialTensorIntegral '
               'Postprocessors/react_z2/type=ADMaterialTensorIntegral '
               'AuxKernels/stress_xx/type=ADRankTwoAux AuxKernels/stress_xy/type=ADRankTwoAux '
               'AuxKernels/stress_yy/type=ADRankTwoAux AuxKernels/stress_zz/type=ADRankTwoAux '
               'AuxKernels/strain_xx/type=ADRankTwoAux AuxKernels/strain_xy/type=ADRankTwoAux '
               'AuxKernels/strain_yy/type=ADRankTwoAux AuxKernels/aux_strain_zz/type=ADRankTwoAux '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/strain1/type=ADComputePlaneSmallStrain '
               'Materials/strain2/type=ADComputePlaneSmallStrain '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall compute the Jacobian for an automatic-differentiation generalized plane strain action with multiple action blocks'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [out_of_plane_pressure_function]
    type = 'Exodiff'
    input = 'out_of_plane_pressure.i'
    exodiff = 'out_of_plane_pressure_out.e'
    abs_zero = 1e-9
    requirement = 'The system shall support setting the out-of-plane pressure using a function for generalized plane strain problems'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [out_of_plane_pressure_function_ad]
    type = 'Exodiff'
    input = 'out_of_plane_pressure.i'
    exodiff = 'out_of_plane_pressure_out.e'
    prereq = out_of_plane_pressure_material
    abs_zero = 1e-9
    cli_args = 'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/use_automatic_differentiation=true '
               'Kernels/SolidMechanics/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'AuxKernels/stress_xx/type=ADRankTwoAux AuxKernels/stress_xy/type=ADRankTwoAux '
               'AuxKernels/stress_yy/type=ADRankTwoAux AuxKernels/stress_zz/type=ADRankTwoAux '
               'AuxKernels/strain_xx/type=ADRankTwoAux AuxKernels/strain_xy/type=ADRankTwoAux '
               'AuxKernels/strain_yy/type=ADRankTwoAux AuxKernels/strain_zz/type=ADRankTwoAux '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/strain/type=ADComputePlaneSmallStrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall support setting the out-of-plane pressure using a function for automatic-differentiation generalized plane strain problems'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [out_of_plane_pressure_material]
    type = 'Exodiff'
    input = 'out_of_plane_pressure.i'
    exodiff = 'out_of_plane_pressure_out.e'
    cli_args = 'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/out_of_plane_pressure_function=0 Physics/SolidMechanics/GeneralizedPlaneStrain/gps/out_of_plane_pressure_material=traction_material'
    abs_zero = 1e-9
    requirement = 'The system shall support setting the out-of-plane pressure using a material property for generalized plane strain problems'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#17250'
    prereq = out_of_plane_pressure_function
  []
  [out_of_plane_pressure_material_ad]
    type = 'Exodiff'
    input = 'out_of_plane_pressure.i'
    exodiff = 'out_of_plane_pressure_out.e'
    cli_args = 'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/use_automatic_differentiation=true '
               'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/out_of_plane_pressure_function=0 '
               'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/out_of_plane_pressure_material=traction_material '
               'Kernels/SolidMechanics/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'AuxKernels/stress_xx/type=ADRankTwoAux AuxKernels/stress_xy/type=ADRankTwoAux '
               'AuxKernels/stress_yy/type=ADRankTwoAux AuxKernels/stress_zz/type=ADRankTwoAux '
               'AuxKernels/strain_xx/type=ADRankTwoAux AuxKernels/strain_xy/type=ADRankTwoAux '
               'AuxKernels/strain_yy/type=ADRankTwoAux AuxKernels/strain_zz/type=ADRankTwoAux '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/strain/type=ADComputePlaneSmallStrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    abs_zero = 1e-9
    requirement = 'The system shall support setting the out-of-plane pressure using a material property for automatic-differentiation generalized plane strain problems'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#17250'
    prereq = out_of_plane_pressure_function_ad
  []
  [out_of_plane_pressure_material_ad_jacobian]
    type = 'PetscJacobianTester'
    input = 'out_of_plane_pressure.i'
    run_sim = 'True'
    ratio_tol = 1e-7
    difference_tol = 1e-1
    cli_args = 'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/use_automatic_differentiation=true '
               'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/out_of_plane_pressure_function=0 '
               'Physics/SolidMechanics/GeneralizedPlaneStrain/gps/out_of_plane_pressure_material=traction_material '
               'Kernels/SolidMechanics/use_automatic_differentiation=true '
               'Postprocessors/react_z/type=ADMaterialTensorIntegral '
               'AuxKernels/stress_xx/type=ADRankTwoAux AuxKernels/stress_xy/type=ADRankTwoAux '
               'AuxKernels/stress_yy/type=ADRankTwoAux AuxKernels/stress_zz/type=ADRankTwoAux '
               'AuxKernels/strain_xx/type=ADRankTwoAux AuxKernels/strain_xy/type=ADRankTwoAux '
               'AuxKernels/strain_yy/type=ADRankTwoAux AuxKernels/strain_zz/type=ADRankTwoAux '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/strain/type=ADComputePlaneSmallStrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall compute the Jacobian for automatic-differentiation generalized plane strain with material-property out-of-plane pressure'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#17250'
  []
  [generalized_plane_strain_scalar_vector]
    type = 'Exodiff'
    input = 'generalized_plane_strain_scalar_vector.i'
    exodiff = 'generalized_plane_strain_scalar_vector_out.e'
    prereq = 'generalized_plane_strain_squares'
    abs_zero = 1e-7
    allow_test_objects = true
    requirement = 'The system shall support listing all of the out-of-plane strain variables in the strain calculator'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [generalized_plane_strain_scalar_vector_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_scalar_vector.i'
    exodiff = 'generalized_plane_strain_scalar_vector_out.e'
    prereq = 'generalized_plane_strain_scalar_vector'
    abs_zero = 1e-7
    allow_test_objects = true
    cli_args = 'Physics/SolidMechanics/GeneralizedPlaneStrain/gps1/use_automatic_differentiation=true '
               'Physics/SolidMechanics/GeneralizedPlaneStrain/gps2/use_automatic_differentiation=true '
               'Kernels/SolidMechanics/use_automatic_differentiation=true '
               'Postprocessors/react_z1/type=ADMaterialTensorIntegral '
               'Postprocessors/react_z2/type=ADMaterialTensorIntegral '
               'AuxKernels/stress_xx/type=ADRankTwoAux AuxKernels/stress_xy/type=ADRankTwoAux '
               'AuxKernels/stress_yy/type=ADRankTwoAux AuxKernels/stress_zz/type=ADRankTwoAux '
               'AuxKernels/strain_xx/type=ADRankTwoAux AuxKernels/strain_xy/type=ADRankTwoAux '
               'AuxKernels/strain_yy/type=ADRankTwoAux AuxKernels/aux_strain_zz/type=ADRankTwoAux '
               'Materials/elastic_tensor/type=ADComputeIsotropicElasticityTensor '
               'Materials/strain1/type=ADComputePlaneSmallStrain '
               'Materials/thermal_strain/type=ADComputeThermalExpansionEigenstrain '
               'Materials/stress/type=ADComputeLinearElasticStress'
    requirement = 'The system shall support listing all of the out-of-plane strain variables in the automatic-differentiation strain calculator'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [generalized_plane_strain_auto_scalar]
    type = 'Exodiff'
    input = 'out_of_plane_pressure.i'
    cli_args = "Variables/inactive=scalar_strain_zz
                Problem/nl_sys_names=mechanics
                Variables/disp_x/solver_sys=mechanics Variables/disp_y/solver_sys=mechanics"
    exodiff = 'out_of_plane_pressure_out.e'
    prereq = 'out_of_plane_pressure_material_ad'
    abs_zero = 1e-9
    requirement = 'The system shall support automatic creation of the scalar out-of-plane strain variable for legacy generalized plane strain problems'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
  [generalized_plane_strain_auto_scalar_ad]
    type = 'Exodiff'
    input = 'generalized_plane_strain_auto_scalar.i'
    exodiff = 'out_of_plane_pressure_out.e'
    prereq = 'generalized_plane_strain_auto_scalar'
    abs_zero = 1e-9
    requirement = 'The system shall support automatic creation of the scalar out-of-plane strain variable for automatic-differentiation generalized plane strain problems'
    design = 'GeneralizedPlaneStrainAction.md'
    issues = '#7840'
  []
[]

(modules/solid_mechanics/test/tests/generalized_plane_strain/generalized_plane_strain_auto_scalar.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 2
    ny = 2
  []
  displacements = 'disp_x disp_y'
[]

[Problem]
  nl_sys_names = 'unused mechanics'
[]

[Variables]
  [unused]
    solver_sys = unused
    outputs = none
  []
  [disp_x]
    solver_sys = mechanics
  []
  [disp_y]
    solver_sys = mechanics
  []
[]

[AuxVariables]
  [saved_x]
    order = FIRST
    family = LAGRANGE
  []
  [saved_y]
    order = FIRST
    family = LAGRANGE
  []

  [stress_xx]
    order = CONSTANT
    family = MONOMIAL
  []
  [stress_xy]
    order = CONSTANT
    family = MONOMIAL
  []
  [stress_yy]
    order = CONSTANT
    family = MONOMIAL
  []
  [stress_zz]
    order = CONSTANT
    family = MONOMIAL
  []

  [strain_xx]
    order = CONSTANT
    family = MONOMIAL
  []
  [strain_xy]
    order = CONSTANT
    family = MONOMIAL
  []
  [strain_yy]
    order = CONSTANT
    family = MONOMIAL
  []
  [strain_zz]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[Postprocessors]
  [react_z]
    type = ADMaterialTensorIntegral
    rank_two_tensor = stress
    index_i = 2
    index_j = 2
  []
[]

[Physics]
  [SolidMechanics]
    [GeneralizedPlaneStrain]
      [gps]
        use_automatic_differentiation = true
        use_displaced_mesh = true
        displacements = 'disp_x disp_y'
        scalar_out_of_plane_strain = scalar_strain_zz
        out_of_plane_pressure_function = traction_function
        pressure_factor = 1e5
      []
    []
  []
[]

[Kernels]
  [unused]
    type = ADReaction
    variable = unused
  []
  [SolidMechanics]
    use_automatic_differentiation = true
    use_displaced_mesh = false
    displacements = 'disp_x disp_y'
    save_in = 'saved_x saved_y'
  []
[]

[AuxKernels]
  [stress_xx]
    type = ADRankTwoAux
    rank_two_tensor = stress
    variable = stress_xx
    index_i = 0
    index_j = 0
  []
  [stress_xy]
    type = ADRankTwoAux
    rank_two_tensor = stress
    variable = stress_xy
    index_i = 0
    index_j = 1
  []
  [stress_yy]
    type = ADRankTwoAux
    rank_two_tensor = stress
    variable = stress_yy
    index_i = 1
    index_j = 1
  []
  [stress_zz]
    type = ADRankTwoAux
    rank_two_tensor = stress
    variable = stress_zz
    index_i = 2
    index_j = 2
  []

  [strain_xx]
    type = ADRankTwoAux
    rank_two_tensor = total_strain
    variable = strain_xx
    index_i = 0
    index_j = 0
  []
  [strain_xy]
    type = ADRankTwoAux
    rank_two_tensor = total_strain
    variable = strain_xy
    index_i = 0
    index_j = 1
  []
  [strain_yy]
    type = ADRankTwoAux
    rank_two_tensor = total_strain
    variable = strain_yy
    index_i = 1
    index_j = 1
  []
  [strain_zz]
    type = ADRankTwoAux
    rank_two_tensor = total_strain
    variable = strain_zz
    index_i = 2
    index_j = 2
  []
[]

[Functions]
  [traction_function]
    type = PiecewiseLinear
    x = '0  2'
    y = '0  1'
  []
[]

[BCs]
  [leftx]
    type = DirichletBC
    boundary = 3
    variable = disp_x
    value = 0.0
  []
  [bottomy]
    type = DirichletBC
    boundary = 0
    variable = disp_y
    value = 0.0
  []
[]

[Materials]
  [elastic_tensor]
    type = ADComputeIsotropicElasticityTensor
    poissons_ratio = 0.3
    youngs_modulus = 1e6
  []
  [strain]
    type = ADComputePlaneSmallStrain
    displacements = 'disp_x disp_y'
    scalar_out_of_plane_strain = scalar_strain_zz
  []
  [stress]
    type = ADComputeLinearElasticStress
  []
  [traction_material]
    type = ADGenericFunctionMaterial
    prop_names = traction_material
    prop_values = traction_function
  []
[]

[Executioner]
  type = Transient

  solve_type = PJFNK
  line_search = none

  l_max_its = 100
  l_tol = 1e-4

  nl_max_its = 15
  nl_rel_tol = 1e-14
  nl_abs_tol = 1e-11

  start_time = 0.0
  dt = 1.0
  dtmin = 1.0
  end_time = 2.0
  num_steps = 2
[]

[Outputs]
  exodus = true
  file_base = out_of_plane_pressure_out
[]

Description
Constructed Objects
Out - of - Plane Pressure
Generalized Plane Strain and Reference Residual
Example Input Syntax
Input Parameters