cs_field_pointer.cpp File Reference

#include "base/cs_defs.h"
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "bft/bft_error.h"
#include "bft/bft_printf.h"
#include "base/cs_field.h"
#include "base/cs_mem.h"
#include "base/cs_field_pointer.h"

Include dependency graph for cs_field_pointer.cpp:

Functions
void	cs_field_pointer_ensure_init (void)
	Ensure field pointer array is initialized.
void	cs_field_pointer_destroy_all (void)
	Free all field pointer data.
void	cs_field_pointer_map (cs_field_pointer_id_t e, cs_field_t *f)
	Map a simple field to an enumerated pointer.
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.
void	cs_field_pointer_map_base (void)
	Map base fields to enumerated pointers.
void	cs_field_pointer_map_boundary (void)
	Map some boundary fields to enumerated pointers.
void	cs_field_pointer_map_atmospheric (int n_chem_species, const int species_f_id[])
	Map base fields to enumerated pointers for atmospheric models.

Variables
struct cs_field_pointer_array_t *	cs_glob_field_pointers = nullptr

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_ensure_init()

void cs_field_pointer_ensure_init

(

void

)

Ensure field pointer array is initialized.

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_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

struct cs_field_pointer_array_t* cs_glob_field_pointers = nullptr