Rocin.h

Go to the documentation of this file.

/* *******************************************************************
 * Rocstar Simulation Suite                                          *
 * Copyright@2015, Illinois Rocstar LLC. All rights reserved.        *
 *                                                                   *
 * Illinois Rocstar LLC                                              *
 * Champaign, IL                                                     *
 * www.illinoisrocstar.com                                           *
 * sales@illinoisrocstar.com                                         *
 *                                                                   *
 * License: See LICENSE file in top level of distribution package or *
 * http://opensource.org/licenses/NCSA                               *
 *********************************************************************/
/* *******************************************************************
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,   *
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES   *
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND          *
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE CONTRIBUTORS OR           *
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER       *
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,   *
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE    *
 * USE OR OTHER DEALINGS WITH THE SOFTWARE.                          *
 *********************************************************************/
// $Id: Rocin.h,v 1.13 2008/12/06 08:43:19 mtcampbe Exp $

/*  Author John Norris
 *  Initial date:   March 19, 2004
 */
/*  Modified by Phillip Alexander
 *  April 8, 2004
 *  -updated to Roccom3 compliance
 *  -added support for use as a Roccom module
 */


#ifndef _ROCIN_H_
#define _ROCIN_H_

#include "roccom.h"
#include "HDF4.h"
#include "rocin_block.h"
#include "roccom_devel.h"

#ifdef USE_CGNS
#include "cgnslib.h"
#define MODE_READ CG_MODE_READ
#endif // USE_CGNS

extern "C" void Rocin_load_module( const char *name);
extern "C" void Rocin_unload_module( const char *name);
//\}

class Rocin : public COM_Object {
public:
  Rocin() : m_is_local( NULL), m_base(0), m_offset(0) {}

  typedef void (*RulesPtr)(const int &pane_id, const int &comm_rank,
                           const int &comm_size, int* is_local);

  void read_by_control_file( const char* control_file_name,
                             const char* window_name,
                             const MPI_Comm* comm=NULL,
                             char* time_level=NULL,
                             const int* str_len=NULL);

  void read_window( const char* filename_patterns,
                    const char* window_name,
                    const MPI_Comm* comm=NULL,
                    RulesPtr is_local=NULL,
                    char* time_level=NULL,
                    const int *str_len=NULL);
  
  void read_windows(const char* filename_patterns,
                    const char* window_prefix,
                    const char* material_names=NULL,
                    const MPI_Comm* comm=NULL,
                    RulesPtr is_local=NULL,
                    char* time_level=NULL,
                    const int *str_len=NULL);
  
  void obtain_attribute( const COM::Attribute *attribute_in,
                         COM::Attribute *user_attribute,
                         int *pane_id=NULL);

void read_parameter_file( const char* file_name, 
                          const char* window_name, 
                          const MPI_Comm *comm = NULL);

  //\}

protected:
  typedef void (Rocin::*MemberRulePtr)(const int&, const int&,
                                        const int&, int*);

  void explicit_local( const int& pid, const int& comm_rank,
                       const int& comm_size, int* il);

  void cyclic_local(const int& pid, const int& comm_rank,
                    const int& comm_size, int* il);
  
  void blockcyclic_local(const int& pid, const int& comm_rank,
                         const int& comm_size, int* il);

  void register_panes(BlockMM_HDF4::iterator hdf4,
                      const BlockMM_HDF4::iterator& hdf4End,
#ifdef USE_CGNS
                      BlockMM_CGNS::iterator cgns,
                      const BlockMM_CGNS::iterator& cgnsEnd,
#endif // USE_CGNS
                      const std::string& window, RulesPtr is_local,
                      const MPI_Comm* comm, int rank, int nprocs);

  //\}

protected:  
  static 
  void init(const std::string &mname);
  
  static 
  void finalize(const std::string &mname);
  //\}

  friend void Rocin_load_module( const char *name);
  friend void Rocin_unload_module( const char *name);
  //\}

protected:
  MemberRulePtr m_is_local;
  std::set<int> m_pane_ids;
  int m_base;
  int m_offset;

  std::map<int32, COM_Type> m_HDF2COM;
#ifdef USE_CGNS
  std::map<DataType_t, COM_Type> m_CGNS2COM;
#endif // USE_CGNS
};

#endif