wip

equinor · Nov 25, 2024 · e56fe00 · e56fe00
1 parent 3a114e1
commit e56fe00
Show file tree

Hide file tree

Showing 31 changed files with 127 additions and 139 deletions.
diff --git a/src/main/java/neqsim/thermo/component/Component.java b/src/main/java/neqsim/thermo/component/Component.java
@@ -63,7 +63,7 @@ public abstract class Component implements ComponentInterface {
   protected double bCPA = 0.0;
   protected double mCPA = 0.0;
   protected double srkacentricFactor = 0.0;
-  // TODO: what are the available options here?
+  // TODO: what are the available options here? Can also see solute
   protected String referenceStateType = "solvent";
   protected String associationScheme = "0";
   protected String antoineLiqVapPresType = null;

diff --git a/src/main/java/neqsim/thermo/component/ComponentBWRS.java b/src/main/java/neqsim/thermo/component/ComponentBWRS.java
@@ -74,12 +74,12 @@ public ComponentBWRS(String name, double moles, double molesInPhase, int compInd
    * Constructor for ComponentBWRS.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentBWRS(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentCSPsrk.java b/src/main/java/neqsim/thermo/component/ComponentCSPsrk.java
@@ -37,12 +37,12 @@ public ComponentCSPsrk(String name, double moles, double molesInPhase, int compI
    * Constructor for ComponentCSPsrk.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentCSPsrk(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentDesmukhMather.java b/src/main/java/neqsim/thermo/component/ComponentDesmukhMather.java
@@ -58,7 +58,7 @@ public ComponentDesmukhMather(String name, double moles, double molesInPhase, in
   public double getGamma(PhaseInterface phase, int numberOfComponents, double temperature,
       double pressure, PhaseType pt, double[][] HValpha, double[][] HVgij, double[][] intparam,
       String[][] mixRule) {
-    // not implemented
+    // todo: not actually implemented
     return getGamma(phase, numberOfComponents, temperature, pressure, pt);
   }
 

diff --git a/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPA.java b/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPA.java
@@ -67,12 +67,12 @@ public ComponentElectrolyteCPA(String name, double moles, double molesInPhase, i
    * Constructor for ComponentElectrolyteCPA.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentElectrolyteCPA(int number, double TC, double PC, double M, double a,
       double moles) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPAOld.java b/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPAOld.java
@@ -65,12 +65,12 @@ public ComponentElectrolyteCPAOld(String name, double moles, double molesInPhase
    * Constructor for ComponentElectrolyteCPAOld.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentElectrolyteCPAOld(int number, double TC, double PC, double M, double a,
       double moles) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPAstatoil.java b/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPAstatoil.java
@@ -33,12 +33,12 @@ public ComponentElectrolyteCPAstatoil(String name, double moles, double molesInP
    * Constructor for ComponentElectrolyteCPAstatoil.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentElectrolyteCPAstatoil(int number, double TC, double PC, double M, double a,
       double moles) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentEos.java b/src/main/java/neqsim/thermo/component/ComponentEos.java
@@ -104,12 +104,12 @@ public ComponentEos(String name, double moles, double molesInPhase, int compInde
    * Constructor for ComponentEos.
    * </p>
    *
-   * @param number a int
+   * @param number a int. Not used.
    * @param TC Critical temperature
    * @param PC Critical pressure
    * @param M Molar mass
    * @param a Acentric factor
-   * @param moles Number of moles
+   * @param moles Total number of moles of component.
    */
   public ComponentEos(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentGERG2004.java b/src/main/java/neqsim/thermo/component/ComponentGERG2004.java
@@ -32,12 +32,12 @@ public ComponentGERG2004(String name, double moles, double molesInPhase, int com
    * Constructor for ComponentGERG2004.
    * </p>
    *
-   * @param number a int
+   * @param number a int. Not used.
    * @param TC Critical temperature
    * @param PC Critical pressure
    * @param M Molar mass
    * @param a Acentric factor
-   * @param moles Number of moles
+   * @param moles Total number of moles of component.
    */
   public ComponentGERG2004(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentModifiedFurstElectrolyteEos.java b/src/main/java/neqsim/thermo/component/ComponentModifiedFurstElectrolyteEos.java
@@ -101,12 +101,12 @@ public ComponentModifiedFurstElectrolyteEos(String name, double moles, double mo
    * Constructor for ComponentModifiedFurstElectrolyteEos.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentModifiedFurstElectrolyteEos(int number, double TC, double PC, double M, double a,
       double moles) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentModifiedFurstElectrolyteEosMod2004.java b/src/main/java/neqsim/thermo/component/ComponentModifiedFurstElectrolyteEosMod2004.java
@@ -101,12 +101,12 @@ public ComponentModifiedFurstElectrolyteEosMod2004(String name, double moles, do
    * Constructor for ComponentModifiedFurstElectrolyteEosMod2004.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentModifiedFurstElectrolyteEosMod2004(int number, double TC, double PC, double M,
       double a, double moles) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentPCSAFT.java b/src/main/java/neqsim/thermo/component/ComponentPCSAFT.java
@@ -52,12 +52,12 @@ public ComponentPCSAFT(String name, double moles, double molesInPhase, int compI
    * Constructor for ComponentPCSAFT.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentPCSAFT(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentPCSAFTa.java b/src/main/java/neqsim/thermo/component/ComponentPCSAFTa.java
@@ -53,12 +53,12 @@ public ComponentPCSAFTa(String name, double moles, double molesInPhase, int comp
    * Constructor for ComponentPCSAFTa.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentPCSAFTa(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentPR.java b/src/main/java/neqsim/thermo/component/ComponentPR.java
@@ -44,12 +44,12 @@ public ComponentPR(String name, double moles, double molesInPhase, int compIndex
    * Constructor for ComponentPR.
    * </p>
    *
-   * @param number a int
+   * @param number a int. Not used.
    * @param TC Critical temperature
    * @param PC Critical pressure
    * @param M Molar mass
    * @param a Acentric factor
-   * @param moles Number of moles
+   * @param moles Total number of moles of component.
    */
   public ComponentPR(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentPRvolcor.java b/src/main/java/neqsim/thermo/component/ComponentPRvolcor.java
@@ -30,12 +30,12 @@ public class ComponentPRvolcor extends ComponentPR {
    * Constructor for ComponentPRvolcor.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentPRvolcor(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentPrCPA.java b/src/main/java/neqsim/thermo/component/ComponentPrCPA.java
@@ -45,12 +45,12 @@ public ComponentPrCPA(String name, double moles, double molesInPhase, int compIn
    * Constructor for ComponentPrCPA.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentPrCPA(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentRK.java b/src/main/java/neqsim/thermo/component/ComponentRK.java
@@ -39,12 +39,12 @@ public ComponentRK(String name, double moles, double molesInPhase, int compIndex
    * Constructor for ComponentRK.
    * </p>
    *
-   * @param number a int
+   * @param number a int. Not used.
    * @param TC Critical temperature
    * @param PC Critical pressure
    * @param M Molar mass
    * @param a Acentric factor
-   * @param moles Number of moles
+   * @param moles Total number of moles of component.
    */
   public ComponentRK(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentSrk.java b/src/main/java/neqsim/thermo/component/ComponentSrk.java
@@ -48,12 +48,12 @@ public ComponentSrk(String name, double moles, double molesInPhase, int compInde
    * Constructor for ComponentSrk.
    * </p>
    *
-   * @param number a int
+   * @param number a int. Not used.
    * @param TC Critical temperature
    * @param PC Critical pressure
    * @param M Molar mass
    * @param a Acentric factor
-   * @param moles Number of moles
+   * @param moles Total number of moles of component.
    */
   public ComponentSrk(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentSrkCPA.java b/src/main/java/neqsim/thermo/component/ComponentSrkCPA.java
@@ -67,12 +67,12 @@ public ComponentSrkCPA(String name, double moles, double molesInPhase, int compI
    * Constructor for ComponentSrkCPA.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentSrkCPA(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentSrkCPAs.java b/src/main/java/neqsim/thermo/component/ComponentSrkCPAs.java
@@ -32,12 +32,12 @@ public ComponentSrkCPAs(String name, double moles, double molesInPhase, int comp
    * Constructor for ComponentSrkCPAs.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentSrkCPAs(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentSrkPeneloux.java b/src/main/java/neqsim/thermo/component/ComponentSrkPeneloux.java
@@ -49,12 +49,12 @@ public ComponentSrkPeneloux(String name, double moles, double molesInPhase, int
    * Constructor for ComponentSrkPeneloux.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentSrkPeneloux(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentTST.java b/src/main/java/neqsim/thermo/component/ComponentTST.java
@@ -41,12 +41,12 @@ public ComponentTST(String name, double moles, double molesInPhase, int compInde
    * Constructor for ComponentTST.
    * </p>
    *
-   * @param number a int
+   * @param number a int. Not used.
    * @param TC Critical temperature
    * @param PC Critical pressure
    * @param M Molar mass
    * @param a Acentric factor
-   * @param moles Number of moles
+   * @param moles Total number of moles of component.
    */
   public ComponentTST(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);

diff --git a/src/main/java/neqsim/thermo/component/ComponentUMRCPA.java b/src/main/java/neqsim/thermo/component/ComponentUMRCPA.java
@@ -67,12 +67,12 @@ public ComponentUMRCPA(String name, double moles, double molesInPhase, int compI
    * Constructor for ComponentSrkCPA.
    * </p>
    *
-   * @param number a int
-   * @param TC a double
-   * @param PC a double
-   * @param M a double
-   * @param a a double
-   * @param moles a double
+   * @param number a int. Not used.
+   * @param TC Critical temperature
+   * @param PC Critical pressure
+   * @param M Molar mass
+   * @param a Acentric factor
+   * @param moles Total number of moles of component.
    */
   public ComponentUMRCPA(int number, double TC, double PC, double M, double a, double moles) {
     super(number, TC, PC, M, a, moles);