]> git.mxchange.org Git - flightgear.git/blobdiff - src/FDM/JSBSim/models/propulsion/FGTank.cpp
Merge branch 'next' into durk-atc
[flightgear.git] / src / FDM / JSBSim / models / propulsion / FGTank.cpp
index 57bebd7dc2a8ba141ffe5422e522178af6b6ecdc..c9d38dab871b08c8396143f284d4a122098df3dd 100644 (file)
@@ -5,23 +5,23 @@
  Date started: 01/21/99
  Called by:    FGAircraft
 
- ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
+ ------------- Copyright (C) 1999  Jon S. Berndt (jon@jsbsim.org) -------------
 
  This program is free software; you can redistribute it and/or modify it under
- the terms of the GNU General Public License as published by the Free Software
+ the terms of the GNU Lesser General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.
 
  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  details.
 
- You should have received a copy of the GNU General Public License along with
+ You should have received a copy of the GNU Lesser General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  Place - Suite 330, Boston, MA  02111-1307, USA.
 
- Further information about the GNU General Public License can also be found on
+ Further information about the GNU Lesser General Public License can also be found on
  the world wide web at http://www.gnu.org.
 
 FUNCTIONAL DESCRIPTION
@@ -36,33 +36,42 @@ HISTORY
 INCLUDES
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-#include <FGFDMExec.h>
-#include <models/FGAuxiliary.h>
 #include "FGTank.h"
+#include "FGFDMExec.h"
+#include "models/FGAuxiliary.h"
+#include "input_output/FGXMLElement.h"
+#include "input_output/FGPropertyManager.h"
+#include <iostream>
+#include <cstdlib>
 
