RK4TimeIntegrator.h

Go to the documentation of this file.

//
// $Id: RK4TimeIntegrator.h,v 1.2 2006/02/07 17:36:01 philipb Exp $
// $Revision: 1.2 $
// $Date: 2006/02/07 17:36:01 $
//
// File:  RK4TimeIntegrator.h
// Copyright:  (c) 2005 The Regents of the University of California
// Description:  Concrete time integrator using Runge-Kutta RK4 method
//
 
#ifndef included_RK4TimeIntegrator
#define included_RK4TimeIntegrator
 
#include <string>
 
#include "AMP/time_integrators/TimeIntegrator.h"
 
namespace AMP::TimeIntegrator {
 
class RK4TimeIntegrator : public AMP::TimeIntegrator::TimeIntegrator
{
public:
    explicit RK4TimeIntegrator(
        std::shared_ptr<AMP::TimeIntegrator::TimeIntegratorParameters> parameters );
 
    ~RK4TimeIntegrator();
 
    static std::unique_ptr<AMP::TimeIntegrator::TimeIntegrator> createTimeIntegrator(
        std::shared_ptr<AMP::TimeIntegrator::TimeIntegratorParameters> parameters )
    {
        return std::unique_ptr<AMP::TimeIntegrator::TimeIntegrator>(
            new RK4TimeIntegrator( parameters ) );
    }
 
    void initialize(
        std::shared_ptr<AMP::TimeIntegrator::TimeIntegratorParameters> parameters ) override;
 
    void reset(
        std::shared_ptr<const AMP::TimeIntegrator::TimeIntegratorParameters> parameters ) override;
 
    bool checkNewSolution( void ) override;
 
    void updateSolution( void ) override;
 
    int advanceSolution( const double dt,
                         const bool first_step,
                         std::shared_ptr<AMP::LinearAlgebra::Vector> in,
                         std::shared_ptr<AMP::LinearAlgebra::Vector> out ) override;
 
    std::string type() const override { return "RK4"; }
 
public: // Write/read restart data
    void registerChildObjects( AMP::IO::RestartManager *manager ) const override;
 
    void writeRestart( int64_t fid ) const override;
 
    RK4TimeIntegrator( int64_t fid, AMP::IO::RestartManager *manager );
 
private:
    RK4TimeIntegrator() = delete;
 
    void setupVectors( void );
 
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_new_solution;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_k1_vec;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_k2_vec;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_k3_vec;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_k4_vec;
};
} // namespace AMP::TimeIntegrator
 
#endif