doc: add boilerplate documentation

src/main/java/neqsim/chemicalreactions/ChemicalReactionOperations.java

@@ -29,7 +29,9 @@
  */
 public class ChemicalReactionOperations
     implements neqsim.thermo.ThermodynamicConstantsInterface, Cloneable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(ChemicalReactionOperations.class);
 
   SystemInterface system;

src/main/java/neqsim/chemicalreactions/chemicalequilibrium/ChemEq.java

@@ -12,6 +12,7 @@
  * @version $Id: $Id
  */
 public class ChemEq implements java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
   int NSPEC = 10;
   int NELE = 3;

src/main/java/neqsim/chemicalreactions/chemicalequilibrium/ChemicalEquilibrium.java

@@ -16,7 +16,9 @@
  * @version $Id: $Id
  */
 public class ChemicalEquilibrium implements java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(ChemicalEquilibrium.class);
 
   SystemInterface system;

src/main/java/neqsim/chemicalreactions/chemicalequilibrium/LinearProgrammingChemicalEquilibrium.java

@@ -36,7 +36,9 @@
  */
 public class LinearProgrammingChemicalEquilibrium
     implements neqsim.thermo.ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(LinearProgrammingChemicalEquilibrium.class);
 
   double[] xEts = null;

src/main/java/neqsim/chemicalreactions/chemicalequilibrium/ReferencePotComparator.java

@@ -19,6 +19,7 @@
  */
 public class ReferencePotComparator
     implements Comparator<ComponentInterface>, java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /** {@inheritDoc} */

src/main/java/neqsim/chemicalreactions/chemicalreaction/ChemicalReaction.java

@@ -22,6 +22,7 @@
  */
 public class ChemicalReaction extends NamedBaseClass
     implements neqsim.thermo.ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   String[] names;

src/main/java/neqsim/chemicalreactions/chemicalreaction/ChemicalReactionFactory.java

