RTOp.h File Reference

#include <stddef.h>
#include <stdio.h>
#include <assert.h>
#include "RTOp_MPI_config.h"

Include dependency graph for RTOp.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RTOp_SubVector
struct	RTOp_MutableSubVector
struct	RTOp_RTOp
struct	RTOp_RTOp_vtbl_t
struct	RTOp_obj_type_vtbl_t

Macros
#define	CALL_API
#define	RTOp_REDUCT_OBJ_NULL   0 /*< Value given to a a \c NULL reduction target object */
#define	RTOp_NUM_DATA_TYPES   3 /*< Number of primative data types used in \c RTOp */

Typedefs
typedef Teuchos_Ordinal	RTOp_index_type
typedef double	RTOp_value_type
typedef char	RTOp_char_type
typedef void *	RTOp_ReductTarget

Functions
typedef	void (CALL_API *RTOp_reduct_op_func_ptr_t)(void *
void	RTOp_sub_vector (RTOp_index_type global_offset, RTOp_index_type sub_dim, const RTOp_value_type values[], ptrdiff_t values_stride, struct RTOp_SubVector *sub_vec)
void	RTOp_sub_vector_null (struct RTOp_SubVector *sub_vec)
void	RTOp_mutable_sub_vector (RTOp_index_type global_offset, RTOp_index_type sub_dim, RTOp_value_type values[], ptrdiff_t values_stride, struct RTOp_MutableSubVector *sub_vec)
void	RTOp_mutable_sub_vector_null (struct RTOp_MutableSubVector *sub_vec)
int	RTOp_get_op_name (const struct RTOp_RTOp *op, const char **op_name)
int	RTOp_get_op_type_num_entries (const struct RTOp_RTOp *op, int *num_values, int *num_indexes, int *num_chars)
int	RTOp_extract_op_state (const struct RTOp_RTOp *op, int num_values, RTOp_value_type value_data[], int num_indexes, RTOp_index_type index_data[], int num_chars, RTOp_char_type char_data[])
int	RTOp_load_op_state (int num_values, const RTOp_value_type value_data[], int num_indexes, const RTOp_index_type index_data[], int num_chars, const RTOp_char_type char_data[], struct RTOp_RTOp *op)
int	RTOp_free_op (struct RTOp_RTOp *op)
int	RTOp_get_reduct_type_num_entries (const struct RTOp_RTOp *op, int *num_values, int *num_indexes, int *num_chars)
int	RTOp_reduct_obj_create (const struct RTOp_RTOp *op, RTOp_ReductTarget *reduct_obj)
int	RTOp_reduct_obj_reinit (const struct RTOp_RTOp *op, RTOp_ReductTarget reduct_obj)
int	RTOp_reduct_obj_free (const struct RTOp_RTOp *op, RTOp_ReductTarget *reduct_obj)
int	RTOp_extract_reduct_obj_state (const struct RTOp_RTOp *op, const RTOp_ReductTarget reduct_obj, int num_values, RTOp_value_type value_data[], int num_indexes, RTOp_index_type index_data[], int num_chars, RTOp_char_type char_data[])
int	RTOp_load_reduct_obj_state (const struct RTOp_RTOp *op, int num_values, const RTOp_value_type value_data[], int num_indexes, const RTOp_index_type index_data[], int num_chars, const RTOp_char_type char_data[], RTOp_ReductTarget reduct_obj)
int	RTOp_coord_invariant (const struct RTOp_RTOp *op, int *coord_invariant)
int	RTOp_apply_op (const struct RTOp_RTOp *op, const int num_vecs, const struct RTOp_SubVector sub_vecs[], const int num_targ_vecs, const struct RTOp_MutableSubVector targ_sub_vecs[], RTOp_ReductTarget reduct_obj)
int	RTOp_reduce_reduct_objs (const struct RTOp_RTOp *op, RTOp_ReductTarget in_reduct_obj, RTOp_ReductTarget inout_reduct_obj)
int	RTOp_get_reduct_op (const struct RTOp_RTOp *op, RTOp_reduct_op_func_ptr_t *reduct_op_func_ptr)
int	RTOp_Server_add_op_name_vtbl (const char op_class_name[], const struct RTOp_RTOp_vtbl_t *op_class_vtbl)
int	RTOp_Server_lookup_op_name (const struct RTOp_RTOp_vtbl_t *op_class_vtbl, char op_class_name[])
int	RTOp_Server_construct_op (const char op_class_name[], int num_values, const RTOp_value_type value_data[], int num_indexes, const RTOp_index_type index_data[], int num_chars, const RTOp_char_type char_data[], struct RTOp_RTOp *op)
void	RTOp_Server_dump (FILE *file)

Error codes returned from various RTOp functions and interfaces.
#define	RTOp_ERR_INVALID_USAGE   -1
#define	RTOp_ERR_INVALID_NUM_VECS   -2
#define	RTOp_ERR_INVALID_NUM_TARG_VECS   -3
#define	RTOp_ERR_INCOMPATIBLE_VECS   -5
#define	RTOp_SERVER_INCOMPATIBLE_OPS   -6
#define	RTOp_SERVER_OP_NAME_TOO_LONG   -7

Macro Definition Documentation

#define CALL_API

Definition at line 65 of file RTOp.h.

Typedef Documentation

typedef Teuchos_Ordinal RTOp_index_type

Definition at line 68 of file RTOp.h.

typedef double RTOp_value_type

Definition at line 69 of file RTOp.h.

typedef char RTOp_char_type

Definition at line 70 of file RTOp.h.