1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8 ------------- Copyright (C) 1999 Jon S. Berndt (jon@jsbsim.org) -------------
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
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
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.
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.
27 FUNCTIONAL DESCRIPTION
28 --------------------------------------------------------------------------------
32 --------------------------------------------------------------------------------
35 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40 #include "FGFDMExec.h"
41 #include "input_output/FGXMLElement.h"
42 #include "input_output/FGPropertyManager.h"
50 static const char *IdSrc = "$Id: FGTank.cpp,v 1.33 2011/10/31 14:54:41 bcoconni Exp $";
51 static const char *IdHdr = ID_TANK;
53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
57 FGTank::FGTank(FGFDMExec* exec, Element* el, int tank_number)
58 : TankNumber(tank_number), Exec(exec)
60 string token, strFuelName;
62 Element* element_Grain;
65 InitialTemperature = Temperature = -9999.0;
66 Ixx = Iyy = Izz = 0.0;
67 Radius = Contents = Standpipe = Length = InnerRadius = 0.0;
70 InitialStandpipe = 0.0;
72 Priority = InitialPriority = 1;
73 PropertyManager = Exec->GetPropertyManager();
75 vXYZ_drain.InitMatrix();
77 type = el->GetAttributeValue("type");
78 if (type == "FUEL") Type = ttFUEL;
79 else if (type == "OXIDIZER") Type = ttOXIDIZER;
80 else Type = ttUNKNOWN;
82 element = el->FindElement("location");
83 if (element) vXYZ = element->FindElementTripletConvertTo("IN");
84 else cerr << "No location found for this tank." << endl;
86 vXYZ_drain = vXYZ; // Set initial drain location to initial tank CG
88 element = el->FindElement("drain_location");
90 vXYZ_drain = element->FindElementTripletConvertTo("IN");
93 if (el->FindElement("radius"))
94 Radius = el->FindElementValueAsNumberConvertTo("radius", "IN");
95 if (el->FindElement("capacity"))
96 Capacity = el->FindElementValueAsNumberConvertTo("capacity", "LBS");
97 if (el->FindElement("contents"))
98 InitialContents = Contents = el->FindElementValueAsNumberConvertTo("contents", "LBS");
99 if (el->FindElement("temperature"))
100 InitialTemperature = Temperature = el->FindElementValueAsNumber("temperature");
101 if (el->FindElement("standpipe"))
102 InitialStandpipe = Standpipe = el->FindElementValueAsNumberConvertTo("standpipe", "LBS");
103 if (el->FindElement("priority"))
104 InitialPriority = Priority = (int)el->FindElementValueAsNumber("priority");
105 if (el->FindElement("density"))
106 Density = el->FindElementValueAsNumberConvertTo("density", "LBS/GAL");
107 if (el->FindElement("type"))
108 strFuelName = el->FindElementValue("type");
111 SetPriority( InitialPriority ); // this will also set the Selected flag
114 cerr << "Tank capacity must not be zero. Reset to 0.00001 lbs!" << endl;
118 PctFull = 100.0*Contents/Capacity; // percent full; 0 to 100.0
120 // Check whether this is a solid propellant "tank". Initialize it if true.
122 grainType = gtUNKNOWN; // This is the default
124 element_Grain = el->FindElement("grain_config");
127 strGType = element_Grain->GetAttributeValue("type");
128 if (strGType == "CYLINDRICAL") grainType = gtCYLINDRICAL;
129 else if (strGType == "ENDBURNING") grainType = gtENDBURNING;
130 else cerr << "Unknown propellant grain type specified" << endl;
132 if (element_Grain->FindElement("length"))
133 Length = element_Grain->FindElementValueAsNumberConvertTo("length", "IN");
134 if (element_Grain->FindElement("bore_diameter"))
135 InnerRadius = element_Grain->FindElementValueAsNumberConvertTo("bore_diameter", "IN")/2.0;
137 // Initialize solid propellant values for debug and runtime use.
141 if (Radius <= InnerRadius) {
142 cerr << "The bore diameter should be smaller than the total grain diameter!" << endl;
145 Volume = M_PI * Length * (Radius*Radius - InnerRadius*InnerRadius); // cubic inches
148 Volume = M_PI * Length * Radius * Radius; // cubic inches
151 cerr << "Unknown grain type found in this rocket engine definition." << endl;
154 Density = (Contents*lbtoslug)/Volume; // slugs/in^3
158 string property_name, base_property_name;
159 base_property_name = CreateIndexedPropertyName("propulsion/tank", TankNumber);
160 property_name = base_property_name + "/contents-lbs";
161 PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetContents,
162 &FGTank::SetContents );
163 property_name = base_property_name + "/priority";
164 PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetPriority,
165 &FGTank::SetPriority );
166 property_name = base_property_name + "/external-flow-rate-pps";
167 PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetExternalFlow,
168 &FGTank::SetExternalFlow );
170 if (Temperature != -9999.0) InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
171 Area = 40.0 * pow(Capacity/1975, 0.666666667);
173 // A named fuel type will override a previous density value
174 if (!strFuelName.empty()) Density = ProcessFuelName(strFuelName);
179 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
186 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
188 void FGTank::ResetToIC(void)
190 SetTemperature( InitialTemperature );
191 SetStandpipe ( InitialStandpipe );
192 SetContents ( InitialContents );
193 PctFull = 100.0*Contents/Capacity;
194 SetPriority( InitialPriority );
198 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
200 FGColumnVector3 FGTank::GetXYZ(void) const
202 return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
205 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
207 double FGTank::GetXYZ(int idx) const
209 return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
212 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
214 double FGTank::Drain(double used)
216 // double AmountToDrain = 2.0*used - PreviousUsed;
217 double remaining = Contents - used;
219 if (remaining >= 0) { // Reduce contents by amount used.
222 PctFull = 100.0*Contents/Capacity;
224 } else { // This tank must be empty.
229 // PreviousUsed = AmountToDrain;
230 if (grainType != gtUNKNOWN) CalculateInertias();
235 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
237 double FGTank::Fill(double amount)
239 double overage = 0.0;
243 if (Contents > Capacity) {
244 overage = Contents - Capacity;
248 PctFull = Contents/Capacity*100.0;
253 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
255 void FGTank::SetContents(double amount)
258 if (Contents > Capacity) {
262 PctFull = Contents/Capacity*100.0;
266 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
268 void FGTank::SetContentsGallons(double gallons)
270 SetContents(gallons * Density);
274 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
276 double FGTank::Calculate(double dt, double TAT_C)
278 if(ExternalFlow < 0.) Drain( -ExternalFlow *dt);
279 else Fill(ExternalFlow * dt);
281 if (Temperature == -9999.0) return 0.0;
282 double HeatCapacity = 900.0; // Joules/lbm/C
283 double TempFlowFactor = 1.115; // Watts/sqft/C
284 double Tdiff = TAT_C - Temperature;
285 double dTemp = 0.0; // Temp change due to one surface
286 if (fabs(Tdiff) > 0.1) {
287 dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
290 return Temperature += (dTemp + dTemp); // For now, assume upper/lower the same
293 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
294 // This function calculates the moments of inertia for a solid propellant
295 // grain - either an end burning cylindrical grain or a bored cylindrical
298 void FGTank::CalculateInertias(void)
300 double Mass = Contents*lbtoslug;
302 double Rad2 = Radius*Radius;
305 Volume = (Contents*lbtoslug)/Density; // in^3
307 cerr << endl << " Solid propellant grain density is zero!" << endl << endl;
313 InnerRadius = sqrt(Rad2 - Volume/(M_PI * Length));
314 RadSumSqr = (Rad2 + InnerRadius*InnerRadius)/144.0;
315 Ixx = 0.5*Mass*RadSumSqr;
316 Iyy = Mass*(3.0*RadSumSqr + Length*Length/144.0)/12.0;
319 Length = Volume/(M_PI*Rad2);
320 Ixx = 0.5*Mass*Rad2/144.0;
321 Iyy = Mass*(3.0*Rad2 + Length*Length)/(144.0*12.0);
324 cerr << "Unknown grain type found." << endl;
332 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
334 double FGTank::ProcessFuelName(const std::string& name)
336 if (name == "AVGAS") return 6.02;
337 else if (name == "JET-A") return 6.74;
338 else if (name == "JET-A1") return 6.74;
339 else if (name == "JET-B") return 6.48;
340 else if (name == "JP-1") return 6.76;
341 else if (name == "JP-2") return 6.38;
342 else if (name == "JP-3") return 6.34;
343 else if (name == "JP-4") return 6.48;
344 else if (name == "JP-5") return 6.81;
345 else if (name == "JP-6") return 6.55;
346 else if (name == "JP-7") return 6.61;
347 else if (name == "JP-8") return 6.66;
348 else if (name == "JP-8+100") return 6.66;
349 //else if (name == "JP-9") return 6.74;
350 //else if (name == "JPTS") return 6.74;
351 else if (name == "RP-1") return 6.73;
352 else if (name == "T-1") return 6.88;
353 else if (name == "ETHANOL") return 6.58;
354 else if (name == "HYDRAZINE")return 8.61;
355 else if (name == "F-34") return 6.66;
356 else if (name == "F-35") return 6.74;
357 else if (name == "F-40") return 6.48;
358 else if (name == "F-44") return 6.81;
359 else if (name == "AVTAG") return 6.48;
360 else if (name == "AVCAT") return 6.81;
362 cerr << "Unknown fuel type specified: "<< name << endl;
369 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
370 // The bitmasked value choices are as follows:
371 // unset: In this case (the default) JSBSim would only print
372 // out the normally expected messages, essentially echoing
373 // the config files as they are read. If the environment
374 // variable is not set, debug_lvl is set to 1 internally
375 // 0: This requests JSBSim not to output any messages
377 // 1: This value explicity requests the normal JSBSim
379 // 2: This value asks for a message to be printed out when
380 // a class is instantiated
381 // 4: When this value is set, a message is displayed when a
382 // FGModel object executes its Run() method
383 // 8: When this value is set, various runtime state variables
384 // are printed out periodically
385 // 16: When set various parameters are sanity checked and
386 // a message is printed out when they go out of bounds
388 void FGTank::Debug(int from)
390 if (debug_lvl <= 0) return;
392 if (debug_lvl & 1) { // Standard console startup message output
393 if (from == 0) { // Constructor
394 cout << " " << type << " tank holds " << Capacity << " lbs. " << type << endl;
395 cout << " currently at " << PctFull << "% of maximum capacity" << endl;
396 cout << " Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
397 cout << " Effective radius: " << Radius << " inches" << endl;
398 cout << " Initial temperature: " << Temperature << " Fahrenheit" << endl;
399 cout << " Priority: " << Priority << endl;
402 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
403 if (from == 0) cout << "Instantiated: FGTank" << endl;
404 if (from == 1) cout << "Destroyed: FGTank" << endl;
406 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
408 if (debug_lvl & 8 ) { // Runtime state variables
410 if (debug_lvl & 16) { // Sanity checking
412 if (debug_lvl & 64) {
413 if (from == 0) { // Constructor
414 cout << IdSrc << endl;
415 cout << IdHdr << endl;