https://mooseframework.inl.gov
PIDChainControl.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 "ChainControl.h"
13 
18 {
19 public:
21 
23 
24  virtual void execute() override;
25 
26 protected:
28  void updateValues();
29 
31  const Real & _input;
33  const Real & _set_point;
35  const Real & _K_p;
37  const Real & _K_i;
39  const Real & _K_d;
40 
44  const Real & _error_old;
45 
54 
57 
60 };
const Real & _K_p
The coefficient for the proportional term.
const Real & _set_point
set point
Real & _output
The output computed by the PID controller.
const Real & _K_d
The coefficient for the derivative term.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Real & _error
The current value of the error.
virtual void execute() override
Execute the control.
Real & _proportional
The proportional component.
static InputParameters validParams()
Implements a proportional-integral-derivative (PID) controller.
Real & _integral
The integral component.
const Real & _K_i
The coefficient for the integral term.
const Real & _integral_old
The old value of _integral.
void updateValues()
Updates all control data values.
Real & _derivative
The derivative component.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const Real & _input
input data
PIDChainControl(const InputParameters &parameters)
const InputParameters & parameters() const
Get the parameters of the object.
const Real & _error_old
The old value of the error.
Real & _previous_time
Previous time for which value was computed.
Control that additionally provides the capability to produce/consume data values, to allow control op...
Definition: ChainControl.h:21