xref: /petsc/src/dm/impls/swarm/data_bucket.h (revision 4b46c5e15be7c29a43df8a7ac989acd1e2bd59f6)

#ifndef __DATA_BUCKET_H__
#define __DATA_BUCKET_H__


#include <petsc.h>
#include <petsc/private/dmswarmimpl.h>    /*I   "petscdmswarm.h"   I*/


#define DEFAULT -32654789

#define DATAFIELD_POINT_ACCESS_GUARD

/* Logging flag */
#define DATA_BUCKET_LOG


typedef enum { DATABUCKET_VIEW_STDOUT=0, DATABUCKET_VIEW_ASCII, DATABUCKET_VIEW_BINARY, DATABUCKET_VIEW_HDF5 } DataBucketViewType;



struct _p_DataField {
	char   *registeration_function;
	PetscInt    L;
	PetscBool active;
	size_t atomic_size;
	char   *name; /* what are they called */
	void   *data; /* the data - an array of structs */
  PetscDataType petsc_type;
};

struct _p_DataBucket {
	PetscInt L; /* number in use */
	PetscInt buffer; /* memory buffer used for re-allocation */
	PetscInt allocated;  /* number allocated, this will equal datafield->L */
	PetscBool finalised; /* DEPRECIATED */
	PetscInt nfields; /* how many fields of this type */
	DataField *field; /* the data */
};

#define ERROR() {\
printf("ERROR: %s() from line %d in %s !!\n", __FUNCTION__, __LINE__, __FILE__);\
exit(EXIT_FAILURE);\
}

#define __DATATFIELD_point_access(data,index,atomic_size) (void*)((char*)(data) + (index)*(atomic_size))
#define __DATATFIELD_point_access_offset(data,index,atomic_size,offset) (void*)((char*)(data) + (index)*(atomic_size) + (offset))



void StringInList( const char name[], const PetscInt N, const DataField gfield[], PetscBool *val );
void StringFindInList( const char name[], const PetscInt N, const DataField gfield[], PetscInt *index );

void DataFieldCreate( const char registeration_function[], const char name[], const size_t size, const PetscInt L, DataField *DF );
void DataFieldDestroy( DataField *DF );
void DataBucketCreate( DataBucket *DB );
void DataBucketDestroy( DataBucket *DB );
void _DataBucketRegisterField(
															DataBucket db,
															const char registeration_function[],
															const char field_name[],
															size_t atomic_size, DataField *_gfield );


#define DataBucketRegisterField(db,name,size,k) {\
  char *location;\
  asprintf(&location,"Registered by %s() at line %d within file %s", __FUNCTION__, __LINE__, __FILE__);\
  _DataBucketRegisterField( (db), location, (name), (size), (k) );\
  free(location);\
}

void DataFieldGetNumEntries(DataField df, PetscInt *sum);
void DataFieldSetSize( DataField df, const PetscInt new_L );
void DataFieldZeroBlock( DataField df, const PetscInt start, const PetscInt end );
void DataFieldGetAccess( const DataField gfield );
void DataFieldAccessPoint( const DataField gfield, const PetscInt pid, void **ctx_p );
void DataFieldAccessPointOffset( const DataField gfield, const size_t offset, const PetscInt pid, void **ctx_p );
void DataFieldRestoreAccess( DataField gfield );
void DataFieldVerifyAccess( const DataField gfield, const size_t size);
void DataFieldGetAtomicSize(const DataField gfield,size_t *size);

void DataFieldGetEntries(const DataField gfield,void **data);
void DataFieldRestoreEntries(const DataField gfield,void **data);

void DataFieldInsertPoint( const DataField field, const PetscInt index, const void *ctx );
void DataFieldCopyPoint( const PetscInt pid_x, const DataField field_x,
												const PetscInt pid_y, const DataField field_y );
void DataFieldZeroPoint( const DataField field, const PetscInt index );

void DataBucketGetDataFieldByName(DataBucket db,const char name[],DataField *gfield);
void DataBucketQueryDataFieldByName(DataBucket db,const char name[],PetscBool *found);
void DataBucketFinalize(DataBucket db);
void DataBucketSetInitialSizes( DataBucket db, const PetscInt L, const PetscInt buffer );
void DataBucketSetSizes( DataBucket db, const PetscInt L, const PetscInt buffer );
void DataBucketGetSizes( DataBucket db, PetscInt *L, PetscInt *buffer, PetscInt *allocated );
void DataBucketGetGlobalSizes(MPI_Comm comm, DataBucket db, PetscInt *L, PetscInt *buffer, PetscInt *allocated );
void DataBucketGetDataFields( DataBucket db, PetscInt *L, DataField *fields[] );

void DataBucketCopyPoint( const DataBucket xb, const PetscInt pid_x,
												 const DataBucket yb, const PetscInt pid_y );
void DataBucketCreateFromSubset( DataBucket DBIn, const PetscInt N, const PetscInt list[], DataBucket *DB );
void DataBucketZeroPoint( const DataBucket db, const PetscInt index );

//void DataBucketLoadFromFile(const char filename[], DataBucketViewType type, DataBucket *db);
void DataBucketLoadFromFile(MPI_Comm comm,const char filename[], DataBucketViewType type, DataBucket *db);
//void DataBucketView(DataBucket db,const char filename[],DataBucketViewType type);
void DataBucketView(MPI_Comm comm,DataBucket db,const char filename[],DataBucketViewType type);

void DataBucketAddPoint( DataBucket db );
void DataBucketRemovePoint( DataBucket db );
void DataBucketRemovePointAtIndex( const DataBucket db, const PetscInt index );

void DataBucketDuplicateFields(DataBucket dbA,DataBucket *dbB);
void DataBucketInsertValues(DataBucket db1,DataBucket db2);

/* helpers for parallel send/recv */
void DataBucketCreatePackedArray(DataBucket db,size_t *bytes,void **buf);
void DataBucketDestroyPackedArray(DataBucket db,void **buf);
void DataBucketFillPackedArray(DataBucket db,const PetscInt index,void *buf);
void DataBucketInsertPackedArray(DataBucket db,const PetscInt idx,void *data);


#endif