Zoltan::MigrationObject Class Reference

Zoltan::MigrationObject: A base class from which the user can derive an application specific support class for Zoltan's migration callback functions. More...

#include <Zoltan_MigrationObject.h>

List of all members.
virtual int Object_Size (void *data, int num_gid_entries, int num_lid_entries, ZOLTAN_ID_PTR global_id, ZOLTAN_ID_PTR local_id, int *ierr)
 Supports ZOLTAN_OBJ_SIZE_FN_TYPE.
virtual void Pre_Migrate (void *data, int num_gid_entries, int num_lid_entries, int num_import, ZOLTAN_ID_PTR import_global_ids, ZOLTAN_ID_PTR import_local_ids, int *import_procs, int num_export, ZOLTAN_ID_PTR export_global_ids, ZOLTAN_ID_PTR export_local_ids, int *export_procs, int *ierr)
 Supports ZOLTAN_PRE_MIGRATE_FN_TYPE.
virtual void Mid_Migrate (void *data, int num_gid_entries, int num_lid_entries, int num_import, ZOLTAN_ID_PTR import_global_ids, ZOLTAN_ID_PTR import_local_ids, int *import_procs, int num_export, ZOLTAN_ID_PTR export_global_ids, ZOLTAN_ID_PTR export_local_ids, int *export_procs, int *ierr)
 Supports ZOLTAN_MID_MIGRATE_FN_TYPE.
virtual void Post_Migrate (void *data, int num_gid_entries, int num_lid_entries, int num_import, ZOLTAN_ID_PTR import_global_ids, ZOLTAN_ID_PTR import_local_ids, int *import_procs, int num_export, ZOLTAN_ID_PTR export_global_ids, ZOLTAN_ID_PTR export_local_ids, int *export_procs, int *ierr)
 Supports ZOLTAN_POST_MIGRATE_FN_TYPE.
virtual void Pack_Object (void *data, int num_gid_entries, int num_lid_entries, ZOLTAN_ID_PTR global_id, ZOLTAN_ID_PTR local_id, int destination_processor, int size, char *buffer, int *ierr)
 Supports ZOLTAN_PACK_OBJ_FN_TYPE.
virtual void Unpack_Object (void *data, int num_gid_entries, ZOLTAN_ID_PTR global_id, int size, char *buffer, int *ierr)
 Supports ZOLTAN_UNPACK_OBJ_FN_TYPE.


Detailed Description

Zoltan::MigrationObject: A base class from which the user can derive an application specific support class for Zoltan's migration callback functions.

As with Zoltan, the user only need implement those methods used by Zoltan during their application executions. If Zoltan calls an unimplemented method, a fatal error will be generated.

Definition at line 27 of file Zoltan_MigrationObject.h.


Member Function Documentation

int Zoltan::MigrationObject::Object_Size ( void *  data,
int  num_gid_entries,
int  num_lid_entries,
ZOLTAN_ID_PTR  global_id,
ZOLTAN_ID_PTR  local_id,
int *  ierr 
) [virtual]

Supports ZOLTAN_OBJ_SIZE_FN_TYPE.

Definition at line 36 of file Zoltan_MigrationObject.cpp.

void Zoltan::MigrationObject::Pre_Migrate ( void *  data,
int  num_gid_entries,
int  num_lid_entries,
int  num_import,
ZOLTAN_ID_PTR  import_global_ids,
ZOLTAN_ID_PTR  import_local_ids,
int *  import_procs,
int  num_export,
ZOLTAN_ID_PTR  export_global_ids,
ZOLTAN_ID_PTR  export_local_ids,
int *  export_procs,
int *  ierr 
) [virtual]

Supports ZOLTAN_PRE_MIGRATE_FN_TYPE.

Definition at line 52 of file Zoltan_MigrationObject.cpp.

void Zoltan::MigrationObject::Mid_Migrate ( void *  data,
int  num_gid_entries,
int  num_lid_entries,
int  num_import,
ZOLTAN_ID_PTR  import_global_ids,
ZOLTAN_ID_PTR  import_local_ids,
int *  import_procs,
int  num_export,
ZOLTAN_ID_PTR  export_global_ids,
ZOLTAN_ID_PTR  export_local_ids,
int *  export_procs,
int *  ierr 
) [virtual]

Supports ZOLTAN_MID_MIGRATE_FN_TYPE.

Definition at line 73 of file Zoltan_MigrationObject.cpp.

void Zoltan::MigrationObject::Post_Migrate ( void *  data,
int  num_gid_entries,
int  num_lid_entries,
int  num_import,
ZOLTAN_ID_PTR  import_global_ids,
ZOLTAN_ID_PTR  import_local_ids,
int *  import_procs,
int  num_export,
ZOLTAN_ID_PTR  export_global_ids,
ZOLTAN_ID_PTR  export_local_ids,
int *  export_procs,
int *  ierr 
) [virtual]

Supports ZOLTAN_POST_MIGRATE_FN_TYPE.

Definition at line 94 of file Zoltan_MigrationObject.cpp.

void Zoltan::MigrationObject::Pack_Object ( void *  data,
int  num_gid_entries,
int  num_lid_entries,
ZOLTAN_ID_PTR  global_id,
ZOLTAN_ID_PTR  local_id,
int  destination_processor,
int  size,
char *  buffer,
int *  ierr 
) [virtual]

Supports ZOLTAN_PACK_OBJ_FN_TYPE.

Definition at line 115 of file Zoltan_MigrationObject.cpp.

void Zoltan::MigrationObject::Unpack_Object ( void *  data,
int  num_gid_entries,
ZOLTAN_ID_PTR  global_id,
int  size,
char *  buffer,
int *  ierr 
) [virtual]

Supports ZOLTAN_UNPACK_OBJ_FN_TYPE.

Definition at line 132 of file Zoltan_MigrationObject.cpp.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:40:42 2010 for EpetraExt by  doxygen 1.4.7