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)
  [../]
[]
(moose/test/tests/ics/function_scalar_ic/function_scalar_ic.i)

Input Parameters

  • functionThe initial condition function.

    C++ Type:std::vector<FunctionName>

    Controllable:No

    Description:The initial condition function.

Required Parameters

  • variableThe variable this initial condition is supposed to provide values for.

    C++ Type:VariableName

    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>

    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:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters