refactor(IB_Utility): remove SkipComponentLevelCheck, IsSavingHVACSystem, GlobalModel that was added to prevent crashing. Now no need to keep with new refactoring

Author: MingboPeng

src/Ironbug.Grasshopper/IronbugInfo.cs

@@ -29,7 +29,6 @@ public override GH_LoadingInstruction PriorityLoad()
         {
             try
             {
-                GH.Instances.DocumentServer.DocumentAdded += DocumentServer_DocumentAdded;
                 Action<string> logger = (string message) => Rhino.RhinoApp.WriteLine($"Ironbug {IronbugInfo.version} is loaded with {message}");
                 Core.OpenStudio.OpenStudioHelper.LoadAssemblies(logger);
             }
@@ -45,40 +44,6 @@ public override GH_LoadingInstruction PriorityLoad()
             return GH_LoadingInstruction.Proceed;
         }
 
-        private void DocumentServer_DocumentAdded(GH_DocumentServer sender, GH_Document doc)
-        {
-            if (doc != null)
-            {
-                //Rhino.RhinoApp.WriteLine($"Document added. Doc Name: {doc.DisplayName} {System.DateTime.Now}");
-                // Hook into the document events
-                doc.SolutionStart += OnSolutionStart;
-                doc.SolutionEnd += Doc_SolutionEnd;
-            }
-        }
-
-        private void Doc_SolutionEnd(object sender, GH_SolutionEventArgs e)
-        {
-            if (e.Document is GH_Document doc)
-            {
-                doc.SolutionEnd -= Doc_SolutionEnd;
-                // Detect the start of document loading process
-                //Rhino.RhinoApp.WriteLine($"Document is Ending its solution. Doc Name: {doc.DisplayName} {System.DateTime.Now}");
-                IB_Utility.SkipComponentLevelCheck = false;
-
-            }
-        }
-
-        private void OnSolutionStart(object sender, GH_SolutionEventArgs e)
-        {
-         
-            if (e.Document is GH_Document doc)
-            {
-                doc.SolutionStart -= OnSolutionStart;
-                // Detect the start of document loading process
-                //Rhino.RhinoApp.WriteLine($"Document is starting its solution. Doc Name: {doc.DisplayName} {System.DateTime.Now}");
-                IB_Utility.SkipComponentLevelCheck = true;
-            }
-        }
 
     }
 }

src/Ironbug.HVAC/BaseClass/IB_ModelObject.cs

@@ -267,18 +267,8 @@ public void SetFieldValue(IB_Field field, object value)
             //but it should have all the same field values as the real one, except handles.
             try
             {
-                object realValue = value;
                 // check and convert IB_Curve IB_Schedule and IB_AvailabilityManager to OpenStudio object
-                if (!realValue.IsFieldValueRealType())
-                {
-                    // the GH file is opening, so no need to do a real-time type checks for users
-                    if (IB_Utility.SkipComponentLevelCheck)
-                        return;
-
-                    var md = this.GhostOSObject.TryGetObjectModel(this.GhostOSModel);
-                    realValue = value.TryGetRealFieldValue(md);
-                }
-
+                var realValue = value.TryGetRealFieldValue(this.GhostOSModel);
                 this.GhostOSObject?.SetFieldValue(field, realValue);
             }
             catch (Exception ex)

src/Ironbug.HVAC/IB_Utility.cs

@@ -7,13 +7,6 @@ namespace Ironbug.HVAC
 {
     public class IB_Utility
     {
-        public static bool SkipComponentLevelCheck { get; set; }
-
-        private static bool _isSavingHVACSystem = false;
-        public static bool IsSavingHVACSystem => _isSavingHVACSystem;
-
-        private static OpenStudio.Model _globalModel;
-        public static OpenStudio.Model GlobalModel => _globalModel;
 
         private static List<Func<bool>> _delaiedAMFuncs;
 
@@ -47,24 +40,13 @@ private static void ExecuteDelayedFuns()
         private static void StartSaving()
         {
             OpsIDMapper.StartRecording();
-
             _delaiedAMFuncs = new();
-            _isSavingHVACSystem = true;
         }
 
         private static void EndSaving()
         {
-            try
-            {
-                _globalModel.Dispose();
-            }
-            finally
-            {
-                OpsIDMapper.EndRecording();
-                _delaiedAMFuncs = null;
-                _isSavingHVACSystem = false;
-            }
-
+            OpsIDMapper.EndRecording();
+            _delaiedAMFuncs = null;
         }
 
 
@@ -79,8 +61,7 @@ public static bool SaveHVAC(IB_HVACSystem hvac, string osmFile)
 
 
             //get Model from file if exists
-            _globalModel = GetOrNewModel(osmFile);
-            var model = _globalModel;
+            var model = GetOrNewModel(osmFile);
 
             //Add outdoor air temperature output variable
             var outT = new OpenStudio.OutputVariable("Site Outdoor Air Drybulb Temperature", model);

src/Ironbug.HVAC/LoopObjs/IB_ChillerElectricEIR.cs

@@ -44,9 +44,10 @@ public IB_ChillerElectricEIR(IB_CurveBiquadratic CCFofT, IB_CurveBiquadratic EIt
 
             // add a fake condenser loop for water cooled chiller to be added to the demand side
             var ghost = this.GhostOSObject as ChillerElectricEIR;
-            var ghostModel = ghost.TryGetObjectModel(this.GhostOSModel);
-            var addGhostCondenserLoop = new PlantLoop(ghostModel);
-            addGhostCondenserLoop.addDemandBranchForComponent(ghost);
+            var addGhostCondenserLoop = new PlantLoop(this.GhostOSModel);
+            var done = addGhostCondenserLoop.addDemandBranchForComponent(ghost);
+            if (!done)
+                throw new ArgumentException("Something when wrong, please provide this sample file to developers!");
 
         }
 

src/Ironbug.HVAC/OSExtensions/ModelObject_Extensions.cs

@@ -262,16 +262,7 @@ public static List<string> SetCustomAttributes(this ModelObject component, Model
                 var field = item.Field;
                 var value = item.Value;
                 // check and convert IB_Curve IB_Schedule and IB_AvailabilityManager to OpenStudio object
-                if (!value.IsFieldValueRealType())
-                {
-                    // only assign the real curve, schedule, and AvailabilityManager when model is being saved to the real OpenStudio Model.
-                    // this helps preventing crashing the application when constantly requesting the object's model at a large mount scale
-                    // especially memory leak issue on OpenStudio SDK side
-                    if (!IB_Utility.IsSavingHVACSystem)
-                        continue;
-                    var md = component.TryGetObjectModel(model);
-                    value = value.TryGetRealFieldValue(md);
-                }
+                value = value.TryGetRealFieldValue(model);
 
                 var invokeResult = component.SetFieldValue(field, value);
 
@@ -281,26 +272,6 @@ public static List<string> SetCustomAttributes(this ModelObject component, Model
             return invokeResults;
         }
 
-        public static OpenStudio.Model TryGetObjectModel(this ModelObject component, Model defaultModel)
-        {
-            OpenStudio.Model md = null;
-            try
-            {
-                var isSavingToGlobalModel = IB_Utility.IsSavingHVACSystem;
-                md = isSavingToGlobalModel ? IB_Utility.GlobalModel : defaultModel;
-            }
-            catch (System.ApplicationException ex)
-            {
-                if (ex.Message == "bad_weak_ptr")
-                {
-                    //ignore error
-                }
-                else
-                    throw;
-
-            }
-            return md;
-        }
 
         public static IEnumerable<string> GetUserFriendlyFieldInfo(this ModelObject component, bool ifIPUnits = false)
         {