p8est_io.h

Go to the documentation of this file.

/*
  This file is part of p4est.
  p4est is a C library to manage a collection (a forest) of multiple
  connected adaptive quadtrees or octrees in parallel.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
  Written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
 
  p4est 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.
 
  p4est 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.
 
  You should have received a copy of the GNU General Public License
  along with p4est; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
#ifndef P8EST_IO_H
#define P8EST_IO_H
 
#include <p8est.h>
 
SC_EXTERN_C_BEGIN;
 
#ifdef P4EST_ENABLE_FILE_DEPRECATED
 
#define P8EST_FILE_MAGIC_NUMBER "p8data0" 
#define P8EST_FILE_METADATA_BYTES 96 
#define P8EST_FILE_MAGIC_BYTES 8 
#define P8EST_FILE_VERSION_STR_BYTES 24 
#define P8EST_FILE_ARRAY_METADATA_BYTES 14 
/* subtract 2 for '\n' at the beginning and end of the array metadata */
#define P8EST_FILE_ARRAY_METADATA_CHARS (P8EST_FILE_ARRAY_METADATA_BYTES - 2) 
#define P8EST_FILE_BYTE_DIV 16 
#define P8EST_FILE_MAX_NUM_PAD_BYTES (P8EST_FILE_BYTE_DIV + 1) 
#define P8EST_FILE_USER_STRING_BYTES 48 
#define P8EST_FILE_FIELD_HEADER_BYTES (2 + P8EST_FILE_ARRAY_METADATA_BYTES + P8EST_FILE_USER_STRING_BYTES)
#define P8EST_FILE_MAX_GLOBAL_QUAD 9999999999999999 
#define P8EST_FILE_MAX_BLOCK_SIZE 9999999999999 
#define P8EST_FILE_MAX_FIELD_ENTRY_SIZE 9999999999999 
#endif /* P4EST_ENABLE_FILE_DEPRECATED */
 
sc_array_t         *p8est_deflate_quadrants (p8est_t * p8est,
                                             sc_array_t ** data);
 
p8est_t            *p8est_inflate (sc_MPI_Comm mpicomm,
                                   p8est_connectivity_t * connectivity,
                                   const p4est_gloidx_t *
                                   global_first_quadrant,
                                   const p4est_gloidx_t * pertree,
                                   sc_array_t * quadrants, sc_array_t * data,
                                   void *user_pointer);
 
p8est_t            *p8est_inflate_null (sc_MPI_Comm mpicomm,
                                        p8est_connectivity_t * connectivity,
                                        const p4est_gloidx_t *
                                        global_first_quadrant,
                                        const p4est_gloidx_t * pertree,
                                        sc_array_t * quadrants,
                                        sc_array_t * data,
                                        void *user_pointer);
 
#ifdef P4EST_ENABLE_FILE_DEPRECATED
 
typedef struct p8est_file_context p8est_file_context_t;
 
typedef enum p8est_file_error
{
  P8EST_FILE_ERR_SUCCESS = sc_MPI_ERR_LASTCODE, 
  P8EST_FILE_ERR_FILE, 
  P8EST_FILE_ERR_NOT_SAME,  
  P8EST_FILE_ERR_AMODE, 
  P8EST_FILE_ERR_NO_SUCH_FILE, 
  P8EST_FILE_ERR_FILE_EXIST, 
  P8EST_FILE_ERR_BAD_FILE, 
  P8EST_FILE_ERR_ACCESS, 
  P8EST_FILE_ERR_NO_SPACE, 
  P8EST_FILE_ERR_QUOTA, 
  P8EST_FILE_ERR_READ_ONLY, 
  P8EST_FILE_ERR_IN_USE, 
  P8EST_FILE_ERR_IO, 
  P8EST_FILE_ERR_FORMAT,  
  P8EST_FILE_ERR_SECTION_TYPE, 
  P8EST_FILE_ERR_CONN, 
  P8EST_FILE_ERR_P8EST, 
  P8EST_FILE_ERR_IN_DATA, 
  P8EST_FILE_ERR_COUNT,   
  P8EST_FILE_ERR_UNKNOWN, 
  P8EST_FILE_ERR_LASTCODE 
}
p8est_file_error_t;
 
p8est_file_context_t *p8est_file_open_create
  (p8est_t * p8est, const char *filename,
   const char *user_string, int *errcode);
 
p8est_file_context_t *p8est_file_open_read (p8est_t * p8est,
                                            const char *filename,
                                            char *user_string, int *errcode);
 
p8est_file_context_t *p8est_file_write_block (p8est_file_context_t * fc,
                                              size_t block_size,
                                              sc_array_t * block_data,
                                              const char *user_string,
                                              int *errcode);
 
p8est_file_context_t *p8est_file_read_block (p8est_file_context_t * fc,
                                             size_t header_size,
                                             sc_array_t * header_data,
                                             char *user_string, int *errcode);
 
p8est_file_context_t *p8est_file_write_field (p8est_file_context_t * fc,
                                              size_t quadrant_size,
                                              sc_array_t * quadrant_data,
                                              const char *user_string,
                                              int *errcode);
 
p8est_file_context_t *p8est_file_read_field (p8est_file_context_t * fc,
                                             size_t quadrant_size,
                                             sc_array_t * quadrant_data,
                                             char *user_string, int *errcode);
 
typedef struct p8est_file_section_metadata
{
  char                block_type; 
  size_t              data_size;  
  char                user_string[P8EST_FILE_USER_STRING_BYTES]; 
}
p8est_file_section_metadata_t;
 
int                 p8est_file_info (p8est_t * p8est, const char *filename,
                                     char *user_string,
                                     sc_array_t * data_sections,
                                     int *errcode);
 
int                 p8est_file_error_string (int errclass,
                                             char *string, int *resultlen);
 
p8est_file_context_t *p8est_file_write_p8est (p8est_file_context_t * fc,
                                              p8est_t * p8est,
                                              const char *quad_string,
                                              const char *quad_data_string,
                                              int *errcode);
 
p8est_file_context_t *p8est_file_read_p8est (p8est_file_context_t * fc,
                                             p8est_connectivity_t * conn,
                                             size_t data_size,
                                             p8est_t ** p8est,
                                             char *quad_string,
                                             char *quad_data_string,
                                             int *errcode);
 
p8est_file_context_t *p8est_file_write_connectivity (p8est_file_context_t *
                                                     fc,
                                                     p8est_connectivity_t *
                                                     conn,
                                                     const char *conn_string,
                                                     int *errcode);
 
p8est_file_context_t *p8est_file_read_connectivity (p8est_file_context_t * fc,
                                                    p8est_connectivity_t **
                                                    conn, char *conn_string,
                                                    int *errcode);
 
int                 p8est_file_close (p8est_file_context_t * fc,
                                      int *errcode);
 
#endif /* P4EST_ENABLE_FILE_DEPRECATED */
 
SC_EXTERN_C_END;
 
#endif /* !P8EST_IO_H */