cs_io.h File Reference

#include "cs_defs.h"
#include "cs_base.h"
#include "cs_file.h"

Include dependency graph for cs_io.h:

Go to the source code of this file.

Data Structures
struct	cs_io_sec_header_t

Macros
#define	CS_IO_NAME_LEN   32 /* Section header name length */
#define	CS_IO_ECHO_NONE   -2 /* No verbosity at all */
#define	CS_IO_ECHO_OPEN_CLOSE   -1 /* Echo open or close operations */
#define	CS_IO_ECHO_HEADERS   0 /* Echo headers */

Typedefs
typedef struct _cs_io_t	cs_io_t

Enumerations
enum	cs_io_mode_t { CS_IO_MODE_READ, CS_IO_MODE_WRITE }

Functions
cs_io_t *	cs_io_initialize (const char *file_name, const char *magic_string, cs_io_mode_t mode, cs_file_access_t method, long echo, MPI_Info hints, MPI_Comm block_comm, MPI_Comm comm)
cs_io_t *	cs_io_initialize_with_index (const char *file_name, const char *magic_string, cs_file_access_t method, long echo, MPI_Info hints, MPI_Comm block_comm, MPI_Comm comm)
void	cs_io_finalize (cs_io_t **pp_io)
const char *	cs_io_get_name (const cs_io_t *pp_io)
size_t	cs_io_get_index_size (const cs_io_t *inp)
const char *	cs_io_get_indexed_sec_name (const cs_io_t *inp, size_t id)
cs_io_sec_header_t	cs_io_get_indexed_sec_header (const cs_io_t *inp, size_t id)
size_t	cs_io_get_echo (const cs_io_t *pp_io)
int	cs_io_read_header (cs_io_t *inp, cs_io_sec_header_t *header)
int	cs_io_set_indexed_position (cs_io_t *inp, cs_io_sec_header_t *header, size_t id)
void	cs_io_set_cs_lnum (cs_io_sec_header_t *header, const cs_io_t *pp_io)
void	cs_io_set_cs_gnum (cs_io_sec_header_t *header, const cs_io_t *pp_io)
void	cs_io_assert_cs_real (const cs_io_sec_header_t *header, const cs_io_t *pp_io)
void *	cs_io_read_global (const cs_io_sec_header_t *header, void *elts, cs_io_t *pp_io)
void *	cs_io_read_block (const cs_io_sec_header_t *header, cs_gnum_t global_num_start, cs_gnum_t global_num_end, void *elts, cs_io_t *pp_io)
void *	cs_io_read_index_block (cs_io_sec_header_t *header, cs_gnum_t global_num_start, cs_gnum_t global_num_end, cs_gnum_t *elts, cs_io_t *pp_io)
void	cs_io_write_global (const char *sec_name, cs_gnum_t n_vals, size_t location_id, size_t index_id, size_t n_location_vals, cs_datatype_t elt_type, const void *elts, cs_io_t *outp)
void	cs_io_write_block (const char *sec_name, cs_gnum_t n_g_elts, cs_gnum_t global_num_start, cs_gnum_t global_num_end, size_t location_id, size_t index_id, size_t n_location_vals, cs_datatype_t elt_type, const void *elts, cs_io_t *outp)
void	cs_io_write_block_buffer (const char *sec_name, cs_gnum_t n_g_elts, cs_gnum_t global_num_start, cs_gnum_t global_num_end, size_t location_id, size_t index_id, size_t n_location_vals, cs_datatype_t elt_type, void *elts, cs_io_t *outp)
void	cs_io_skip (const cs_io_sec_header_t *header, cs_io_t *pp_io)
cs_file_off_t	cs_io_get_offset (cs_io_t *inp)
void	cs_io_set_offset (cs_io_t *inp, cs_file_off_t offset)
void	cs_io_log_initialize (void)
void	cs_io_log_finalize (void)
void	cs_io_dump (const cs_io_t *cs_io)

Variables
int	cs_glob_io_hints

Macro Definition Documentation

CS_IO_ECHO_HEADERS

#define CS_IO_ECHO_HEADERS   0 /* Echo headers */

CS_IO_ECHO_NONE

#define CS_IO_ECHO_NONE   -2 /* No verbosity at all */

CS_IO_ECHO_OPEN_CLOSE

#define CS_IO_ECHO_OPEN_CLOSE   -1 /* Echo open or close operations */

CS_IO_NAME_LEN

#define CS_IO_NAME_LEN   32 /* Section header name length */

Typedef Documentation

cs_io_t

typedef struct _cs_io_t cs_io_t

Enumeration Type Documentation

cs_io_mode_t

enum cs_io_mode_t

Enumerator
CS_IO_MODE_READ
CS_IO_MODE_WRITE

