src/integrators/Integrator.hpp

/*
 * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
 * 
 * Contact: oopse@oopse.org
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * All we ask is that proper credit is given for our work, which includes
 * - but is not limited to - adding the above copyright notice to the beginning
 * of your source code files, and to any copyright notice that you may distribute
 * with programs based on this work.
 * 
 * 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser 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 Integrator.hpp
  * @author tlin
  * @date 11/08/2004
  * @time 13:25am
  * @version 1.0
  */

#ifndef INTEGRATORS_INTEGRATOR_HPP
#define INTEGRATORS_INTEGRATOR_HPP

namespace oopse {

/**
 * @class Integrator Integrator.hpp "integrators/Integrator.hpp"
 * @brief Base class of Integrator
 * @todo document
 */
class Integrator {
    public:

        virtual ~Integrator() {}

        virtual void integrate() =0;

        virtual void update() {}

        void setForceManager(ForceManager* forceMan) {
            if (forceMan_  != NULL) {
                delete forceMan_;
            }
            forceMan_ = forceMan;
        }
        
    protected:
        Integrator(SimInfo* info) : info_(info), forceMan_(NULL) {}
        
        SimInfo* info_;
        ForceManager* forceMan_;

    private:
        virtual double calcConservedQuantity() = 0;

};

    
}
#endif //INTEGRATORS_INTEGRATOR_HPP
Revision:	1775
Committed:	Wed Nov 24 17:42:37 2004 UTC (19 years, 9 months ago) by tim
File size:	2068 byte(s)
Log Message:	add SetForceManager method to integrator
#	User	Rev	Content
1	tim	1721	/*
2			* Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project
3			*
4			* Contact: oopse@oopse.org
5			*
6			* This program is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU Lesser General Public License
8			* as published by the Free Software Foundation; either version 2.1
9			* of the License, or (at your option) any later version.
10			* All we ask is that proper credit is given for our work, which includes
11			* - but is not limited to - adding the above copyright notice to the beginning
12			* of your source code files, and to any copyright notice that you may distribute
13			* with programs based on this work.
14			*
15			* This program is distributed in the hope that it will be useful,
16			* but WITHOUT ANY WARRANTY; without even the implied warranty of
17			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			* GNU Lesser General Public License for more details.
19			*
20			* You should have received a copy of the GNU Lesser General Public License
21			* along with this program; if not, write to the Free Software
22			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23			*
24			*/
25
26			/**
27			* @file Integrator.hpp
28			* @author tlin
29			* @date 11/08/2004
30			* @time 13:25am
31			* @version 1.0
32			*/
33	gezelter	1490
34	tim	1721	#ifndef INTEGRATORS_INTEGRATOR_HPP
35			#define INTEGRATORS_INTEGRATOR_HPP
36	gezelter	1490
37	tim	1721	namespace oopse {
38	gezelter	1490
39	tim	1721	/**
40			* @class Integrator Integrator.hpp "integrators/Integrator.hpp"
41			* @brief Base class of Integrator
42	tim	1775	* @todo document
43	tim	1721	*/
44			class Integrator {
45	gezelter	1490	public:
46
47	tim	1721	virtual ~Integrator() {}
48	gezelter	1490
49	tim	1721	virtual void integrate() =0;
50	tim	1774
51			virtual void update() {}
52	tim	1775
53			void setForceManager(ForceManager* forceMan) {
54			if (forceMan_ != NULL) {
55			delete forceMan_;
56			}
57			forceMan_ = forceMan;
58			}
59
60	tim	1721	protected:
61	tim	1775	Integrator(SimInfo* info) : info_(info), forceMan_(NULL) {}
62	tim	1721
63	tim	1775	SimInfo* info_;
64			ForceManager* forceMan_;
65
66			private:
67	tim	1774	virtual double calcConservedQuantity() = 0;
68	tim	1722
69	gezelter	1490	};
70
71
72	tim	1721	}
73			#endif //INTEGRATORS_INTEGRATOR_HPP