SimVessel.cs

/*
 * Copyright Lamont Granquist, Sebastien Gaggini and the MechJeb contributors
 * SPDX-License-Identifier: LicenseRef-PD-hp OR Unlicense OR CC0-1.0 OR 0BSD OR MIT-0 OR MIT OR LGPL-2.1+
 */

using System;
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using System.Text;
using MechJebLib.FuelFlowSimulation.PartModules;
using MechJebLib.Primitives;
using MechJebLib.Utils;

namespace MechJebLib.FuelFlowSimulation
{
    public class SimVessel : IDisposable
    {
        private static readonly ObjectPool<SimVessel> _pool = new ObjectPool<SimVessel>(New, Clear);

        public readonly List<SimPart>                      Parts                   = new List<SimPart>(30);
        public readonly DictOfLists<int, SimPart>          PartsRemainingInStage   = new DictOfLists<int, SimPart>(10);
        public readonly DictOfLists<int, SimModuleEngines> EnginesDroppedInStage   = new DictOfLists<int, SimModuleEngines>(10);
        public readonly DictOfLists<int, SimModuleEngines> EnginesActivatedInStage = new DictOfLists<int, SimModuleEngines>(10);
        public readonly DictOfLists<int, SimModuleRCS>     RCSActivatedInStage     = new DictOfLists<int, SimModuleRCS>(10);
        public readonly DictOfLists<int, SimModuleRCS>     RCSDroppedInStage       = new DictOfLists<int, SimModuleRCS>(10);
        public readonly List<SimModuleEngines>             ActiveEngines           = new List<SimModuleEngines>(10);
        public readonly List<SimModuleRCS>                 ActiveRcs               = new List<SimModuleRCS>(10);

        public bool   HasLaunchClamp;
        public int    CurrentStage;
        public double MainThrottle = 1.0;
        public double Mass;
        public V3     ThrustCurrent;
        public double RcsThrust;
        public double ThrustMagnitude;
        public double ThrustNoCosLoss;
        public double SpoolupCurrent;
        public double ATMPressure;
        public double ATMDensity;
        public double MachNumber;
        public double T;
        public V3     R, V, U;

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void SetConditions(double atmDensity, double atmPressure, double machNumber)
        {
            ATMDensity  = atmDensity;
            ATMPressure = atmPressure;
            MachNumber  = machNumber;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void SetInitial(double t, V3 r, V3 v, V3 u)
        {
            T = t;
            R = r;
            V = v;
            U = u;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void UpdateMass()
        {
            Mass = 0;

            foreach (SimPart part in PartsRemainingInStage[CurrentStage])
            {
                part.UpdateMass();
                Mass += part.Mass;
            }
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void Stage()
        {
            if (CurrentStage < 0)
                return;

            CurrentStage--;

            ActivateEnginesAndRCS();

            UpdateMass();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void ActivateEnginesAndRCS()
        {
            foreach (SimModuleEngines e in EnginesActivatedInStage[CurrentStage])
                if (e.IsEnabled)
                    e.Activate();

            foreach (SimModuleRCS r in RCSActivatedInStage[CurrentStage])
                if (r.IsEnabled)
                    r.Activate();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void UpdateActiveEngines()
        {
            ActiveEngines.Clear();

            // FIXME: why am i not iterating over the last ActiveEngines?
            for (int i = -1; i < CurrentStage; i++)
            {
                foreach (SimModuleEngines e in EnginesDroppedInStage[i])
                {
                    if (e.MassFlowRate <= 0) continue;

                    if (e.UnrestartableDeadEngine)
                        continue;

                    e.UpdateEngineStatus();

                    if (!e.IsOperational)
                        continue;

                    ActiveEngines.Add(e);
                }
            }

            ComputeThrustAndSpoolup();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void UpdateActiveRcs()
        {
            ActiveRcs.Clear();

            // FIXME: why am i not iterating over the last ActiveRcs?
            for (int i = -1; i < CurrentStage; i++)
            {
                foreach (SimModuleRCS r in RCSDroppedInStage[i])
                {
                    if (r.MassFlowRate <= 0) continue;

                    r.UpdateRCSStatus();

                    if (!r.RcsEnabled)
                        continue;

                    ActiveRcs.Add(r);
                }
            }

            ComputeRcsThrust();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private void ComputeRcsThrust()
        {
            RcsThrust = 0;

            for (int i = 0; i < ActiveRcs.Count; i++)
            {
                SimModuleRCS r = ActiveRcs[i];

                r.Update();
                RcsThrust += r.Thrust;
            }
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private void ComputeThrustAndSpoolup()
        {
            ThrustCurrent   = V3.zero;
            ThrustMagnitude = 0;
            ThrustNoCosLoss = 0;
            SpoolupCurrent  = 0;

            for (int i = 0; i < ActiveEngines.Count; i++)
            {
                SimModuleEngines e = ActiveEngines[i];

                if (!e.IsOperational)
                    continue;

                SpoolupCurrent += e.ThrustCurrent.magnitude * e.ModuleSpoolupTime;

                e.Update();
                ThrustCurrent   += e.ThrustCurrent;
                ThrustNoCosLoss += e.ThrustCurrent.magnitude;
            }

            ThrustMagnitude =  ThrustCurrent.magnitude;
            SpoolupCurrent  /= ThrustCurrent.magnitude;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void Dispose()
        {
            foreach (SimPart p in Parts)
                p.Dispose();
            _pool.Release(this);
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static SimVessel Borrow() => _pool.Borrow();

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static SimVessel New() => new SimVessel();

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static void Clear(SimVessel v)
        {
            v.HasLaunchClamp = false;
            v.Parts.Clear();
            v.PartsRemainingInStage.Clear();
            v.EnginesDroppedInStage.Clear();
            v.EnginesActivatedInStage.Clear();
            v.RCSActivatedInStage.Clear();
            v.RCSDroppedInStage.Clear();
            v.ActiveEngines.Clear();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void UpdateRcsStats()
        {
            for (int i = -1; i < CurrentStage; i++)
                foreach (SimModuleRCS e in RCSDroppedInStage[i])
                    e.Update();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void UpdateEngineStats()
        {
            for (int i = -1; i < CurrentStage; i++)
                foreach (SimModuleEngines e in EnginesDroppedInStage[i])
                    e.Update();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void SaveRcsStatus()
        {
            for (int i = -1; i < CurrentStage; i++)
                foreach (SimModuleRCS r in RCSDroppedInStage[i])
                    r.SaveStatus();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void ResetRcsStatus()
        {
            for (int i = -1; i < CurrentStage; i++)
                foreach (SimModuleRCS r in RCSDroppedInStage[i])
                    r.ResetStatus();
        }

        public override string ToString()
        {
            var sb = new StringBuilder();

            for (int i = 0; i <= CurrentStage; i++)
            {
                sb.AppendLine($"stage {i}:");
                foreach (SimPart part in PartsRemainingInStage[i])
                    sb.Append(part);
                sb.AppendLine("------------------------");
            }

            return sb.ToString();
        }
    }
}