dsim_integrator.h

Go to the documentation of this file.

/*
 *  dsim_integrator.h
 *  DSimEngine2
 *
 *  Created by David Wilson on 4/21/09.
 *  Copyright 2009 Princeton Satellite Systems. All rights reserved.
 *
 */

#ifndef __DSIM_INTEGRATOR__
#define __DSIM_INTEGRATOR__

#include "dsim_variable.h"
class dsim_simulation;
class ds_dictionary;

class dsim_integrator
{
    public:
        dsim_integrator(const char *name);
        static dsim_integrator *load_integrator(const char *name,const char *type,const char *library);
        virtual ~dsim_integrator();
        
        enum dsim_integrator_result {   dsim_integ_none = 0, 
                                        dsim_integ_continue = 1, 
                                        dsim_integ_finished = 2 
                                    };
        const char *name() const { return _name; }
        
        virtual void *describe_setup(void *ds);
        void describe_setup_command(void *ds,const char *command,const char *description);
        virtual bool parse_setup(const char *command,const char *data);
        
        virtual void setup_variable(dsim_variable &variable);
        virtual void cleanup_variable(dsim_variable &variable);
        
        virtual double effective_time_for_step(int step,double t,double dt);
        virtual dsim_integrator::dsim_integrator_result step_integration(dsim_variable &variable,int step,double t,double dt);
        // Overridden by subclasses to set up a variable for integration at the start of each timestep.
        //virtual void setup_for_first_step(dsim_variable &variable,double t,double dt);
        // Overridden by subclasses to set up a variable for the next integration step.
        //virtual void setup_for_next_step(dsim_variable &variable,int step,double t,double dt);
        
        void request_new_time_delta(double dt,bool restart = false);
                
        // Error handling and logging
        void error(const char *msg,...) const;
        void warning(const char *msg,...) const;
        void log(const char *msg,...) const;
    private:
        void add_variable(dsim_variable &variable);
        // Called by the simulation; internally iterates over variables and calls the user functions
        void start_integration(double t,double dt);
        void step_variable(dsim_variable &variable,int step,double t,double dt);
        enum dsim_integrator_result complete_integration_step(int step,double t,double dt);
        bool complete_integration(double &new_timestep);
        
        void annotate_description(ds_dictionary *desc);
        
        char *_name;
        dsim_integrator::dsim_integrator_result _result;
        std::vector<dsim_variable> _variables;
        double _next_dt;
        bool _need_restart;
        dsim_simulation *_simulation;
    
    friend class dsim_simulation;
    friend class dsim_model;
};

typedef dsim_integrator *(*dsim_integrator_factory_t)(const char *);

#endif