programmer's documentation
Data Fields
cs_field_t Struct Reference

Field descriptor. More...

#include <cs_field.h>

Collaboration diagram for cs_field_t:
Collaboration graph

Data Fields

const char * name
 
int id
 
int type
 
int dim
 
bool interleaved
 
int location_id
 
int n_time_vals
 
cs_real_t ** vals
 
cs_real_tval
 
cs_real_tval_pre
 
cs_field_bc_coeffs_tbc_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

location_id

Id of matching mesh location

n_time_vals

Number of time values

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)

vals

vals[0][:] is a pointer to val vals[1][:] is a pointer to val_pre vals[p][:] is a pointer to p ith previous field values


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