TerminateControl

construction:Undocumented Class

The TerminateControl has not been documented. The content contained on this page 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.

Input Parameters

inputThe name of boolean control data indicating if simulation should be terminated.
C++ Type:std::string
Controllable:No
Description:The name of boolean control data indicating if simulation should be terminated.
termination_messageMessage to use if termination occurs
C++ Type:std::string
Controllable:No
Description:Message to use if termination occurs

Required Parameters

depends_onThe Controls that this control relies upon (i.e. must execute before this one)
C++ Type:std::vector<std::string>
Controllable:No
Description:The Controls that this control relies upon (i.e. must execute before this one)
throw_errorFalseFlag to throw an error on termination
Default:False
C++ Type:bool
Controllable:No
Description:Flag to throw an error on termination

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

Input Files

(modules/thermal_hydraulics/test/tests/controls/terminate/terminate.i)

References

No citations exist within this document.

(modules/thermal_hydraulics/test/tests/controls/terminate/terminate.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [diff]
    type = CoefDiffusion
    variable = u
    coef = 0.1
  []
  [time]
    type = TimeDerivative
    variable = u
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Postprocessors]
  [dt_pp]
    type = TimestepSize
  []
[]

[Components]
[]

[ControlLogic]
  [threshold]
    type = UnitTripControl
    condition = 'dt_pp > 3'
    vars = 'dt_pp'
    vals = 'dt_pp'
  []

  [terminate]
    type = TerminateControl
    input = threshold:state
    termination_message = 'Threshold exceeded'
  []
[]

[Functions]
  [dt_fn]
    type = ParsedFunction
    value = '1 + t'
  []
[]

[Executioner]
  type = Transient
  [TimeStepper]
    type = FunctionDT
    function = dt_fn
  []
  num_steps = 10
  abort_on_solve_fail = true
[]

Input Parameters
Input Files
References

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access