MaterialRealAux

Outputs element volume-averaged material properties

Description

The MaterialRealAux AuxKernel is used to output material properties as a element-level, constant variable. The computed value will be the volume-averaged quantity over the element.

Example Input Syntax


[AuxKernels]
  [./copy_bar]
    type = MaterialRealAux
    property = bar
    variable = foo
    boundary = right
    execute_on = timestep_end
  [../]
[]
(moose/test/tests/materials/boundary_material/elem_aux_bc_on_bnd.i)

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Description:The name of the variable that this object applies to

  • propertyThe scalar material property name

    C++ Type:MaterialPropertyName

    Description:The scalar material property name

Required Parameters

  • execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:LINEAR

    C++ Type:ExecFlagEnum

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • offset0The offset to add to your material property for visualization

    Default:0

    C++ Type:double

    Description:The offset to add to your material property for visualization

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Description:The list of block ids (SubdomainID) that this object will be applied

  • factor1The factor by which to multiply your material property for visualization

    Default:1

    C++ Type:double

    Description:The factor by which to multiply your material property for visualization

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    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

    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