src/FDM/JSBSim/models/propulsion/FGThruster.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGThruster.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 08/23/00
   6  Purpose:      Encapsulates the thruster object
   7
   8  ------------- Copyright (C) 2000  Jon S. Berndt (jon@jsbsim.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU Lesser General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU Lesser General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU Lesser General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 HISTORY
  31 --------------------------------------------------------------------------------
  32 08/23/00  JSB  Created
  33
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 INCLUDES
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  37
  38 #include <iostream>
  39 #include <sstream>
  40
  41 #include "FGThruster.h"
  42 #include "input_output/FGXMLElement.h"
  43
  44 using namespace std;
  45
  46 namespace JSBSim {
  47
  48 static const char *IdSrc = "$Id: FGThruster.cpp,v 1.14 2011/03/10 01:35:25 dpculp Exp $";
  49 static const char *IdHdr = ID_THRUSTER;
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 CLASS IMPLEMENTATION
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55
  56 FGThruster::FGThruster(FGFDMExec *FDMExec, Element *el, int num ): FGForce(FDMExec)
  57 {
  58   Element* thruster_element = el->GetParent();
  59   Element* element;
  60   FGColumnVector3 location, orientation;
  61
  62   Type = ttDirect;
  63   SetTransformType(FGForce::tCustom);
  64
  65   Name = el->GetAttributeValue("name");
  66
  67   GearRatio = 1.0;
  68   ReverserAngle = 0.0;
  69   ClutchCtrlNorm = 1.0;
  70   EngineNum = num;
  71   PropertyManager = FDMExec->GetPropertyManager();
  72
  73 // Determine the initial location and orientation of this thruster and load the
  74 // thruster with this information.
  75
  76   element = thruster_element->FindElement("location");
  77   if (element)  location = element->FindElementTripletConvertTo("IN");
  78   else          cerr << fgred << "      No thruster location found." << reset << endl;
  79
  80   element = thruster_element->FindElement("orient");
  81   if (element)  orientation = element->FindElementTripletConvertTo("RAD");
  82   else          cerr << "      No thruster orientation found." << endl;
  83
  84   SetLocation(location);
  85   SetAnglesToBody(orientation);
  86
  87   string property_name, base_property_name;
  88   base_property_name = CreateIndexedPropertyName("propulsion/engine", EngineNum);
  89   property_name = base_property_name + "/pitch-angle-rad";
  90   PropertyManager->Tie( property_name.c_str(), (FGForce *)this, &FGForce::GetPitch, &FGForce::SetPitch);
  91   property_name = base_property_name + "/yaw-angle-rad";
  92   PropertyManager->Tie( property_name.c_str(), (FGForce *)this, &FGForce::GetYaw, &FGForce::SetYaw);
  93
  94   if (el->GetName() == "direct") // this is a direct thruster. At this time
  95                                  // only a direct thruster can be reversed.
  96   {
  97     property_name = base_property_name + "/reverser-angle-rad";
  98     PropertyManager->Tie( property_name.c_str(), (FGThruster *)this, &FGThruster::GetReverserAngle,
  99                                                           &FGThruster::SetReverserAngle);
 100   }
 101
 102   if (el->GetName() == "rotor") // At this time only a rotor can have a clutch.
 103   {
 104     property_name = base_property_name + "/clutch-ctrl-norm";
 105     PropertyManager->Tie( property_name.c_str(), (FGThruster *)this, &FGThruster::GetClutchCtrl,
 106                                                           &FGThruster::SetClutchCtrl);
 107   }
 108
 109   Debug(0);
 110 }
 111
 112 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 113
 114 FGThruster::~FGThruster()
 115 {
 116   Debug(1);
 117 }
 118
 119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 120
 121 string FGThruster::GetThrusterLabels(int id, string delimeter)
 122 {
 123   std::ostringstream buf;
 124
 125   buf << Name << " Thrust (engine " << id << " in lbs)";
 126
 127   return buf.str();
 128 }
 129
 130 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 131
 132 string FGThruster::GetThrusterValues(int id, string delimeter)
 133 {
 134   std::ostringstream buf;
 135
 136   buf << Thrust;
 137
 138   return buf.str();
 139 }
 140
 141 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 142 //    The bitmasked value choices are as follows:
 143 //    unset: In this case (the default) JSBSim would only print
 144 //       out the normally expected messages, essentially echoing
 145 //       the config files as they are read. If the environment
 146 //       variable is not set, debug_lvl is set to 1 internally
 147 //    0: This requests JSBSim not to output any messages
 148 //       whatsoever.
 149 //    1: This value explicity requests the normal JSBSim
 150 //       startup messages
 151 //    2: This value asks for a message to be printed out when
 152 //       a class is instantiated
 153 //    4: When this value is set, a message is displayed when a
 154 //       FGModel object executes its Run() method
 155 //    8: When this value is set, various runtime state variables
 156 //       are printed out periodically
 157 //    16: When set various parameters are sanity checked and
 158 //       a message is printed out when they go out of bounds
 159
 160 void FGThruster::Debug(int from)
 161 {
 162   if (debug_lvl <= 0) return;
 163
 164   if (debug_lvl & 1) { // Standard console startup message output
 165     if (from == 0) { // Constructor
 166
 167     }
 168   }
 169   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 170     if (from == 0) cout << "Instantiated: FGThruster" << endl;
 171     if (from == 1) cout << "Destroyed:    FGThruster" << endl;
 172   }
 173   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 174   }
 175   if (debug_lvl & 8 ) { // Runtime state variables
 176   }
 177   if (debug_lvl & 16) { // Sanity checking
 178   }
 179   if (debug_lvl & 64) {
 180     if (from == 0) { // Constructor
 181       cout << IdSrc << endl;
 182       cout << IdHdr << endl;
 183     }
 184   }
 185 }
 186 }