SUPGFunctorTestMaterial

construction:Undocumented Class

The SUPGFunctorTestMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

This material provides parameters for testing isotope mass transport kernels.

Overview

Example Input File Syntax

Input Parameters

diffThe diffusion coefficient.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The diffusion coefficient.
var_nameThe name of the variable.
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable.
velThe velocity.
C++ Type:libMesh::VectorValue<double>
Unit:(no unit assumed)
Controllable:No
Description:The velocity.

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
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.
execute_onLINEARThe 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
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM
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.
ghost_layers2The number of layers of elements to ghost.
Default:2
C++ Type:unsigned short
Controllable:No
Description:The number of layers of elements to ghost.

Optional 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

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>
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>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files

(examples/2D_mms_dispersion_fv/mms_temporal.i)
(examples/2D_mms_dispersion_cgfem/mms_spatial.i)
(examples/2D_mms_dispersion_cgfem/mms_temporal.i)
(examples/2D_mms_dispersion_fv/mms_spatial.i)

(examples/2D_mms_dispersion_fv/mms_temporal.i)

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

[Variables]
  [u]
    type = MooseVariableFVReal
    fv = true
  []
[]

[FVKernels]
  [Time]
    type = ADFVMassFractionTimeDerivative
    variable = u
    density = 1.0
  []

  [Diffusion]
    type = ADFVMassFractionNuclideDiffusion
    variable = u
    density = 1.0
  []

  [Advection]
    type = ADFVMassFractionFunctorAdvection
    variable = u
    density = 1.0
    u = 1.0
    v = 1.0
    advected_interp_method = vanLeer
    velocity_interp_method = average
  []

  [Decay]
    type = ADFVMassFractionNuclideDecaySink
    variable = u
    density = 1.0
    decay_const = 1.0
  []

  [Force]
    type = FVBodyForce
    variable = u
    function = force
  []
[]

[FVBCs]
  [All]
    type = FVFunctionDirichletBC
    variable = u
    function = exact
    boundary = 'left right top bottom'
  []
[]

[Materials]
  [Mat1]
    type = SUPGFunctorTestMaterial
    var_name = u
    diff = 1.0
    vel = '1.0 1.0 0.0'
  []
[]

[Functions]
  [force]
    type = ParsedFunction
    value = 'x*y*alpha*t^3 + 3*x*y*t^2 + x*t^3*vec_y + y*t^3*vec_x'
    vars = 'vec_x alpha vec_y'
    vals = '1.0 1.0 1.0'
  []
  [exact]
    type = ParsedFunction
    value = 'x*y*t^3'
  []
[]

[Postprocessors]
  [error]
    type = ElementL2Error
    function = exact
    variable = u
  []
  [h]
    type = AverageElementSize
  []
[]

[Executioner]
  type = Transient
  solve_type = NEWTON
  petsc_options_iname = '-pc_type -pc_factor_shift_type'
  petsc_options_value = ' lu       NONZERO'

  dt = 1
  end_time = 3

  line_search = 'none'

  automatic_scaling = true
  off_diagonals_in_auto_scaling = true
  compute_scaling_once = false
[]

[Outputs]
  exodus = true
  csv = true
[]

(examples/2D_mms_dispersion_cgfem/mms_spatial.i)

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

[Variables]
  [u]
  []
[]

[Kernels]
  [Diffusion]
    type = ADMassFractionNuclideDiffusion
    variable = u
    u = 1.0
    v = 1.0
    density = 1.0
  []

  [Advection]
    type = ADMassFractionNuclideAdvection
    variable = u
    u = 1.0
    v = 1.0
    density = 1.0
  []

  [Decay]
    type = ADMassFractionNuclideDecaySink
    variable = u
    u = 1.0
    v = 1.0
    decay_const = 1.0
    density = 1.0
  []

  [Force]
    type = ADIsotopeForcing
    variable = u
    u = 1.0
    v = 1.0
    forcing = force
    density = 1.0
  []
[]

[BCs]
  [all]
    type = FunctionDirichletBC
    variable = u
    function = exact
    boundary = 'left right top bottom'
  []
[]

[Materials]
  [Mat1]
    type = SUPGFunctorTestMaterial
    var_name = u
    diff = 1.0
    vel = '1.0 1.0 0.0'
  []
[]

[Functions]
  [force]
    type = ParsedFunction
    value = '-x^2*D*exp(x*y) + x*vec_y*exp(x*y) - y^2*D*exp(x*y) + y*vec_x*exp(x*y) + alpha*exp(x*y)'
    vars = 'alpha vec_y D vec_x'
    vals = '1.0 1.0 1.0 1.0'
  []
  [exact]
    type = ParsedFunction
    value = 'exp(x*y)'
  []
