SolutionTimeAdaptiveDT

construction:Undocumented Class

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


# SolutionTimeAdaptiveDT

!syntax description /Executioner/TimeStepper/SolutionTimeAdaptiveDT

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Executioner/TimeStepper/SolutionTimeAdaptiveDT

!syntax inputs /Executioner/TimeStepper/SolutionTimeAdaptiveDT

!syntax children /Executioner/TimeStepper/SolutionTimeAdaptiveDT

Compute simulation timestep based on actual solution time.

Input Parameters

dtThe timestep size between solves
C++ Type:double
Options:
Description:The timestep size between solves

Required Parameters

adapt_logFalseOutput adaptive time step log
Default:False
C++ Type:bool
Options:
Description:Output adaptive time step log
cutback_factor_at_failure0.5Factor to apply to timestep if it a time step fails to convergence.
Default:0.5
C++ Type:double
Options:
Description:Factor to apply to timestep if it a time step fails to convergence.
initial_direction1Direction for the first step. 1 for up... -1 for down.
Default:1
C++ Type:int
Options:
Description:Direction for the first step. 1 for up... -1 for down.
percent_change0.1Percentage to change the timestep by. Should be between 0 and 1
Default:0.1
C++ Type:double
Options:
Description:Percentage to change the timestep by. Should be between 0 and 1
reset_dtFalseUse when restarting a calculation to force a change in dt.
Default:False
C++ Type:bool
Options:
Description:Use when restarting a calculation to force a change in dt.

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