EigenDecompositionMaterial

Emits material properties for the eigenvalues and eigenvectors of a symmetric rank two tensor.

Description

This class reads in a symmetric RankTwoTensor material given by "rank_two_tensor" and performs an eigendecomposition on it. The results of the decomposition are scalar materials named max_eigen_value, mid_eigen_value, and min_eigen_value and the corresponding vector material properties named max_eigen_vector, mid_eigen_vector, and min_eigen_vector. These names can be preceeded by the "base_name" to allow for more than one EigenDecompositionMaterial per block. These material properties can be output using the Material Outputs system with the "output_properties" as shown in the below example. This material is useful for visualizing the elemental maximum principal stress and direction as a vector. An error will be produced if an unsymmetric RankTwoTensor is decomposed which can happen for the deformation gradient.

Example Input File Syntax

[Materials]
  [nonADeig_decomp]
    type = EigenDecompositionMaterial
    rank_two_tensor = mechanical_strain
    base_name = nonAD
    outputs = exodus
    output_properties = "nonAD_max_eigen_vector nonAD_mid_eigen_vector nonAD_min_eigen_vector nonAD_max_eigen_value nonAD_mid_eigen_value nonAD_min_eigen_value"
  []
[]

Input Parameters

rank_two_tensorThe name of the symmetric rank two tensor to used in eigen decomposition.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The name of the symmetric rank two tensor to used in eigen decomposition.

Required Parameters

base_nameOptional parameter to allow multiple tensors to be decomposed on the same block.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Optional parameter to allow multiple tensors to be decomposed on the same block.
blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:NONE, ELEMENT, SUBDOMAIN
Controllable:No
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.
prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The seed for the master random number generator
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
Unit:(no unit assumed)
Controllable:No
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

output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

(moose/modules/solid_mechanics/test/tests/eigen_decomp_material/prescribed_strain_3D.i)

[Debug]
  show_material_props = true
[]

[Problem]
  kernel_coverage_check = false
  solve = false
[]

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 1
  ny = 1
  nz = 1
  displacements = 'disp_x disp_y disp_z'
[]

[AuxVariables]
  [disp_y]
    initial_condition = 0
  []
  [disp_x]
    initial_condition = 0
  []
  [disp_z]
    initial_condition = 0
  []
[]

[AuxKernels]
  # The applied displacements will cause the max eigenvector to change directions.
  # At t=5, the body undergoes simple shear, producing a nonsymmetric deformation gradient.
  [disp_x]
    execute_on = 'TIMESTEP_BEGIN'
    type = ParsedAux
    variable = disp_x
    use_xyzt = true
    expression = "if(t<4.1,4e-1*x*t,x)"
  []
  [disp_y]
    execute_on = 'TIMESTEP_BEGIN'
    type = ParsedAux
    variable = disp_y
    use_xyzt = true
    expression = "if(t<4.1,3e-1*y*t^2,1e-1*y*t+1e-1*x*t)"
  []
  [disp_z]
    execute_on = 'TIMESTEP_BEGIN'
    type = ParsedAux
    variable = disp_z
    use_xyzt = true
    expression = "if(t<4.1,1e-1*z*t^3,z)"
  []
[]

[Materials]
  [compute_strain]
    type = ComputeLagrangianStrain
    displacements = 'disp_x disp_y disp_z'
    large_kinematics = true
  []
  [nonAD_strain]
    type = RankTwoTensorMaterialADConverter
    reg_props_in = mechanical_strain
    ad_props_out = AD_mechanical_strain
  []
  [eig_decomp]
    type = ADEigenDecompositionMaterial
    rank_two_tensor = AD_mechanical_strain
    outputs = exodus
    output_properties = "max_eigen_vector mid_eigen_vector min_eigen_vector max_eigen_value "
                        "mid_eigen_value min_eigen_value"
  []
  [nonADeig_decomp]
    type = EigenDecompositionMaterial
    rank_two_tensor = mechanical_strain
    base_name = nonAD
    outputs = exodus
    output_properties = "nonAD_max_eigen_vector nonAD_mid_eigen_vector nonAD_min_eigen_vector "
                        "nonAD_max_eigen_value nonAD_mid_eigen_value nonAD_min_eigen_value"
  []

  [non_symmetric_eig_decomp_error]
    type = EigenDecompositionMaterial
    rank_two_tensor = deformation_gradient
    base_name = nonSym
  []
[]

[BCs]
[]

[Executioner]
  type = Transient
  solve_type = LINEAR
  dt = 1
  end_time = 5
[]

[Postprocessors]
  [sxx]
    type = MaterialTensorAverage
    rank_two_tensor = mechanical_strain
    index_i = 0
    index_j = 0
    execute_on = 'TIMESTEP_END'
  []
  [sxy]
    type = MaterialTensorAverage
    rank_two_tensor = mechanical_strain
    index_i = 0
    index_j = 1
    execute_on = 'TIMESTEP_END'
  []
  [syy]
    type = MaterialTensorAverage
    rank_two_tensor = mechanical_strain
    index_i = 1
    index_j = 1
  []
  [szz]
    type = MaterialTensorAverage
    rank_two_tensor = mechanical_strain
    index_i = 1
    index_j = 0
  []
  [AD_eigval_max]
    type = ADElementAverageMaterialProperty
    mat_prop = max_eigen_value
  []
  [AD_eigval_mid]
    type = ADElementAverageMaterialProperty
    mat_prop = mid_eigen_value
  []
  [AD_eigval_min]
    type = ADElementAverageMaterialProperty
    mat_prop = min_eigen_value
  []
  [nonAD_eigval_max]
    type = ElementAverageMaterialProperty
    mat_prop = nonAD_max_eigen_value
  []
  [nonAD_eigval_mid]
    type = ElementAverageMaterialProperty
    mat_prop = nonAD_mid_eigen_value
  []
  [nonAD_eigval_min]
    type = ElementAverageMaterialProperty
    mat_prop = nonAD_min_eigen_value
  []
[]

[Outputs]
  exodus = true
[]