Integrator.hpp

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Integrator header file
 
Author: Alex Reynolds
*/
 
#ifndef INTEGRATOR_HPP
#define INTEGRATOR_HPP
 
#include <array>
 
#include "Rates.hpp"
 
namespace clockwerk {
 
    /// This class is a base implementation of the integrator. It defines the 
    /// basic functions and components of an integrator.
    /// 
    /// It cannot function on its own. A derived class for RK4, forward Euler,
    /// etc. must be implemented to use the integrator.
    template <typename T, unsigned int N>
    class Integrator {
    public:
        /// Constructor for the 
        Integrator(Rates<T, N>& rate_calculator);
 
        /// Function to step the integrator forward from time start to time end
        /// @param   start_time      Start time for integration
        /// @param   end_time        End time for integration
        /// @param   start_state     State at start of integration
        /// @param   out_state       Output state via implicit -- result of integration
        /// @note    Un-implemented in this base class definition
        virtual void step(T start_time, T end_time,
                        const std::array<T, N> &start_state, std::array<T, N> &out_state) {}
    protected:
        /// Reference to dynamics object that calculates rates
        Rates<T, N>& _rate_calculator;
    };
 
    template <typename T, unsigned int N>
    Integrator<T, N>::Integrator(Rates<T, N>& rate_calculator)
        : _rate_calculator(rate_calculator) {}
 
}
 
#endif