FunctionScalarIC

Initializes a scalar variable using a function.

The function is evaluated at the simulation start time and at the point of coordinate (0, 0, 0).

Example input syntax

In this example, the scalar variable n, solution of a first order ODE, is initialized using function f. Since the start time of the simulation is 0, f is evaluated to cos(0)=1.

[ICs]
  [./f]
    type = FunctionScalarIC
    variable = n
    function = f
  [../]
[]

[Functions]
  [./f]
    type = ParsedFunction
    expression = cos(t)
  [../]
[]

Input Parameters

functionThe initial condition function.
C++ Type:std::vector<FunctionName>
Unit:(no unit assumed)
Controllable:No
Description:The initial condition function.

Required Parameters

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/function_scalar_ic/function_scalar_ic.i)

[Mesh]
  # a dummy mesh
  type = GeneratedMesh
  dim = 2
  xmin = 0
  xmax = 1
  ymin = 0
  ymax = 1
  nx = 1
  ny = 1
  elem_type = QUAD4
[]

[Variables]
  [./n]
    family = SCALAR
    order = FIRST
  [../]
[]

[Functions]
  [./f]
    type = ParsedFunction
    expression = cos(t)
  [../]
[]

[ICs]
  [./f]
    type = FunctionScalarIC
    variable = n
    function = f
  [../]
[]

[ScalarKernels]
  [./dn]
    type = ODETimeDerivative
    variable = n
  [../]
  [./ode1]
    type = ParsedODEKernel
    expression = '-n'
    variable = n
  [../]
[]

[Executioner]
  type = Transient
  start_time = 0
  end_time = 1
  dt = 0.01
  scheme = bdf2
  solve_type = 'PJFNK'
  timestep_tolerance = 1e-12
[]

[Outputs]
  csv = true
[]