generic/solver/lsode.h

/*  ASCEND modelling environment
    Copyright 1997, Carnegie Mellon University
    Copyright (C) 2006 Carnegie Mellon University

    This program 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, or (at your option)
    any later version.

    This program is distributed in the 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*//** @file
    Lsode Integrator.

    @NOTE
    The macro DOTIME is defined inside Lsode.c. If its value is
    TRUE, we spew all sorts of time junk. If FALSE we are quiet.
    Default for this macro is FALSE.

    @NOTE the analytic jacobian routines (state matrix) depend on the
    assumption that struct var_variable *<--> struct Instance *.
    Requires:
    #include <utilities/ascConfig.h>
    #include <solver/slv_client.h>
    #include <solver/integrator.h>
*//*
    by Kirk Abbott and Ben Allan
    Created: 1/94
    Version: $Revision: 1.6 $
    Version control file: $RCSfile: Lsode.h,v $
    Date last modified: $Date: 1997/07/18 12:23:18 $
    Last modified by: $Author: mthomas $
*/

#ifndef ASC_LSODE_H
#define ASC_LSODE_H

#include "linsol.h"
#include "linsolqr.h"
#include "slv_client.h"

/// Perform LSODE integration of a specified 'Integ_system'.
/**
    Takes the start and finish index as defined by the user and carries
    out the integration using repeated calls to the function lsode.
    Assumes sys corresponds to g_solvinst_cur.
    works off instances of type blsode taken from blsys.
 */
extern int integrator_lsode_solve(IntegratorSystem *blsys
        ,unsigned long i1, unsigned long i2
);

void integrator_lsode_create(IntegratorSystem *blsys);
void integrator_lsode_init(IntegratorSystem *blsys);
void integrator_lsode_free(void *enginedata);

#endif  /* ASC_LSODE_H */

1	johnpye	669	/* ASCEND modelling environment
2			Copyright 1997, Carnegie Mellon University
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			//* @file
20			Lsode Integrator.
21
22			@NOTE
23			The macro DOTIME is defined inside Lsode.c. If its value is
24			TRUE, we spew all sorts of time junk. If FALSE we are quiet.
25			Default for this macro is FALSE.
26
27	ben.allan	704	@NOTE the analytic jacobian routines (state matrix) depend on the
28			assumption that struct var_variable <--> struct Instance .
29	johnpye	669	Requires:
30			#include <utilities/ascConfig.h>
31			#include <solver/slv_client.h>
32			#include <solver/integrator.h>
33			//
34			by Kirk Abbott and Ben Allan
35			Created: 1/94
36			Version: $Revision: 1.6 $
37			Version control file: $RCSfile: Lsode.h,v $
38			Date last modified: $Date: 1997/07/18 12:23:18 $
39			Last modified by: $Author: mthomas $
40			*/
41
42			#ifndef ASC_LSODE_H
43			#define ASC_LSODE_H
44
45	ben.allan	704	#include "linsol.h"
46			#include "linsolqr.h"
47			#include "slv_client.h"
48	johnpye	669
49			/// Perform LSODE integration of a specified 'Integ_system'.
50			/**
51			Takes the start and finish index as defined by the user and carries
52			out the integration using repeated calls to the function lsode.
53			Assumes sys corresponds to g_solvinst_cur.
54			works off instances of type blsode taken from blsys.
55			*/
56			extern int integrator_lsode_solve(IntegratorSystem *blsys
57			,unsigned long i1, unsigned long i2
58			);
59
60			void integrator_lsode_create(IntegratorSystem *blsys);
61			void integrator_lsode_init(IntegratorSystem *blsys);
62			void integrator_lsode_free(void *enginedata);
63
64			#endif /* ASC_LSODE_H */
65