Skip to content

Commit

Permalink
doc: doc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
asmfstatoil committed Oct 24, 2024
1 parent 4a6bd7e commit 45e6476
Show file tree
Hide file tree
Showing 17 changed files with 67 additions and 67 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,7 @@ public interface SimulationInterface extends NamedInterface, Runnable, Serializa
*/
public void run(UUID id);

/**
* <p>
* run.
* </p>
*/
/** {@inheritDoc} */
@Override
public default void run() {
if (isRunInSteps()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,7 @@ public String toJson() {
return null;
}

/**
* {@inheritDoc}
*
* @return a String
*/
/** {@inheritDoc} */
@Override
public String getReport_json() {
return new Report(this).generateJsonReport();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,14 +223,7 @@ public default SystemInterface getFluid() {
*/
public String toJson();

/**
* <p>
* getReport_json
* </p>
* Return results of simulation in json format
*
* @return a String
*/
/** {@inheritDoc} */
@Override
public String getReport_json();
}
Original file line number Diff line number Diff line change
Expand Up @@ -1403,23 +1403,48 @@ public String toJson() {
return new GsonBuilder().create().toJson(new CompressorResponse(this));
}

/**
* <p>Getter for the field <code>maxOutletPressure</code>.</p>
*
* @return a double
*/
public double getMaxOutletPressure() {
return maxOutletPressure;
}

/**
* <p>Setter for the field <code>maxOutletPressure</code>.</p>
*
* @param maxOutletPressure a double
*/
public void setMaxOutletPressure(double maxOutletPressure) {
this.maxOutletPressure = maxOutletPressure;
this.isSetMaxOutletPressure = true;
}

/**
* <p>isSetMaxOutletPressure.</p>
*
* @return a boolean
*/
public boolean isSetMaxOutletPressure() {
return isSetMaxOutletPressure;
}

/**
* <p>Setter for the field <code>isSetMaxOutletPressure</code>.</p>
*
* @param isSetMaxOutletPressure a boolean
*/
public void setIsSetMaxOutletPressure(boolean isSetMaxOutletPressure) {
this.isSetMaxOutletPressure = isSetMaxOutletPressure;
}

/**
* <p>Getter for the field <code>actualCompressionRatio</code>.</p>
*
* @return a double
*/
public double getActualCompressionRatio() {
return actualCompressionRatio;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -703,16 +703,31 @@ public String toJson() {
.toJson(new HXResponse(this));
}

/**
* <p>Setter for the field <code>useDeltaT</code>.</p>
*
* @param useDeltaT a boolean
*/
public void setUseDeltaT(boolean useDeltaT) {
this.useDeltaT = useDeltaT;
}

private double deltaT = 1.0;

/**
* <p>Getter for the field <code>deltaT</code>.</p>
*
* @return a double
*/
public double getDeltaT() {
return deltaT;
}

/**
* <p>Setter for the field <code>deltaT</code>.</p>
*
* @param deltaT a double
*/
public void setDeltaT(double deltaT) {
useDeltaT = true;
this.deltaT = deltaT;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,7 @@ public EquilibriumStream clone() {
return clonedStream;
}

/**
* Clone Equilibriumstream object and give it a new name.
*
* @param name Name to set for the cloned object
* @return Cloned EquilibriumStream object
*/
/** {@inheritDoc} */
@Override
public EquilibriumStream clone(String name) {
if (this.getName() == name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,7 @@ public IronIonSaturationStream clone() {
return clonedSystem;
}

/**
* Clone IronIonSaturationStream object and give it a new name.
*
* @param name Name to set for the cloned object
* @return Cloned IronIonSaturationStream object
*/
/** {@inheritDoc} */
@Override
public IronIonSaturationStream clone(String name) {
if (this.getName() == name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,7 @@ public NeqStream clone() {
return clonedStream;
}

/**
* Clone NeqStream object and give it a new name.
*
* @param name Name to set for the cloned object
* @return Cloned NeqStream object
*/
/** {@inheritDoc} */
@Override
public NeqStream clone(String name) {
if (this.getName() == name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,7 @@ public ScalePotentialCheckStream clone() {
return clonedSystem;
}

/**
* Clone ScalePotentialCheckStream object and give it a new name.
*
* @param name Name to set for the cloned object
* @return Cloned ScalePotentialCheckStream object
*/
/** {@inheritDoc} */
@Override
public ScalePotentialCheckStream clone(String name) {
if (this.getName() == name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,7 @@ public Stream clone() {
return clonedSystem;
}

/**
* Clone Stream object and give it a new name.
*
* @param name Name to set for the cloned object
* @return Cloned Stream object
*/
/** {@inheritDoc} */
@Override
public Stream clone(String name) {
if (this.getName() == name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ public boolean needRecalculation() {
return false;
}

/**
* <p>runAntiSurgeCalc.</p>
*
* @param id a {@link java.util.UUID} object
*/
public void runAntiSurgeCalc(UUID id) {
Compressor compressor = (Compressor) inputVariable.get(0);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,11 +249,7 @@ public ArrayList<String[]> getReport() {
return null;
}

/**
* {@inheritDoc}
*
* @return a String
*/
/** {@inheritDoc} */
@Override
public String getReport_json() {
return new Report(this).generateJsonReport();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,11 +245,7 @@ public String toJson() {
return null;
}

/**
* {@inheritDoc}
*
* @return a String
*/
/** {@inheritDoc} */
@Override
public String getReport_json() {
return new Report(this).generateJsonReport();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -732,9 +732,7 @@ public String getName() {
return name;
}

/**
* {@inheritDoc}
*/
/** {@inheritDoc} */
@Override
public void setName(String name) {
this.name = name;
Expand Down Expand Up @@ -938,11 +936,7 @@ public boolean equals(Object obj) {
&& Objects.equals(unitOperations, other.unitOperations);
}

/**
* {@inheritDoc}
*
* @return a String
*/
/** {@inheritDoc} */
@Override
public String getReport_json() {
return new Report(this).generateJsonReport();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ public interface PlusFractionModelInterface extends java.io.Serializable {
*/
public int getLastPlusFractionNumber();

/**
* <p>setLastPlusFractionNumber.</p>
*
* @param fract a int
*/
public void setLastPlusFractionNumber(int fract);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,6 @@ public void Finit(PhaseInterface phase, double temperature, double pressure,
* </p>
*
* @param unit Unit of return pressure
*
* @return The normal boiling point of the component
*/
public double getNormalBoilingPoint(String unit);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ public class ThermodynamicOperations implements java.io.Serializable, Cloneable
private Thread thermoOperationThread = new Thread();
private OperationInterface operation = null;

/**
* <p>Getter for the field <code>system</code>.</p>
*
* @return a {@link neqsim.thermo.system.SystemInterface} object
*/
public SystemInterface getSystem() {
return system;
}
Expand Down

0 comments on commit 45e6476

Please sign in to comment.