Added Test Examples Documentation and Modified Model Documentation

FOSSEE / OMChemSim

Chemical library developed using OpenModelica for steady-state and dynamic process simulation

BSD 3-Clause "New" or "Revised" License

37 stars 28 forks source link

Added Test Examples Documentation and Modified Model Documentation #48

Closed nayakpriyam closed 4 years ago

nayakpriyam commented 4 years ago

Added documentation for following test examples:

Heater
Cooler
Mixer
Shortcut Column
Valve
Centrifugal Pump
Adiabatic Expander
Adiabatic Compressor
Conversion Reactor
Flash
Equilibrium Reactor
Splitter
Compound Separator
CSTR
Material Stream
Distillation Column
Absorption Column
PFR

Modified documentation for following models

Heater
Cooler
Mixer
Shortcut Column
Valve
Centrifugal Pump
Adiabatic Expander
Adiabatic Compressor
Conversion Reactor
Flash
Material Stream
Distillation Column
Absorption Column
PFR

Added documentation for the following models:

Conversion Reaction
Equilibrium Reaction
Equilibrium Reactor
Splitter
Compound Separator
CSTR
Kinetic Reaction

pravindalve commented 4 years ago

Please consider the following suggestions

In the shortcut column description, it will be better to refer Hkey and Lkey as Heavy Key and Light Key rather than High Key and Low Key.
The type of Hkey and Lkey is parameter Integer, not parameter Real.
There are linking issues in description for ms in Simulator.Examples.CopositeMS and for main in Simulator.Examples.ShortcutColumn.ms
In Simulator.Examples.CSTR.MS description test1 is linked in place of test2 also.
In Simulator.UnitOperations.Flash BPdef is written as PTdef in the third last paragraph.
Spell check is required.

nayakpriyam commented 4 years ago

All the suggestions have been addressed through commit id d7ef13e

Please consider the following suggestions

1. In the shortcut column description, it will be better to refer Hkey and Lkey as Heavy Key and Light Key rather than High Key and Low Key. 

2. The type of Hkey and Lkey is parameter Integer, not parameter Real.

3. There are linking issues in description for ms in Simulator.Examples.CopositeMS and for main in Simulator.Examples.ShortcutColumn.ms

4. In Simulator.Examples.CSTR.MS description test1 is linked in place of test2 also.

5. In Simulator.UnitOperations.Flash BPdef is written as PTdef in the third last paragraph.

6. Spell check is required.