ConstantFunction

buildconstruction:Undocumented Class

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


# ConstantFunction

!syntax description /Functions/ConstantFunction

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Functions/ConstantFunction

!syntax inputs /Functions/ConstantFunction

!syntax children /Functions/ConstantFunction

A function that returns a constant value as defined by an input parameter.

Input Parameters

  • value0The constant value

    Default:0

    C++ Type:double

    Options:

    Description:The constant value

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