Fortran wrapper methods

Functions
void	serialboxFortranSerializerRegisterField (void *serializer, const char *name, int type, int bytesPerElement, int iSize, int jSize, int kSize, int lSize, int iMinusHalo, int iPlusHalo, int jMinusHalo, int jPlusHalo, int kMinusHalo, int kPlusHalo, int lMinusHalo, int lPlusHalo)
	Register field within the serializer. More...
void	serialboxFortranSerializerWrite (void *serializer, const void *savepoint, const char *name, void *originPtr, int istride, int jstride, int kstride, int lstride)
	Wrapper for serialboxSerializerWrite.
void	serialboxFortranSerializerRead (void *serializer, const void *savepoint, const char *name, void *originPtr, int istride, int jstride, int kstride, int lstride)
	Wrapper for serialboxSerializerRead.
void	serialboxFortranSerializerPrintDebugInfo (void *serializer)
	Print debug information (i.e convert serializer to string)
void	serialboxFortranSerializerCheckField (const void *serializer, const char *name, int *type, int *isize, int *jsize, int *ksize, int *lsize)
	Perform consistency checks concerning dimensions and type of the field name
void	serialboxFortranComputeStrides (void *serializer, const char *fieldname, const void *basePtr, const void *iplus1, const void *jplus1, const void *kplus1, const void *lplus1, int *istride, int *jstride, int *kstride, int *lstride)
	Compute unit-strides of registered field fieldname
void	serialboxFortranSerializerGetFieldDimensions (const void *serializer, const char *name, int *isize, int *jsize, int *ksize, int *lsize)
	Returns the dimensions of the field name
void	serialboxFortranSerializerGetFieldHalos (const void *serializer, const char *name, int *iMinusHalo, int *iPlusHalo, int *jMinusHalo, int *jPlusHalo, int *kMinusHalo, int *kPlusHalo, int *lMinusHalo, int *lPlusHalo)
	Returns the halos of the field name
void	serialboxFortranSerializerAddMetainfoBoolean (void *serializer, const char *key, int value)
	Add a global meta-information key=value pair to the Serializer. More...
void	serialboxFortranSerializerAddMetainfoInt32 (void *serializer, const char *key, int value)
void	serialboxFortranSerializerAddMetainfoFloat32 (void *serializer, const char *key, float value)
void	serialboxFortranSerializerAddMetainfoFloat64 (void *serializer, const char *key, double value)
void	serialboxFortranSerializerAddMetainfoString (void *serializer, const char *key, const char *value)
void	serialboxFortranSerializerAddFieldMetainfoBoolean (void *serializer, const char *field, const char *key, int value)
	Add a meta-information key=value pair to field of the serializer. More...
void	serialboxFortranSerializerAddFieldMetainfoInt32 (void *serializer, const char *field, const char *key, int value)
void	serialboxFortranSerializerAddFieldMetainfoFloat32 (void *serializer, const char *field, const char *key, float value)
void	serialboxFortranSerializerAddFieldMetainfoFloat64 (void *serializer, const char *field, const char *key, double value)
void	serialboxFortranSerializerAddFieldMetainfoString (void *serializer, const char *field, const char *key, const char *value)
void	serialboxFortranSavepointAddMetainfoBoolean (void *savepoint, const char *key, int value)
	Add a meta-information key=value pair to the savepoint More...
void	serialboxFortranSavepointAddMetainfoInt32 (void *savepoint, const char *key, int value)
void	serialboxFortranSavepointAddMetainfoFloat32 (void *savepoint, const char *key, float value)
void	serialboxFortranSavepointAddMetainfoFloat64 (void *savepoint, const char *key, double value)
void	serialboxFortranSavepointAddMetainfoString (void *savepoint, const char *key, const char *value)

Detailed Description

Function Documentation

serialboxFortranSavepointAddMetainfoBoolean()

void serialboxFortranSavepointAddMetainfoBoolean	(	void *	savepoint,
		const char *	key,
		int	value
	)

Add a meta-information key=value pair to the savepoint

This function corresponds to fs_add_savepoint_metainfo_f

Parameters

savepoint	Savepoint to use
key	Key of the new element
value	Object to be copied to the value of the new element

Definition at line 330 of file FortranWrapper.cpp.

serialboxFortranSerializerAddFieldMetainfoBoolean()

void serialboxFortranSerializerAddFieldMetainfoBoolean	(	void *	serializer,
		const char *	field,
		const char *	key,
		int	value
	)

Add a meta-information key=value pair to field of the serializer.

This function corresponds to fs_add_field_metainfo_i

Parameters

serializer	Serializer to use
field	Name of the field
key	Key of the new element
value	Object to be copied to the value of the new element

Definition at line 261 of file FortranWrapper.cpp.

serialboxFortranSerializerAddMetainfoBoolean()

void serialboxFortranSerializerAddMetainfoBoolean	(	void *	serializer,
		const char *	key,
		int	value
	)

Add a global meta-information key=value pair to the Serializer.

This function corresponds to fs_add_serializer_metainfo_X

Parameters

serializer	Serializer to use
key	Key of the new element
value	Object to be copied to the value of the new element

Definition at line 201 of file FortranWrapper.cpp.

serialboxFortranSerializerRegisterField()

void serialboxFortranSerializerRegisterField	(	void *	serializer,
		const char *	name,
		int	type,
		int	bytesPerElement,
		int	iSize,
		int	jSize,
		int	kSize,
		int	lSize,
		int	iMinusHalo,
		int	iPlusHalo,
		int	jMinusHalo,
		int	jPlusHalo,
		int	kMinusHalo,
		int	kPlusHalo,
		int	lMinusHalo,
		int	lPlusHalo
	)

Register field within the serializer.

This function corresponds to fs_register_field

Parameters

serializer	Serializer to use
name	The name of the field
type	TypeID of the field (serialboxTypeID)
bytesPerElement	The size in bytes of a scalar value (e.g. 8 for doubles)
iSize	The size of the first dimension
jSize	The size of the second dimension
kSize	The size of the third dimension
lsize	The size of the fourth dimension
iMinusHalo	The dimension of the halo in negative i-direction
iPlusHalo	The dimension of the halo in positive i-direction
jMinusHalo	The dimension of the halo in negative j-direction
jPlusHalo	The dimension of the halo in positive j-direction
kMinusHalo	The dimension of the halo in negative k-direction
kPlusHalo	The dimension of the halo in positive k-direction
lMinusHalo	The dimension of the halo in negative l-direction
lPlusHalo	The dimension of the halo in positive l-direction

Definition at line 247 of file FortranWrapper.cpp.