src/ccpp_fields_idx.h File Reference
Go to the source code of this file.
Detailed Description
Routines and functions to generate and lookup fields/variables needed for the physics routines.
Define Documentation
#define CCPP_FIELD_IDX_GROW 1.75 |
#define CCPP_FIELD_IDX_MAX 75 |
Function Documentation
int ccpp_field_idx_add |
( |
const char * |
name, |
|
|
void ** |
index | |
|
) |
| | |
CCPP field index add/insert a field.
Add/Insert a field into the index.
- Parameters:
-
[in] | name | The name to add to the index array. |
[in,out] | index | The index array. |
- Return values:
-
| > | 0 The index location. |
| -1 | If there was an error. |
int ccpp_field_idx_find |
( |
const char * |
name, |
|
|
void ** |
index | |
|
) |
| | |
CCPP field index find a field location.
Find the index number of a field.
- Parameters:
-
[in] | name | The field name to find the index array. |
[in,out] | index | The index array. |
- Return values:
-
| > | 0 The position in the index array of the requested field. |
| -1 | If there was an error. |
int ccpp_field_idx_fini |
( |
void ** |
index |
) |
|
CCPP field index finialization routine.
Finialization routine.
Deallocates the field indices array.
- Parameters:
-
[in] | index | The index array. |
- Return values:
-
int ccpp_field_idx_grow |
( |
void ** |
index |
) |
|
CCPP field index array extension.
Grow the index field array.
- Parameters:
-
[in,out] | index | The index array. |
- Return values:
-
int ccpp_field_idx_init |
( |
void ** |
index |
) |
|
CCPP field index initialization routine.
Initialization routine.
Allocates an array for the field indices.
- Parameters:
-
[in,out] | index | The index array. |
- Return values:
-
| 0 | If it was sucessful. |
| 1 | If there was an error. |
int ccpp_field_idx_max |
( |
void ** |
index |
) |
|
CCPP field index maximum number of fields.
Get the maximum number of fields the index array can hold.
- Parameters:
-
[in,out] | index | The index array. |
- Return values:
-
| >= | 0 The maximum number of fields. |
int ccpp_field_idx_sort |
( |
void ** |
index |
) |
|
CCPP field index sorting routine.
Sort the index by calling qsort() and using cmp() as the comparison function.
- Parameters:
-
[in,out] | index | The index array. |
- Return values:
-