src/FDM/JSBSim/models/flight_control/FGActuator.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGActuator.cpp
   4  Author:       Jon Berndt
   5  Date started: 21 February 2006
   6
   7  ------------- Copyright (C) 2007 Jon S. Berndt (jon@jsbsim.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU Lesser General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU Lesser General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU Lesser General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 FUNCTIONAL DESCRIPTION
  27 --------------------------------------------------------------------------------
  28
  29 HISTORY
  30 --------------------------------------------------------------------------------
  31
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  33 COMMENTS, REFERENCES,  and NOTES
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 INCLUDES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  39
  40 #include "FGActuator.h"
  41
  42 using namespace std;
  43
  44 namespace JSBSim {
  45
  46 static const char *IdSrc = "$Id: FGActuator.cpp,v 1.18 2011/05/13 17:14:47 bcoconni Exp $";
  47 static const char *IdHdr = ID_ACTUATOR;
  48
  49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  50 CLASS IMPLEMENTATION
  51 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  52
  53
  54 FGActuator::FGActuator(FGFCS* fcs, Element* element) : FGFCSComponent(fcs, element)
  55 {
  56   double denom;
  57
  58   // inputs are read from the base class constructor
  59
  60   PreviousOutput = 0.0;
  61   PreviousHystOutput = 0.0;
  62   PreviousRateLimOutput = 0.0;
  63   PreviousLagInput = PreviousLagOutput = 0.0;
  64   bias = lag = hysteresis_width = deadband_width = 0.0;
  65   rate_limit = 0.0; // no limit
  66   fail_zero = fail_hardover = fail_stuck = false;
  67   ca = cb = 0.0;
  68
  69   if ( element->FindElement("deadband_width") ) {
  70     deadband_width = element->FindElementValueAsNumber("deadband_width");
  71   }
  72   if ( element->FindElement("hysteresis_width") ) {
  73     hysteresis_width = element->FindElementValueAsNumber("hysteresis_width");
  74   }
  75   if ( element->FindElement("rate_limit") ) {
  76     rate_limit = element->FindElementValueAsNumber("rate_limit");
  77   }
  78   if ( element->FindElement("bias") ) {
  79     bias = element->FindElementValueAsNumber("bias");
  80   }
  81   if ( element->FindElement("lag") ) {
  82     lag = element->FindElementValueAsNumber("lag");
  83     denom = 2.00 + dt*lag;
  84     ca = dt*lag / denom;
  85     cb = (2.00 - dt*lag) / denom;
  86   }
  87
  88   FGFCSComponent::bind();
  89   bind();
  90
  91   Debug(0);
  92 }
  93
  94 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  95
  96 FGActuator::~FGActuator()
  97 {
  98   Debug(1);
  99 }
 100
 101 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 102
 103 bool FGActuator::Run(void )
 104 {
 105   Input = InputNodes[0]->getDoubleValue() * InputSigns[0];
 106
 107   if (fail_zero) Input = 0;
 108   if (fail_hardover) Input =  clipmax*sign(Input);
 109
 110   Output = Input; // Perfect actuator. At this point, if no failures are present
 111                   // and no subsequent lag, limiting, etc. is done, the output
 112                   // is simply the input. If any further processing is done
 113                   // (below) such as lag, rate limiting, hysteresis, etc., then
 114                   // the Input will be further processed and the eventual Output
 115                   // will be overwritten from this perfect value.
 116
 117   if (!fcs->GetTrimStatus()) {
 118     if (lag != 0.0)              Lag();        // models actuator lag
 119     if (rate_limit != 0)         RateLimit();  // limit the actuator rate
 120   }
 121   if (deadband_width != 0.0)   Deadband();
 122   if (!fcs->GetTrimStatus() && hysteresis_width != 0.0) Hysteresis();
 123   if (bias != 0.0)             Bias();       // models a finite bias
 124
 125   if (fail_stuck) Output = PreviousOutput;
 126   PreviousOutput = Output; // previous value needed for "stuck" malfunction
 127
 128   if (fcs->GetTrimStatus()) {
 129     PreviousHystOutput = Output;
 130     PreviousRateLimOutput = Output;
 131     PreviousLagInput = Output;
 132     PreviousLagOutput = Output;
 133   }
 134
 135   Clip();
 136   if (IsOutput) SetOutput();
 137
 138   return true;
 139 }
 140
 141 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 142
 143 void FGActuator::Bias(void)
 144 {
 145   Output += bias;
 146 }
 147
 148 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 149
 150 void FGActuator::Lag(void)
 151 {
 152   // "Output" on the right side of the "=" is the current frame input
 153   // for this Lag filter
 154   double input = Output;
 155   Output = ca * (input + PreviousLagInput) + PreviousLagOutput * cb;
 156   PreviousLagInput = input;
 157   PreviousLagOutput = Output;
 158 }
 159
 160 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 161
 162 void FGActuator::Hysteresis(void)
 163 {
 164   // Note: this function acts cumulatively on the "Output" parameter. So, "Output"
 165   // is - for the purposes of this Hysteresis method - really the input to the
 166   // method.
 167   double input = Output;
 168
 169   if (input > PreviousHystOutput) {
 170     Output = max(PreviousHystOutput, input-0.5*hysteresis_width);
 171   } else if (input < PreviousHystOutput) {
 172     Output = min(PreviousHystOutput, input+0.5*hysteresis_width);
 173   }
 174
 175   PreviousHystOutput = Output;
 176 }
 177
 178 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 179
 180 void FGActuator::RateLimit(void)
 181 {
 182   // Note: this function acts cumulatively on the "Output" parameter. So, "Output"
 183   // is - for the purposes of this RateLimit method - really the input to the
 184   // method.
 185   double input = Output;
 186   if (dt > 0.0) {
 187     double rate = (input - PreviousRateLimOutput)/dt;
 188     if (fabs(rate) > rate_limit) {
 189       Output = PreviousRateLimOutput + (rate_limit*fabs(rate)/rate)*dt;
 190     }
 191   }
 192   PreviousRateLimOutput = Output;
 193 }
 194
 195 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 196
 197 void FGActuator::Deadband(void)
 198 {
 199   // Note: this function acts cumulatively on the "Output" parameter. So, "Output"
 200   // is - for the purposes of this Deadband method - really the input to the
 201   // method.
 202   double input = Output;
 203
 204   if (input < -deadband_width/2.0) {
 205     Output = (input + deadband_width/2.0);
 206   } else if (input > deadband_width/2.0) {
 207     Output = (input - deadband_width/2.0);
 208   } else {
 209     Output = 0.0;
 210   }
 211 }
 212
 213 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 214
 215 void FGActuator::bind(void)
 216 {
 217   string tmp = Name;
 218   if (Name.find("/") == string::npos) {
 219     tmp = "fcs/" + PropertyManager->mkPropertyName(Name, true);
 220   }
 221   const string tmp_zero = tmp + "/malfunction/fail_zero";
 222   const string tmp_hardover = tmp + "/malfunction/fail_hardover";
 223   const string tmp_stuck = tmp + "/malfunction/fail_stuck";
 224
 225   PropertyManager->Tie( tmp_zero, this, &FGActuator::GetFailZero, &FGActuator::SetFailZero);
 226   PropertyManager->Tie( tmp_hardover, this, &FGActuator::GetFailHardover, &FGActuator::SetFailHardover);
 227   PropertyManager->Tie( tmp_stuck, this, &FGActuator::GetFailStuck, &FGActuator::SetFailStuck);
 228 }
 229
 230 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 231 //    The bitmasked value choices are as follows:
 232 //    unset: In this case (the default) JSBSim would only print
 233 //       out the normally expected messages, essentially echoing
 234 //       the config files as they are read. If the environment
 235 //       variable is not set, debug_lvl is set to 1 internally
 236 //    0: This requests JSBSim not to output any messages
 237 //       whatsoever.
 238 //    1: This value explicity requests the normal JSBSim
 239 //       startup messages
 240 //    2: This value asks for a message to be printed out when
 241 //       a class is instantiated
 242 //    4: When this value is set, a message is displayed when a
 243 //       FGModel object executes its Run() method
 244 //    8: When this value is set, various runtime state variables
 245 //       are printed out periodically
 246 //    16: When set various parameters are sanity checked and
 247 //       a message is printed out when they go out of bounds
 248
 249 void FGActuator::Debug(int from)
 250 {
 251   if (debug_lvl <= 0) return;
 252
 253   if (debug_lvl & 1) { // Standard console startup message output
 254     if (from == 0) { // Constructor
 255       if (InputSigns[0] < 0)
 256         cout << "      INPUT: -" << InputNames[0] << endl;
 257       else
 258         cout << "      INPUT: " << InputNames[0] << endl;
 259
 260       if (IsOutput) {
 261         for (unsigned int i=0; i<OutputNodes.size(); i++)
 262           cout << "      OUTPUT: " << OutputNodes[i]->getName() << endl;
 263       }
 264       if (bias != 0.0) cout << "      Bias: " << bias << endl;
 265       if (rate_limit != 0) cout << "      Rate limit: " << rate_limit << endl;
 266       if (lag != 0) cout << "      Actuator lag: " << lag << endl;
 267       if (hysteresis_width != 0) cout << "      Hysteresis width: " << hysteresis_width << endl;
 268       if (deadband_width != 0) cout << "      Deadband width: " << deadband_width << endl;
 269     }
 270   }
 271   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 272     if (from == 0) cout << "Instantiated: FGActuator" << endl;
 273     if (from == 1) cout << "Destroyed:    FGActuator" << endl;
 274   }
 275   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 276   }
 277   if (debug_lvl & 8 ) { // Runtime state variables
 278   }
 279   if (debug_lvl & 16) { // Sanity checking
 280   }
 281   if (debug_lvl & 64) {
 282     if (from == 0) { // Constructor
 283       cout << IdSrc << endl;
 284       cout << IdHdr << endl;
 285     }
 286   }
 287 }
 288 }