ConstantScalarAux

construction:Undocumented Class

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


# ConstantScalarAux

!syntax description /AuxScalarKernels/ConstantScalarAux

## Overview

!! Replace these lines with information regarding the ConstantScalarAux object.

## Example Input File Syntax

!! Describe and include an example of how to use the ConstantScalarAux object.

!syntax parameters /AuxScalarKernels/ConstantScalarAux

!syntax inputs /AuxScalarKernels/ConstantScalarAux

!syntax children /AuxScalarKernels/ConstantScalarAux

Compute a histogram of volume fractions binned according to variable values.

Input Parameters

valueThe value to be set to the scalar variable.
C++ Type:double
Options:
Description:The value to be set to the scalar variable.
variableThe name of the variable that this kernel operates on
C++ Type:AuxVariableName
Options:
Description:The name of the variable that this kernel operates on

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
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM
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.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
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
Options:
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

Input Files

(test/tests/misc/check_error/scalar_aux_kernel_with_var.i)
(test/tests/controls/dependency/test.i)
(test/tests/auxkernels/constant_scalar_aux/constant_scalar_aux.i)
(test/tests/multiapps/stateful_material_sub_cycling/material_sub_app_test_sub.i)

(test/tests/misc/check_error/scalar_aux_kernel_with_var.i)

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

[Variables]
  [./u]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[AuxVariables]
  [./v]
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]
  [./rea]
    type = Reaction
    variable = u
  [../]
[]

[AuxScalarKernels]
  [./nope]
    type = ConstantScalarAux
    variable = u
    value = 11
  [../]
[]

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

  [./right]
    type = DirichletBC
    variable = u
    boundary = 2
    value = 1
  [../]
[]

[Executioner]
  type = Steady
  solve_type = 'NEWTON'
[]

[Outputs]
  file_base = out
  exodus = true
[]

(test/tests/controls/dependency/test.i)

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

[Variables]
  [./u]
  [../]
[]

[AuxVariables]
  [./a]
    family = SCALAR
    order = FIRST
  [../]
[]

[AuxScalarKernels]
  [./a_sk]
    type = ConstantScalarAux
    variable = a
    value = 0
  [../]
[]

[Kernels]
  [./diff]
    type = CoefDiffusion
    variable = u
    coef = 0.1
  [../]
[]

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

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

[Outputs]
  csv = true
[]

[Functions]
  [./func_coef]
    type = ParsedFunction
    value = 1
  [../]
[]

[Controls]
  # We start with a = 0, control2 sets its value to 1 and then control1 will multiply it by 3,
  # so the end value has to be 3. If dependecy is broken, we multiply by 3 and then set to 1,
  # which is wrong
  [./control1]
    type = TestControl
    parameter = 'AuxScalarKernels/a_sk/value'
    test_type = MULT
    execute_on = 'initial timestep_begin'
    depends_on = control2
  [../]
  [./control2]
    type = RealFunctionControl
    parameter = 'AuxScalarKernels/a_sk/value'
    function = 'func_coef'
    execute_on = 'initial timestep_begin'
  [../]
[]

(test/tests/auxkernels/constant_scalar_aux/constant_scalar_aux.i)

#
# Testing a solution that is second order in space and first order in time
#

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = -1
  xmax = 1
  ymin = -1
  ymax = 1
  nx = 10
  ny = 10
  elem_type = QUAD9
[]

[AuxVariables]
  [./x]
    family = SCALAR
    order = FIRST
  [../]
[]

[Variables]
  [./u]
    order = SECOND
    family = LAGRANGE

    [./InitialCondition]
      type = ConstantIC
      value = 0
    [../]
  [../]
[]

[ICs]
  [./ic_x]
    type = ScalarConstantIC
    variable = x
    value = 11
  [../]
[]

[Functions]
  [./forcing_fn]
    type = ParsedFunction
    value = ((x*x)+(y*y))-(4*t)
  [../]

  [./exact_fn]
    type = ParsedFunction
    value = t*((x*x)+(y*y))
  [../]
[]

[AuxScalarKernels]
  [./const_x]
    type = ConstantScalarAux
    variable = x
    value = 11
  [../]
[]

[Kernels]
  [./ie]
    type = TimeDerivative
    variable = u
  [../]

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = '0 1 2 3'
    function = exact_fn
  [../]
[]

[Postprocessors]
  [./l2_err]
    type = ElementL2Error
    variable = u
    function = exact_fn
    execute_on = 'initial timestep_end'
  [../]

  [./x]
    type = ScalarVariable
    variable = x
    execute_on = 'initial timestep_end'
  [../]
[]

[Executioner]
  type = Transient
  scheme = 'implicit-euler'

  solve_type = 'PJFNK'

  start_time = 0.0
  num_steps = 5
  dt = 0.25

#  [./Adaptivity]
#    refine_fraction = 0.2
#    coarsen_fraction = 0.3
#    max_h_level = 4
#  [../]
[]

[Outputs]
  exodus = true
[]

(test/tests/multiapps/stateful_material_sub_cycling/material_sub_app_test_sub.i)

[Problem]
  solve = false
[]

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

[AuxVariables]
  [./x]
    family = SCALAR
    order = FIRST
  [../]
[]

[AuxScalarKernels]
  [./const_x]
    type = ConstantScalarAux
    variable = x
    value = 0
  [../]
[]

[Materials]
  [./stateful]
    type = StatefulMaterial
  [../]
[]

[Executioner]
  type = Transient
[]

[Postprocessors]
  [./matl_integral]
    type = ElementIntegralMaterialProperty
    mat_prop = diffusivity
    execute_on = timestep_end
    outputs = 'console csv'
  [../]
[]

[Outputs]
  csv = true
  exodus = true
[]

Input Parameters
Input Files

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access