SimplePredictor

under construction:Undocumented Class

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


# SimplePredictor

!syntax description /Executioner/Predictor/SimplePredictor

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Executioner/Predictor/SimplePredictor

!syntax inputs /Executioner/Predictor/SimplePredictor

!syntax children /Executioner/Predictor/SimplePredictor

!syntax description /Executioner/Predictor/SimplePredictor

Input Parameters

  • scaleThe scale factor for the predictor (can range from 0 to 1)

    C++ Type:double

    Options:

    Description:The scale factor for the predictor (can range from 0 to 1)

Required Parameters

  • skip_timesSkip the predictor if the current solution time is in this list of times

    C++ Type:std::vector

    Options:

    Description:Skip the predictor if the current solution time is in this list of times

  • skip_times_oldSkip the predictor if the previous solution time is in this list of times

    C++ Type:std::vector

    Options:

    Description:Skip the predictor if the previous solution time is in this list of times

Optional Parameters

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

    C++ Type:std::vector

    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 Files