https://mooseframework.inl.gov
UnitTripControl.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "THMControl.h"
14 
16 
21 {
22 public:
24 
25  virtual void initialSetup() override;
26  virtual void init() override;
27  virtual void execute() override;
28 
29 protected:
34 
36  std::string _condition;
38  bool & _state;
40  const bool & _latch;
42  bool _tripped;
43 
45  std::unique_ptr<THMParsedFunctionWrapper> _condition_ptr;
46 
47 public:
49 };
virtual void initialSetup() override
virtual void init() override
const bool & _latch
Determines if the state of the trip should stay true for the rest of the simulation after the trip ha...
std::string _condition
The user-defined condition.
bool _tripped
true if the trip happened, otherwise false
A wrapper class for creating and evaluating parsed functions via the libMesh::ParsedFunction interfac...
static InputParameters validParams()
std::unique_ptr< THMParsedFunctionWrapper > _condition_ptr
Pointer to the Parsed function wrapper object.
This control block uses a user-defined condition to determine if a trip happened. ...
void buildConditionFunction()
Build the function that is used to evaluate the condition of this trip control.
const InputParameters & parameters() const
bool & _state
The state of this control object.
virtual void execute() override
UnitTripControl(const InputParameters &parameters)