My Project
programmer's documentation
Data Fields
cs_adv_field_t Struct Reference

#include <cs_advection_field.h>

Collaboration diagram for cs_adv_field_t:
Collaboration graph

Data Fields

int id
 
char *restrict name
 
cs_advection_field_status_t status
 
cs_advection_field_type_t type
 
cs_flag_t flag
 
int vtx_field_id
 
int cell_field_id
 
int bdy_field_id
 
int int_field_id
 
cs_xdef_tdefinition
 
int n_bdy_flux_defs
 
cs_xdef_t ** bdy_flux_defs
 
short int * bdy_def_ids
 

Field Documentation

◆ bdy_def_ids

short int* bdy_def_ids

◆ bdy_field_id

bdy_field_id

id to retrieve the related cs_field_t structure corresponding to the value of the normal flux across boundary faces. It's always defined since it's used for dealing with the boundary conditions.

◆ bdy_flux_defs

bdy_flux_defs

Array of pointers to the definitions of the jormal flux at the boundary

◆ cell_field_id

cell_field_id

id to retrieve the related cs_field_t structure. It's always defined since it's used during the building of the advection scheme

◆ definition

definition

pointer to the generic structure used to define the advection field. We assume that only one definition is available (i.e. there is not several zones).

◆ flag

flag

short descriptor dedicated to postprocessing

◆ id

id

identification number

◆ int_field_id

int_field_id

id to retrieve the related cs_field_t structure corresponding to the value of the normal flux across interior faces. It's always defined when the advection field arise from the resolution of the Navier-Stokes system with the legacy FV solver.

◆ n_bdy_flux_defs

n_bdy_flux_defs

Number of definitions related to the normal flux at the boundary

◆ name

name

name of the advection field

◆ status

status

status of the advection field (user, gwf...)

◆ type

type

type of advection field (velocity, flux..)

◆ vtx_field_id

vtx_field_id

id to retrieve the related cs_field_t structure (-1 if not used)


The documentation for this struct was generated from the following file: