/[ascend]/trunk/base/generic/compiler/ascCompiler.h
ViewVC logotype

Contents of /trunk/base/generic/compiler/ascCompiler.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1066 - (show annotations) (download) (as text)
Sun Jan 7 10:02:41 2007 UTC (17 years, 8 months ago) by johnpye
File MIME type: text/x-chdr
File size: 2210 byte(s)
Adding doxygen 'addtogroup' for Solver, Compiler, Integrator.
1 /* ASCEND modelling environment
2 Copyright (C) 1997 Benjamin Andrew Allan
3 Copyright (C) 2006 Carnegie Mellon University
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
8 any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
19 *//**
20 @file
21 Basic Initializations for Ascend
22
23 This module initializes the fundamental data structures used by the rest of
24 Ascend and pulls in system headers. Largely this means memory management.
25
26 Requires:
27 #include "utilities/ascConfig.h"
28 *//*
29 by Ben Allan
30 Version: $Revision: 1.2 $
31 Version control file: $RCSfile: ascCompiler.h,v $
32 Date last modified: $Date: 1997/07/18 12:27:56 $
33 Last modified by: $Author: mthomas $
34 */
35
36 #ifndef ASC_ASCCOMPILER_H
37 #define ASC_ASCCOMPILER_H
38
39 /** addtogroup compiler Compiler
40 @{
41 */
42
43 #include <utilities/ascConfig.h>
44
45 ASC_DLLSPEC int Asc_CompilerInit(int simplify_relations);
46 /**<
47 * Initialize any resources used by the ASCEND compiler.
48 *
49 * If this function returns nonzero, ASCEND cannot run and a ton
50 * of memory might be leaked.
51 *
52 * The value of simplify_relations sets the initial value of a flag
53 * which tells the compiler to simplify compiled equations or not.
54 * It has no effect on the success or failure of the call.
55 *
56 * @BUG At present it needs to more aggressively check the return codes
57 * from the functions this calls. Currently returns 0 regardless.
58 */
59
60 ASC_DLLSPEC void Asc_CompilerDestroy(void);
61 /**<
62 * Clean up any resources used by the compiler.
63 * This function should not be called while there are any clients
64 * with pointers to any compiler structures, including gl_lists.
65 */
66
67 /* @} */
68
69 #endif /* ASC_ASCCOMPILER_H */

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