BatchStressGrad

Description

This UserObject computes double contraction of the elasticity tensor derivative and the forward mechanical strain, i.e., $var element = document.getElementById("moose-equation-771da493-f248-4c5f-8675-655f92a77994");katex.render("\\underbrace{\\frac{\\partial \\boldsymbol{C}}{\\partial p}}_{\\text{elasticity tensor derivative}} \\underbrace{(\\boldsymbol{L} u)}_{\\text{forward strain}}", element, {displayMode:true,throwOnError:false});$ as a batch material. Here, $var element = document.getElementById("moose-equation-9c82928b-7ae6-4e41-bd9c-75eb2f815805");katex.render("\\boldsymbol{C}", element, {displayMode:false,throwOnError:false});$ is the elasticity tensor, $var element = document.getElementById("moose-equation-cfaf5515-222c-48f8-ba04-4ce18ab691d7");katex.render("p", element, {displayMode:false,throwOnError:false});$ is the interested parameter, $var element = document.getElementById("moose-equation-0be95a8e-12f3-40ef-96cc-abe5cbf0242e");katex.render("\\boldsymbol{L}", element, {displayMode:false,throwOnError:false});$ is the symmetric strain operator for the elasticity problem, and $var element = document.getElementById("moose-equation-fe4fb34f-b9d2-4767-9b3a-21e33c79c6d3");katex.render("\\boldsymbol{L} u", element, {displayMode:false,throwOnError:false});$ is the strain from the forward problem. This object requires the elasticity tensor derivative material property (i.e., $var element = document.getElementById("moose-equation-9dcd2db1-79f6-4d1c-897d-27f1e5f9a67f");katex.render("\\frac{\\partial \\boldsymbol{C}}{\\partial p}", element, {displayMode:false,throwOnError:false});$ ) as its input.

This object is used together with AdjointStrainStressGradInnerProduct in a linear elastic inversion problem.

Example Input File Syntax

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [stress_grad_lambda]
    type = BatchStressGrad<<<{"description": "Compute the double contraction of the elasticity tensor derivative and the forward mechanical strain", "href": "BatchStressGrad.html"}>>>
    elasticity_tensor_derivative<<<{"description": "Name of the elasticity tensor derivative material property."}>>> = 'dC_dlambda_elasticity_tensor' # calculated in dC_dlambda
  []
[]

Input Parameters

elasticity_tensor_derivativeName of the elasticity tensor derivative material property.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Name of the elasticity tensor derivative material property.

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, TRANSFER
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
execution_order_group-1BatchStressGrad userObject needs to be completely executed before vectorPostprocessors.
Default:-1
C++ Type:int
Controllable:No
Description:BatchStressGrad userObject needs to be completely executed before vectorPostprocessors.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling 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.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
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
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
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
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

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

Material Property Retrieval Parameters

Input Files

(test/tests/bimaterial_elastic_inversion_batch_mat/grad.i)

