TimeStepper.h

Go to the documentation of this file.

// Copyright (C) 2003 Johan Hoffman and Anders Logg.
// Licensed under the GNU GPL Version 2.
//
// Modified by Johan Jansson 2003, 2004.

#ifndef __TIME_STEPPER_H
#define __TIME_STEPPER_H

#include <dolfin/constants.h>
#include <dolfin/Partition.h>
#include <dolfin/Adaptivity.h>
#include <dolfin/RHS.h>
#include <dolfin/Solution.h>
#include <dolfin/File.h>
#include <dolfin/FixedPointIteration.h>

namespace dolfin {

  class ODE;
  class TimeSlab;


  class TimeStepper {
  public:

    TimeStepper(ODE& ode, Function& function);

    ~TimeStepper();
    
    static void solve(ODE& ode, Function& function);

    real step();

    bool finished() const;

  private:

    // Create the first time slab
    bool createFirstTimeSlab();

    // Create a standard (recursive) time slab
    bool createGeneralTimeSlab();

    // Prepare for next time slab
    void shift();

    // Save interpolated solution (when necessary)
    void save(TimeSlab& timeslab);

    // Save at fixed sample points
    void saveFixedSamples(TimeSlab& timeslab);
    
    // Save using adaptive samples
    void saveAdaptiveSamples(TimeSlab& timeslab);

    // Stabilize using a sequence of small time steps
    void stabilize(real K);
    
    //--- Time-stepping data ---

    // Size of system
    unsigned int N;

    // Current time
    real t;

    // End time of computation
    real T;

    // Partition of components into small and large time steps
    Partition partition;

    // Adaptivity, including regulation of the time step
    Adaptivity adaptivity;

    // A function representing the solution being computed
    Function& function;

    // The solution being computed
    Solution u;

    ODE& ode;

    // The right-hand side
    RHS f;

    // Damped fixed point iteration
    FixedPointIteration fixpoint;

    // Storing the computed solution
    File file;
    
    // Progress bar
    Progress p;

    // True if we have reached the given end time
    bool _finished;

    // True if we should save the solution
    bool save_solution;

    // True if we should solve the dual
    bool solve_dual;

    // True if we should use adaptive samples
    bool adaptive_samples;

    // Number of samples to save (for non-adaptive sampling)
    unsigned int no_samples;
    
    // Density of sampling (for adaptive sampling)
    unsigned int sample_density;

  };

}

#endif

Documentation automatically generated with Doxygen on 10 Sep 2004.