fix doc (#1933)

Author: EvenSol

docs/README.md

@@ -26,6 +26,7 @@ gas.setMixingRule("classic");
 // Perform flash calculation
 ThermodynamicOperations ops = new ThermodynamicOperations(gas);
 ops.TPflash();
+gas.initProperties();
 
 // Get properties
 System.out.println("Density: " + gas.getDensity("kg/m3") + " kg/m³");

docs/cookbook/pipeline-recipes.md

@@ -92,7 +92,7 @@ pipe = TwoFluidPipe("Flowline", inlet_stream)
 pipe.setLength(20000)
 pipe.setDiameter(0.25)
 pipe.setNumberOfSections(100)   # Computational cells
-pipe.setOuterTemperature(278.15)  # 5°C ambient
+pipe.setOuterTemperatures([278.15])  # 5°C ambient (array)
 
 process.add(pipe)
 process.run()
@@ -263,7 +263,7 @@ time = 0.0
 while time < t_end:
     pipe.runTransient(dt, run_id)
     time += dt
-    
+
     # Ramp up flow rate after 60 seconds
     if time > 60.0:
         inlet.setFlowRate(25.0, "kg/sec")
@@ -343,8 +343,7 @@ pipe.setDiameter(0.15)           # 150 mm (promotes slugging)
 pipe.setNumberOfSections(400)    # Fine grid for slug resolution
 
 # Enable Lagrangian slug tracking
-pipe.enableSlugTracking(True)
-pipe.setSlugDetectionThreshold(0.7)  # Holdup threshold for slug
+pipe.setEnableSlugTracking(True)
 
 # Set terrain to promote terrain-induced slugging
 elevations = []
@@ -363,12 +362,12 @@ pipe.run()
 run_id = str(uuid.uuid4())
 for step in range(600):  # 5 minutes @ 0.5s steps
     pipe.runTransient(0.5, run_id)
-    
+
     # Monitor slugs every 30 seconds
     if step % 60 == 0:
-        slug_count = pipe.getSlugCount()
-        avg_slug_length = pipe.getAverageSlugLength()
-        slug_frequency = pipe.getSlugFrequency()
+        slug_count = pipe.getSlugTracker().getSlugCount()
+        avg_slug_length = pipe.getSlugTracker().getAverageSlugLength()
+        slug_frequency = pipe.getSlugTracker().getSlugFrequency()
         print(f"Time: {step*0.5:.0f}s - Slugs: {slug_count}, "
               f"Avg length: {avg_slug_length:.1f}m, "
               f"Frequency: {slug_frequency:.3f} Hz")
@@ -463,25 +462,25 @@ dx = 25000 / num_sections
 elevations = []
 for i in range(num_sections):
     x = i * dx
-    
+
     # Start at platform (-50m), descend to seabed, undulations, rise to FPSO
-    
+
     # Riser down (0-500m)
     if x < 500:
         elev = -50 - (x / 500) * 300  # Descend 300m
-    
+
     # Seabed section with undulations (500m - 24000m)
     elif x < 24000:
         base = -350  # Base seabed depth
         # Add hills and valleys
         undulation = 20 * math.sin(x / 2000 * 2 * math.pi)  # ±20m
         valley = -40 * math.exp(-((x - 12000) / 3000)**2)   # Deep valley mid-pipe
         elev = base + undulation + valley
-    
+
     # Riser up (24000m - 25000m)
     else:
         elev = -350 + ((x - 24000) / 1000) * 340  # Rise to -10m
-    
+
     elevations.append(elev)
 
 pipe.setElevationProfile(elevations)
@@ -518,7 +517,7 @@ process.add(section1)
 
 # Section 2: Reduced diameter spur
 section2 = TwoFluidPipe("Spur Line", section1.getOutletStream())
-section2.setLength(8000)           # 8 km  
+section2.setLength(8000)           # 8 km
 section2.setDiameter(0.25)         # 250 mm
 section2.setNumberOfSections(80)
 process.add(section2)
@@ -566,8 +565,8 @@ pipe.setLength(30000)
 pipe.setDiameter(0.3)
 
 # Heat transfer
-pipe.setOuterTemperature(277.15)  # 4°C seawater
-pipe.setPipeHeatTransferCoefficient(10.0)  # W/m²K (overall U-value)
+pipe.setConstantSurfaceTemperature(4.0, "C")  # 4°C seawater
+pipe.setHeatTransferCoefficient(10.0)  # W/m²K (overall U-value)
 
 process.add(pipe)
 process.run()
@@ -581,14 +580,14 @@ print(f"Temperature drop: {inlet_T - outlet_T:.1f} °C")
 
 ```python
 # Higher insulation = lower U-value
-pipe.setPipeHeatTransferCoefficient(2.0)  # W/m²K (well insulated)
+pipe.setHeatTransferCoefficient(2.0)  # W/m²K (well insulated)
 ```
 
 ### Buried Pipeline
 
 ```python
-pipe.setOuterTemperature(283.15)  # 10°C soil temperature
-pipe.setPipeHeatTransferCoefficient(5.0)  # W/m²K (buried)
+pipe.setConstantSurfaceTemperature(10.0, "C")  # 10°C soil temperature
+pipe.setHeatTransferCoefficient(5.0)  # W/m²K (buried)
 ```
 
 ---
@@ -653,7 +652,7 @@ print(f"Flow regime: {flow_pattern}")
 pipe = TwoFluidPipe("Slugging Line", inlet_stream)
 pipe.setLength(5000)
 pipe.setDiameter(0.15)
-pipe.setNumberOfNodes(200)
+pipe.setNumberOfSections(200)
 
 process.add(pipe)
 process.run()
@@ -701,7 +700,7 @@ flowline1.setLength(5000)
 flowline1.setDiameter(0.2)
 process.add(flowline1)
 
-# Well 2 stream  
+# Well 2 stream
 well2 = Stream("Well-2", fluid2)
 well2.setFlowRate(20000, "kg/hr")
 process.add(well2)

docs/cookbook/process-recipes.md

@@ -333,11 +333,10 @@ process.run()
 ```python
 Adjuster = jneqsim.process.equipment.util.Adjuster
 
-# Adjust compressor outlet pressure to achieve target flow
+# Adjust compressor outlet pressure to achieve target gas volume flow
 adjuster = Adjuster("Adjust-1")
-adjuster.setAdjustedVariable(compressor, "outlet pressure")
-adjuster.setTargetVariable(outlet_stream, "flow rate", "kg/hr")
-adjuster.setTargetValue(5000)  # Target 5000 kg/hr
+adjuster.setAdjustedVariable(compressor, "pressure", "bara")
+adjuster.setTargetVariable(outlet_stream, "gasVolumeFlow", 5000.0, "Am3/hr")
 adjuster.setTolerance(1e-4)
 process.add(adjuster)
 

docs/cookbook/thermodynamics-recipes.md

@@ -100,9 +100,9 @@ print(f"Phases: {fluid.getNumberOfPhases()}")
 fluid.initProperties()
 H_initial = fluid.getEnthalpy("J")
 
-# Change pressure, calculate new T
-new_pressure = 30.0  # bara
-ops.PHflash(new_pressure * 1e5, H_initial)  # P in Pa!
+# Set new pressure, then flash at constant enthalpy
+fluid.setPressure(30.0, "bara")
+ops.PHflash(H_initial)
 
 print(f"New temperature: {fluid.getTemperature() - 273.15:.2f} °C")
 ```
@@ -114,9 +114,9 @@ print(f"New temperature: {fluid.getTemperature() - 273.15:.2f} °C")
 fluid.initProperties()
 S_initial = fluid.getEntropy("J/K")
 
-# Isentropic expansion
-new_pressure = 20.0  # bara
-ops.PSflash(new_pressure * 1e5, S_initial)
+# Set new pressure, then flash at constant entropy
+fluid.setPressure(20.0, "bara")
+ops.PSflash(S_initial)
 
 print(f"New temperature: {fluid.getTemperature() - 273.15:.2f} °C")
 ```
@@ -186,7 +186,7 @@ for i in range(fluid.getNumberOfComponents()):
     comp = fluid.getComponent(i)
     name = str(comp.getComponentName())
     z = comp.getz()  # Overall mole fraction
-    
+
     print(f"{name}: z={z:.4f}, Tc={comp.getTC():.1f} K, Pc={comp.getPC():.1f} bara")
 ```
 
@@ -257,8 +257,8 @@ print(f"Cricondentherm: {cricondentherm_T:.2f} °C at {cricondentherm_P:.2f} bar
 | **Heavy oil** | PR or CPA | `SystemPrEos`, `SystemSrkCPAstatoil` |
 | **CO₂ systems** | CPA | `SystemSrkCPAstatoil` |
 | **CO₂ + water** | CPA or Electrolyte-CPA | `SystemSrkCPAstatoil` |
-| **Natural gas (custody)** | GERG-2008 | `SystemGERG2008` |
-| **LNG** | GERG-2008 or PR | `SystemGERG2008`, `SystemPrEos` |
+| **Natural gas (custody)** | GERG-2008 | `SystemGERG2008Eos` |
+| **LNG** | GERG-2008 or PR | `SystemGERG2008Eos`, `SystemPrEos` |
 | **Aqueous systems** | CPA | `SystemSrkCPAstatoil` |
 | **Electrolytes** | Electrolyte-CPA | See electrolyte guide |
 
@@ -277,7 +277,7 @@ fluid = jneqsim.thermo.system.SystemPrEos(T, P)
 fluid = jneqsim.thermo.system.SystemSrkCPAstatoil(T, P)
 
 # For custody transfer (natural gas)
-fluid = jneqsim.thermo.system.SystemGERG2008(T, P)
+fluid = jneqsim.thermo.system.SystemGERG2008Eos(T, P)
 ```
 
 ---
@@ -290,9 +290,6 @@ fluid = jneqsim.thermo.system.SystemGERG2008(T, P)
 # Full fluid state as JSON
 json_str = fluid.toJson()
 print(json_str)
-
-# Component-specific JSON
-comp_json = fluid.getComponent(0).toJson()
 ```
 
 ### Export to Python Dictionary

docs/development/CODE_PATTERNS.md

@@ -120,7 +120,10 @@ ops.PSflash(entropy);
 
 // Phase envelope
 ops.calcPTphaseEnvelope();
-double[][] phaseEnvelope = ops.get2phaseTVPdata();
+double[] dewT = ops.get("dewT");
+double[] dewP = ops.get("dewP");
+double[] bubT = ops.get("bubT");
+double[] bubP = ops.get("bubP");
 ```
 
 ---
@@ -414,11 +417,10 @@ process.add(recycle);
 ### Adjuster (Match a Spec)
 
 ```java
-// Adjust one variable to match a target
-Adjuster adj = new Adjuster("water dew point adj");
-adj.setAdjustedVariable(tegStream, "flow rate", "kg/hr");  // what to vary
-adj.setTargetVariable(gasOut, "waterDewPointTemperature", "C"); // what to match
-adj.setTargetValue(-18.0);  // target value
+// Adjust flow to match a target outlet pressure
+Adjuster adj = new Adjuster("pressure adj");
+adj.setAdjustedVariable(stream1, "flow", "MSm3/day");  // what to vary
+adj.setTargetVariable(outletStream, "pressure", 50.0, "bara"); // target spec
 adj.setMaxAdjustmentSteps(50);
 process.add(adj);
 ```

docs/development/TASK_SOLVING_GUIDE.md

@@ -255,7 +255,7 @@ fluid.addComponent("methane", 1.0);
 fluid.setMixingRule("classic");
 ThermodynamicOperations ops = new ThermodynamicOperations(fluid);
 ops.TPflash();
-fluid.init(3);
+fluid.initProperties();
 System.out.println("Density: " + fluid.getDensity("kg/m3"));
 ```