ExplicitEuler.h

Go to the documentation of this file.

//
// $Id: ExplicitEuler.h,v 1.2 2006/02/07 17:36:01 philipb Exp $
// $Revision: 1.2 $
// $Date: 2006/02/07 17:36:01 $
//
// File:  ExplicitEuler.h
// Copyright:  (c) 2005 The Regents of the University of California
// Description:  Concrete time integrator using backward Euler method
//
 
#ifndef included_ExplicitEuler
#define included_ExplicitEuler
 
#include <string>
 
namespace AMP::LinearAlgebra {
class Vector;
}
 
#include "AMP/time_integrators/TimeIntegrator.h"
 
namespace AMP::TimeIntegrator {
 
class ExplicitEuler : public AMP::TimeIntegrator::TimeIntegrator
{
public:
    explicit ExplicitEuler(
        std::shared_ptr<AMP::TimeIntegrator::TimeIntegratorParameters> parameters );
 
    ~ExplicitEuler();
 
    static std::unique_ptr<TimeIntegrator> createTimeIntegrator(
        std::shared_ptr<AMP::TimeIntegrator::TimeIntegratorParameters> parameters )
    {
        return std::unique_ptr<TimeIntegrator>( new ExplicitEuler( 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 "ExplicitEuler"; }
 
private:
    ExplicitEuler() = delete;
 
    void setupVectors( void );
 
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_new_solution = nullptr;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_f_vec        = nullptr;
};
} // namespace AMP::TimeIntegrator
 
#endif