Rocout.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.                          *
 *********************************************************************/
/*  Author John Norris
 *  Initial date:   May 17, 2004
 */


#ifndef _ROCOUT_H_
#define _ROCOUT_H_

#include <map>
#include "roccom.h"
#include "HDF4.h"
#include "roccom_devel.h"

#ifdef USE_CGNS
#include "Rocout_cgns.h"
#define MODE_READ CG_MODE_READ 
#define MODE_WRITE CG_MODE_WRITE 
#define MODE_MODIFY CG_MODE_MODIFY
#endif // USE_CGNS

void write_attr_CGNS(const std::string& fname, const std::string& mfile, 
                     const COM::Attribute* attr, const char* material, 
                     const char* timelevel, int pane_id,
                     const std::string& ghosthandle,
                     const std::string& errorhandle, int mode);

extern "C" void Rocout_load_module( const char *name);
extern "C" void Rocout_unload_module( const char *name);
//\}


class Rocout : public COM_Object {
 public:
  void write_attribute( const char* filename_pre,
                        const COM::Attribute* attr,
                        const char* material,
                        const char* timelevel,
                        const char* mfile_pre=NULL,
                        const MPI_Comm* comm=NULL,
                        const int* pane_id=NULL);

  void put_attribute( const char* filename_pre,
                      const COM::Attribute* attr,
                      const char* material,
                      const char* timelevel,
                      const char* mfile_pre=NULL,
                      const MPI_Comm* comm=NULL,
                      const int* pane_id=NULL);

  void add_attribute( const char* filename_pre,
                      const COM::Attribute* attr,
                      const char* material,
                      const char* timelevel,
                      const char* mfile_pre=NULL,
                      const MPI_Comm* comm=NULL,
                      const int* pane_id=NULL);

  void sync();

  void write_rocin_control_file( const char* window_name,
                                 const char* file_prefixes,
                                 const char* control_file_name);

  void set_option( const char* option_name,
                   const char* option_val);

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

  void read_control_file( const char* filename);
    //\}

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

  friend void Rocout_load_module( const char *name);
  friend void Rocout_unload_module( const char *name);
  //\}

  static
  void* write_attr_internal(void* attrInfo);

  std::string get_fname(const std::string& pre, int rank = -1,
                        const int paneId = 0, bool check = false);
  //\}

  std::map<std::string, std::string> _options;
# ifdef USE_PTHREADS
  std::vector<pthread_t> _writers;
  static Semaphore _writesem;
# endif // USE_PTHREADS
};

#endif