/[ascend]/trunk/ascend/solver/slv_interface.h
ViewVC logotype

Contents of /trunk/ascend/solver/slv_interface.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2375 - (show annotations) (download) (as text)
Tue Feb 1 05:53:26 2011 UTC (11 years, 5 months ago) by jpye
File MIME type: text/x-chdr
File size: 2420 byte(s)
Add updated comments to slv_interface.[ch].
Add markup to solver/solver.h so that it appears correctly in the new doxygen documentation.
1 /* ASCEND modelling environment
2 Copyright (c) 1990 Thomas Guthrie Epperly
3 Copyright (c) 1994 Joseph Zaher, Benjamin Andrew Allan
4 Copyright (c) 2011 Carnegie Mellon University
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.
20 *//** @file
21 Interface to Karl Westerberg's Solver.
22
23 @DEPRECATED This header file relates to a disused command-line based interface
24 for the ASCEND system. It might still be possible to do something useful
25 with this though, so it has been kept for now -- JP, Feb 2011.
26
27 @todo Clean junk out of solver/slv_interface.h.
28 *//*
29 * Interface to Karl Westerberg's Solver
30 * Tom Epperly
31 * Created: June, 1990
32 * Copyright (C) 1990 Thomas Guthrie Epperly
33 * Patched 1/94 for ASCEND3C -baa
34 * Only Solve is implemented in slv_interface.c
35 * Last in CVS: $Revision: 1.4 $ $Date: 1997/07/18 12:17:10 $ $Author: mthomas $
36 */
37
38 #ifndef ASC_SLV_INTERFACE_H
39 #define ASC_SLV_INTERFACE_H
40
41 #include <ascend/general/platform.h>
42 /* #include <compiler/instance_enum.h> */
43
44 /** @addtogroup solver Solver
45 @{
46 */
47
48 /* ASC_DLLSPEC void Solve(struct Instance *inst); */
49 /**<
50 * This is the link that the command line interface should call.
51
52 @TODO can we delete this?
53 */
54
55 #define JACFUNC void (*)(int,int,double)
56 /**<
57 * Type definition for storing Jacobian elements. The function definition
58 * is as follows:
59 *
60 * void JacStore(row,col,value)
61 * int row,col;
62 * double value;
63 *
64 * @todo If still needed, should it be a typedef?
65 */
66
67 #define SLOPEFUNC void (*)(int,int,double,double)
68 /**<
69 * Type definition for storing slope matrix elements. The function
70 * definition is as follows:
71 *
72 * void SlopeStore(row,col,low,high)
73 * int row,col;
74 * double low,high;
75 *
76 * @todo If still needed, should it be a typedef?
77 */
78
79 /* @} */
80
81 #endif /* ASC_SLV_INTERFACE_H */
82

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