example_integrator.h

Go to the documentation of this file.

/*
Copyright (c) 2014, Sam Schetterer, Nathan Kutz, University of Washington
Authors: Sam Schetterer
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/
#ifndef EXAMPLE_INTEGRATOR_H
#define EXAMPLE_INTEGRATOR_H
//example_rhs should be studied before this class
#include "engine/item.h"
#include "integrator.h"
class example_integrator : public integrator{
    //This holds a pointer to what will be the actual implementation
    //We do this since the actual implementation is a template, so that it can integrate generic
    //types without the performance problems of dynamic polymorphism
    std::shared_ptr<example_integrator> actual_int;
    public:
        //This is the definition of the integrate function
        //Nothing too interesting here, but \sa example_integrator_tmpl::integrate
        int integrate(ptr_passer u, double t0, double tf);

        //Returns the type of the current class

        //This is the name that one would write in the input file to initialize this class
        std::string type() const;


        std::vector<std::string> dependencies() const;

        //This function processes the input data after being read from the file
        //This is only called once, at the beginning of the program
        //Updates from variables must be done in the update function
        void postprocess(input& inval);

        //This returns the variable type of the integrator
        //This is actually going to be done by the integrator
        const std::type_info& vtype() const;

};
#endif