mbs_part.h File Reference

#include "mbs_data.h"
#include "MBSfun.h"

Go to the source code of this file.

Classes
struct	MbsPartOptions
	Structure defining the options of the coordinate partitioning module. More...
struct	MbsPart
	Main structure for the coordinate partitioning module. More...

Functions
int	mbs_run_part (MbsPart *mbs_part, MbsData *mbs_data)
	Main function of the coordinate partitioning module. More...
MbsPart *	mbs_new_part (MbsData *mbs_data)
	Allocate a new MbsPart structure for the given MbsData structure. More...
void	mbs_delete_part (MbsPart *mbs_part)
	Free the memory of the given MbsPart structure. More...
MbsPartOptions *	mbs_new_part_options (void)
	Allocate a new MbsPartOptions structure and intialize options with default values. More...
void	mbs_delete_part_options (MbsPartOptions *part_option_strct)
	Free the memory of the given MbsPartOptions structure. More...

Function Documentation

mbs_delete_part()

void mbs_delete_part

(

MbsPart *

mbs_part

)

Free the memory of the given MbsPart structure.

The memory of the associated options (mbs_part->options) is also freed.

Parameters

mbs_part

the structure to be freed.

mbs_delete_part_options()

void mbs_delete_part_options

(

MbsPartOptions *

part_option_strct

)

Free the memory of the given MbsPartOptions structure.

This function will be called by mbs_delete_part() and should never be called by the user.

Parameters

part_option_strct

the structure to be freed.

mbs_new_part()

MbsPart* mbs_new_part

(

MbsData *

mbs_data

)

Allocate a new MbsPart structure for the given MbsData structure.

A new MbsPartOptions is also allocated and a pointer to this structure is kept from the new MbsPart.

Parameters

mbs_data

the structure of the mbs for which the coordinate part. will be performed.

mbs_new_part_options()

MbsPartOptions* mbs_new_part_options

(

void

)

Allocate a new MbsPartOptions structure and intialize options with default values.

mbs_run_part()

int mbs_run_part	(	MbsPart *	mbs_part,
		MbsData *	mbs_data
	)

Main function of the coordinate partitioning module.

It compute the coordinate partitioning for the given MbsData structure.

Parameters

mbs_part	the coord. part. structure
mbs_data	the structure of the mbs for which the coord. part. must be performed

Returns

error status, < 0 in case of failure.