ParsedVectorFunction

Returns a vector function based on string descriptions for each component.

The ParsedVectorFunction is a vectorized version of the ParsedFunction. The vector components, the curl and the divergence of the function may be specified. The inputs for the components of the vector, the curl and the divergence 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
    expression_x = 'y'
    expression_y = '-x'
    curl_z = '-2'
  [../]
  [./ffn_x]
    type = ParsedFunction
    expression = 'y'
  [../]
  [./ffn_y]
    type = ParsedFunction
    expression = '-x'
  [../]
[]

[BCs]
  [./top]
    type = VectorCurlBC
    curl_value = field
    variable = u
    boundary = 'left right top bottom'
  [../]
[]
(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.

  • div0divergence of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:divergence of function.

  • execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

    Default:LINEAR

    C++ Type:ExecFlagEnum

    Options:FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed, the available options include FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.

  • expression_x0x-component of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:x-component of function.

  • expression_y0y-component of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:y-component of function.

  • expression_z0z-component of function.

    Default:0

    C++ Type:std::string

    Controllable:No

    Description:z-component of function.

  • symbol_namesSymbols (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:Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.

  • symbol_valuesConstant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names.

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

    Controllable:No

    Description:Constant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names.

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

Input Files