ScalarComponentIC

Initial condition to set different values on each component of scalar variable.

All components of the scalar variable must be set simultaneously.

Example input syntax

In this example, the initial values of scalar variables v and a, both of size 2, are set using ScalarComponentIC.

[ICs]
  [./v_ic]
    type = ScalarComponentIC
    variable = 'v'
    values = '1 2'
  [../]

  [./a_ic]
    type = ScalarComponentIC
    variable = 'a'
    values = '4 5'
  [../]
[]

Input Parameters

valuesInitial values to initialize the scalar variable.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Initial values to initialize the scalar variable.

Required Parameters

stateCURRENTThis parameter is used to set old state solutions at the start of simulation. If specifying multiple states at the start of simulation, use one IC object for each state being specified. The states are CURRENT=0 OLD=1 OLDER=2. States older than 2 are not currently supported. When the user only specifies current state, the solution is copied to the old and older states, as expected. This functionality is mainly used for dynamic simulations with explicit time integration schemes, where old solution states are used in the velocity and acceleration approximations.
Default:CURRENT
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:CURRENT, OLD, OLDER
Controllable:No
Description:This parameter is used to set old state solutions at the start of simulation. If specifying multiple states at the start of simulation, use one IC object for each state being specified. The states are CURRENT=0 OLD=1 OLDER=2. States older than 2 are not currently supported. When the user only specifies current state, the solution is copied to the old and older states, as expected. This functionality is mainly used for dynamic simulations with explicit time integration schemes, where old solution states are used in the velocity and acceleration approximations.
variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:The variable this initial condition is supposed to provide values for.

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:No
Description:Set the enabled status of the MooseObject.

Advanced Parameters

(moose/test/tests/ics/component_ic/component_ic.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 1
  ymin = 0
  ymax = 1
  nx = 2
  ny = 2
[]

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

  [./v]
    order = SECOND
    family = SCALAR
  [../]
[]

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

[ICs]
  [./v_ic]
    type = ScalarComponentIC
    variable = 'v'
    values = '1 2'
  [../]

  [./a_ic]
    type = ScalarComponentIC
    variable = 'a'
    values = '4 5'
  [../]
[]

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

[ScalarKernels]
  [./ask]
    type = AlphaCED
    variable = v
    value = 100
  [../]
[]

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

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

[Postprocessors]
  [./v1]
    type = ScalarVariable
    variable = v
    component = 0
    execute_on = 'initial timestep_end'
  [../]
  [./v2]
    type = ScalarVariable
    variable = v
    component = 1
    execute_on = 'initial timestep_end'
  [../]

  [./a1]
    type = ScalarVariable
    variable = a
    component = 0
    execute_on = 'initial timestep_end'
  [../]
  [./a2]
    type = ScalarVariable
    variable = a
    component = 1
    execute_on = 'initial timestep_end'
  [../]
[]


[Executioner]
  type = Steady
[]

[Outputs]
  [./out]
    type = Exodus
    execute_scalars_on = none
  [../]
[]