[]

[Postprocessors]
  [error]
    type = ElementL2Error
    function = exact
    variable = u
  []
  [h]
    type = AverageElementSize
  []
[]

[Executioner]
  type = Steady
  solve_type = 'PJFNK'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
  csv = true
[]

(examples/2D_mms_dispersion_cgfem/mms_temporal.i)

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

[Variables]
  [u]
  []
[]

[Kernels]
  [Time]
    type = ADMassFractionNuclideTimeDerivative
    variable = u
    density = 1.0
    u = 1.0
    v = 1.0
  []

  [Diffusion]
    type = ADMassFractionNuclideDiffusion
    variable = u
    density = 1.0
    u = 1.0
    v = 1.0
  []

  [Advection]
    type = ADMassFractionNuclideAdvection
    variable = u
    u = 1.0
    v = 1.0
    density = 1.0
  []

  [Decay]
    type = ADMassFractionNuclideDecaySink
    variable = u
    decay_const = 1.0
    density = 1.0
    u = 1.0
    v = 1.0
  []

  [Force]
    type = ADIsotopeForcing
    variable = u
    u = 1.0
    v = 1.0
    forcing = force
    density = 1.0
  []
[]

[BCs]
  [all]
    type = FunctionDirichletBC
    variable = u
    function = exact
    boundary = 'left right top bottom'
  []
[]

[Materials]
  [Mat1]
    type = SUPGFunctorTestMaterial
    var_name = u
    diff = 1.0
    vel = '1.0 1.0 0.0'
  []
[]

[Functions]
  [force]
    type = ParsedFunction
    value = 'x*y*alpha*t^3 + 3*x*y*t^2 + x*t^3*vec_y + y*t^3*vec_x'
    vars = 'alpha vec_y vec_x'
    vals = '1.0 1.0 1.0'
  []
  [exact]
    type = ParsedFunction
    value = 'x*y*t^3'
  []
[]

[Postprocessors]
  [error]
    type = ElementL2Error
    function = exact
    variable = u
  []
  [h]
    type = AverageElementSize
  []
[]

[Executioner]
  type = Transient
  dt = 1
  end_time = 3
  solve_type = 'PJFNK'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
  csv = true
[]

(examples/2D_mms_dispersion_fv/mms_spatial.i)

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

[Variables]
  [u]
    type = MooseVariableFVReal
    fv = true
  []
[]

[FVKernels]
  [Diffusion]
    type = ADFVMassFractionNuclideDiffusion
    variable = u
    density = 1.0
  []

  [Advection]
    type = ADFVMassFractionFunctorAdvection
    variable = u
    density = 1.0
    u = 1.0
    v = 1.0
    advected_interp_method = upwind
    velocity_interp_method = average
  []

  [Decay]
    type = ADFVMassFractionNuclideDecaySink
    variable = u
    density = 1.0
    decay_const = 1.0
  []

  [Force]
    type = FVBodyForce
    variable = u
    function = force
  []
[]

[FVBCs]
  [All]
    type = FVFunctionDirichletBC
    variable = u
    function = exact
    boundary = 'left right top bottom'
  []
[]

[Materials]
  [Mat1]
    type = SUPGFunctorTestMaterial
    var_name = u
    diff = 1.0
    vel = '1.0 1.0 0.0'
  []
[]

[Functions]
  [force]
    type = ParsedFunction
    value = '-x^2*D*exp(x*y) + x*vec_y*exp(x*y) - y^2*D*exp(x*y) + y*vec_x*exp(x*y) + alpha*exp(x*y)'
    vars = 'alpha vec_y D vec_x'
    vals = '1.0 1.0 1.0 1.0'
  []
  [exact]
    type = ParsedFunction
    value = 'exp(x*y)'
  []
  [peclet]
    type = ParsedFunction
    value = 'h * sqrt(2.0) / 1.0'
    symbol_names = 'h'
    symbol_values = 'h'
  []
[]

[Postprocessors]
  [error]
    type = ElementL2Error
    function = exact
    variable = u
  []
  [h]
    type = AverageElementSize
  []
  [PecletNumber]
    type = FunctionValuePostprocessor
    function = peclet
    indirect_dependencies = 'h'
  []
[]

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

  line_search = 'none'

  automatic_scaling = true
  off_diagonals_in_auto_scaling = true
  compute_scaling_once = false
[]

[Outputs]
  exodus = true
  csv = true
[]

Overview
Example Input File Syntax
Input Parameters
Input Files