ADScaledCoupledTimeDerivative

Description

The ADScaledCoupledTimeDerivative kernel is an extension of the ADCoupledTimeDerivative kernel that has a scaling factor. This factor can be an ADReal-valued material property, set using the "mat_prop" parameter. The Jacobian contribution is computed using forward mode automatic differentiation.

Example Syntax

The syntax is simple, first with the "type" parameter set to (ADScaledCoupledTimeDerivative), the kernel "variable" parameter set to the equation/variable that the ADScaledCoupledTimeDerivative residual is assigned to, the coupled variable parameter "v" set to the variable that the time derivative operator acts upon, and the material property "mat_prop". Example syntax can be found in the kernel block below:

[Kernels<<<{"href": "../../syntax/Kernels/index.html"}>>>]
  [time_u]
    type = ADTimeDerivative<<<{"description": "The time derivative operator with the weak form of $(\\psi_i, \\frac{\\partial u_h}{\\partial t})$.", "href": "ADTimeDerivative.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
  []
  [diff_u]
    type = ADDiffusion<<<{"description": "Same as `Diffusion` in terms of physics/residual, but the Jacobian is computed using forward automatic differentiation", "href": "ADDiffusion.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
  []
  [fn_u]
    type = ADBodyForce<<<{"description": "Demonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form $(\\psi_i, -f)$.", "href": "BodyForce.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
    function<<<{"description": "A function that describes the body force"}>>> = force_u
  []
  [time_v]
    type = ADScaledCoupledTimeDerivative<<<{"description": "Extension of the ADCoupledTimeDerivative kernel that calculates the time derivative of a coupled variable scaled by a material property.", "href": "ADScaledCoupledTimeDerivative.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = v
    v<<<{"description": "Coupled variable"}>>> = u
    mat_prop<<<{"description": "Name of the material property factor"}>>> = mat_prop
  []
  [diff_v]
    type = ADDiffusion<<<{"description": "Same as `Diffusion` in terms of physics/residual, but the Jacobian is computed using forward automatic differentiation", "href": "ADDiffusion.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = v
  []
  [fn_v]
    type = ADBodyForce<<<{"description": "Demonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form $(\\psi_i, -f)$.", "href": "BodyForce.html"}>>>
    variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = v
    function<<<{"description": "A function that describes the body force"}>>> = force_v
  []
[]

Input Parameters

mat_propName of the material property factor
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Name of the material property factor
vCoupled variable
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Coupled variable
variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on

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
displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
matrix_onlyFalseWhether this object is only doing assembly to matrices (no vectors)
Default:False
C++ Type:bool
Controllable:No
Description:Whether this object is only doing assembly to matrices (no vectors)

Optional Parameters

absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Controllable:No
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<TagName>
Controllable:No
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
Controllable:No
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
Controllable:No
Description:The tag for the vectors this Kernel should fill

Contribution To Tagged Field Data 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.
diag_save_inThe name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this Kernel's diagonal Jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
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
save_inThe name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this Kernel's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
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/kernels/scaled_coupled_time_derivative/ad_scaled_coupled_time_derivative_test.i)

(test/tests/kernels/scaled_coupled_time_derivative/ad_scaled_coupled_time_derivative_test.i)

###########################################################
# This is a test of the ADScaledCoupledTimeDerivative kernel
# solving the following PDE system using mms:
# du/dt - div(grad(u)) = f_u
# v*du/dt - div(grad(v)) = f_v
# The manufactured solution for the variables u and v are
# u(t,x,y) = t^4*exp(x+y) and v(x,y) = sin(2*pi*x)*cos(2*pi*y)
###########################################################

[Mesh]
  type = GeneratedMesh
  nx = 10
  ny = 10
  dim = 2
[]

[Variables]
  [u]
  []
  [v]
  []
[]

[Kernels]
  [time_u]
    type = ADTimeDerivative
    variable = u
  []
  [diff_u]
    type = ADDiffusion
    variable = u
  []
  [fn_u]
    type = ADBodyForce
    variable = u
    function = force_u
  []
  [time_v]
    type = ADScaledCoupledTimeDerivative
    variable = v
    v = u
    mat_prop = mat_prop
  []
  [diff_v]
    type = ADDiffusion
    variable = v
  []
  [fn_v]
    type = ADBodyForce
    variable = v
    function = force_v
  []
[]

[Materials]
  [mat_prop]
    type = ADParsedMaterial
    property_name = mat_prop
    coupled_variables = 'v'
    expression = 'v'
  []
[]

[BCs]
  [allv]
    type = FunctionDirichletBC
    variable = v
    boundary = 'left right bottom top'
    function = v_exact
  []
  [allu]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right bottom top'
    function = u_exact
  []
[]

[Functions]

  ### u manufactured terms ###

  [u_exact]
    type = ParsedFunction
    expression = 't^4*exp(x+y)'
  []
  [du_exact]
    type = ParsedFunction
    expression = '4*t^3*exp(x+y)'
  []
  [laplacian_u]
    type = ParsedFunction
    expression = '2*t^4*exp(x+y)'
  []
  [force_u]
    type = ParsedFunction
    symbol_names = 'du_exact laplacian_u'
    symbol_values = 'du_exact laplacian_u'
    expression = 'du_exact - laplacian_u'
  []

  ### v manufactured terms ###

  [v_exact]
    type = ParsedFunction
    expression = 'sin(2*pi*x)*cos(2*pi*y)'
  []
  [laplacian_v]
    type = ParsedFunction
    expression = '-8*pi^2*sin(2*x*pi)*cos(2*y*pi)'
  []
  [force_v]
    type = ParsedFunction
    symbol_names = 'v_exact du_exact laplacian_v'
    symbol_values = 'v_exact du_exact laplacian_v'
    expression = 'v_exact*du_exact - laplacian_v'
  []
[]

[Postprocessors]
  [error_v]
    type = ElementL2Error
    function = v_exact
    variable = v
  []
  [error_u]
    type = ElementL2Error
    function = u_exact
    variable = u
  []
[]

[Executioner]
  type = Transient
  dt = 0.1
  end_time = 1
  scheme = BDF2
  solve_type = 'Newton'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  exodus = true
[]

(test/tests/kernels/scaled_coupled_time_derivative/ad_scaled_coupled_time_derivative_test.i)

###########################################################
# This is a test of the ADScaledCoupledTimeDerivative kernel
# solving the following PDE system using mms:
# du/dt - div(grad(u)) = f_u
# v*du/dt - div(grad(v)) = f_v
# The manufactured solution for the variables u and v are
# u(t,x,y) = t^4*exp(x+y) and v(x,y) = sin(2*pi*x)*cos(2*pi*y)
###########################################################

[Mesh]
  type = GeneratedMesh
  nx = 10
  ny = 10
  dim = 2
[]

[Variables]
  [u]
  []
  [v]
  []
[]

[Kernels]
  [time_u]
    type = ADTimeDerivative
    variable = u
  []
  [diff_u]
    type = ADDiffusion
    variable = u
  []
  [fn_u]
    type = ADBodyForce
    variable = u
    function = force_u
  []
  [time_v]
    type = ADScaledCoupledTimeDerivative
    variable = v
    v = u
    mat_prop = mat_prop
  []
  [diff_v]
    type = ADDiffusion
    variable = v
  []
  [fn_v]
    type = ADBodyForce
    variable = v
    function = force_v
  []
[]

[Materials]
  [mat_prop]
    type = ADParsedMaterial
    property_name = mat_prop
    coupled_variables = 'v'
    expression = 'v'
  []
[]

[BCs]
  [allv]
    type = FunctionDirichletBC
    variable = v
    boundary = 'left right bottom top'
    function = v_exact
  []
  [allu]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right bottom top'
    function = u_exact
  []
[]

[Functions]

  ### u manufactured terms ###

  [u_exact]
    type = ParsedFunction
    expression = 't^4*exp(x+y)'
  []
  [du_exact]
    type = ParsedFunction
    expression = '4*t^3*exp(x+y)'
  []
  [laplacian_u]
    type = ParsedFunction
    expression = '2*t^4*exp(x+y)'
  []
  [force_u]
    type = ParsedFunction
    symbol_names = 'du_exact laplacian_u'
    symbol_values = 'du_exact laplacian_u'
    expression = 'du_exact - laplacian_u'
  []

  ### v manufactured terms ###

  [v_exact]
    type = ParsedFunction
    expression = 'sin(2*pi*x)*cos(2*pi*y)'
  []
  [laplacian_v]
    type = ParsedFunction
    expression = '-8*pi^2*sin(2*x*pi)*cos(2*y*pi)'
  []
  [force_v]
    type = ParsedFunction
    symbol_names = 'v_exact du_exact laplacian_v'
    symbol_values = 'v_exact du_exact laplacian_v'
    expression = 'v_exact*du_exact - laplacian_v'
  []
[]

[Postprocessors]
  [error_v]
    type = ElementL2Error
    function = v_exact
    variable = v
  []
  [error_u]
    type = ElementL2Error
    function = u_exact
    variable = u
  []
[]

[Executioner]
  type = Transient
  dt = 0.1
  end_time = 1
  scheme = BDF2
  solve_type = 'Newton'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Outputs]
  exodus = true
[]

Description
Example Syntax
Input Parameters
Input Files