Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style, needs to verify inherited comments in Component.java #635

Merged
merged 6 commits into from
Apr 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ public ParachorSurfaceTension(SystemInterface system) {
/**
* {@inheritDoc}
*
* <p>
* Calculates the pure component surfacetension using the Macleod/Sugden method
* </p>
*/
@Override
public double calcPureComponentSurfaceTension(int componentNumber) {
Expand All @@ -53,7 +55,9 @@ public double calcPureComponentSurfaceTension(int componentNumber) {
/**
* {@inheritDoc}
*
* <p>
* Calculates the surfacetension using the Macleod/Sugden method for mixtures Units: N/m
* </p>
*/
@Override
public double calcSurfaceTension(int interface1, int interface2) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,62 +18,62 @@
* @version $Id: $Id
*/
public class SurfaceTension extends InterfaceProperties implements SurfaceTensionInterface {
private static final long serialVersionUID = 1000;
private static final long serialVersionUID = 1000;

protected SystemInterface system;
protected SystemInterface system;

/**
* <p>
* Constructor for SurfaceTension.
* </p>
*/
public SurfaceTension() {}
/**
* <p>
* Constructor for SurfaceTension.
* </p>
*/
public SurfaceTension() {}

/**
* <p>
* Constructor for SurfaceTension.
* </p>
*
* @param system a {@link neqsim.thermo.system.SystemInterface} object
*/
public SurfaceTension(SystemInterface system) {
this.system = system;
}
/**
* <p>
* Constructor for SurfaceTension.
* </p>
*
* @param system a {@link neqsim.thermo.system.SystemInterface} object
*/
public SurfaceTension(SystemInterface system) {
this.system = system;
}

/**
* <p>
* calcPureComponentSurfaceTension.
* </p>
*
* @param componentNumber a int
* @return a double
*/
public double calcPureComponentSurfaceTension(int componentNumber) {
return 0.0;
}
/**
* <p>
* calcPureComponentSurfaceTension.
* </p>
*
* @param componentNumber a int
* @return a double
*/
public double calcPureComponentSurfaceTension(int componentNumber) {
return 0.0;
}

/** {@inheritDoc} */
@Override
public double calcSurfaceTension(int int1, int int2) {
return 0.0;
}
/** {@inheritDoc} */
@Override
public double calcSurfaceTension(int int1, int int2) {
return 0.0;
}

/**
* <p>
* getComponentWithHighestBoilingpoint.
* </p>
*
* @return a int
*/
public int getComponentWithHighestBoilingpoint() {
int compNumb = 0;
double boilPoint = -273.15;
for (int i = 0; i < system.getPhase(0).getNumberOfComponents(); i++) {
if (system.getPhase(0).getComponent(i).getNormalBoilingPoint() > boilPoint) {
compNumb = i;
boilPoint = system.getPhase(0).getComponent(i).getNormalBoilingPoint();
}
}
return compNumb;
/**
* <p>
* getComponentWithHighestBoilingpoint.
* </p>
*
* @return a int
*/
public int getComponentWithHighestBoilingpoint() {
int compNumb = 0;
double boilPoint = -273.15;
for (int i = 0; i < system.getPhase(0).getNumberOfComponents(); i++) {
if (system.getPhase(0).getComponent(i).getNormalBoilingPoint() > boilPoint) {
compNumb = i;
boilPoint = system.getPhase(0).getComponent(i).getNormalBoilingPoint();
}
}
return compNumb;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ public Density clone() {
/**
* {@inheritDoc}
*
* <p>
* Returns the density of the phase. Unit: kg/m^3
* </p>
*/
@Override
public double calcDensity() {
Expand Down
12 changes: 2 additions & 10 deletions src/main/java/neqsim/processSimulation/SimulationBaseClass.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,7 @@ public SimulationBaseClass(String name) {
super(name);
}

/**
* {@inheritDoc}
*
* @return a {@link java.util.UUID} object
*/
/** {@inheritDoc} */
public UUID getCalculationIdentifier() {
return calcIdentifier;
}
Expand All @@ -58,11 +54,7 @@ public void setCalculateSteadyState(boolean steady) {
this.calculateSteadyState = steady;
}

/**
* {@inheritDoc}
*
* @return a double
*/
/** {@inheritDoc} */
public double getTime() {
return this.time;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,9 @@ public interface SimulationInterface extends NamedInterface, Runnable, Serializa
* {@inheritDoc}
*
* <p>
* run
* </p>
* In this method all thermodynamic and unit operations will be calculated in a steady state
* calculation. Sets calc identifier UUID.
* </p>
*/
@Override
public default void run() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public class SevereSlugAnalyser extends MeasurementDeviceBaseClass {
double alfaRiser = 0.0; // gas fraction in the riser
double z = 0.0001; // some initial value to start the calculation
double lambdaStagnant = 0.0;
double uLevel = 0.0;// some initial value to start the calculation
double uLevel = 0.0; // some initial value to start the calculation
double valveConstant = 0.0;
double normalPressure = 100000.0;
final double pi = neqsim.thermo.ThermodynamicConstantsInterface.pi;
Expand Down Expand Up @@ -661,6 +661,25 @@ public double getMeasuredValue() {
return slugValue;
}

/**
* <p>
* getMeasuredValue.
* </p>
*
* @param fluid a
* {@link neqsim.processSimulation.measurementDevice.simpleFlowRegime.FluidSevereSlug}
* object
* @param pipe a {@link neqsim.processSimulation.measurementDevice.simpleFlowRegime.Pipe} object
* @param severeSlug a
* {@link neqsim.processSimulation.measurementDevice.simpleFlowRegime.SevereSlugAnalyser}
* object
* @return a double
*/
public double getMeasuredValue(FluidSevereSlug fluid, Pipe pipe, SevereSlugAnalyser severeSlug) {
checkFlowRegime(fluid, pipe, severeSlug);
return slugValue;
}

/**
* <p>
* getPredictedFlowRegime.
Expand Down Expand Up @@ -694,25 +713,6 @@ public String getPredictedFlowRegime() {
return flowPattern;
}

/**
* <p>
* getMeasuredValue.
* </p>
*
* @param fluid a
* {@link neqsim.processSimulation.measurementDevice.simpleFlowRegime.FluidSevereSlug}
* object
* @param pipe a {@link neqsim.processSimulation.measurementDevice.simpleFlowRegime.Pipe} object
* @param severeSlug a
* {@link neqsim.processSimulation.measurementDevice.simpleFlowRegime.SevereSlugAnalyser}
* object
* @return a double
*/
public double getMeasuredValue(FluidSevereSlug fluid, Pipe pipe, SevereSlugAnalyser severeSlug) {
checkFlowRegime(fluid, pipe, severeSlug);
return slugValue;
}

/**
* <p>
* getPredictedFlowRegime.
Expand Down Expand Up @@ -740,7 +740,7 @@ public String getPredictedFlowRegime(FluidSevereSlug fluid, Pipe pipe,
*
* @param args an array of {@link java.lang.String} objects
*/
public static void main(String args[]) {
public static void main(String[] args) {
neqsim.thermo.system.SystemInterface testSystem =
new neqsim.thermo.system.SystemSrkEos((273.15 + 15.0), 10);
testSystem.addComponent("methane", 0.015, "MSm^3/day");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ public SimpleAbsorber(String name, StreamInterface inStream1) {
*
* @return a {@link neqsim.processSimulation.mechanicalDesign.absorber.AbsorberMechanicalDesign} object
*/
@Override
public AbsorberMechanicalDesign getMechanicalDesign() {
return new AbsorberMechanicalDesign(this);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ public void setCurves(double[] chartConditions, double[] speed, double[][] flow,
* Get method for polytropic head from reference curves.
*
* @param flow [m3/h], speed in [rpm].
* @return polytropic head in unit [getHeadUnit]
* @param speed a double
* @return polytropic head in unit [getHeadUnit]
*/
public double getPolytropicHead(double flow, double speed);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,28 +65,28 @@ public interface WaxModelInterface extends java.io.Serializable, Cloneable {

/**
* <p>
* removeWax.
* setParameterWaxHeatOfFusion.
* </p>
*
* @param parameterWaxHeatOfFusion an array of {@link double} objects
*/
public void removeWax();
public void setParameterWaxHeatOfFusion(double[] parameterWaxHeatOfFusion);

/**
* <p>
* getParameterWaxHeatOfFusion.
* removeWax.
* </p>
*
* @return an array of {@link double} objects
*/
public double[] getParameterWaxHeatOfFusion();
public void removeWax();

/**
* <p>
* setParameterWaxHeatOfFusion.
* getParameterWaxHeatOfFusion.
* </p>
*
* @param parameterWaxHeatOfFusion an array of {@link double} objects
* @return an array of {@link double} objects
*/
public void setParameterWaxHeatOfFusion(double[] parameterWaxHeatOfFusion);
public double[] getParameterWaxHeatOfFusion();

/**
* <p>
Expand Down
Loading