-#if !defined ( sgi ) || defined( __GNUC__ ) && (_COMPILER_VERSION < 740)
-using std::cerr;
-using std::endl;
-using std::cout;
-#endif
+using namespace std;
 
 namespace JSBSim {
 
-static const char *IdSrc = "$Id$";
+static const char *IdSrc = "$Id: FGTank.cpp,v 1.28 2010/01/24 19:26:04 jberndt Exp $";
 static const char *IdHdr = ID_TANK;
 
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 CLASS IMPLEMENTATION
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-FGTank::FGTank(FGFDMExec* exec, Element* el)
+FGTank::FGTank(FGFDMExec* exec, Element* el, int tank_number)
+                  : TankNumber(tank_number), Exec(exec)
 {
-  string token;
+  string token, strFuelName;
   Element* element;
+  Element* element_Grain;
   Area = 1.0;
-  Temperature = -9999.0;
-  Auxiliary = exec->GetAuxiliary();
-  Radius = Capacity = Contents = 0.0;
+  Density = 6.6;
+  InitialTemperature = Temperature = -9999.0;
+  Ixx = Iyy = Izz = 0.0;
+  Radius = Contents = Standpipe = Length = InnerRadius = 0.0;
+  InitialStandpipe = 0.0;
+  Capacity = 0.00001;
+  Priority = InitialPriority = 1;
+  PropertyManager = Exec->GetPropertyManager();
+  vXYZ.InitMatrix();
+  vXYZ_drain.InitMatrix();
 
   type = el->GetAttributeValue("type");
   if      (type == "FUEL")     Type = ttFUEL;
@@ -73,27 +82,93 @@ FGTank::FGTank(FGFDMExec* exec, Element* el)
   if (element)  vXYZ = element->FindElementTripletConvertTo("IN");
   else          cerr << "No location found for this tank." << endl;
 
+  vXYZ_drain = vXYZ; // Set initial drain location to initial tank CG
+
+  element = el->FindElement("drain_location");
+  if (element)  {
+    vXYZ_drain = element->FindElementTripletConvertTo("IN");
+  }
+
   if (el->FindElement("radius"))
     Radius = el->FindElementValueAsNumberConvertTo("radius", "IN");
   if (el->FindElement("capacity"))
     Capacity = el->FindElementValueAsNumberConvertTo("capacity", "LBS");
   if (el->FindElement("contents"))
-    Contents = el->FindElementValueAsNumberConvertTo("contents", "LBS");
+    InitialContents = Contents = el->FindElementValueAsNumberConvertTo("contents", "LBS");
   if (el->FindElement("temperature"))
-    Temperature = el->FindElementValueAsNumber("temperature");
-
-  Selected = true;
-
-  if (Capacity != 0) {
-    PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
-  } else {
-    Contents = 0;
-    PctFull  = 0;
+    InitialTemperature = Temperature = el->FindElementValueAsNumber("temperature");
+  if (el->FindElement("standpipe"))
+    InitialStandpipe = Standpipe = el->FindElementValueAsNumberConvertTo("standpipe", "LBS");
+  if (el->FindElement("priority"))
+    InitialPriority = Priority = el->FindElementValueAsNumber("priority");
+  if (el->FindElement("density"))
+    Density = el->FindElementValueAsNumberConvertTo("density", "LBS/GAL");
+  if (el->FindElement("type"))
+    strFuelName = el->FindElementValue("type");
+
+
+  SetPriority( InitialPriority );     // this will also set the Selected flag
+
+  if (Capacity == 0) {
+    cerr << "Tank capacity must not be zero. Reset to 0.00001 lbs!" << endl;
+    Capacity = 0.00001;
+    Contents = 0.0;
+  }
+  PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
+
+  // Check whether this is a solid propellant "tank". Initialize it if true.
+
+  grainType = gtUNKNOWN; // This is the default
+  
+  element_Grain = el->FindElement("grain_config");
+  if (element_Grain) {
+
+    strGType = element_Grain->GetAttributeValue("type");
+    if (strGType == "CYLINDRICAL")     grainType = gtCYLINDRICAL;
+    else if (strGType == "ENDBURNING") grainType = gtENDBURNING;
+    else                               cerr << "Unknown propellant grain type specified" << endl;
+
+    if (element_Grain->FindElement("length"))
+      Length = element_Grain->FindElementValueAsNumberConvertTo("length", "IN");
+    if (element_Grain->FindElement("bore_diameter"))
+      InnerRadius = element_Grain->FindElementValueAsNumberConvertTo("bore_diameter", "IN")/2.0;
+
+    // Initialize solid propellant values for debug and runtime use.
+
+    switch (grainType) {
+      case gtCYLINDRICAL:
+        if (Radius <= InnerRadius) {
+          cerr << "The bore diameter should be smaller than the total grain diameter!" << endl;
+          exit(-1);
+        }
+        Volume = M_PI * Length * (Radius*Radius - InnerRadius*InnerRadius); // cubic inches
+        break;
+      case gtENDBURNING:
+        Volume = M_PI * Length * Radius * Radius; // cubic inches
+        break;
+      case gtUNKNOWN:
+        cerr << "Unknown grain type found in this rocket engine definition." << endl;
+        exit(-1);
+    }
+    Density = (Contents*lbtoslug)/Volume; // slugs/in^3
+    CalculateInertias();
   }
 
-  if (Temperature != -9999.0)  Temperature = FahrenheitToCelsius(Temperature);
+  string property_name, base_property_name;
+  base_property_name = CreateIndexedPropertyName("propulsion/tank", TankNumber);
+  property_name = base_property_name + "/contents-lbs";
+  PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetContents,
+                                       &FGTank::SetContents );
+  property_name = base_property_name + "/priority";
+  PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetPriority,
+                                       &FGTank::SetPriority );
+
+  if (Temperature != -9999.0)  InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
   Area = 40.0 * pow(Capacity/1975, 0.666666667);
 
+  // A named fuel type will override a previous density value
+  if (!strFuelName.empty()) Density = ProcessFuelName(strFuelName); 
+
   Debug(0);
 }
 
