ParsedODEKernel

under construction:Undocumented Class

The ParsedODEKernel has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Parsed ODE function kernel.

Input Parameters

  • functionfunction expression

    C++ Type:std::string

    Options:

    Description:function expression

  • variableThe name of the variable that this kernel operates on

    C++ Type:NonlinearVariableName

    Options:

    Description:The name of the variable that this kernel operates on

Required Parameters

  • constant_expressionsVector of values for the constants in constant_names (can be an FParser expression)

    C++ Type:std::vector

    Options:

    Description:Vector of values for the constants in constant_names (can be an FParser expression)

  • argsadditional coupled variables

    C++ Type:std::vector

    Options:

    Description:additional coupled variables

  • constant_namesVector of constants used in the parsed function (use this for kB etc.)

    C++ Type:std::vector

    Options:

    Description:Vector of constants used in the parsed function (use this for kB etc.)

Optional Parameters

  • fail_on_evalerrorFalseFail fatally if a function evaluation returns an error code (otherwise just pass on NaN)

    Default:False

    C++ Type:bool

    Options:

    Description:Fail fatally if a function evaluation returns an error code (otherwise just pass on NaN)

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

  • enable_jitTrueEnable just-in-time compilation of function expressions for faster evaluation

    Default:True

    C++ Type:bool

    Options:

    Description:Enable just-in-time compilation of function expressions for faster evaluation

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • disable_fpoptimizerFalseDisable the function parser algebraic optimizer

    Default:False

    C++ Type:bool

    Options:

    Description:Disable the function parser algebraic optimizer

  • enable_auto_optimizeTrueEnable automatic immediate optimization of derivatives

    Default:True

    C++ Type:bool

    Options:

    Description:Enable automatic immediate optimization of derivatives

  • enable_ad_cacheTrueEnable cacheing of function derivatives for faster startup time

    Default:True

    C++ Type:bool

    Options:

    Description:Enable cacheing of function derivatives for faster startup time

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Options:

    Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Options:nontime time

    Description:The tag for the vectors this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Options:nontime system

    Description:The tag for the matrices this Kernel should fill

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the matrices this Kernel should fill

Tagging Parameters

Input Files

References