Merge pull request #311 from portyanikhin/with-state-specified-phase

The `WithState` method of the `Fluid` and `Mixture` no longer resets the specified phase
portyanikhin · Oct 2, 2024 · 7aa8e96 · 7aa8e96
2 parents 03ba619 + f924e8f
commit 7aa8e96
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 6 deletions.
diff --git a/src/SharpProp/Fluids/AbstractFluid.cs b/src/SharpProp/Fluids/AbstractFluid.cs
@@ -3,6 +3,7 @@
 /// <inheritdoc cref="IAbstractFluid"/>
 public abstract partial class AbstractFluid : IAbstractFluid
 {
+    private Phases? _specifiedPhase;
     protected AbstractState Backend = default!;
 
     protected IList<IKeyedInput<Parameters>> Inputs { get; private set; } =
@@ -46,12 +47,14 @@ public virtual void Reset()
     protected AbstractFluid SpecifyPhase(Phases phase)
     {
         Backend.SpecifyPhase(phase);
+        _specifiedPhase = phase;
         return this;
     }
 
     protected AbstractFluid UnspecifyPhase()
     {
         Backend.UnspecifyPhase();
+        _specifiedPhase = null;
         return this;
     }
 
@@ -68,6 +71,11 @@ IKeyedInput<Parameters> secondInput
     )
     {
         var fluid = CreateInstance();
+        if (_specifiedPhase is not null)
+        {
+            fluid.SpecifyPhase(_specifiedPhase.Value);
+        }
+
         fluid.Update(firstInput, secondInput);
         return fluid;
     }

diff --git a/tests/SharpProp.Tests/Fluids/FluidExtended.cs b/tests/SharpProp.Tests/Fluids/FluidExtended.cs
@@ -33,6 +33,10 @@ public override void Reset()
         _ozoneDepletionPotential = null;
     }
 