@@ -106,19 +181,49 @@ FGTank::~FGTank()
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+void FGTank::ResetToIC(void)
+{
+  SetTemperature( InitialTemperature );
+  SetStandpipe ( InitialStandpipe );
+  SetContents ( InitialContents );
+  PctFull = 100.0*Contents/Capacity;
+  SetPriority( InitialPriority );
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+const FGColumnVector3 FGTank::GetXYZ(void)
+{
+  return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+const double FGTank::GetXYZ(int idx)
+{
+  return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 double FGTank::Drain(double used)
 {
-  double shortage = Contents - used;
+  double remaining = Contents - used;
+
+  if (remaining >= 0) { // Reduce contents by amount used.
 
-  if (shortage >= 0) {
     Contents -= used;
     PctFull = 100.0*Contents/Capacity;
-  } else {
+
+  } else { // This tank must be empty.
+
     Contents = 0.0;
     PctFull = 0.0;
-    Selected = false;
   }
-  return shortage;
+
+  if (grainType != gtUNKNOWN) CalculateInertias();
+
+  return remaining;
 }
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -152,6 +257,14 @@ void FGTank::SetContents(double amount)
   }
 }
 
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+void FGTank::SetContentsGallons(double gallons)
+{
+  SetContents(gallons * Density);
+}
+
+
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 double FGTank::Calculate(double dt)
@@ -159,15 +272,91 @@ double FGTank::Calculate(double dt)
   if (Temperature == -9999.0) return 0.0;
   double HeatCapacity = 900.0;        // Joules/lbm/C
   double TempFlowFactor = 1.115;      // Watts/sqft/C
-  double TAT = Auxiliary->GetTAT_C();
+  double TAT = Exec->GetAuxiliary()->GetTAT_C();
   double Tdiff = TAT - Temperature;
-  double dT = 0.0;                    // Temp change due to one surface
+  double dTemp = 0.0;                 // Temp change due to one surface
   if (fabs(Tdiff) > 0.1) {
-    dT = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
+    dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
   }
-  return Temperature += (dT + dT);    // For now, assume upper/lower the same
+  return Temperature += (dTemp + dTemp);    // For now, assume upper/lower the same
 }
 
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+//  This function calculates the moments of inertia for a solid propellant
+//  grain - either an end burning cylindrical grain or a bored cylindrical
+//  grain.
+
+void FGTank::CalculateInertias(void)
+{
+  double Mass = Contents*lbtoslug;
+  double RadSumSqr;
+  double Rad2 = Radius*Radius;
+
+  if (Density > 0.0) {
+    Volume = (Contents*lbtoslug)/Density; // in^3
+  } else {
+    cerr << endl << "  Solid propellant grain density is zero!" << endl << endl;
+    exit(-1);
+  }
+
+  switch (grainType) {
+    case gtCYLINDRICAL:
+      InnerRadius = sqrt(Rad2 - Volume/(M_PI * Length));
+      RadSumSqr = (Rad2 + InnerRadius*InnerRadius)/144.0;
+      Ixx = 0.5*Mass*RadSumSqr;
+      Iyy = Mass*(3.0*RadSumSqr + Length*Length/144.0)/12.0;
+      break;
+    case gtENDBURNING:
+      Length = Volume/(M_PI*Rad2);
+      Ixx = 0.5*Mass*Rad2/144.0;
+      Iyy = Mass*(3.0*Rad2 + Length*Length)/(144.0*12.0);
+      break;
+    case gtUNKNOWN:
+      cerr << "Unknown grain type found." << endl;
+      exit(-1);
+      break;
+  }
+  Izz  = Iyy;
+
+}
+
+//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+double FGTank::ProcessFuelName(std::string const& name)
+{
+   if      (name == "AVGAS")    return 6.02; 
+   else if (name == "JET-A")    return 6.74;
+   else if (name == "JET-A1")   return 6.74;
+   else if (name == "JET-B")    return 6.48;
+   else if (name == "JP-1")     return 6.76;
+   else if (name == "JP-2")     return 6.38;
+   else if (name == "JP-3")     return 6.34;
+   else if (name == "JP-4")     return 6.48;
+   else if (name == "JP-5")     return 6.81;
+   else if (name == "JP-6")     return 6.55;
+   else if (name == "JP-7")     return 6.61;
+   else if (name == "JP-8")     return 6.66;
+   else if (name == "JP-8+100") return 6.66;
+ //else if (name == "JP-9")     return 6.74;
+ //else if (name == "JPTS")     return 6.74;
+   else if (name == "RP-1")     return 6.73;
+   else if (name == "T-1")      return 6.88;
+   else if (name == "ETHANOL")  return 6.58;
+   else if (name == "HYDRAZINE")return 8.61;
+   else if (name == "F-34")     return 6.66;
+   else if (name == "F-35")     return 6.74;
+   else if (name == "F-40")     return 6.48;
+   else if (name == "F-44")     return 6.81;
+   else if (name == "AVTAG")    return 6.48;
+   else if (name == "AVCAT")    return 6.81;
+   else {
+     cerr << "Unknown fuel type specified: "<< name << endl;
+   } 
+
+   return 6.6;
+}
+
+
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 //    The bitmasked value choices are as follows:
 //    unset: In this case (the default) JSBSim would only print
@@ -198,6 +387,7 @@ void FGTank::Debug(int from)
       cout << "      Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
       cout << "      Effective radius: " << Radius << " inches" << endl;
       cout << "      Initial temperature: " << Temperature << " Fahrenheit" << endl;
+      cout << "      Priority: " << Priority << endl;
     }
   }
   if (debug_lvl & 2 ) { // Instantiation/Destruction notification