VectorFunctionIC

The VectorFunctionIC allows the components of a vector variable to be defined using a Function object. This function supplied requires that the vectorValue method of the supplied function be defined, since this is used to populate the vector variable.

Sets component values for a vector field variable based on a vector function.

Input 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.

Required Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

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

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

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

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • functionThe initial condition vector function. This cannot be supplied with the component parameters.

    C++ Type:FunctionName

    Controllable:No

    Description:The initial condition vector function. This cannot be supplied with the component parameters.

  • function_x0A function that describes the x-component of the initial condition

    Default:0

    C++ Type:FunctionName

    Controllable:No

    Description:A function that describes the x-component of the initial condition

  • function_y0A function that describes the y-component of the initial condition

    Default:0

    C++ Type:FunctionName

    Controllable:No

    Description:A function that describes the y-component of the initial condition

  • function_z0A function that describes the z-component of the initial condition

    Default:0

    C++ Type:FunctionName

    Controllable:No

    Description:A function that describes the z-component of the initial condition

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

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.

  • ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC

    Default:False

    C++ Type:bool

    Controllable:No

    Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

Advanced Parameters

Input Files

References

No citations exist within this document.