/[ascend]/trunk/models/README.txt
ViewVC logotype

Contents of /trunk/models/README.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (show annotations) (download)
Fri Oct 29 20:54:12 2004 UTC (19 years, 7 months ago) by aw0a
File MIME type: text/plain
File size: 7536 byte(s)
Setting up web subdirectory in repository
1 $Revision: 1.2 $
2
3 Topics-
4
5 1) content description
6 2) file extensions
7 3) file names
8 4) subdirectories
9 5) File summaries
10
11
12 1) Description:
13
14 This directory tree contains the ASCEND IV code for library models and
15 example models.
16
17 All the files in this directory hierarchy are Copyright
18 Carnegie Mellon University and distributed under the GNU
19 License version 2 unless OTHERWISE noted in an individual
20 file.
21
22 All 'supported' models are in this top level directory.
23 Subdirectories are supported by their authors (if at all) and
24 not by the ASCEND Project at large.
25
26
27 2) Files have 5 extensions:
28
29 .a4s: A Script (tcl) for loading in the ASCEND script window.
30 .a4l: A library of reusable models. Each library contains enough
31 test models to be self-validating and self-documenting.
32 .a4c: Model code examples and demos.
33 .a4v: A file of saved values from a simulation.
34 .tcl: Auxillary TCL scripts for performing miscellaneous tasks
35 related to modeling that the user may wish to copy and
36 modify: for example, the user can create many permutations
37 on the set_intervals.tcl functions which specify a
38 time sampling schedule for the integrators.
39
40 and 1 prefix
41
42 z- normally of no interest to users, z files are models that
43 contain code testing 1 or more features of the system which
44 are not ordinarily tested in the course of routine distillation
45 modeling.
46
47
48 3) A note on file names:
49
50 We frequently develop alternative modeling strategies as part of
51 research. Since all our models live in one directory, several files
52 may have names starting with part of the author's name to distinguish
53 them from similar sets of models by another author.
54 Groups of related models may be kept in subdirectories.
55
56
57 4) Subdirectories:
58
59 Most subdirectories only exist at Carnegie Mellon, and are generally
60 full of experimental goop designed to frustrate the casual user.
61 They also contain legacy goop. Old style extensions in use for
62 these files include .s (now .a4s), .lib (now .a4l), .asc (now .a4c).
63 .values (now .a4v), .units (now defunct).
64
65 ben: This directory contains the models presented in Ben Allan's
66 thesis. These models are somewhat less flexible than the
67 main models directory, but are generally less consuming of
68 computer CPU tim/memory resources.
69
70 libraries: This directory contains *.lib files, containing model
71 libraries. There is a link between H_G_thermodynamics.lib
72 and thermo.lib.
73
74 examples: This directory contains example files. Each example has a
75 *.asc and a *.s file. The *.s is a script for running the
76 models in the *.asc file.
77
78 pending: This directory contains possible additions or changes to the
79 libraries and examples directories. The models in these
80 directories fall under the GNU license, but there are no
81 guarantees on how well they will work. A generic GNU
82 header is provided in each of the sub-directories to be
83 added to any models placed in pendings.
84
85
86 5) Models are primarily chemical engineering library application
87 except as OTHERWISE noted.
88
89 Guthrie_costs.a4l
90 Cost correlation modeling, chemical engineering.
91 KenPendings.a4l
92 Experimental code.
93 abc_flowsheet.a4l
94 Experimental code.
95 atoms.a4l
96 Basic variable definitions for all engineering and physics.
97 Additional ATOM contributions welcomed.
98 basemodel.a4l
99 Base system library.
100 bvp.a4l
101 Generic mathematical boundary value problem framework for
102 differential algebraic equations.
103 casestudy.a4s
104 Simple example of case studies for chemical engineering flash MODEL.
105 collocation.a4l
106 Reduced order distillation modeling by collocation.
107 Variable number of trays and tray sections supported.
108 collocation.a4s
109 Demo script for collocation.a4l.
110 collocation_tests.a4s
111 Obsolete file.
112 column.a4l
113 Rigorous tray-by-tray distillation models for chemical engineering.
114 Fixed number of trays user configurable. Mass or energy balance
115 options.
116 components.a4l
117 Physical properties database from Reid Prausnitz and Poling
118 (McGraw-Hill) for chemical engineering. Will be expanded greatly
119 shortly with permission from McGraw-Hill.
120 cost_column.a4l
121 Economic evaluation of collocation modeled distillation.
122 distance_calc.a4c
123 Simple physics example.
124 dyn_column.a4l
125 Dynamic simulation of vapor-liquid distillation in
126 chemical engineering. Mass or energy balance options.
127 dyn_flash.a4l
128 Dynamic simulation of vapor-liquid flash, condensers, reboilers etc
129 for chemical engineering.
130 dyn_separation_demos.a4s
131 Demo script for dynamic simulation of flash and distillation models.
132 dyn_tank.a4c
133 dyn_tank.a4s
134 Dynamic simulation of water level in a tank.
135 flash.a4l
136 Steady-state flash separation models for chemical engineering.
137 Condenser, reboiler, tray, etc. Mass or energy balance options.
138 force1d.a4c
139 force1d.a4s
140 Mass-spring-force models for basic physics or mechanical engineering.
141 heatex.a4c
142 heatex.a4s
143 Heat exchange MODEL with condensation boundary determination.
144 ivpsystem.a4l
145 Basic variable definitions for algebraic and initial value problem
146 solvers.
147 kinetics.a4l
148 kinetics.a4s
149 Models for computing chemical reactions.
150 linear_balance.a4c
151 linear_balance.a4s
152 Trivial mass-balance flowsheet superstructures for chemical
153 engineering solved with conditional modeling. Requires CONOPT
154 measures.a4l
155 Units of measure definitions based on MKS system.
156 mix.a4l
157 mix.a4s
158 Mixer unit for process streams in chemical engineering.
159 old_separation_demos.a4s
160 Steady-state flash and distillation models from Ben Allan's thesis.
161 phaseq.a4c
162 phaseq.a4s
163 phaseq_comp.a4c
164 phaseq_comp.a4s
165 phases.a4l
166 pipeline.a4c
167 pipeline.a4s
168 Conditional models of multiphase thermodynamic equilibrium
169 and pipe networks.
170 plot.a4l
171 Antiquated but sometimes useful plot package.
172 plotbvp.a4c
173 plotbvp.a4s
174 Plot package application example for differential equations.
175 plotcol.a4c
176 Plot package application example for distillation.
177 rachford.a4c
178 rachford.a4s
179 Simple Rachford-Rice flash calculation.
180 ratelaws.a4c
181 Chemical kinetics examples.
182 reactor.a4l
183 reactor.a4s
184 Chemical reactor modeling examples, chemical engineering.
185 roots_of_poly.a4c
186 Simple equation solving example. Mathematics.
187 separation_demos.a4s
188 Steady-state flash and distillation models.
189 set_intervals.tcl
190 Support script for initial value solver interface.
191 simple_fs.a4c
192 simple_fs.a4s
193 Obsolete flowsheet structuring examples a la ASCEND III.
194 simple_fs_cost.a4c
195 simple_fs_cost.a4s
196 simple_fs_ext.a4c
197 Obsolete flowsheet optimization examples a la ASCEND III.
198 Requires CONOPT.
199 sonic.a4c
200 sonic.a4s
201 Calculation of sonic flow transition in a pipe. Chemical/mechanical
202 engineering.
203 splitter.a4l
204 splitter.a4s
205 Process stream splitter models for chemical engineering.
206 stream_holdup.a4l
207 Basic process stream definitions.
208 system.a4l
209 Basic variable definition for algebraic solvers.
210 ternary_plot.a4l
211 Plot library for 3 component mixtures in distillation columns from
212 chemical engineering.
213 thermodynamics.a4l
214 Vapor, liquid, and equilibrium thermodynamic calculation library.
215 vessel.a4c
216 vessel.a4s
217 vesselMethods.a4c
218 vesselNotes.a4c
219 vesselParams.a4c
220 vesselPlain.a4c
221 vesselPlot.a4c
222 vesselPlot.a4s
223 vesselStudy.a4s
224 vesselTabulated.a4c
225 vesselTabulated.a4s
226 Simple models accumulated from the HowTo's for ASCEND.
227 when_demo.a4c
228 when_demo.a4s
229 Simple example of conditional modeling.
230 z-addmethod.a4c
231 z-align.a4c
232 z-alike.a4c
233 z-anontype.a4c
234 z-arsubs.a4c
235 z-context.a4c
236 z-emptyarg.a4c
237 z-emptyfor.a4c
238 z-iflogic.a4c
239 z-indirect.a4c
240 z-isawhere.a4c
241 z-relname.a4c
242 z-suite.a4s
243 Software Quality Assurance tests and bug documentation.
244 Not for routine use.

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22