FunctionScalarIC

construction:Undocumented Class

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


# FunctionScalarIC

!syntax description /ICs/FunctionScalarIC

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/FunctionScalarIC

!syntax inputs /ICs/FunctionScalarIC

!syntax children /ICs/FunctionScalarIC

Initializes a scalar variable using a function.

Input Parameters

functionThe initial condition function.
C++ Type:std::vector<FunctionName>
Options:
Description:The initial condition function.

Required Parameters

variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Options:
Description:The variable this initial condition is supposed to provide values for.

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