cs_field_pointer.c File Reference

#include "cs_defs.h"
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "bft_mem.h"
#include "bft_error.h"
#include "bft_printf.h"
#include "cs_field.h"
#include "cs_field_pointer.h"

Include dependency graph for cs_field_pointer.c:

Functions
void	cs_field_pointer_destroy_all (void)
	Free all field pointer data. More...
void	cs_field_pointer_map (cs_field_pointer_id_t e, cs_field_t *f)
	Map a simple field to an enumerated pointer. More...
void	cs_field_pointer_map_indexed (cs_field_pointer_id_t e, int index, cs_field_t *f)
	Map a field to an (enumerated pointer, index) couple. More...
void	cs_field_pointer_map_base (void)
	Map base fields to enumerated pointers. More...
void	cs_field_pointer_map_boundary (void)
	Map some boundary fields to enumerated pointers. More...
void	cs_field_pointer_map_atmospheric (int n_chem_species, const int species_f_id[])
	Map base fields to enumerated pointers for atmospheric models. More...
void	cs_field_pointer_map_coal_combustion (int n_coals, int n_classes)
	Map base fields to enumerated pointers for coal combustion. More...
void	cs_field_pointer_map_compressible (void)
	Map base fields to enumerated pointers for compressible model. More...
void	cs_field_pointer_map_gas_mix (void)
	Map base fields to enumerated pointers for gas mix model. More...
void	cs_field_pointer_map_gas_combustion (void)
	Map base fields to enumerated pointers for gas combustion. More...
void	cs_field_pointer_map_groundwater (void)
	Map base fields to enumerated pointers for groundwater flows. More...

Variables
union cs_field_pointer_val_t *	cs_glob_field_pointers = NULL

Detailed Description

Field pointers and ids for standard and model fields.

Function Documentation

cs_field_pointer_destroy_all()

void cs_field_pointer_destroy_all

(

void

)

Free all field pointer data.

cs_field_pointer_map()

void cs_field_pointer_map	(	cs_field_pointer_id_t	e,
		cs_field_t *	f
	)

Map a simple field to an enumerated pointer.

The associated field pointer may then be retreived using CS_F_(e).

Parameters

[in]	e	field enumerator value
[in]	f	pointer to field structure

cs_field_pointer_map_atmospheric()

void cs_field_pointer_map_atmospheric	(	int	n_chem_species,
		const int	species_f_id[]
	)

Map base fields to enumerated pointers for atmospheric models.

Parameters

[in]	n_chem_species	number of chemical species
[in]	species_f_id	field id for each chemical species

cs_field_pointer_map_base()

void cs_field_pointer_map_base

(

void

)

Map base fields to enumerated pointers.

cs_field_pointer_map_boundary()

void cs_field_pointer_map_boundary

(

void

)

Map some boundary fields to enumerated pointers.

cs_field_pointer_map_coal_combustion()

void cs_field_pointer_map_coal_combustion	(	int	n_coals,
		int	n_classes
	)

Map base fields to enumerated pointers for coal combustion.

Parameters

[in]	n_coals	number of coals
[in]	n_classes	number of coal classes

cs_field_pointer_map_compressible()

void cs_field_pointer_map_compressible

(

void

)

Map base fields to enumerated pointers for compressible model.

cs_field_pointer_map_gas_combustion()

void cs_field_pointer_map_gas_combustion

(

void

)

Map base fields to enumerated pointers for gas combustion.

cs_field_pointer_map_gas_mix()

void cs_field_pointer_map_gas_mix

(

void

)

Map base fields to enumerated pointers for gas mix model.

cs_field_pointer_map_groundwater()

void cs_field_pointer_map_groundwater

(

void

)

Map base fields to enumerated pointers for groundwater flows.

cs_field_pointer_map_indexed()

void cs_field_pointer_map_indexed	(	cs_field_pointer_id_t	e,
		int	index,
		cs_field_t *	f
	)

Map a field to an (enumerated pointer, index) couple.

This sort of mapping may be used for sets of fields whose size is not known in advance.

The associated field pointer may then be retreived using CS_FI_(e, i).

Parameters

[in]	e	field enumerator value
[in]	index	field enumerator index
[in]	f	pointer to field structure

Variable Documentation

cs_glob_field_pointers

union cs_field_pointer_val_t* cs_glob_field_pointers = NULL