SystemStepper.hpp

Go to the documentation of this file.
00001 //::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
00002 //
00003 //        This file is part of E-Cell Simulation Environment package
00004 //
00005 //                Copyright (C) 2004 Keio University
00006 //
00007 //::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
00008 //
00009 //
00010 // E-Cell is free software; you can redistribute it and/or
00011 // modify it under the terms of the GNU General Public
00012 // License as published by the Free Software Foundation; either
00013 // version 2 of the License, or (at your option) any later version.
00014 // 
00015 // E-Cell is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00018 // See the GNU General Public License for more details.
00019 // 
00020 // You should have received a copy of the GNU General Public
00021 // License along with E-Cell -- see the file COPYING.
00022 // If not, write to the Free Software Foundation, Inc.,
00023 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00024 // 
00025 //END_HEADER
00026 //
00027 // written by Koichi Takahashi <shafi@e-cell.org>,
00028 // E-Cell Project.
00029 //
00030 
00031 #ifndef __SYSTEMSTEPPER_HPP
00032 #define __SYSTEMSTEPPER_HPP
00033 
00034 #include "libecs.hpp"
00035 
00036 #include "Stepper.hpp"
00037 
00038 
00039 
00040 namespace libecs
00041 {
00042 
00043   /** @addtogroup stepper
00044    *@{
00045    */
00046 
00047   /** @file */
00048 
00049 
00050   /**
00051 
00052 
00053   */
00054 
00055 
00056   LIBECS_DM_CLASS( SystemStepper, Stepper )
00057   {
00058 
00059   public:
00060 
00061     LIBECS_DM_OBJECT( SystemStepper, Stepper )
00062       {
00063         INHERIT_PROPERTIES( Stepper );
00064         
00065       }
00066 
00067 
00068 
00069     SystemStepper(); 
00070     virtual ~SystemStepper();
00071 
00072     virtual GET_METHOD( Real, TimeScale )
00073     {
00074       return 0.0;
00075     }
00076 
00077 
00078     virtual void initialize();
00079 
00080     virtual void integrate( RealParam aTime );
00081 
00082     virtual void step();
00083 
00084     virtual void interrupt( TimeParam aTime )
00085     {
00086       ; // do nothing
00087     }
00088 
00089 
00090   protected:
00091 
00092     void integrateVariablesRecursively( SystemPtr const aSystem,
00093                                         RealParam aTime );
00094 
00095   };
00096 
00097 
00098 } // namespace libecs
00099 
00100 #endif /* __SYSTEMSTEPPER_HPP */
00101 
00102 
00103 
00104 /*
00105   Do not modify
00106   $Author: shafi $
00107   $Revision: 2540 $
00108   $Date: 2005-12-19 05:40:56 +0100 (Mon, 19 Dec 2005) $
00109   $Locker$
00110 */

Generated on Mon Dec 18 07:24:08 2006 for E-CELL C++ libraries (libecs and libemc) 3.1.105 by  doxygen 1.5.1