 |
6.3
general documentation
|
|
Go to the documentation of this file.
55 #define CS_FIELD_INTENSIVE (1 << 0)
58 #define CS_FIELD_EXTENSIVE (1 << 1)
63 #define CS_FIELD_VARIABLE (1 << 2)
66 #define CS_FIELD_PROPERTY (1 << 3)
69 #define CS_FIELD_POSTPROCESS (1 << 4)
72 #define CS_FIELD_ACCUMULATOR (1 << 5)
75 #define CS_FIELD_USER (1 << 6)
78 #define CS_FIELD_CDO (1 << 7)
533 double default_value,
555 const char *default_value,
581 const void *default_value,
cs_field_t * cs_field_by_name(const char *name)
Return a pointer to a field based on its name.
Definition: cs_field.c:2338
void cs_field_define_keys_base(void)
Define base keys.
Definition: cs_field.c:4265
int dim
Definition: cs_field.h:132
int cs_field_n_fields(void)
Return the number of defined fields.
Definition: cs_field.c:1528
void cs_field_allocate_bc_coeffs(cs_field_t *f, bool have_flux_bc, bool have_mom_bc, bool have_conv_bc, bool have_exch_bc)
Allocate boundary condition coefficients arrays.
Definition: cs_field.c:1797
cs_field_t * cs_field_create(const char *name, int type_flag, int location_id, int dim, bool has_previous)
Create a field descriptor.
Definition: cs_field.c:1548
@ CS_FIELD_LOCKED
Definition: cs_field.h:97
cs_real_t * hext
Definition: cs_field.h:118
cs_real_t * a
Definition: cs_field.h:108
int cs_field_set_key_int_bits(cs_field_t *f, int key_id, int mask)
Set integer bits matching a mask to 1 for a given key for a field.
Definition: cs_field.c:3062
cs_real_t * ac
Definition: cs_field.h:114
const void * cs_field_get_key_struct_const_ptr(const cs_field_t *f, int key_id)
Return a read-only pointer to a simple structure for a given key to a field.
Definition: cs_field.c:3565
cs_real_t ** vals
Definition: cs_field.h:138
void cs_field_set_n_time_vals(cs_field_t *f, int n_time_vals)
Change the number of time values managed by a field.
Definition: cs_field.c:1652
cs_real_t * af
Definition: cs_field.h:110
void cs_field_log_key_defs(void)
Print info relative to all key definitions to log file.
Definition: cs_field.c:3957
void() cs_field_clear_key_struct_t(void *t)
Definition: cs_field.h:178
int id
Definition: cs_field.h:129
cs_field_bc_coeffs_t * bc_coeffs
Definition: cs_field.h:153
const char * cs_field_get_label(const cs_field_t *f)
Return a label associated with a field.
Definition: cs_field.c:4291
cs_real_t * b
Definition: cs_field.h:109
#define END_C_DECLS
Definition: cs_defs.h:493
int cs_field_id_by_name(const char *name)
Return the id of a defined field based on its name.
Definition: cs_field.c:2387
int cs_field_clear_key_int_bits(cs_field_t *f, int key_id, int mask)
Set integer bits matching a mask to 0 for a given key for a field.
Definition: cs_field.c:3093
const char * name
Definition: cs_field.h:127
double cs_real_t
Floating-point value.
Definition: cs_defs.h:304
bool is_owner
Definition: cs_field.h:156
int type
Definition: cs_field.h:130
int n_time_vals
Definition: cs_field.h:136
cs_field_t * cs_field_find_or_create(const char *name, int type_flag, int location_id, int dim, bool has_previous)
Return a field matching a given name and attributes, creating it if necessary.
Definition: cs_field.c:1592
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
int cs_field_set_key_int(cs_field_t *f, int key_id, int value)
Assign a integer value for a given key to a field.
Definition: cs_field.c:2943
void cs_field_log_fields(int log_keywords)
Print info relative to all defined fields to log file.
Definition: cs_field.c:3896
void cs_field_current_to_previous(cs_field_t *f)
Copy current field values to previous values if applicable.
Definition: cs_field.c:2168
int cs_field_set_key_str(cs_field_t *f, int key_id, const char *str)
Assign a character string for a given key to a field.
Definition: cs_field.c:3241
void cs_field_log_all_key_vals(bool log_defaults)
Print info relative to all given field keys to log file.
Definition: cs_field.c:4234
@ CS_FIELD_INVALID_FIELD
Definition: cs_field.h:96
void() cs_field_log_key_struct_t(const void *t)
Definition: cs_field.h:168
void cs_field_log_defs(void)
Print info relative to all field definitions to log file.
Definition: cs_field.c:3624
int cs_field_set_key_struct(cs_field_t *f, int key_id, void *s)
Assign a simple structure for a given key to a field.
Definition: cs_field.c:3362
cs_real_t * val
Definition: cs_field.h:146
void cs_field_destroy_all_keys(void)
Destroy all defined field keys and associated values.
Definition: cs_field.c:2757
const char * cs_glob_field_comp_name_3[]
int cs_field_define_key_double(const char *name, double default_value, int type_flag)
Define a key for an floating point value by its name and return an associated id.
Definition: cs_field.c:2589
cs_real_t * ad
Definition: cs_field.h:112
void cs_field_map_values(cs_field_t *f, cs_real_t *val, cs_real_t *val_pre)
Map existing value arrays to field descriptor.
Definition: cs_field.c:1744
const void * cs_field_get_key_struct(const cs_field_t *f, int key_id, void *s)
Return a structure for a given key associated with a field.
Definition: cs_field.c:3414
bool cs_field_is_key_set(const cs_field_t *f, int key_id)
Query if a given key has been set for a field.
Definition: cs_field.c:2835
@ CS_FIELD_INVALID_CATEGORY
Definition: cs_field.h:94
void cs_field_allocate_values(cs_field_t *f)
Allocate arrays for field values.
Definition: cs_field.c:1713
cs_field_t * cs_field_by_name_try(const char *name)
Return a pointer to a field based on its name if present.
Definition: cs_field.c:2364
int cs_field_define_key_struct(const char *name, const void *default_value, cs_field_log_key_struct_t *log_func, cs_field_log_key_struct_t *log_func_default, cs_field_clear_key_struct_t *clear_func, size_t size, int type_flag)
Define a key for a structure value by its name and return an associated id.
Definition: cs_field.c:2678
cs_real_t * bf
Definition: cs_field.h:111
cs_field_t * cs_field_by_id(int id)
Return a pointer to a field based on its id.
Definition: cs_field.c:2314
double cs_field_get_key_double(const cs_field_t *f, int key_id)
Return a floating point value for a given key associated with a field.
Definition: cs_field.c:3171
int cs_field_define_key_int(const char *name, int default_value, int type_flag)
Define a key for an integer value by its name and return an associated id.
Definition: cs_field.c:2552
void cs_field_init_bc_coeffs(cs_field_t *f)
Initialize boundary condition coefficients arrays.
Definition: cs_field.c:1945
int cs_field_key_id_try(const char *name)
Return an id associated with a given key name if present.
Definition: cs_field.c:2524
const char * cs_glob_field_comp_name_6[]
bool cs_field_is_key_locked(const cs_field_t *f, int key_id)
Query if a given key has been locked for a field.
Definition: cs_field.c:2866
int cs_field_define_key_str(const char *name, const char *default_value, int type_flag)
Define a key for a string value by its name and return an associated id.
Definition: cs_field.c:2626
int cs_field_get_key_int(const cs_field_t *f, int key_id)
Return a integer value for a given key associated with a field.
Definition: cs_field.c:2991
int cs_field_set_key_double(cs_field_t *f, int key_id, double value)
Assign a floating point value for a given key to a field.
Definition: cs_field.c:3123
const char * cs_field_get_key_str(const cs_field_t *f, int key_id)
Return a string for a given key associated with a field.
Definition: cs_field.c:3293
void cs_field_component_id_by_name(const char *name, int *f_id, int *c_id)
Return the id of a defined field and an associated component based on a component name.
Definition: cs_field.c:2408
void cs_field_log_info(const cs_field_t *f, int log_keywords)
Print info relative to a given field to log file.
Definition: cs_field.c:3762
void cs_field_destroy_all(void)
Destroy all defined fields.
Definition: cs_field.c:2226
int location_id
Definition: cs_field.h:106
cs_real_t * hint
Definition: cs_field.h:117
@ t
Definition: cs_field_pointer.h:98
cs_real_t * bd
Definition: cs_field.h:113
int cs_field_lock_key(cs_field_t *f, int key_id)
Lock a field relative to a given key.
Definition: cs_field.c:2898
cs_field_error_type_t
Definition: cs_field.h:89
int cs_field_define_sub_key(const char *name, int parent_id)
Define a sub key.
Definition: cs_field.c:2731
@ CS_FIELD_INVALID_KEY_NAME
Definition: cs_field.h:92
int cs_field_key_flag(int key_id)
Get the type flag associated with a given key id.
Definition: cs_field.c:2789
cs_real_t * val_pre
Definition: cs_field.h:149
@ CS_FIELD_INVALID_TYPE
Definition: cs_field.h:95
@ CS_FIELD_INVALID_KEY_ID
Definition: cs_field.h:93
@ CS_FIELD_OK
Definition: cs_field.h:91
Field boundary condition descriptor (for variables)
Definition: cs_field.h:104
int cs_field_key_id(const char *name)
Return an id associated with a given key name.
Definition: cs_field.c:2497
Field descriptor.
Definition: cs_field.h:125
void * cs_field_get_key_struct_ptr(cs_field_t *f, int key_id)
Return a pointer to a simple structure for a given key to a field.
Definition: cs_field.c:3487
cs_real_t * bc
Definition: cs_field.h:115
int location_id
Definition: cs_field.h:134
void cs_field_key_disable_setup_log(int key_id)
Disable logging setup values associated with a given key.
Definition: cs_field.c:2813
void cs_field_set_values(cs_field_t *f, cs_real_t c)
Set current field values to the given constant.
Definition: cs_field.c:2141
void cs_field_log_key_vals(int key_id, bool log_defaults)
Print info relative to a given field key to log file.
Definition: cs_field.c:4110
void cs_field_allocate_or_map_all(void)
Allocate arrays for all defined fields based on their location.
Definition: cs_field.c:2283
const char * cs_glob_field_comp_name_9[]