LinearCombinationFunction

under construction:Undocumented Class

The LinearCombinationFunction 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.

Returns the linear combination of the functions

Input Parameters

  • functionsThis function will return Sum_over_i(w_i * functions_i)

    C++ Type:std::vector

    Description:This function will return Sum_over_i(w_i * functions_i)

  • wThis function will return Sum_over_i(w_i * functions_i)

    C++ Type:std::vector

    Description:This function will return Sum_over_i(w_i * functions_i)

Required Parameters

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

    C++ Type:std::vector

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

References