Function Documentation

cs_io_assert_cs_real()

void cs_io_assert_cs_real	(	const cs_io_sec_header_t *	header,
		const cs_io_t *	pp_io
	)

cs_io_dump()

void cs_io_dump

(

const cs_io_t *

cs_io

)

cs_io_finalize()

void cs_io_finalize

(

cs_io_t **

pp_io

)

cs_io_get_echo()

size_t cs_io_get_echo

(

const cs_io_t *

pp_io

)

cs_io_get_index_size()

size_t cs_io_get_index_size

(

const cs_io_t *

inp

)

cs_io_get_indexed_sec_header()

cs_io_sec_header_t cs_io_get_indexed_sec_header	(	const cs_io_t *	inp,
		size_t	id
	)

cs_io_get_indexed_sec_name()

const char* cs_io_get_indexed_sec_name	(	const cs_io_t *	inp,
		size_t	id
	)

cs_io_get_name()

const char* cs_io_get_name

(

const cs_io_t *

pp_io

)

cs_io_get_offset()

cs_file_off_t cs_io_get_offset

(

cs_io_t *

inp

)

cs_io_initialize()

cs_io_t* cs_io_initialize	(	const char *	file_name,
		const char *	magic_string,
		cs_io_mode_t	mode,
		cs_file_access_t	method,
		long	echo,
		MPI_Info	hints,
		MPI_Comm	block_comm,
		MPI_Comm	comm
	)

cs_io_initialize_with_index()

cs_io_t* cs_io_initialize_with_index	(	const char *	file_name,
		const char *	magic_string,
		cs_file_access_t	method,
		long	echo,
		MPI_Info	hints,
		MPI_Comm	block_comm,
		MPI_Comm	comm
	)

cs_io_log_finalize()

void cs_io_log_finalize

(

void

)

cs_io_log_initialize()

void cs_io_log_initialize

(

void

)

cs_io_read_block()

void* cs_io_read_block	(	const cs_io_sec_header_t *	header,
		cs_gnum_t	global_num_start,
		cs_gnum_t	global_num_end,
		void *	elts,
		cs_io_t *	pp_io
	)

cs_io_read_global()

void* cs_io_read_global	(	const cs_io_sec_header_t *	header,
		void *	elts,
		cs_io_t *	pp_io
	)

cs_io_read_header()

int cs_io_read_header	(	cs_io_t *	inp,
		cs_io_sec_header_t *	header
	)

cs_io_read_index_block()

void* cs_io_read_index_block	(	cs_io_sec_header_t *	header,
		cs_gnum_t	global_num_start,
		cs_gnum_t	global_num_end,
		cs_gnum_t *	elts,
		cs_io_t *	pp_io
	)

cs_io_set_cs_gnum()

void cs_io_set_cs_gnum	(	cs_io_sec_header_t *	header,
		const cs_io_t *	pp_io
	)

cs_io_set_cs_lnum()

void cs_io_set_cs_lnum	(	cs_io_sec_header_t *	header,
		const cs_io_t *	pp_io
	)

cs_io_set_indexed_position()

int cs_io_set_indexed_position	(	cs_io_t *	inp,
		cs_io_sec_header_t *	header,
		size_t	id
	)

cs_io_set_offset()

void cs_io_set_offset	(	cs_io_t *	inp,
		cs_file_off_t	offset
	)

cs_io_skip()

void cs_io_skip	(	const cs_io_sec_header_t *	header,
		cs_io_t *	pp_io
	)

cs_io_write_block()

void cs_io_write_block	(	const char *	sec_name,
		cs_gnum_t	n_g_elts,
		cs_gnum_t	global_num_start,
		cs_gnum_t	global_num_end,
		size_t	location_id,
		size_t	index_id,
		size_t	n_location_vals,
		cs_datatype_t	elt_type,
		const void *	elts,
		cs_io_t *	outp
	)

cs_io_write_block_buffer()

void cs_io_write_block_buffer	(	const char *	sec_name,
		cs_gnum_t	n_g_elts,
		cs_gnum_t	global_num_start,
		cs_gnum_t	global_num_end,
		size_t	location_id,
		size_t	index_id,
		size_t	n_location_vals,
		cs_datatype_t	elt_type,
		void *	elts,
		cs_io_t *	outp
	)

cs_io_write_global()

void cs_io_write_global	(	const char *	sec_name,
		cs_gnum_t	n_vals,
		size_t	location_id,
		size_t	index_id,
		size_t	n_location_vals,
		cs_datatype_t	elt_type,
		const void *	elts,
		cs_io_t *	outp
	)

Variable Documentation

cs_glob_io_hints

int cs_glob_io_hints