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 "models/FGAuxiliary.h"
42 #include "input_output/FGXMLElement.h"
43 #include "input_output/FGPropertyManager.h"
51 static const char *IdSrc = "$Id$";
52 static const char *IdHdr = ID_TANK;
54 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
58 FGTank::FGTank(FGFDMExec* exec, Element* el, int tank_number)
59 : TankNumber(tank_number), Exec(exec)
63 Element* element_Grain;
66 InitialTemperature = Temperature = -9999.0;
67 Ixx = Iyy = Izz = 0.0;
68 Radius = Contents = Standpipe = Length = InnerRadius = 0.0;
70 Priority = InitialPriority = 1;
71 PropertyManager = Exec->GetPropertyManager();
73 vXYZ_drain.InitMatrix();
75 type = el->GetAttributeValue("type");
76 if (type == "FUEL") Type = ttFUEL;
77 else if (type == "OXIDIZER") Type = ttOXIDIZER;
78 else Type = ttUNKNOWN;
80 element = el->FindElement("location");
81 if (element) vXYZ = element->FindElementTripletConvertTo("IN");
82 else cerr << "No location found for this tank." << endl;
84 vXYZ_drain = vXYZ; // Set initial drain location to initial tank CG
86 element = el->FindElement("drain_location");
88 vXYZ_drain = element->FindElementTripletConvertTo("IN");
91 if (el->FindElement("radius"))
92 Radius = el->FindElementValueAsNumberConvertTo("radius", "IN");
93 if (el->FindElement("capacity"))
94 Capacity = el->FindElementValueAsNumberConvertTo("capacity", "LBS");
95 if (el->FindElement("contents"))
96 InitialContents = Contents = el->FindElementValueAsNumberConvertTo("contents", "LBS");
97 if (el->FindElement("temperature"))
98 InitialTemperature = Temperature = el->FindElementValueAsNumber("temperature");
99 if (el->FindElement("standpipe"))
100 InitialStandpipe = Standpipe = el->FindElementValueAsNumberConvertTo("standpipe", "LBS");
101 if (el->FindElement("priority"))
102 InitialPriority = Priority = el->FindElementValueAsNumber("priority");
103 if (el->FindElement("density"))
104 Density = el->FindElementValueAsNumberConvertTo("density", "LBS/GAL");
106 SetPriority( InitialPriority ); // this will also set the Selected flag
109 cerr << "Tank capacity must not be zero. Reset to 0.00001 lbs!" << endl;
113 PctFull = 100.0*Contents/Capacity; // percent full; 0 to 100.0
115 // Check whether this is a solid propellant "tank". Initialize it if true.
117 grainType = gtUNKNOWN; // This is the default
119 element_Grain = el->FindElement("grain_config");
122 strGType = element_Grain->GetAttributeValue("type");
123 if (strGType == "CYLINDRICAL") grainType = gtCYLINDRICAL;
124 else if (strGType == "ENDBURNING") grainType = gtENDBURNING;
125 else cerr << "Unknown propellant grain type specified" << endl;
127 if (element_Grain->FindElement("length"))
128 Length = element_Grain->FindElementValueAsNumberConvertTo("length", "IN");
129 if (element_Grain->FindElement("bore_diameter"))
130 InnerRadius = element_Grain->FindElementValueAsNumberConvertTo("bore_diameter", "IN")/2.0;
132 // Initialize solid propellant values for debug and runtime use.
136 if (Radius <= InnerRadius) {
137 cerr << "The bore diameter should be smaller than the total grain diameter!" << endl;
140 Volume = M_PI * Length * (Radius*Radius - InnerRadius*InnerRadius); // cubic inches
143 Volume = M_PI * Length * Radius * Radius; // cubic inches
146 cerr << "Unknown grain type found in this rocket engine definition." << endl;
149 Density = (Contents*lbtoslug)/Volume; // slugs/in^3
153 string property_name, base_property_name;
154 base_property_name = CreateIndexedPropertyName("propulsion/tank", TankNumber);
155 property_name = base_property_name + "/contents-lbs";
156 PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetContents,
157 &FGTank::SetContents );
158 property_name = base_property_name + "/priority";
159 PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetPriority,
160 &FGTank::SetPriority );
162 if (Temperature != -9999.0) InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
163 Area = 40.0 * pow(Capacity/1975, 0.666666667);
168 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
175 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
177 void FGTank::ResetToIC(void)
179 SetTemperature( InitialTemperature );
180 SetStandpipe ( InitialStandpipe );
181 SetContents ( InitialContents );
182 PctFull = 100.0*Contents/Capacity;
183 SetPriority( InitialPriority );
186 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
188 const FGColumnVector3 FGTank::GetXYZ(void)
190 return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
193 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
195 const double FGTank::GetXYZ(int idx)
197 return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
200 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
202 double FGTank::Drain(double used)
204 double remaining = Contents - used;
206 if (remaining >= 0) { // Reduce contents by amount used.
209 PctFull = 100.0*Contents/Capacity;
211 } else { // This tank must be empty.
217 if (grainType != gtUNKNOWN) CalculateInertias();
222 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
224 double FGTank::Fill(double amount)
226 double overage = 0.0;
230 if (Contents > Capacity) {
231 overage = Contents - Capacity;
235 PctFull = Contents/Capacity*100.0;
240 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
242 void FGTank::SetContents(double amount)
245 if (Contents > Capacity) {
249 PctFull = Contents/Capacity*100.0;
253 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
255 void FGTank::SetContentsGallons(double gallons)
257 SetContents(gallons * Density);
261 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
263 double FGTank::Calculate(double dt)
265 if (Temperature == -9999.0) return 0.0;
266 double HeatCapacity = 900.0; // Joules/lbm/C
267 double TempFlowFactor = 1.115; // Watts/sqft/C
268 double TAT = Exec->GetAuxiliary()->GetTAT_C();
269 double Tdiff = TAT - Temperature;
270 double dTemp = 0.0; // Temp change due to one surface
271 if (fabs(Tdiff) > 0.1) {
272 dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
274 return Temperature += (dTemp + dTemp); // For now, assume upper/lower the same
277 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
278 // This function calculates the moments of inertia for a solid propellant
279 // grain - either an end burning cylindrical grain or a bored cylindrical
282 void FGTank::CalculateInertias(void)
284 double Mass = Contents*lbtoslug;
286 double Rad2 = Radius*Radius;
289 Volume = (Contents*lbtoslug)/Density; // in^3
291 cerr << endl << " Solid propellant grain density is zero!" << endl << endl;
297 InnerRadius = sqrt(Rad2 - Volume/(M_PI * Length));
298 RadSumSqr = (Rad2 + InnerRadius*InnerRadius)/144.0;
299 Ixx = 0.5*Mass*RadSumSqr;
300 Iyy = Mass*(3.0*RadSumSqr + Length*Length/144.0)/12.0;
303 Length = Volume/(M_PI*Rad2);
304 Ixx = 0.5*Mass*Rad2/144.0;
305 Iyy = Mass*(3.0*Rad2 + Length*Length)/(144.0*12.0);
308 cerr << "Unknown grain type found." << endl;
316 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
317 // The bitmasked value choices are as follows:
318 // unset: In this case (the default) JSBSim would only print
319 // out the normally expected messages, essentially echoing
320 // the config files as they are read. If the environment
321 // variable is not set, debug_lvl is set to 1 internally
322 // 0: This requests JSBSim not to output any messages
324 // 1: This value explicity requests the normal JSBSim
326 // 2: This value asks for a message to be printed out when
327 // a class is instantiated
328 // 4: When this value is set, a message is displayed when a
329 // FGModel object executes its Run() method
330 // 8: When this value is set, various runtime state variables
331 // are printed out periodically
332 // 16: When set various parameters are sanity checked and
333 // a message is printed out when they go out of bounds
335 void FGTank::Debug(int from)
337 if (debug_lvl <= 0) return;
339 if (debug_lvl & 1) { // Standard console startup message output
340 if (from == 0) { // Constructor
341 cout << " " << type << " tank holds " << Capacity << " lbs. " << type << endl;
342 cout << " currently at " << PctFull << "% of maximum capacity" << endl;
343 cout << " Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
344 cout << " Effective radius: " << Radius << " inches" << endl;
345 cout << " Initial temperature: " << Temperature << " Fahrenheit" << endl;
346 cout << " Priority: " << Priority << endl;
349 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
350 if (from == 0) cout << "Instantiated: FGTank" << endl;
351 if (from == 1) cout << "Destroyed: FGTank" << endl;
353 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
355 if (debug_lvl & 8 ) { // Runtime state variables
357 if (debug_lvl & 16) { // Sanity checking
359 if (debug_lvl & 64) {
360 if (from == 0) { // Constructor
361 cout << IdSrc << endl;
362 cout << IdHdr << endl;