LinearCombinationFunction

construction:Undocumented Class

The LinearCombinationFunction has not been documented. The content listed below should be used as a starting point for documenting the class, which 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.


# LinearCombinationFunction

!syntax description /Functions/LinearCombinationFunction

## Overview

!! Replace these lines with information regarding the LinearCombinationFunction object.

## Example Input File Syntax

!! Describe and include an example of how to use the LinearCombinationFunction object.

!syntax parameters /Functions/LinearCombinationFunction

!syntax inputs /Functions/LinearCombinationFunction

!syntax children /Functions/LinearCombinationFunction

Returns the linear combination of the functions

Input Parameters

functionsThis function will return Sum_over_i(w_i * functions_i)
C++ Type:std::vector<FunctionName>
Options:
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<double>
Options:
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<std::string>
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 Parameters