MaterialRateRealAux

Outputs element material properties rate of change

Description

The MaterialRateRealAux AuxKernel is used to output the rate of change of material properties as an element-level, variable. The rate is computed by

var element = document.getElementById("moose-equation-2714ff25-eb62-4046-8638-9166060bcd1e");katex.render("rate = \\dfrac{\\mathrm{property}(t)-\\mathrm{property}(t_{old})}{dt}", element, {displayMode:true,throwOnError:false});

where $var element = document.getElementById("moose-equation-f06eaada-1da9-4ff4-981e-e9acd82c723f");katex.render("dt=t-t_{old}", element, {displayMode:false,throwOnError:false});$ is the time step size and "property" is the material property being evaluated. This class derives from the same base class as MaterialRealAux and therefore also has optional parameters "factor" and "offset".

Example Input Syntax

[AuxKernels]
  [rate]
    type = MaterialRateRealAux
    variable = rate
    property = prop
  []
[]

Input Parameters

propertyThe material property name.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:The material property name.
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to

Required Parameters

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
check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
execute_onLINEAR TIMESTEP_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:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_DISPLACE
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.
factor1The factor by which to multiply your material property for visualization
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The factor by which to multiply your material property for visualization
offset0The offset to add to your material property for visualization
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The offset to add to your material property for visualization
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.
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
selected_qpEvaluate the material property at a specified quadrature point. This only needs to be used if you are interested in a particular quadrature point in each element. Otherwise do not include this parameter in your input file.
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Evaluate the material property at a specified quadrature point. This only needs to be used if you are interested in a particular quadrature point in each element. Otherwise do not include this parameter in your input file.
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

(moose/test/tests/auxkernels/material_rate_real/material_rate_real.i)

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

[AuxVariables]
  [rate]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[AuxKernels]
  [rate]
    type = MaterialRateRealAux
    variable = rate
    property = prop
  []
[]

[Variables]
  [u]
  []
[]

[Functions]
  [func]
    type = ParsedFunction
    expression = t*t/2
  []
[]

[Kernels]
  [diff]
    type = CoefDiffusion
    variable = u
    coef = 0.1
  []
  [time]
    type = TimeDerivative
    variable = u
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Materials]
  [mat]
    type = GenericFunctionMaterial
    prop_names = prop
    prop_values = func
    block = 0
  []
[]

[Executioner]
  type = Transient
  num_steps = 10
  dt = 1
  solve_type = 'NEWTON'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
[]

[Postprocessors]
  [rate]
    type = PointValue
    point = '0.5 0.5 0'
    variable = rate
  []
[]

[Outputs]
  csv = True
[]

Description
Example Input Syntax
Input Parameters