@@ -19,6 +19,7 @@
  * @version $Id: $Id
  */
 public final class ChemicalReactionFactory {
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(ChemicalReactionFactory.class);
 
   /**

src/main/java/neqsim/chemicalreactions/chemicalreaction/ChemicalReactionList.java

@@ -27,7 +27,9 @@
  * @version $Id: $Id
  */
 public class ChemicalReactionList implements ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(ChemicalReactionList.class);
 
   ArrayList<ChemicalReaction> chemicalReactionList = new ArrayList<ChemicalReaction>();

src/main/java/neqsim/chemicalreactions/kinetics/Kinetics.java

@@ -20,6 +20,7 @@
  * @version $Id: $Id
  */
 public class Kinetics implements java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
   protected ChemicalReactionOperations operations;
   double phiInfinite = 0.0;

src/main/java/neqsim/datapresentation/DataHandling.java

@@ -17,6 +17,7 @@
  * @version $Id: $Id
  */
 public class DataHandling {
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(DataHandling.class);
 
   /**

src/main/java/neqsim/datapresentation/filehandling/TextFile.java

@@ -14,7 +14,9 @@
  * @version $Id: $Id
  */
 public class TextFile implements java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(TextFile.class);
 
   String fileName = "c:/example.txt";

src/main/java/neqsim/datapresentation/jfreechart/Graph2b.java

@@ -29,7 +29,9 @@
  * @version $Id: $Id
  */
 public class Graph2b extends javax.swing.JFrame {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(Graph2b.class);
 
   XYDataset xyData;

src/main/java/neqsim/fluidmechanics/flowleg/FlowLeg.java

@@ -20,6 +20,7 @@
  * @version $Id: $Id
  */
 public abstract class FlowLeg implements FlowLegInterface, java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   protected FlowNodeInterface[] flowNode;

src/main/java/neqsim/fluidmechanics/flowleg/pipeleg/PipeLeg.java

@@ -18,6 +18,7 @@
  * @version $Id: $Id
  */
 public class PipeLeg extends FlowLeg {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   // FlowNodeInterface[] node;
@@ -27,8 +28,7 @@ public class PipeLeg extends FlowLeg {
    * Constructor for PipeLeg.
    * </p>
    */
-  public PipeLeg() {
-  }
+  public PipeLeg() {}
 
   /** {@inheritDoc} */
   @Override

src/main/java/neqsim/fluidmechanics/flownode/FlowNode.java

@@ -33,7 +33,9 @@
  * @version $Id: $Id
  */
 public abstract class FlowNode implements FlowNodeInterface, ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(FlowNode.class);
 
   protected double distanceToCenterOfNode = 0;

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/FluidBoundary.java

@@ -29,7 +29,9 @@
  * @version $Id: $Id
  */
 public abstract class FluidBoundary implements FluidBoundaryInterface, java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(FluidBoundary.class);
 
   protected FlowNodeInterface flowNode;

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/equilibriumfluidboundary/EquilibriumFluidBoundary.java

@@ -18,6 +18,7 @@
  */
 public class EquilibriumFluidBoundary
     extends neqsim.fluidmechanics.flownode.fluidboundary.heatmasstransfercalc.FluidBoundary {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/nonequilibriumfluidboundary/NonEquilibriumFluidBoundary.java

@@ -17,7 +17,9 @@
  */
 public abstract class NonEquilibriumFluidBoundary
     extends neqsim.fluidmechanics.flownode.fluidboundary.heatmasstransfercalc.FluidBoundary {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(NonEquilibriumFluidBoundary.class);
 
   protected int neq = 0;

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/nonequilibriumfluidboundary/filmmodelboundary/KrishnaStandartFilmModel.java

@@ -24,7 +24,9 @@
 public class KrishnaStandartFilmModel extends
     neqsim.fluidmechanics.flownode.fluidboundary.heatmasstransfercalc.nonequilibriumfluidboundary.NonEquilibriumFluidBoundary
     implements ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(KrishnaStandartFilmModel.class);
   Matrix phiMatrix;
   Matrix redPhiMatrix;

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/nonequilibriumfluidboundary/filmmodelboundary/reactivefilmmodel/ReactiveFluidBoundary.java

@@ -17,7 +17,9 @@
  * @version $Id: $Id
  */
 public abstract class ReactiveFluidBoundary extends KrishnaStandartFilmModel {
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(ReactiveFluidBoundary.class);
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   protected int neq = 0;

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/heatmasstransfercalc/nonequilibriumfluidboundary/filmmodelboundary/reactivefilmmodel/ReactiveKrishnaStandartFilmModel.java

@@ -22,6 +22,7 @@
  * @version $Id: $Id
  */
 public class ReactiveKrishnaStandartFilmModel extends KrishnaStandartFilmModel {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   int enhancementType = 1;

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/interphasetransportcoefficient/interphasetwophase/interphasepipeflow/InterphaseAnnularFlow.java

@@ -11,6 +11,7 @@
  * @version $Id: $Id
  */
 public class InterphaseAnnularFlow extends InterphaseStratifiedFlow {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/interphasetransportcoefficient/interphasetwophase/interphasepipeflow/InterphaseDropletFlow.java

@@ -12,6 +12,7 @@
  */
 public class InterphaseDropletFlow extends InterphaseTwoPhasePipeFlow
     implements neqsim.thermo.ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/interphasetransportcoefficient/interphasetwophase/interphasepipeflow/InterphaseStratifiedFlow.java

@@ -12,6 +12,7 @@
  */
 public class InterphaseStratifiedFlow extends InterphaseTwoPhasePipeFlow
     implements neqsim.thermo.ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/interphasetransportcoefficient/interphasetwophase/interphasereactorflow/InterphasePackedBed.java

@@ -12,6 +12,7 @@
  */
 public class InterphasePackedBed extends InterphaseReactorFlow
     implements neqsim.thermo.ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/fluidboundary/interphasetransportcoefficient/interphasetwophase/stirredcell/InterphaseStirredCellFlow.java

@@ -12,6 +12,7 @@
  * @version $Id: $Id
  */
 public class InterphaseStirredCellFlow extends InterphaseStratifiedFlow {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/multiphasenode/MultiPhaseFlowNode.java

@@ -17,7 +17,9 @@
  * @version $Id: $Id
  */
 public abstract class MultiPhaseFlowNode extends FlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(MultiPhaseFlowNode.class);
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/multiphasenode/waxnode/WaxDepositionFlowNode.java

@@ -23,7 +23,9 @@
  * @version $Id: $Id
  */
 public class WaxDepositionFlowNode extends MultiPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(WaxDepositionFlowNode.class);
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/onephasenode/onePhaseFlowNode.java

@@ -16,7 +16,9 @@
  * @version $Id: $Id
  */
 public abstract class onePhaseFlowNode extends FlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(onePhaseFlowNode.class);
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/onephasenode/onephasepipeflownode/onePhasePipeFlowNode.java

@@ -22,7 +22,9 @@
  * @version $Id: $Id
  */
 public class onePhasePipeFlowNode extends onePhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(onePhasePipeFlowNode.class);
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/TwoPhaseFlowNode.java

@@ -16,7 +16,9 @@
  * @version $Id: $Id
  */
 public abstract class TwoPhaseFlowNode extends FlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(TwoPhaseFlowNode.class);
 
   // public double[] molarMassTransferFlux;

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/twophasepipeflownode/AnnularFlow.java

@@ -25,7 +25,9 @@
  * @version $Id: $Id
  */
 public class AnnularFlow extends TwoPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(AnnularFlow.class);
   // ThermodynamicOperations interphaseOps = new ThermodynamicOperations();
   // double liquidFilmThickness=0;

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/twophasepipeflownode/BubbleFlowNode.java

@@ -20,7 +20,9 @@
  * @version $Id: $Id
  */
 public class BubbleFlowNode extends TwoPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(BubbleFlowNode.class);
   private double averageBubbleDiameter = 0.001;
 

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/twophasepipeflownode/DropletFlowNode.java

@@ -19,6 +19,7 @@
  * @version $Id: $Id
  */
 public class DropletFlowNode extends TwoPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
   private double averageDropletDiameter = 100.0e-6;
 

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/twophasepipeflownode/StratifiedFlowNode.java

@@ -20,7 +20,9 @@
  * @version $Id: $Id
  */
 public class StratifiedFlowNode extends TwoPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(StratifiedFlowNode.class);
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/twophasereactorflownode/TwoPhasePackedBedFlowNode.java

@@ -23,7 +23,9 @@
  * @version $Id: $Id
  */
 public class TwoPhasePackedBedFlowNode extends TwoPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(TwoPhasePackedBedFlowNode.class);
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/twophasereactorflownode/TwoPhaseTrayTowerFlowNode.java

@@ -22,7 +22,9 @@
  * @version $Id: $Id
  */
 public class TwoPhaseTrayTowerFlowNode extends TwoPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(TwoPhaseTrayTowerFlowNode.class);
 
   /**

src/main/java/neqsim/fluidmechanics/flownode/twophasenode/twophasestirredcellnode/StirredCellNode.java

@@ -22,7 +22,9 @@
  * @version $Id: $Id
  */
 public class StirredCellNode extends TwoPhaseFlowNode {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(StirredCellNode.class);
 
   private double[] stirrerRate = {1.0, 1.0};

src/main/java/neqsim/fluidmechanics/flowsolver/FlowSolver.java

@@ -15,6 +15,7 @@
  * @version $Id: $Id
  */
 public abstract class FlowSolver implements FlowSolverInterface, java.io.Serializable {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   protected int numberOfVelocityNodes = 0;

src/main/java/neqsim/fluidmechanics/flowsolver/onephaseflowsolver/OnePhaseFlowSolver.java

@@ -15,6 +15,7 @@
  * @version $Id: $Id
  */
 public abstract class OnePhaseFlowSolver extends neqsim.fluidmechanics.flowsolver.FlowSolver {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
 
   /**

src/main/java/neqsim/fluidmechanics/flowsolver/onephaseflowsolver/onephasepipeflowsolver/OnePhaseFixedStaggeredGrid.java

@@ -22,7 +22,9 @@
  */
 public class OnePhaseFixedStaggeredGrid extends OnePhasePipeFlowSolver
     implements neqsim.thermo.ThermodynamicConstantsInterface {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(OnePhaseFixedStaggeredGrid.class);
 
   Matrix diffMatrix;

src/main/java/neqsim/fluidmechanics/flowsolver/onephaseflowsolver/onephasepipeflowsolver/OnePhasePipeFlowSolver.java

@@ -21,7 +21,9 @@
  */
 public class OnePhasePipeFlowSolver
     extends neqsim.fluidmechanics.flowsolver.onephaseflowsolver.OnePhaseFlowSolver {
+  /** Serialization version UID. */
   private static final long serialVersionUID = 1000;
+  /** Logger object for class. */
   static Logger logger = LogManager.getLogger(OnePhasePipeFlowSolver.class);
 
   protected double[] PbArray; // = new double[100];