SolutionFunction

construction:Undocumented Class

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


# SolutionFunction

!syntax description /Functions/SolutionFunction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Functions/SolutionFunction

!syntax inputs /Functions/SolutionFunction

!syntax children /Functions/SolutionFunction

Function for reading a solution from file.

Input Parameters

solutionThe SolutionUserObject to extract data from.
C++ Type:UserObjectName
Options:
Description:The SolutionUserObject to extract data from.

Required Parameters

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'
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'

Optional 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