src/expde/grid/sto_man.h

Go to the documentation of this file.

//    expde: expression templates for partial differential equations.
//    Copyright (C) 2001  Christoph Pflaum
//    This program is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//                 SEE  Notice1.doc made by 
//                 LAWRENCE LIVERMORE NATIONAL LABORATORY
//

// ------------------------------------------------------------
//
// sto_man.h
//
// ------------------------------------------------------------

#ifndef STOMAN_H_
#define STOMAN_H_
      
//  Storage Manager


//-----------------------------------------
// storage structure of cell informations:
// 1. cell variable     -> begin with: 0
// 2. stencils          -> use: cell_number_of_stencil(int num)
// 3. boundary sencils  -> use: cell_number_of_bo_stencil(int num)

//  A few member functions of the following class 
//  are contained in labbo.cc

class Storage_manager {
 public:
  Storage_manager() : label_initialize(false), max_num_var(0),
    max_num_bo_stencil(0), max_num_stencil(0), 
    max_num_coarse_stencil(0),
    max_num_var_cell(0),
    max_num_label(0) {
    for(int i=0;i<Max_label_number;++i) occupied[i] = false;
  };

  // Give a new storage number
  int Give_number_variable();             // storage number for points
  int Give_number_bo_stencil();           // |-> for a boundary stencil
  int Give_number_stencil();              // |-> for a stencil
  int Give_number_cell_variable();        // storage number for cell point

  // Give or delete a label number
  int  Give_number_label_bo();             // Erzeuge neue Labelnummer
  void Remove_number_label_bo(int num);    // Streiche     Labelnummer

  // Was storage initialized?
  bool Is_storage_initialized();

  // transformation of the numbers
  int cell_number_of_bo_stencil(int num) const;
  int cell_number_of_stencil(int num) const;

 protected:
  // Initialization is done
  void Storge_initialization_done();

  // Give maximal storage number
  int Give_max_num_var();                  // for points
  int Give_max_num_cell_var();             // for cell variables
  int Give_max_num_coarse_int_cells();     // for coarse interior cells
  int Give_max_num_bo_cells();             // for coares boundary cells
  int Give_max_num_fine_all_cells();       // for all fine cells
  int Give_max_num_label();                // for labels
  int Give_max_num_matrices_bo();          // for boundary matrices 
  bool Give_increase_max_num_label();      // for labels
  void No_increase_max_num_label();        // for labels

 private:
  bool label_initialize;   // Initialisierung dieser Speicher schon gemacht?

  // Verwaltung der Datenspeicher:
  // Anzahl der double's die in einem Punkt oder Zelle oder so
  // gespeichert werden 

  // a) Number of storage for points (for Variable)
  int max_num_var;
  // b) Number of storage for a stencil near the boundary 
  //    (at coarse boundary cells) ( -> for Res_stencil_boundary)
  //    each requires 64 doubles
  int max_num_bo_stencil;
  // c) Number of storage for a stencil near the boundary and coarse int cells
  //    (at coarse boundary cells) ( -> for Res_stencil)
  //    each requires 64 doubles
  int max_num_stencil;
  // d) Number of storage for a stencil on coarse cells
  int max_num_coarse_stencil;
  // e) Number of storage for cell variables
  int max_num_var_cell;
  // f) labels at the boundary. Which labes are occupied:
  bool occupied[Max_label_number];
  int  max_num_label;
  bool increase_max_num_label;
  // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
};


inline int Storage_manager::Give_number_variable() {
  ++max_num_var;
  return max_num_var-1;
}
inline int Storage_manager::Give_number_cell_variable() {
  ++max_num_var_cell;
  return max_num_var_cell-1;
}


inline int Storage_manager::Give_number_bo_stencil() {
  ++max_num_bo_stencil;
  return max_num_bo_stencil-1;
}

inline int Storage_manager::Give_number_stencil() {
  ++max_num_stencil;
  return max_num_stencil-1;
}

inline bool Storage_manager::Give_increase_max_num_label() {
  return increase_max_num_label;
}

inline void Storage_manager::No_increase_max_num_label() {
  increase_max_num_label = false;
}

inline  int Storage_manager::Give_max_num_label() {
  return max_num_label;
}
inline  int Storage_manager::Give_max_num_var() {
  return max_num_var;
}
inline  int Storage_manager::Give_max_num_cell_var() {
  return max_num_var_cell;
}

inline  int Storage_manager::Give_max_num_bo_cells() {
  return (max_num_bo_stencil+max_num_stencil) * 64 + max_num_var_cell;
}

inline  int Storage_manager::Give_max_num_matrices_bo() {
  return max_num_bo_stencil+max_num_stencil;
}

inline  int Storage_manager::Give_max_num_coarse_int_cells() {
  return max_num_stencil * 64 + max_num_var_cell;
}

inline  int Storage_manager::Give_max_num_fine_all_cells() {
  return max_num_var_cell;
}

//-----
// transformation of the numbers
inline int Storage_manager::cell_number_of_bo_stencil(int num) const {
  return max_num_var_cell + (max_num_stencil+num) * 64;
}

inline int Storage_manager::cell_number_of_stencil(int num) const {
  return max_num_var_cell + num * 64;
}
//-----

inline void Storage_manager::Storge_initialization_done() {
  label_initialize = true;
}

inline bool Storage_manager::Is_storage_initialized() { 
  return label_initialize;
}

#endif
     

---