cs_field_t Struct Reference

| programmer's documentation

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- Data Structures
- Data Structure Index
- Data Fields

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
cs_field_t Struct Reference

Field descriptor. More...

`#include <cs_field.h>`

Collaboration diagram for cs_field_t:

## Data Fields
const char * | name
int | id
int | type
int | dim
bool | interleaved
int | location_id
int | n_time_vals
cs_real_t * | val
cs_real_t * | val_pre
cs_field_bc_coeffs_t * | bc_coeffs
bool | is_owner

## Detailed Description

Field descriptor.

Members of this field are publicly accessible, to allow for concise syntax, as it is expected to be used in many places.

## Field Documentation

bc_coeffs

Boundary condition coefficients, for variable type fields

dim

Field dimension (usually 1 for scalar, 3 for vector, or 6 for symmetric tensor)

id

Field id (based on order of field declaration, starting at 0)

interleaved

are field value arrays interleaved ? (recommended for new developments, but mapped legacy fields may be non-interleaved)

is_owner

Ownership flag for values and boundary coefficients

location_id

Id of matching mesh location

n_time_vals

Number of time values (1 or 2)

name

Canonical name

type

Field type flag (sum of field mask constants, defining if a field is a variable, a property, ...)

val

For each active location, pointer to matching values array

val_pre

For each active location, pointer to matching previous values array (only if n_time_vals > 1)

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

- src/base/cs_field.h
- src/base/cs_field.c