generic/interface/Sensitivity.h

/*
 *  Sensitivity.h
 *  by Kirk Abbott and Ben Allan
 *  Created: 1/94
 *  Version: $Revision: 1.9 $
 *  Version control file: $RCSfile: Sensitivity.h,v $
 *  Date last modified: $Date: 2003/08/23 18:43:08 $
 *  Last modified by: $Author: ballan $
 *
 *  This file is part of the ASCEND Tcl/Tk interface
 *
 *  Copyright 1997, Carnegie Mellon University
 *
 *  The ASCEND Tcl/Tk interface is free software; you can redistribute
 *  it and/or modify it under the terms of the GNU General Public License as
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version.
 *
 *  The ASCEND Tcl/Tk interface is distributed in hope that it will be
 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with the program; if not, write to the Free Software Foundation,
 *  Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check the file named
 *  COPYING.  COPYING is found in ../compiler.
 */

/** @file
 *  Sensititvity analysis code.
 *  <pre>
 *  Requires:     #include "tcl.h"
 *                #include "utilities/ascConfig.h"
 *                #include "solver/slv_client.h"
 *  </pre>
 *  @todo Do we really need 2 files called sensitivity.[ch]?  Other one in base/packages.
 */

#ifndef ASCTK_SENSITIVITY_H
#define ASCTK_SENSITIVITY_H

extern int Asc_BLsodeDerivatives(slv_system_t sys,
                                 double **dy_dx,
                                 int *inputs_ndx_list,
                                 int ninputs,
                                 int *outputs_ndx_list,
                                 int noutputs);
/**<
 *  The entry point for the Lsode Integrator.
 *  This needs further explanation, but roughly:
 *  dy_dx IS_A 2d array of sensitivity partial derivatives.
 *  ninputs  the number of fixed state variables in the DAE.
 *  noutputs the number of derivatives
 *  ndx_list the var indices of the variables in question.
 *
 *  @todo Asc_BLsodeDerivatives() does not pass in a list of 
 *        var_variables instead of indices, as it should.
 */

extern int Asc_MtxNormsCmd(ClientData cdata, Tcl_Interp *interp,
                           int argc, CONST84 char *argv[]);
/**<
 *  Calculates some matrix norms and a condition number.
 *  This code is placed here until we can find a proper home for it.
 *  It should perhaps be in DebugProc[12].[ch].  In the current incarnation
 *  is to be in conjuction with some sensiticity ananlysis code.
 *
 *  @todo Find proper home for Asc_MtxNormsCmd().
 */

#endif  /* _ASCTK_SENSITIVITY_H */

1	/*
2	* Sensitivity.h
3	* by Kirk Abbott and Ben Allan
4	* Created: 1/94
5	* Version: $Revision: 1.9 $
6	* Version control file: $RCSfile: Sensitivity.h,v $
7	* Date last modified: $Date: 2003/08/23 18:43:08 $
8	* Last modified by: $Author: ballan $
9	*
10	* This file is part of the ASCEND Tcl/Tk interface
11	*
12	* Copyright 1997, Carnegie Mellon University
13	*
14	* The ASCEND Tcl/Tk interface is free software; you can redistribute
15	* it and/or modify it under the terms of the GNU General Public License as
16	* published by the Free Software Foundation; either version 2 of the
17	* License, or (at your option) any later version.
18	*
19	* The ASCEND Tcl/Tk interface is distributed in hope that it will be
20	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22	* General Public License for more details.
23	*
24	* You should have received a copy of the GNU General Public License
25	* along with the program; if not, write to the Free Software Foundation,
26	* Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
27	* COPYING. COPYING is found in ../compiler.
28	*/
29
30	/** @file
31	* Sensititvity analysis code.
32	* <pre>
33	* Requires: #include "tcl.h"
34	* #include "utilities/ascConfig.h"
35	* #include "solver/slv_client.h"
36	* </pre>
37	* @todo Do we really need 2 files called sensitivity.[ch]? Other one in base/packages.
38	*/
39
40	#ifndef ASCTK_SENSITIVITY_H
41	#define ASCTK_SENSITIVITY_H
42
43	extern int Asc_BLsodeDerivatives(slv_system_t sys,
44	double **dy_dx,
45	int *inputs_ndx_list,
46	int ninputs,
47	int *outputs_ndx_list,
48	int noutputs);
49	/**<
50	* The entry point for the Lsode Integrator.
51	* This needs further explanation, but roughly:
52	* dy_dx IS_A 2d array of sensitivity partial derivatives.
53	* ninputs the number of fixed state variables in the DAE.
54	* noutputs the number of derivatives
55	* ndx_list the var indices of the variables in question.
56	*
57	* @todo Asc_BLsodeDerivatives() does not pass in a list of
58	* var_variables instead of indices, as it should.
59	*/
60
61	extern int Asc_MtxNormsCmd(ClientData cdata, Tcl_Interp *interp,
62	int argc, CONST84 char *argv[]);
63	/**<
64	* Calculates some matrix norms and a condition number.
65	* This code is placed here until we can find a proper home for it.
66	* It should perhaps be in DebugProc[12].[ch]. In the current incarnation
67	* is to be in conjuction with some sensiticity ananlysis code.
68	*
69	* @todo Find proper home for Asc_MtxNormsCmd().
70	*/
71
72	#endif /* _ASCTK_SENSITIVITY_H */
73