8.0
general documentation
cs_xdef_array_context_t Struct Reference

Context structure when an array is used for the definition. More...

#include <cs_xdef.h>

+ Collaboration diagram for cs_xdef_array_context_t:

Data Fields

int z_id
 
int stride
 
cs_flag_t value_location
 
bool is_owner
 
bool full_length
 
cs_real_tvalues
 
cs_lnum_tfull2subset
 
cs_lnum_t n_list_elts
 
const cs_lnum_telt_ids
 
const cs_adjacency_tadjacency
 

Detailed Description

Context structure when an array is used for the definition.

Field Documentation

◆ adjacency

adjacency

(Optional) Pointer to a shared adjacency structure (an indexed list). This structure can be useful to manipulate arrays with advanced value location (i.e. not the classical ones as vertices, cells or boundary faces). One assumes that the lifecycle of this buffer is managed outside (pointer to a cs_adjacency_t stored either in the cs_cdo_connect_t struct. or the cs_mesh_t struct. for instance)

◆ elt_ids

elt_ids

(Optional) List of element ids. Useful when the array describes only a part of the full-length array and the value location is neither the cells for a volume definition nor the boundary faces for a boundary definition. One assumes that the lifecycle of this array is managed outside.

◆ full2subset

full2subset

(Optional) Array of size equal to the full support to get the position in the subset list of an element. Allocated only if full_length is set to false and only if needed.

◆ full_length

full_length

The array describes only a part of the support. To know which part is defined, one can relies on the elements of the zone when the support flag corresponds to the (primal) cells or to the boundary faces. In other cases, one needs the number of elements and its associated list.

◆ is_owner

is_owner

If true the lifecycle of the values is managed by the cs_xdef_t structure. Otherwise, the lifecycle is managed by the calling code.

◆ n_list_elts

n_list_elts

(Optional) Number of element in the (sub)list of elements when the array describes only a part of the full-length array (Case of value_location which is neither the cells nor the boundary faces).

◆ stride

stride

Stride to access the array values

◆ value_location

value_location

Flag to know where are defined array values

◆ values

values

Array values

◆ z_id

z_id

id related to a zone (volume or boundary). If id = 0, then all cells (in case of volume zone) or all boundary faces (in case of boundary zone) are selected. A full length array is thus considered and the way to apply a definition by array is simpler.


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