From abe75f57da1e4c03d02b69a73459fd8ef8893ae8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=85smund=20V=C3=A5ge=20Fannemel?= <34712686+asmfstatoil@users.noreply.github.com> Date: Fri, 2 Aug 2024 10:49:27 +0200 Subject: [PATCH] chore: fix javadoc (#1066) --- .../neqsim/thermo/component/Component.java | 20 +++++++++---------- .../neqsim/thermo/component/ComponentEos.java | 4 ++++ .../thermo/component/ComponentInterface.java | 6 +++--- .../thermo/component/ComponentPRvolcor.java | 8 +++++++- .../mixingRule/EosMixingRulesInterface.java | 7 +++++++ src/main/java/neqsim/thermo/phase/Phase.java | 4 ++-- .../thermo/phase/PhaseDesmukhMather.java | 1 + .../neqsim/thermo/phase/PhaseDuanSun.java | 1 + .../thermo/phase/PhaseEosInterface.java | 4 ++-- .../java/neqsim/thermo/phase/PhaseGENRTL.java | 3 ++- .../thermo/phase/PhaseGENRTLmodifiedHV.java | 4 ++-- .../thermo/phase/PhaseGENRTLmodifiedWS.java | 4 ++-- .../neqsim/thermo/phase/PhaseGEUnifac.java | 2 +- .../thermo/phase/PhaseGEUnifacPSRK.java | 2 +- .../thermo/phase/PhaseGEUnifacUMRPRU.java | 16 ++++++++++++--- .../neqsim/thermo/phase/PhaseGEUniquac.java | 3 ++- .../neqsim/thermo/phase/PhaseGEWilson.java | 3 ++- .../neqsim/thermo/phase/PhaseHydrate.java | 2 +- .../neqsim/thermo/phase/PhaseInterface.java | 14 ++++++------- .../neqsim/thermo/phase/PhasePrEosvolcor.java | 16 ++------------- .../java/neqsim/thermo/phase/PhaseType.java | 2 ++ .../neqsim/thermo/phase/StateOfMatter.java | 2 ++ .../neqsim/thermo/system/SystemInterface.java | 18 +++++++++++------ .../neqsim/thermo/system/SystemThermo.java | 9 +++------ 24 files changed, 91 insertions(+), 64 deletions(-) diff --git a/src/main/java/neqsim/thermo/component/Component.java b/src/main/java/neqsim/thermo/component/Component.java index befcaffbc5..486f93cb70 100644 --- a/src/main/java/neqsim/thermo/component/Component.java +++ b/src/main/java/neqsim/thermo/component/Component.java @@ -17,6 +17,13 @@ import neqsim.util.unit.PressureUnit; import neqsim.util.unit.TemperatureUnit; +/** + *

+ * Abstract Component class. + *

+ * + * @author Even Solbraa + */ public abstract class Component implements ComponentInterface { private static final long serialVersionUID = 1000; static Logger logger = LogManager.getLogger(Component.class); @@ -499,11 +506,10 @@ public Component clone() { @Override public void addMolesChemReac(double dn, double totdn) { if (numberOfMoles + totdn < 0 || numberOfMolesInPhase + dn < 0) { - if (Math.abs(dn) < 1e-12){ + if (Math.abs(dn) < 1e-12) { dn = 0; totdn = 0; - } - else{ + } else { String msg = "will lead to negative number of moles of component in phase for component " + getComponentName() + " who has " + numberOfMolesInPhase + " in phase and chage request was " + dn; @@ -2285,13 +2291,7 @@ public double getVolumeCorrectionT() { return volumeCorrectionT; } - /** - *

- * getVolumeCorrection. - *

- * - * @return a double - */ + /** {@inheritDoc} */ @Override public double getVolumeCorrection() { return 0.0; diff --git a/src/main/java/neqsim/thermo/component/ComponentEos.java b/src/main/java/neqsim/thermo/component/ComponentEos.java index 935d52ae0c..b48e16fedf 100644 --- a/src/main/java/neqsim/thermo/component/ComponentEos.java +++ b/src/main/java/neqsim/thermo/component/ComponentEos.java @@ -33,6 +33,10 @@ import neqsim.thermo.phase.PhaseInterface; /** + *

+ * Abstract ComponentEos class. + *

+ * * @author Even Solbraa */ public abstract class ComponentEos extends Component implements ComponentEosInterface { diff --git a/src/main/java/neqsim/thermo/component/ComponentInterface.java b/src/main/java/neqsim/thermo/component/ComponentInterface.java index 16823d7686..eece17095e 100644 --- a/src/main/java/neqsim/thermo/component/ComponentInterface.java +++ b/src/main/java/neqsim/thermo/component/ComponentInterface.java @@ -635,9 +635,8 @@ public double fugcoefDiffTempNumeric(PhaseInterface phase, int numberOfComponent *

* setMolarMass. *

- * + * * @param molarMass a double - * * @param unit a String */ public void setMolarMass(double molarMass, String unit); @@ -994,8 +993,9 @@ public void Finit(PhaseInterface phase, double temperature, double pressure, *

* getNormalLiquidDensity. *

- * + * * @param unit i String with unit of return return a double + * @return a double */ public double getNormalLiquidDensity(String unit); diff --git a/src/main/java/neqsim/thermo/component/ComponentPRvolcor.java b/src/main/java/neqsim/thermo/component/ComponentPRvolcor.java index 204f91649d..b4abaf4883 100644 --- a/src/main/java/neqsim/thermo/component/ComponentPRvolcor.java +++ b/src/main/java/neqsim/thermo/component/ComponentPRvolcor.java @@ -102,7 +102,13 @@ public void init(double temp, double pres, double totMoles, double beta, int ini c = calcc(); } - /** {@inheritDoc} */ + /** + *

+ * getc. + *

+ * + * @return a double + */ public double getc() { return c; } diff --git a/src/main/java/neqsim/thermo/mixingRule/EosMixingRulesInterface.java b/src/main/java/neqsim/thermo/mixingRule/EosMixingRulesInterface.java index 086949a171..6332ab9778 100644 --- a/src/main/java/neqsim/thermo/mixingRule/EosMixingRulesInterface.java +++ b/src/main/java/neqsim/thermo/mixingRule/EosMixingRulesInterface.java @@ -275,6 +275,13 @@ public double calcAiT(int compNumb, PhaseInterface phase, double temperature, do */ public PhaseInterface getGEPhase(); + /** + *

+ * getBinaryInteractionParameters. + *

+ * + * @return an array of type double + */ public double[][] getBinaryInteractionParameters(); // double calcA2(PhaseInterface phase, double temperature, double pressure, int // numbcomp); diff --git a/src/main/java/neqsim/thermo/phase/Phase.java b/src/main/java/neqsim/thermo/phase/Phase.java index 2f71cc4bd3..d3c8407ded 100644 --- a/src/main/java/neqsim/thermo/phase/Phase.java +++ b/src/main/java/neqsim/thermo/phase/Phase.java @@ -1276,7 +1276,7 @@ public void initRefPhases(boolean onlyPure) { *

* * @param onlyPure a boolean - * @param name a {@link String} object + * @param name a {@link java.lang.String} object */ public void initRefPhases(boolean onlyPure, String name) { refPhase = new PhaseInterface[numberOfComponents]; @@ -2294,7 +2294,7 @@ public double getFlowRate(String flowunit) { * Getter for the field thermoPropertyModelName. *

* - * @return a {@link String} object + * @return a {@link java.lang.String} object */ public String getThermoPropertyModelName() { return thermoPropertyModelName; diff --git a/src/main/java/neqsim/thermo/phase/PhaseDesmukhMather.java b/src/main/java/neqsim/thermo/phase/PhaseDesmukhMather.java index 76413838c0..b40d6006e4 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseDesmukhMather.java +++ b/src/main/java/neqsim/thermo/phase/PhaseDesmukhMather.java @@ -282,6 +282,7 @@ public double getSolventMolarMass() { return molesMass / moles; } + /** {@inheritDoc} */ @Override public double molarVolume(double pressure, double temperature, double A, double B, PhaseType pt) throws IsNaNException, TooManyIterationsException { diff --git a/src/main/java/neqsim/thermo/phase/PhaseDuanSun.java b/src/main/java/neqsim/thermo/phase/PhaseDuanSun.java index fcc12f3039..0af4f441e5 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseDuanSun.java +++ b/src/main/java/neqsim/thermo/phase/PhaseDuanSun.java @@ -120,6 +120,7 @@ public double getGibbsEnergy() { return R * temperature * numberOfMolesInPhase * (GE + Math.log(pressure)); } + /** {@inheritDoc} */ @Override public double molarVolume(double pressure, double temperature, double A, double B, PhaseType pt) throws IsNaNException, TooManyIterationsException { diff --git a/src/main/java/neqsim/thermo/phase/PhaseEosInterface.java b/src/main/java/neqsim/thermo/phase/PhaseEosInterface.java index 4420be0b23..0fbab32499 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseEosInterface.java +++ b/src/main/java/neqsim/thermo/phase/PhaseEosInterface.java @@ -35,7 +35,7 @@ public interface PhaseEosInterface extends PhaseInterface { * getMixingRuleName. *

* - * @return a {@link String} object + * @return a {@link java.lang.String} object */ public String getMixingRuleName(); @@ -80,7 +80,7 @@ public interface PhaseEosInterface extends PhaseInterface { * displayInteractionCoefficients. *

* - * @param intType a {@link String} object + * @param intType a {@link java.lang.String} object */ public void displayInteractionCoefficients(String intType); // public double getA(); diff --git a/src/main/java/neqsim/thermo/phase/PhaseGENRTL.java b/src/main/java/neqsim/thermo/phase/PhaseGENRTL.java index 9e4988603b..8bd014d5f7 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGENRTL.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGENRTL.java @@ -45,7 +45,7 @@ public PhaseGENRTL() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGENRTL(PhaseInterface phase, double[][] alpha, double[][] Dij, String[][] mixRule, @@ -133,6 +133,7 @@ public double getGibbsEnergy() { return R * temperature * numberOfMolesInPhase * (GE + Math.log(pressure)); } + /** {@inheritDoc} */ @Override public double molarVolume(double pressure, double temperature, double A, double B, PhaseType pt) throws IsNaNException, TooManyIterationsException { diff --git a/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedHV.java b/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedHV.java index 7117877844..6ddb386f36 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedHV.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedHV.java @@ -41,7 +41,7 @@ public PhaseGENRTLmodifiedHV() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGENRTLmodifiedHV(PhaseInterface phase, double[][] alpha, double[][] Dij, @@ -66,7 +66,7 @@ public PhaseGENRTLmodifiedHV(PhaseInterface phase, double[][] alpha, double[][] * @param alpha an array of type double * @param Dij an array of type double * @param DijT an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGENRTLmodifiedHV(PhaseInterface phase, double[][] alpha, double[][] Dij, diff --git a/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedWS.java b/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedWS.java index 5793df3913..5d0704d8bb 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedWS.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGENRTLmodifiedWS.java @@ -31,7 +31,7 @@ public PhaseGENRTLmodifiedWS() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGENRTLmodifiedWS(PhaseInterface phase, double[][] alpha, double[][] Dij, @@ -56,7 +56,7 @@ public PhaseGENRTLmodifiedWS(PhaseInterface phase, double[][] alpha, double[][] * @param alpha an array of type double * @param Dij an array of type double * @param DijT an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGENRTLmodifiedWS(PhaseInterface phase, double[][] alpha, double[][] Dij, diff --git a/src/main/java/neqsim/thermo/phase/PhaseGEUnifac.java b/src/main/java/neqsim/thermo/phase/PhaseGEUnifac.java index 84200acb19..8275d73433 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGEUnifac.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGEUnifac.java @@ -44,7 +44,7 @@ public PhaseGEUnifac() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGEUnifac(PhaseInterface phase, double[][] alpha, double[][] Dij, String[][] mixRule, diff --git a/src/main/java/neqsim/thermo/phase/PhaseGEUnifacPSRK.java b/src/main/java/neqsim/thermo/phase/PhaseGEUnifacPSRK.java index 4a9f2ac1c9..9629aa678e 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGEUnifacPSRK.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGEUnifacPSRK.java @@ -37,7 +37,7 @@ public PhaseGEUnifacPSRK() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGEUnifacPSRK(PhaseInterface phase, double[][] alpha, double[][] Dij, diff --git a/src/main/java/neqsim/thermo/phase/PhaseGEUnifacUMRPRU.java b/src/main/java/neqsim/thermo/phase/PhaseGEUnifacUMRPRU.java index 06e2b87775..1c99290b90 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGEUnifacUMRPRU.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGEUnifacUMRPRU.java @@ -44,7 +44,7 @@ public PhaseGEUnifacUMRPRU() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGEUnifacUMRPRU(PhaseInterface phase, double[][] alpha, double[][] Dij, @@ -82,10 +82,20 @@ public void calcCommontemp(PhaseInterface phase, int numberOfComponents, double } } + /** + *

getVCommontemp.

+ * + * @return a double + */ public double getVCommontemp() { return VCommontemp; } + /** + *

getFCommontemp.

+ * + * @return a double + */ public double getFCommontemp() { return FCommontemp; } @@ -163,7 +173,7 @@ public void initQmixdN() { * getQmix. *

* - * @param name a {@link String} object + * @param name a {@link java.lang.String} object * @return a double */ public double getQmix(String name) { @@ -181,7 +191,7 @@ public double getQmix(String name) { * getQmixdN. *

* - * @param name a {@link String} object + * @param name a {@link java.lang.String} object * @return an array of type double */ public double[] getQmixdN(String name) { diff --git a/src/main/java/neqsim/thermo/phase/PhaseGEUniquac.java b/src/main/java/neqsim/thermo/phase/PhaseGEUniquac.java index ba4ae00b17..ce2b236542 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGEUniquac.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGEUniquac.java @@ -47,7 +47,7 @@ public PhaseGEUniquac() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGEUniquac(PhaseInterface phase, double[][] alpha, double[][] Dij, String[][] mixRule, @@ -120,6 +120,7 @@ public double getExcessGibbsEnergy(PhaseInterface phase, int numberOfComponents, return R * temperature * numberOfMolesInPhase * GE; } + /** {@inheritDoc} */ @Override public double molarVolume(double pressure, double temperature, double A, double B, PhaseType pt) throws IsNaNException, TooManyIterationsException { diff --git a/src/main/java/neqsim/thermo/phase/PhaseGEWilson.java b/src/main/java/neqsim/thermo/phase/PhaseGEWilson.java index 9c104d2ca3..d79b79a1ea 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseGEWilson.java +++ b/src/main/java/neqsim/thermo/phase/PhaseGEWilson.java @@ -36,7 +36,7 @@ public PhaseGEWilson() { * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object * @param alpha an array of type double * @param Dij an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public PhaseGEWilson(PhaseInterface phase, double[][] alpha, double[][] Dij, String[][] mixRule, @@ -110,6 +110,7 @@ public double getExcessGibbsEnergy(PhaseInterface phase, int numberOfComponents, return R * temperature * numberOfMolesInPhase * GE; } + /** {@inheritDoc} */ @Override public double molarVolume(double pressure, double temperature, double A, double B, PhaseType pt) throws IsNaNException, TooManyIterationsException { diff --git a/src/main/java/neqsim/thermo/phase/PhaseHydrate.java b/src/main/java/neqsim/thermo/phase/PhaseHydrate.java index e8a2f83aa6..e49a1ddefd 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseHydrate.java +++ b/src/main/java/neqsim/thermo/phase/PhaseHydrate.java @@ -36,7 +36,7 @@ public PhaseHydrate() { * Constructor for PhaseHydrate. *

* - * @param fluidModel a {@link String} object + * @param fluidModel a {@link java.lang.String} object */ public PhaseHydrate(String fluidModel) { if (fluidModel.isEmpty()) { diff --git a/src/main/java/neqsim/thermo/phase/PhaseInterface.java b/src/main/java/neqsim/thermo/phase/PhaseInterface.java index a19a7ec570..c2861712b0 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseInterface.java +++ b/src/main/java/neqsim/thermo/phase/PhaseInterface.java @@ -260,7 +260,7 @@ public void init(double totalNumberOfMoles, int numberOfComponents, int initType * initPhysicalProperties. *

* - * @param type a {@link String} object + * @param type a {@link java.lang.String} object */ public void initPhysicalProperties(String type); @@ -452,7 +452,7 @@ public void init(double totalNumberOfMoles, int numberOfComponents, int initType * getFugacity. *

* - * @param compName a {@link String} object + * @param compName a {@link java.lang.String} object * @return a double */ public double getFugacity(String compName); @@ -608,7 +608,7 @@ public void init(double totalNumberOfMoles, int numberOfComponents, int initType * getWtFrac. *

* - * @param componentName a {@link String} object + * @param componentName a {@link java.lang.String} object * @return a double */ public double getWtFrac(String componentName); @@ -618,7 +618,7 @@ public void init(double totalNumberOfMoles, int numberOfComponents, int initType * setMixingRuleGEModel. *

* - * @param name a {@link String} object + * @param name a {@link java.lang.String} object */ public void setMixingRuleGEModel(String name); @@ -1846,7 +1846,7 @@ public default void addMolesChemReac(int component, double dn) { * @param alpha an array of type double * @param Dij an array of type double * @param DijT an array of type double - * @param mixRule an array of {@link String} objects + * @param mixRule an array of {@link java.lang.String} objects * @param intparam an array of type double */ public void setParams(PhaseInterface phase, double[][] alpha, double[][] Dij, double[][] DijT, @@ -1871,7 +1871,7 @@ public void setParams(PhaseInterface phase, double[][] alpha, double[][] Dij, do * Getter for property phaseTypeName. *

* - * @return a {@link String} object + * @return a {@link java.lang.String} object */ public default String getPhaseTypeName() { return getType().getDesc(); @@ -1882,7 +1882,7 @@ public default String getPhaseTypeName() { * Setter for property phaseTypeName. *

* - * @param phaseTypeName a {@link String} object + * @param phaseTypeName a {@link java.lang.String} object */ public default void setPhaseTypeName(String phaseTypeName) { setType(PhaseType.byDesc(phaseTypeName)); diff --git a/src/main/java/neqsim/thermo/phase/PhasePrEosvolcor.java b/src/main/java/neqsim/thermo/phase/PhasePrEosvolcor.java index 71524fa028..02641bde54 100644 --- a/src/main/java/neqsim/thermo/phase/PhasePrEosvolcor.java +++ b/src/main/java/neqsim/thermo/phase/PhasePrEosvolcor.java @@ -296,13 +296,7 @@ public double gVV() { // return -1.0 / (val2 * val2) + 1.0 / (val1 * val1); } - /** - *

- * gVVV. - *

- * - * @return a double - */ + /** {@inheritDoc} */ @Override public double gVVV() { double val1 = numberOfMolesInPhase * getMolarVolume(); @@ -332,13 +326,7 @@ public double fVV() { // return 1.0 / (R * loc_B * (delta1 - delta2)) * (-1.0 / (val1 * val1) + 1.0 / (val2 * val2)); } - /** - *

- * fVVV. - *

- * - * @return a double - */ + /** {@inheritDoc} */ @Override public double fVVV() { double val1 = numberOfMolesInPhase * molarVolume + getB() * delta1 + getC(); diff --git a/src/main/java/neqsim/thermo/phase/PhaseType.java b/src/main/java/neqsim/thermo/phase/PhaseType.java index e00b3781fa..82d8171713 100644 --- a/src/main/java/neqsim/thermo/phase/PhaseType.java +++ b/src/main/java/neqsim/thermo/phase/PhaseType.java @@ -5,6 +5,8 @@ /** * Types of phases. + * + * @author ASMF */ public enum PhaseType implements Serializable { LIQUID("liquid", 0), GAS("gas", 1), OIL("oil", 2), AQUEOUS("aqueous", 3), HYDRATE("hydrate", diff --git a/src/main/java/neqsim/thermo/phase/StateOfMatter.java b/src/main/java/neqsim/thermo/phase/StateOfMatter.java index ccf16bd1ab..8ce4150c92 100644 --- a/src/main/java/neqsim/thermo/phase/StateOfMatter.java +++ b/src/main/java/neqsim/thermo/phase/StateOfMatter.java @@ -2,6 +2,8 @@ /** * States of matter, a way of relating the PhaseTypes to classical states of matter. + * + * @author ASMF */ public enum StateOfMatter { GAS, LIQUID, SOLID; diff --git a/src/main/java/neqsim/thermo/system/SystemInterface.java b/src/main/java/neqsim/thermo/system/SystemInterface.java index 90daf4d133..4db3307a74 100644 --- a/src/main/java/neqsim/thermo/system/SystemInterface.java +++ b/src/main/java/neqsim/thermo/system/SystemInterface.java @@ -1129,7 +1129,6 @@ public default double getGamma2() { * method to return molar volume of the fluid: eventual volume correction included. * * @param unit Supported units are m3/mol, litre/mol - * * @return molar volume volume in unit */ public double getMolarVolume(String unit); @@ -2580,30 +2579,37 @@ public void setImplementedTemperatureDeriativesofFugacity( /** *

- * getKvector - return vector of equilibrium constants + * getKvector - return vector of equilibrium constants. *

+ * + * @return an array of {@link double} objects */ public double[] getKvector(); /** *

- * getzvector - return vector of total molar composition + * getzvector - return vector of total molar composition. *

+ * + * @return an array of {@link double} objects */ public double[] getzvector(); /** *

- * toJson - return String with json inormation of fluid + * toJson - return String with json inormation of fluid. *

+ * + * @return a {@link java.lang.String} object */ public String toJson(); /** *

- * toCompJson - return String with json inormation of pure component properties of fluid + * toCompJson - return String with json inormation of pure component properties of fluid. *

+ * + * @return a {@link java.lang.String} object */ public String toCompJson(); - } diff --git a/src/main/java/neqsim/thermo/system/SystemThermo.java b/src/main/java/neqsim/thermo/system/SystemThermo.java index f570c4a78a..1b37514249 100644 --- a/src/main/java/neqsim/thermo/system/SystemThermo.java +++ b/src/main/java/neqsim/thermo/system/SystemThermo.java @@ -32,6 +32,8 @@ /** * This is the base class of the System classes. + * + * @author Even Solbraa */ public abstract class SystemThermo implements SystemInterface { /** Logger object for class. */ @@ -3074,12 +3076,7 @@ public double getZvolcorr() { / getTemperature() / getDensity("kg/m3"); } - /** - * Verify if system has a phase of a specific type. - * - * @param pt PhaseType to look for. - * @return True if system contains a phase of requested type. - */ + /** {@inheritDoc} */ @Override public boolean hasPhaseType(PhaseType pt) { for (int i = 0; i < numberOfPhases; i++) {