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 "models/FGAuxiliary.h"
48 static const char *IdSrc = "$Id$";
49 static const char *IdHdr = ID_TANK;
51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
55 FGTank::FGTank(FGFDMExec* exec, Element* el, int tank_number)
56 : TankNumber(tank_number), Exec(exec)
60 Element* element_Grain;
62 Temperature = -9999.0;
63 Ixx = Iyy = Izz = 0.0;
64 Radius = Contents = Standpipe = Length = InnerRadius = 0.0;
66 Priority = InitialPriority = 1;
67 PropertyManager = Exec->GetPropertyManager();
69 vXYZ_drain.InitMatrix();
71 type = el->GetAttributeValue("type");
72 if (type == "FUEL") Type = ttFUEL;
73 else if (type == "OXIDIZER") Type = ttOXIDIZER;
74 else Type = ttUNKNOWN;
76 element = el->FindElement("location");
77 if (element) vXYZ = element->FindElementTripletConvertTo("IN");
78 else cerr << "No location found for this tank." << endl;
80 vXYZ_drain = vXYZ; // Set initial drain location to initial tank CG
82 element = el->FindElement("drain_location");
84 vXYZ_drain = element->FindElementTripletConvertTo("IN");
87 if (el->FindElement("radius"))
88 Radius = el->FindElementValueAsNumberConvertTo("radius", "IN");
89 if (el->FindElement("capacity"))
90 Capacity = el->FindElementValueAsNumberConvertTo("capacity", "LBS");
91 if (el->FindElement("contents"))
92 InitialContents = Contents = el->FindElementValueAsNumberConvertTo("contents", "LBS");
93 if (el->FindElement("temperature"))
94 InitialTemperature = Temperature = el->FindElementValueAsNumber("temperature");
95 if (el->FindElement("standpipe"))
96 InitialStandpipe = Standpipe = el->FindElementValueAsNumberConvertTo("standpipe", "LBS");
97 if (el->FindElement("priority"))
98 InitialPriority = Priority = el->FindElementValueAsNumber("priority");
100 SetPriority( InitialPriority ); // this will also set the Selected flag
103 cerr << "Tank capacity must not be zero. Reset to 0.00001 lbs!" << endl;
107 PctFull = 100.0*Contents/Capacity; // percent full; 0 to 100.0
109 // Check whether this is a solid propellant "tank". Initialize it if true.
111 grainType = gtUNKNOWN; // This is the default
113 element_Grain = el->FindElement("grain_config");
116 strGType = element_Grain->GetAttributeValue("type");
117 if (strGType == "CYLINDRICAL") grainType = gtCYLINDRICAL;
118 else if (strGType == "ENDBURNING") grainType = gtENDBURNING;
119 else cerr << "Unknown propellant grain type specified" << endl;
121 if (element_Grain->FindElement("length"))
122 Length = element_Grain->FindElementValueAsNumberConvertTo("length", "IN");
123 if (element_Grain->FindElement("bore_diameter"))
124 InnerRadius = element_Grain->FindElementValueAsNumberConvertTo("bore_diameter", "IN")/2.0;
126 // Initialize solid propellant values for debug and runtime use.
130 if (Radius <= InnerRadius) {
131 cerr << "The bore diameter should be smaller than the total grain diameter!" << endl;
134 Volume = M_PI * Length * (Radius*Radius - InnerRadius*InnerRadius); // cubic inches
137 Volume = M_PI * Length * Radius * Radius; // cubic inches
140 cerr << "Unknown grain type found in this rocket engine definition." << endl;
143 Density = (Contents*lbtoslug)/Volume; // slugs/in^3
147 string property_name, base_property_name;
148 base_property_name = CreateIndexedPropertyName("propulsion/tank", TankNumber);
149 property_name = base_property_name + "/contents-lbs";
150 PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetContents,
151 &FGTank::SetContents );
152 property_name = base_property_name + "/priority";
153 PropertyManager->Tie( property_name.c_str(), (FGTank*)this, &FGTank::GetPriority,
154 &FGTank::SetPriority );
156 if (Temperature != -9999.0) InitialTemperature = Temperature = FahrenheitToCelsius(Temperature);
157 Area = 40.0 * pow(Capacity/1975, 0.666666667);
162 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
169 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
171 void FGTank::ResetToIC(void)
173 SetTemperature( InitialTemperature );
174 SetStandpipe ( InitialStandpipe );
175 SetContents ( InitialContents );
176 PctFull = 100.0*Contents/Capacity;
177 SetPriority( InitialPriority );
180 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
182 const FGColumnVector3 FGTank::GetXYZ(void)
184 return vXYZ_drain + (Contents/Capacity)*(vXYZ - vXYZ_drain);
187 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
189 const double FGTank::GetXYZ(int idx)
191 return vXYZ_drain(idx) + (Contents/Capacity)*(vXYZ(idx)-vXYZ_drain(idx));
194 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
196 double FGTank::Drain(double used)
198 double remaining = Contents - used;
200 if (remaining >= 0) { // Reduce contents by amount used.
203 PctFull = 100.0*Contents/Capacity;
205 } else { // This tank must be empty.
212 if (grainType != gtUNKNOWN) CalculateInertias();
217 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
219 double FGTank::Fill(double amount)
221 double overage = 0.0;
225 if (Contents > Capacity) {
226 overage = Contents - Capacity;
230 PctFull = Contents/Capacity*100.0;
235 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
237 void FGTank::SetContents(double amount)
240 if (Contents > Capacity) {
244 PctFull = Contents/Capacity*100.0;
248 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
250 double FGTank::Calculate(double dt)
252 if (Temperature == -9999.0) return 0.0;
253 double HeatCapacity = 900.0; // Joules/lbm/C
254 double TempFlowFactor = 1.115; // Watts/sqft/C
255 double TAT = Exec->GetAuxiliary()->GetTAT_C();
256 double Tdiff = TAT - Temperature;
257 double dTemp = 0.0; // Temp change due to one surface
258 if (fabs(Tdiff) > 0.1) {
259 dTemp = (TempFlowFactor * Area * Tdiff * dt) / (Contents * HeatCapacity);
261 return Temperature += (dTemp + dTemp); // For now, assume upper/lower the same
264 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
265 // This function calculates the moments of inertia for a solid propellant
266 // grain - either an end burning cylindrical grain or a bored cylindrical
269 void FGTank::CalculateInertias(void)
271 double Mass = Contents*lbtoslug;
273 double Rad2 = Radius*Radius;
276 Volume = (Contents*lbtoslug)/Density; // in^3
278 cerr << endl << " Solid propellant grain density is zero!" << endl << endl;
284 InnerRadius = sqrt(Rad2 - Volume/(M_PI * Length));
285 RadSumSqr = (Rad2 + InnerRadius*InnerRadius)/144.0;
286 Ixx = 0.5*Mass*RadSumSqr;
287 Iyy = Mass*(3.0*RadSumSqr + Length*Length/144.0)/12.0;
290 Length = Volume/(M_PI*Rad2);
291 Ixx = 0.5*Mass*Rad2/144.0;
292 Iyy = Mass*(3.0*Rad2 + Length*Length)/(144.0*12.0);
295 cerr << "Unknown grain type found." << endl;
303 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
304 // The bitmasked value choices are as follows:
305 // unset: In this case (the default) JSBSim would only print
306 // out the normally expected messages, essentially echoing
307 // the config files as they are read. If the environment
308 // variable is not set, debug_lvl is set to 1 internally
309 // 0: This requests JSBSim not to output any messages
311 // 1: This value explicity requests the normal JSBSim
313 // 2: This value asks for a message to be printed out when
314 // a class is instantiated
315 // 4: When this value is set, a message is displayed when a
316 // FGModel object executes its Run() method
317 // 8: When this value is set, various runtime state variables
318 // are printed out periodically
319 // 16: When set various parameters are sanity checked and
320 // a message is printed out when they go out of bounds
322 void FGTank::Debug(int from)
324 if (debug_lvl <= 0) return;
326 if (debug_lvl & 1) { // Standard console startup message output
327 if (from == 0) { // Constructor
328 cout << " " << type << " tank holds " << Capacity << " lbs. " << type << endl;
329 cout << " currently at " << PctFull << "% of maximum capacity" << endl;
330 cout << " Tank location (X, Y, Z): " << vXYZ(eX) << ", " << vXYZ(eY) << ", " << vXYZ(eZ) << endl;
331 cout << " Effective radius: " << Radius << " inches" << endl;
332 cout << " Initial temperature: " << Temperature << " Fahrenheit" << endl;
333 cout << " Priority: " << Priority << endl;
336 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
337 if (from == 0) cout << "Instantiated: FGTank" << endl;
338 if (from == 1) cout << "Destroyed: FGTank" << endl;
340 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
342 if (debug_lvl & 8 ) { // Runtime state variables
344 if (debug_lvl & 16) { // Sanity checking
346 if (debug_lvl & 64) {
347 if (from == 0) { // Constructor
348 cout << IdSrc << endl;
349 cout << IdHdr << endl;