amroc/amr/Interfaces/SchemeBase.h

Go to the documentation of this file.

// -*- C++ -*-

// Copyright (C) 2013 Oak Ridge National Laboratory
// Ralf Deiterding, deiterdingr@ornl.gov

#ifndef SCHEME_BASE_H
#define SCHEME_BASE_H

#include "AMRBase.h"

template <class vector_type, int dim>
class SchemeBase : public AMRBase<vector_type,dim> {
  typedef AMRBase<vector_type,dim> base;
public:
  typedef vector_type VectorType;
  typedef typename VectorType::InternalDataType DataType;
  typedef typename base::vec_grid_data_type vec_grid_data_type;
  typedef GridData<DataType,dim> grid_data_type; 
  typedef Vector<DataType,dim> point_type;

  enum SideName { Left, Right, Bottom, Top, Front, Back }; 
  enum Conversion { Conserved, Primitive }; 

  SchemeBase() : base() {}
 
  virtual ~SchemeBase() {}

  //******************************************************************************
  // Abstract class interface
  //******************************************************************************
  // Take one time step 
  virtual double Step(vec_grid_data_type& fvec, vec_grid_data_type& ovec, vec_grid_data_type* Flux[], 
                      const double& t, const double& dt, const int& mpass) const = 0;

  virtual void ICStandard(vec_grid_data_type &fvec, const int type, DataType* aux=0, const int naux=0,
                          const int scaling=0) const = 0;
  virtual void BCStandard(vec_grid_data_type &fvec, const BBox &bb, const int type, const int side,
                          DataType* aux=0, const int naux=0, const int scaling=0) const = 0;

  virtual bool GFMUseTransform() const = 0;
  virtual void GFMTransform(vec_grid_data_type &fvec, vec_grid_data_type &fvechelp) const = 0;
  virtual void GFMBCStandard(vec_grid_data_type &fvec, const int type, const int& nc, const int* idx,
                             const VectorType* f, const point_type* xc, const DataType* distance, 
                             const point_type* normal, DataType* aux=0, const int naux=0,
                             const int scaling=0) const = 0;

  virtual void Input(vec_grid_data_type& fvec, grid_data_type& work, const int cnt,
                     const int skip_ghosts=1) const = 0;
  virtual void Output(vec_grid_data_type& fvec, grid_data_type& work, const int cnt,
                      const int skip_ghosts=1) const = 0;
  virtual int Check(vec_grid_data_type& fvec, const BBox &bb, const double& time, 
                    const int verbose) const = 0;
  virtual int NMethodOrder() const = 0;
  virtual int NMaxPass() const = 0;
  //******************************************************************************

  inline int idx(const int i) const { return (i); }
  inline int idx(const int i, const int j, const int Nx) const { return (i+Nx*j); }
  inline int idx(const int i, const int j, const int k, const int Nx, const int Ny) const { return (i+Nx*(j+Ny*k)); }
};


#endif

---