amroc/amr/Solver.h

Go to the documentation of this file.

// -*- C++ -*-

// Copyright (C) 2002 Ralf Deiterding
// Brandenburgische Universitaet Cottbus
//
// Copyright (C) 2003-2007 California Institute of Technology
// Ralf Deiterding, ralf@cacr.caltech.edu

#ifndef AMROC_SOLVER_H
#define AMROC_SOLVER_H

#include "IO/control-device.h"
#include <string>

class Solver : public controlable {
public:
  Solver() {}

  virtual ~Solver() {}

  //******************************************************************************
  // Initialize members
  //******************************************************************************
  virtual void init() {}

  //******************************************************************************
  // Register members at control device
  //******************************************************************************
  virtual void register_at(ControlDevice& Ctrl) {}
  virtual void register_at(ControlDevice& Ctrl, const std::string& prefix) {}

  //******************************************************************************
  // Update members after reading values from control device
  //******************************************************************************
  virtual void update() {}

  //******************************************************************************
  // Setup communication and data structures based on updated members
  // returns true to allow for numerical method, false jumps to finish()
  //******************************************************************************
  virtual bool setup() = 0;

  //******************************************************************************
  // Functions for an instationary numerical method
  //******************************************************************************
  virtual void Initialize(double& t, double& dt) = 0;    
  virtual void Advance(double& t, double& dt) = 0;
  virtual void Output() = 0;  
  virtual int  NSteps() = 0;

  virtual void Restart(double& t, double& dt) {}
  virtual void Checkpointing() {}

  //******************************************************************************
  // Clean-up communication and data structures
  //******************************************************************************
  virtual void finish() {} 
};


#endif

---