+    public new IFluidExtended SpecifyPhase(Phases phase) => (FluidExtended)base.SpecifyPhase(phase);
+
+    public new IFluidExtended UnspecifyPhase() => (FluidExtended)base.UnspecifyPhase();
+
     public new IFluidExtended WithState(
         IKeyedInput<Parameters> firstInput,
         IKeyedInput<Parameters> secondInput

diff --git a/tests/SharpProp.Tests/Fluids/FluidExtendedTests.cs b/tests/SharpProp.Tests/Fluids/FluidExtendedTests.cs
@@ -40,6 +40,7 @@ public void Methods_New_ReturnsInstancesOfInheritedType()
     {
         _fluid.Clone().Should().BeOfType<FluidExtended>();
         _fluid.Factory().Should().BeOfType<FluidExtended>();
+        _fluid.SpecifyPhase(Phases.Gas).UnspecifyPhase().Should().BeOfType<FluidExtended>();
         _fluid
             .WithState(Input.Pressure(HighPressure), Input.Temperature(_fluid.Temperature))
             .Should()

diff --git a/tests/SharpProp.Tests/Fluids/FluidTests.cs b/tests/SharpProp.Tests/Fluids/FluidTests.cs
@@ -161,11 +161,50 @@ public void Reset_Always_ResetsAllNonTrivialProperties()
     public void SpecifyPhase_Always_SpecifiesPhaseForAllFurtherCalculations()
     {
         _fluid.SpecifyPhase(Phases.Gas);
-        var action = () =>
+        var update = () =>
             _fluid.Update(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
-        action.Should().Throw<ApplicationException>();
+        Action withState = () =>
+            _ = _fluid.WithState(
+                Input.Pressure(1.Atmospheres()),
+                Input.Temperature(20.DegreesCelsius())
+            );
+        update.Should().Throw<ApplicationException>();
+        withState.Should().Throw<ApplicationException>();
         _fluid.UnspecifyPhase();
-        action.Should().NotThrow();
+        update.Should().NotThrow();
+        withState.Should().NotThrow();
+    }
+
+    [Fact]
+    public void SpecifyPhase_MethodsChaining_SpecifiesPhaseForAllFurtherCalculations()
+    {
+        _fluid.SpecifyPhase(Phases.Gas);
+        var invalidUpdate = () =>
+            _fluid
+                .SpecifyPhase(Phases.Gas)
+                .Update(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        Action invalidWithState = () =>
+            _ = _fluid
+                .SpecifyPhase(Phases.Gas)
+                .WithState(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        invalidUpdate.Should().Throw<ApplicationException>();
+        invalidWithState.Should().Throw<ApplicationException>();
+        var validUpdate = () =>
+        {
+            _fluid.SpecifyPhase(Phases.Gas);
+            _fluid
+                .UnspecifyPhase()
+                .Update(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        };
+        var validWithState = () =>
+        {
+            _fluid.SpecifyPhase(Phases.Gas);
+            _ = _fluid
+                .UnspecifyPhase()
+                .WithState(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        };
+        validUpdate.Should().NotThrow();
+        validWithState.Should().NotThrow();
     }
 
     [Fact]

diff --git a/tests/SharpProp.Tests/Fluids/IFluidExtended.cs b/tests/SharpProp.Tests/Fluids/IFluidExtended.cs
@@ -21,6 +21,12 @@ public interface IFluidExtended : IFluid
     /// </summary>
     double? OzoneDepletionPotential { get; }
 
+    /// <inheritdoc cref="IFluid.SpecifyPhase"/>
+    new IFluidExtended SpecifyPhase(Phases phase);
+
+    /// <inheritdoc cref="IFluid.UnspecifyPhase"/>
+    new IFluidExtended UnspecifyPhase();
+
     /// <inheritdoc cref="IFluid.WithState"/>
     new IFluidExtended WithState(
         IKeyedInput<Parameters> firstInput,

diff --git a/tests/SharpProp.Tests/Fluids/MixtureTests.cs b/tests/SharpProp.Tests/Fluids/MixtureTests.cs
@@ -50,14 +50,53 @@ public void Update_Always_InputsAreCached()
     public void SpecifyPhase_Always_SpecifiesPhaseForAllFurtherCalculations()
     {
         _mixture.SpecifyPhase(Phases.Gas);
-        var action = () =>
+        var update = () =>
             _mixture.Update(
                 Input.Pressure(1.Atmospheres()),
                 Input.Temperature(20.DegreesCelsius())
             );
-        action.Should().Throw<ApplicationException>();
+        Action withState = () =>
+            _ = _mixture.WithState(
+                Input.Pressure(1.Atmospheres()),
+                Input.Temperature(20.DegreesCelsius())
+            );
+        update.Should().Throw<ApplicationException>();
+        withState.Should().Throw<ApplicationException>();
         _mixture.UnspecifyPhase();
-        action.Should().NotThrow();
+        update.Should().NotThrow();
+        withState.Should().NotThrow();
+    }
+
+    [Fact]
+    public void SpecifyPhase_MethodsChaining_SpecifiesPhaseForAllFurtherCalculations()
+    {
+        _mixture.SpecifyPhase(Phases.Gas);
+        var invalidUpdate = () =>
+            _mixture
+                .SpecifyPhase(Phases.Gas)
+                .Update(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        Action invalidWithState = () =>
+            _ = _mixture
+                .SpecifyPhase(Phases.Gas)
+                .WithState(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        invalidUpdate.Should().Throw<ApplicationException>();
+        invalidWithState.Should().Throw<ApplicationException>();
+        var validUpdate = () =>
+        {
+            _mixture.SpecifyPhase(Phases.Gas);
+            _mixture
+                .UnspecifyPhase()
+                .Update(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        };
+        var validWithState = () =>
+        {
+            _mixture.SpecifyPhase(Phases.Gas);
+            _ = _mixture
+                .UnspecifyPhase()
+                .WithState(Input.Pressure(1.Atmospheres()), Input.Temperature(20.DegreesCelsius()));
+        };
+        validUpdate.Should().NotThrow();
+        validWithState.Should().NotThrow();
     }
 
     [Fact]