SolutionFunction

under construction:Undocumented Class

The SolutionFunction has not been documented. The content contained on this page includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Functions/SolutionFunction

Input Parameters

  • solutionThe SolutionUserObject to extract data from.

    C++ Type:UserObjectName

    Options:

    Description:The SolutionUserObject to extract data from.

Required Parameters

  • from_variableThe name of the variable in the file that is to be extracted

    C++ Type:std::string

    Options:

    Description:The name of the variable in the file that is to be extracted

  • scale_factor1Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'

    Default:1

    C++ Type:double

    Options:

    Description:Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'

  • add_factor0Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'

    Default:0

    C++ Type:double

    Options:

    Description:Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'

Optional Parameters

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

References