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

doc: fix javadoc #891

Merged
merged 3 commits into from
Dec 22, 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 @@ -453,6 +453,7 @@ public boolean solveChemEq(int phase, int type) {
solver = new ChemicalEquilibrium(Amatrix, bVector, system, components, phase);
} catch (Exception ex) {
logger.error(ex.getMessage(), ex);
// todo: Will this crash below?
}
return solver.solve();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,11 @@ public void update() {
}
}

/**
* <p>update.</p>
*
* @param deltaTime a double
*/
public void update(double deltaTime) {
for (int componentNumber = 0; componentNumber < getBulkSystem().getPhases()[0]
.getNumberOfComponents(); componentNumber++) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,21 @@ public default void runTransient(double initResponse, double dt) {

/**
* <p>
* setActive
* setActive.
* </p>
* Set if controller is active
*
* @param isActive Set true to make controller active.
*/
public void setActive(boolean isActive);

/**
* <p>
* isActive
* isActive.
* </p>
* Specifies if controller is active
*
* @return a boolean
*/
public boolean isActive();
}
5 changes: 1 addition & 4 deletions src/main/java/neqsim/thermo/ThermodynamicModelTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -424,11 +424,8 @@ public boolean checkNumerically() {
}

/**
* <p>
*
* @param maxErr Maximum error before test will report failed Set maximum allowed error in model
* check
* </p>
* @param maxErr before test will report failed Set maximum allowed error in model check
*/
public void setMaxError(double maxErr) {
this.maxError = maxErr;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/neqsim/util/unit/LengthUnit.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ public class LengthUnit extends neqsim.util.unit.BaseUnit {
* Constructor for LengthUnit.
* </p>
*
* @param value
* @param name
* @param value Numeric value
* @param name Name of unit
*/
public LengthUnit(double value, String name) {
super(value, name);
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/neqsim/util/unit/TimeUnit.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ public class TimeUnit extends neqsim.util.unit.BaseUnit {
* Constructor for TimeUnit.
* </p>
*
* @param value
* @param name
* @param value Numeric value
* @param name Name of unit
*/
public TimeUnit(double value, String name) {
super(value, name);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ void setUp() throws Exception {
testSystem.initProperties();
}

/**
* Test method for {@link neqsim.thermodynamicOperations.flashOps.PHFlashGERG2008#run()}.
*/
@Test
void testRun() {
double[] gergProps = testSystem.getPhase(0).getProperties_GERG2008();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,6 @@ void setUp() throws Exception {
testSystem.setMixingRule("classic");
}

/**
* Test method for {@link neqsim.thermodynamicOperations.flashOps.PHFlash#run()}.
*/
@Test
void testRun() {
testOps = new ThermodynamicOperations(testSystem);
Expand Down
Loading