ParsedVectorFunction

Return a vector component values based on a string function.

The ParsedVectorFunction is a vectorized version of the ParsedFunction. Both the vector components and the curl of the function may be specified. The inputs for the components of the vector and curl of the function follow the same rules as outlined for the ParsedFunction.

Example input syntax

In this example, a ParsedVectorFunction is used to define a curl boundary condition. Both x,y component and the z-curl are set for this function.

[Functions]
  # Simple "clockwise rotating" field in XY plane. curl(u) = (0, 0, -2)
  [./field]
    type = ParsedVectorFunction
    value_x = 'y'
    value_y = '-x'
    curl_z = '-2'
  [../]
  [./ffn_x]
    type = ParsedFunction
    value = 'y'
  [../]
  [./ffn_y]
    type = ParsedFunction
    value = '-x'
  [../]
[]

[BCs]
  [./top]
    type = VectorCurlBC
    curl_value = field
    variable = u
    boundary = 'left right top bottom'
  [../]
[]
(../../../SoftwareDownloads/moose/test/tests/functions/parsed/function_curl.i)

Input Parameters

  • curl_x0x-component of curl of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:x-component of curl of function.

  • curl_y0y-component of curl of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:y-component of curl of function.

  • curl_z0z-component of curl of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:z-component of curl of function.

  • 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, ALWAYS.

    Default:LINEAR

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS

    Controllable:No

    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, ALWAYS.

  • valsConstant numeric values, postprocessor names, or function names for vars.

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

    Controllable:No

    Description:Constant numeric values, postprocessor names, or function names for vars.

  • value_x0x-component of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:x-component of function.

  • value_y0y-component of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:y-component of function.

  • value_z0z-component of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:z-component of function.

  • varsVariables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.

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

    Controllable:No

    Description:Variables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.

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