(test/tests/bimaterial_elastic_inversion_batch_mat/grad.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 11
    ny = 11
    xmin = -4
    xmax = 4
    ymin = -4
    ymax = 4
  []
[]

[Variables]
  [ux]
  []
  [uy]
  []
[]

[AuxVariables]
  [state_x]
  []
  [state_y]
  []
  [dummy]
  []
[]

[DiracKernels]
  [misfit_is_adjoint_force]
    type = ReporterPointSource
    variable = ux
    x_coord_name = misfit/measurement_xcoord
    y_coord_name = misfit/measurement_ycoord
    z_coord_name = misfit/measurement_zcoord
    value_name = misfit/misfit_values
  []
[]

[Kernels]
  [div_sigma_x]
    type = StressDivergenceTensors
    variable = ux
    displacements = 'ux uy'
    component = 0
    volumetric_locking_correction = false
  []
  [div_sigma_y]
    type = StressDivergenceTensors
    variable = uy
    displacements = 'ux uy'
    component = 1
    volumetric_locking_correction = false
  []
[]

[BCs]
  [bottom_ux]
    type = DirichletBC
    variable = ux
    boundary = bottom
    value = 0.0
  []
  [bottom_uy]
    type = DirichletBC
    variable = uy
    boundary = bottom
    value = 0.0
  []
[]

[Materials]
  [stress]
    type = ComputeLinearElasticStress
  []
  [strain]
    type = ComputeSmallStrain
    displacements = 'ux uy'
  []
  [elasticity_tensor]
    type = ComputeVariableIsotropicElasticityTensor
    args = dummy
    youngs_modulus = E_material
    poissons_ratio = nu_material
  []
  [E_material]
    type = GenericFunctionMaterial
    prop_names = 'E_material'
    prop_values = E
  []
  [nu_material]
    type = GenericFunctionMaterial
    prop_names = 'nu_material'
    prop_values = nu
  []
  [forward_strain]
    type = ComputeSmallStrain
    displacements = 'state_x state_y'
    base_name = 'forward'
  []
  # Below are the gradients of elasticity tensor for this elastic inversion problem
  [dC_dlambda]
    type = ComputeElasticityTensor
    C_ijkl = '1 1 1 1 1 1 0 0 0'
    fill_method = symmetric9
    base_name = 'dC_dlambda'
  []
  [dC_dmu]
    type = ComputeElasticityTensor
    C_ijkl = '2 0 0 2 0 2 1 1 1'
    fill_method = symmetric9
    base_name = 'dC_dmu'
  []
[]

[Functions]
  [E]
    type = ParsedFunction
    expression = mu*(3*lambda+2*mu)/(lambda+mu)
    symbol_names = 'lambda mu'
    symbol_values = 'lambda mu'
  []
  [nu]
    type = ParsedFunction
    expression = lambda/2/(lambda+mu)
    symbol_names = 'lambda mu'
    symbol_values = 'lambda mu'
  []
  [lambda]
    type = NearestReporterCoordinatesFunction
    x_coord_name = parametrization/coordx
    y_coord_name = parametrization/coordy
    value_name = parametrization/lambda
  []
  [mu]
    type = NearestReporterCoordinatesFunction
    x_coord_name = parametrization/coordx
    y_coord_name = parametrization/coordy
    value_name = parametrization/mu
  []
[]

[Reporters]
  [measure_data]
    type = OptimizationData
    variable = ux
  []
  [misfit]
    type = OptimizationData
  []
  [parametrization]
    type = ConstantReporter
    real_vector_names = 'coordx coordy lambda mu'
    real_vector_values = '0 1 2; 0 1 2; 5 4 3; 1 2 3'
  []
[]

# Below is the part where a customized userObject that takes NEML stress gradient
# and transforms it into a batch material that has the output type as RankTwoTensor
# One userObject per gradient material property from NEML
[UserObjects]
  [stress_grad_lambda]
    type = BatchStressGrad
    elasticity_tensor_derivative = 'dC_dlambda_elasticity_tensor' # calculated in dC_dlambda
  []
  [stress_grad_mu]
    type = BatchStressGrad
    elasticity_tensor_derivative = 'dC_dmu_elasticity_tensor' # calculated in dC_dmu
  []
[]

# Below is where the stress gradient batch material objects are utilized in the
# actual gradient calculations
[VectorPostprocessors]
  [grad_lambda]
    type = AdjointStrainStressGradInnerProduct
    stress_grad_name = 'stress_grad_lambda'
    adjoint_strain_name = 'mechanical_strain'
    variable = dummy
    function = lambda
  []
  [grad_mu]
    type = AdjointStrainStressGradInnerProduct
    stress_grad_name = 'stress_grad_mu'
    adjoint_strain_name = 'mechanical_strain'
    variable = dummy
    function = mu
  []
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  file_base = 'adjoint'
  console = false
[]

(test/tests/bimaterial_elastic_inversion_batch_mat/grad.i)

[Mesh]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 11
    ny = 11
    xmin = -4
    xmax = 4
    ymin = -4
    ymax = 4
  []
[]

[Variables]
  [ux]
  []
  [uy]
  []
[]

[AuxVariables]
  [state_x]
  []
  [state_y]
  []
  [dummy]
  []
[]

[DiracKernels]
  [misfit_is_adjoint_force]
    type = ReporterPointSource
    variable = ux
    x_coord_name = misfit/measurement_xcoord
    y_coord_name = misfit/measurement_ycoord
    z_coord_name = misfit/measurement_zcoord
    value_name = misfit/misfit_values
  []
[]

[Kernels]
  [div_sigma_x]
    type = StressDivergenceTensors
    variable = ux
    displacements = 'ux uy'
    component = 0
    volumetric_locking_correction = false
  []
  [div_sigma_y]
    type = StressDivergenceTensors
    variable = uy
    displacements = 'ux uy'
    component = 1
    volumetric_locking_correction = false
  []
[]

[BCs]
  [bottom_ux]
    type = DirichletBC
    variable = ux
    boundary = bottom
    value = 0.0
  []
  [bottom_uy]
    type = DirichletBC
    variable = uy
    boundary = bottom
    value = 0.0
  []
[]

[Materials]
  [stress]
    type = ComputeLinearElasticStress
  []
  [strain]
    type = ComputeSmallStrain
    displacements = 'ux uy'
  []
  [elasticity_tensor]
    type = ComputeVariableIsotropicElasticityTensor
    args = dummy
    youngs_modulus = E_material
    poissons_ratio = nu_material
  []
  [E_material]
    type = GenericFunctionMaterial
    prop_names = 'E_material'
    prop_values = E
  []
  [nu_material]
    type = GenericFunctionMaterial
    prop_names = 'nu_material'
    prop_values = nu
  []
  [forward_strain]
    type = ComputeSmallStrain
    displacements = 'state_x state_y'
    base_name = 'forward'
  []
  # Below are the gradients of elasticity tensor for this elastic inversion problem
  [dC_dlambda]
    type = ComputeElasticityTensor
    C_ijkl = '1 1 1 1 1 1 0 0 0'
    fill_method = symmetric9
    base_name = 'dC_dlambda'
  []
  [dC_dmu]
    type = ComputeElasticityTensor
    C_ijkl = '2 0 0 2 0 2 1 1 1'
    fill_method = symmetric9
    base_name = 'dC_dmu'
  []
[]

[Functions]
  [E]
    type = ParsedFunction
    expression = mu*(3*lambda+2*mu)/(lambda+mu)
    symbol_names = 'lambda mu'
    symbol_values = 'lambda mu'
  []
  [nu]
    type = ParsedFunction
    expression = lambda/2/(lambda+mu)
    symbol_names = 'lambda mu'
    symbol_values = 'lambda mu'
  []
  [lambda]
    type = NearestReporterCoordinatesFunction
    x_coord_name = parametrization/coordx
    y_coord_name = parametrization/coordy
    value_name = parametrization/lambda
  []
  [mu]
    type = NearestReporterCoordinatesFunction
    x_coord_name = parametrization/coordx
    y_coord_name = parametrization/coordy
    value_name = parametrization/mu
  []
[]

[Reporters]
  [measure_data]
    type = OptimizationData
    variable = ux
  []
  [misfit]
    type = OptimizationData
  []
  [parametrization]
    type = ConstantReporter
    real_vector_names = 'coordx coordy lambda mu'
    real_vector_values = '0 1 2; 0 1 2; 5 4 3; 1 2 3'
  []
[]

# Below is the part where a customized userObject that takes NEML stress gradient
# and transforms it into a batch material that has the output type as RankTwoTensor
# One userObject per gradient material property from NEML
[UserObjects]
  [stress_grad_lambda]
    type = BatchStressGrad
    elasticity_tensor_derivative = 'dC_dlambda_elasticity_tensor' # calculated in dC_dlambda
  []
  [stress_grad_mu]
    type = BatchStressGrad
    elasticity_tensor_derivative = 'dC_dmu_elasticity_tensor' # calculated in dC_dmu
  []
[]

# Below is where the stress gradient batch material objects are utilized in the
# actual gradient calculations
[VectorPostprocessors]
  [grad_lambda]
    type = AdjointStrainStressGradInnerProduct
    stress_grad_name = 'stress_grad_lambda'
    adjoint_strain_name = 'mechanical_strain'
    variable = dummy
    function = lambda
  []
  [grad_mu]
    type = AdjointStrainStressGradInnerProduct
    stress_grad_name = 'stress_grad_mu'
    adjoint_strain_name = 'mechanical_strain'
    variable = dummy
    function = mu
  []
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  file_base = 'adjoint'
  console = false
[]

Description
Example Input File Syntax
Input Parameters
Input Files