/usr/include/code_saturne/cs_field.h is in code-saturne-include 3.2.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 | #ifndef __CS_FIELD_H__
#define __CS_FIELD_H__
/*============================================================================
* Field management.
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2013 EDF S.A.
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "cs_defs.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*=============================================================================
* Macro definitions
*============================================================================*/
/*
* Field property type
*/
#define CS_FIELD_INTENSIVE (1 << 0)
#define CS_FIELD_EXTENSIVE (1 << 1)
/* Field category */
#define CS_FIELD_VARIABLE (1 << 2)
#define CS_FIELD_PROPERTY (1 << 3)
#define CS_FIELD_POSTPROCESS (1 << 4)
#define CS_FIELD_ACCUMULATOR (1 << 5)
#define CS_FIELD_USER (1 << 6)
/*============================================================================
* Type definitions
*============================================================================*/
/* Field handling error types */
/*----------------------------*/
typedef enum {
CS_FIELD_OK,
CS_FIELD_INVALID_KEY_NAME,
CS_FIELD_INVALID_KEY_ID,
CS_FIELD_INVALID_CATEGORY,
CS_FIELD_INVALID_TYPE
} cs_field_error_type_t;
/* Field boundary condition descriptor (for variables) */
/*-----------------------------------------------------*/
typedef struct {
int location_id; /* Id of matching location */
cs_real_t *a; /* Explicit coefficient */
cs_real_t *b; /* Implicit coefficient */
cs_real_t *af; /* Explicit coefficient for flux */
cs_real_t *bf; /* Implicit coefficient for flux */
cs_real_t *ad; /* Explicit coefficient for divergence */
cs_real_t *bd; /* Implicit coefficient for divergence */
cs_real_t *ac; /* Explicit coefficient for convection */
cs_real_t *bc; /* Implicit coefficient for convection */
} cs_field_bc_coeffs_t;
/* Field descriptor */
/*------------------*/
typedef struct {
const char *name; /* Canonical name */
int id; /* Field id */
int type; /* Field type flag */
int dim; /* Field dimension */
bool interleaved; /* is field interleaved ? */
int location_id; /* Id of matching location */
int n_time_vals; /* Number of time values (1 or 2) */
cs_real_t *val; /* For each active location, pointer
to matching values array */
cs_real_t *val_pre; /* For each active location, pointer
to matching previous values array
(if n_time_vals == 2) */
cs_field_bc_coeffs_t *bc_coeffs; /* Boundary condition coefficients,
for variable type fields */
bool is_owner; /* Ownership flag for values
and boundary coefficients */
} cs_field_t;
/*----------------------------------------------------------------------------
* Function pointer for structure associated to field key
*
* parameters:
* t <-- pointer to structure
*----------------------------------------------------------------------------*/
typedef void
(cs_field_log_key_struct_t) (const void *t);
/*=============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Return the number of defined fields.
*
* returns:
* number of defined fields.
*----------------------------------------------------------------------------*/
int
cs_field_n_fields(void);
/*----------------------------------------------------------------------------
* Create a field descriptor.
*
* parameters:
* name <-- field name
* type_flag <-- mask of field property and category values
* location_id <-- id of associated location
* dim <-- field dimension (number of components)
* interleaved <-- indicate if values are interleaved
* (ignored if number of components < 2)
* has_previous <-- maintain values at the previous time step ?
*
* returns:
* pointer to new field.
*----------------------------------------------------------------------------*/
cs_field_t *
cs_field_create(const char *name,
int type_flag,
int location_id,
int dim,
bool interleaved,
bool has_previous);
/*----------------------------------------------------------------------------
* Allocate arrays for field values.
*
* parameters:
* f <-- pointer to field structure
*----------------------------------------------------------------------------*/
void
cs_field_allocate_values(cs_field_t *f);
/*----------------------------------------------------------------------------
* Map existing value arrays to field descriptor.
*
* parameters:
* f <-> pointer to field structure
* val <-- pointer to array of values
* val_pre <-- pointer to array of previous values, or NULL
*----------------------------------------------------------------------------*/
void
cs_field_map_values(cs_field_t *f,
cs_real_t *val,
cs_real_t *val_pre);
/*----------------------------------------------------------------------------
* Allocate boundary condition coefficient arrays.
*
* For fields on location CS_MESH_LOCATION_CELLS, boundary conditions
* are located on CS_MESH_LOCATION_BOUNDARY_FACES.
*
* Boundary condition coefficients are not currently supported for other
* locations (though support could be added by mapping a boundary->location
* indirection array in the cs_mesh_location_t structure).
*
* For multidimensional fields, arrays are assumed to have the same
* interleaving behavior as the field, unless components are coupled.
*
* For multidimensional fields with coupled components, interleaving
* is the norm, and implicit b and bf coefficient arrays are arrays of
* block matrices, not vectors, so the number of entries for each boundary
* face is dim*dim instead of dim.
*
* parameters:
* f <-- pointer to field structure
* have_flux_bc <-- if true, flux BC coefficients (af and bf) are added
* have_mom_bc <-- if true, div BC coefficients (ad and bd) are added
* have_conv_bc <-- if true, convection BC coefficients (ac and bc) are added
*----------------------------------------------------------------------------*/
void
cs_field_allocate_bc_coeffs(cs_field_t *f,
bool have_flux_bc,
bool have_mom_bc,
bool have_conv_bc);
/*----------------------------------------------------------------------------*/
/* Initialize boundary condition coefficients arrays.
*
* For fields on location CS_MESH_LOCATION_CELLS, boundary conditions
* are located on CS_MESH_LOCATION_BOUNDARY_FACES.
*
* Boundary condition coefficients are not currently supported for other
* locations (though support could be added by mapping a boundary->location
* indirection array in the cs_mesh_location_t structure).
*
* For multidimensional fields, arrays are assumed to have the same
* interleaving behavior as the field, unless components are coupled.
*
* For multidimensional fields with coupled components, interleaving
* is the norm, and implicit b and bf coefficient arrays are arrays of
* block matrices, not vectors, so the number of entries for each boundary
* face is dim*dim instead of dim.
*
* parameters:
* f <-> pointer to field structure
* have_flux_bc <-- if true, flux bc coefficients (af and bf)
* are initialized
* have_mom_bc <-- if true, div BC coefficients (ad and bd)
* are initialized
* have_conv_bc <-- if true, convection BC coefficients (ac and bc)
* are initialized
*----------------------------------------------------------------------------*/
void
cs_field_init_bc_coeffs(cs_field_t *f,
bool have_flux_bc,
bool have_mom_bc,
bool have_conv_bc);
/*----------------------------------------------------------------------------
* Map existing field boundary condition coefficient arrays.
*
* For fields on location CS_MESH_LOCATION_CELLS, boundary conditions
* are located on CS_MESH_LOCATION_BOUNDARY_FACES.
*
* Boundary condition coefficients are not currently supported for other
* locations (though support could be added by mapping a boundary->location
* indirection array in the cs_mesh_location_t structure).
*
* For multidimensional fields, arrays are assumed to have the same
* interleaving behavior as the field, unless components are coupled.
*
* For multidimensional fields with coupled components, interleaving
* is the norm, and implicit coefficients arrays are arrays of block matrices,
* not vectors, so the number of entris for each boundary face is
* dim*dim instead of dim.
*
* parameters:
* f <-> pointer to field structure
* a <-- explicit BC coefficients array
* b <-- implicit BC coefficients array
* af <-- explicit flux BC coefficients array, or NULL
* bf <-- implicit flux BC coefficients array, or NULL
* ad explicit div BC coefficients array, or NULL
* bd implicit div BC coefficients array, or NULL
* ac explicit convection BC coefficients array, or NULL
* bc implicit convection BC coefficients array, or NULL
*----------------------------------------------------------------------------*/
void
cs_field_map_bc_coeffs(cs_field_t *f,
cs_real_t *a,
cs_real_t *b,
cs_real_t *af,
cs_real_t *bf,
cs_real_t *ad,
cs_real_t *bd,
cs_real_t *ac,
cs_real_t *bc);
/*----------------------------------------------------------------------------
* Copy current field values to previous values if applicable.
*
* For fields with only one time value, or values not allocated yet,
* this is a no-op.
*
* parameters:
* f <-> pointer to field structure
*----------------------------------------------------------------------------*/
void
cs_field_current_to_previous(cs_field_t *f);
/*----------------------------------------------------------------------------
* Destroy all defined fields.
*----------------------------------------------------------------------------*/
void
cs_field_destroy_all(void);
/*----------------------------------------------------------------------------
* Allocate arrays for all defined fields based on their location.
*
* Location sized must thus be known.
*
* Fields that do not own their data should all have been mapped at this
* stage, and are checked.
*----------------------------------------------------------------------------*/
void
cs_field_allocate_or_map_all(void);
/*----------------------------------------------------------------------------
* Return a pointer to a field based on its id.
*
* This function requires that a field of the given id is defined.
*
* parameters:
* id <-- field id
*
* returns:
* pointer to the field structure
*----------------------------------------------------------------------------*/
cs_field_t *
cs_field_by_id(int id);
/*----------------------------------------------------------------------------
* Return a pointer to a field based on its name.
*
* This function requires that a field of the given name is defined.
*
* parameters:
* name <-- field name
*
* returns:
* pointer to the field structure
*----------------------------------------------------------------------------*/
cs_field_t *
cs_field_by_name(const char *name);
/*----------------------------------------------------------------------------
* Return a pointer to a field based on its name if present.
*
* If no field of the given name is defined, NULL is returned.
*
* parameters:
* name <-- field name
*
* returns:
* pointer to the field structure, or NULL
*----------------------------------------------------------------------------*/
cs_field_t *
cs_field_by_name_try(const char *name);
/*----------------------------------------------------------------------------
* Return the id of a defined field based on its name.
*
* If no field with the given name exists, -1 is returned.
*
* parameters:
* name <-- field name
*
* returns:
* id the field, or -1 if not found
*----------------------------------------------------------------------------*/
int
cs_field_id_by_name(const char *name);
/*----------------------------------------------------------------------------
* Return an id associated with a given key name.
*
* The key must have been defined previously.
*
* parameters:
* name <-- key name
*
* returns:
* id associated with key
*----------------------------------------------------------------------------*/
int
cs_field_key_id(const char *name);
/*----------------------------------------------------------------------------
* Return an id associated with a given key name if present.
*
* If the key has not been defined previously, -1 is returned.
*
* parameters:
* name <-- key name
*
* returns:
* id associated with key, or -1
*----------------------------------------------------------------------------*/
int
cs_field_key_id_try(const char *name);
/*----------------------------------------------------------------------------
* Define a key for an integer value by its name and return an associated id.
*
* If the key has already been defined, its previous default value is replaced
* by the current value, and its id is returned.
*
* parameters:
* name <-- key name
* default_value <-- default value associated with key
* type flag <-- mask associated with field types with which the
* key may be associated, or 0
*
* returns:
* id associated with key
*----------------------------------------------------------------------------*/
int
cs_field_define_key_int(const char *name,
int default_value,
int type_flag);
/*----------------------------------------------------------------------------
* Define a key for an floating point value by its name and return an
* associated id.
*
* If the key has already been defined, its previous default value is replaced
* by the current value, and its id is returned.
*
* parameters:
* name <-- key name
* default_value <-- default value associated with key
* type flag <-- mask associated with field types with which the
* key may be associated, or 0
*
* returns:
* id associated with key
*----------------------------------------------------------------------------*/
int
cs_field_define_key_double(const char *name,
double default_value,
int type_flag);
/*----------------------------------------------------------------------------
* Define a key for an string point value by its name and return an
* associated id.
*
* If the key has already been defined, its previous default value is replaced
* by the current value, and its id is returned.
*
* parameters:
* name <-- key name
* default_value <-- default value associated with key
* type flag <-- mask associated with field types with which the
* key may be associated, or 0
*
* returns:
* id associated with key
*----------------------------------------------------------------------------*/
int
cs_field_define_key_str(const char *name,
const char *default_value,
int type_flag);
/*----------------------------------------------------------------------------
* Define a key for a structure value by its name and return an
* associated id.
*
* If the key has already been defined, its previous default value is replaced
* by the current value, and its id is returned.
*
* parameters:
* name <-- key name
* default_value <-- pointer to default value associated with key
* log_funct <-- pointer to logging function
* size <-- sizeof structure
* type_flag <-- mask associated with field types with which
* the key may be associated, or 0
*
* returns:
* id associated with key
*----------------------------------------------------------------------------*/
int
cs_field_define_key_struct(const char *name,
const void *default_value,
cs_field_log_key_struct_t *log_func,
size_t size,
int type_flag);
/*----------------------------------------------------------------------------
* Define a sub key.
*
* The sub key is the same type as the parent key.
*
* For a given field, when querying a sub key's value and that value has not
* been set, the query will return the value of the parent key.
*
* parameters:
* name <-- key name
* parent_id <-- parent key id
*
* returns:
* id associated with key
*----------------------------------------------------------------------------*/
int
cs_field_define_sub_key(const char *name,
int parent_id);
/*----------------------------------------------------------------------------
* Destroy all defined field keys and associated values.
*----------------------------------------------------------------------------*/
void
cs_field_destroy_all_keys(void);
/*----------------------------------------------------------------------------
* Get the type flag associated with a given key id.
*
* If the key has not been defined previously, -1 is returned.
*
* parameters:
* key_id <-- id of associated key
*
* returns:
* type flag associated with key, or -1
*----------------------------------------------------------------------------*/
int
cs_field_key_flag(int key_id);
/*----------------------------------------------------------------------------
* Query if a given key has been set for a field.
*
* If the key id is not valid, or the field category is not
* compatible, a fatal error is provoked.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
*
* returns:
* true if the key has been set for this field, false otherwise
*----------------------------------------------------------------------------*/
bool
cs_field_is_key_set(const cs_field_t *f,
int key_id);
/*----------------------------------------------------------------------------
* Assign a integer value for a given key to a field.
*
* If the key id is not valid, CS_FIELD_INVALID_KEY_ID is returned.
* If the field category is not compatible with the key (as defined
* by its type flag), CS_FIELD_INVALID_CATEGORY is returned.
* If the data type does not match, CS_FIELD_INVALID_TYPE is returned.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
* value <-- value associated with key
*
* returns:
* 0 in case of success, > 1 in case of error
*----------------------------------------------------------------------------*/
int
cs_field_set_key_int(cs_field_t *f,
int key_id,
int value);
/*----------------------------------------------------------------------------
* Return a integer value for a given key associated with a field.
*
* If the key id is not valid, or the value type or field category is not
* compatible, a fatal error is provoked.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
*
* returns:
* integer value associated with the key id for this field
*----------------------------------------------------------------------------*/
int
cs_field_get_key_int(const cs_field_t *f,
int key_id);
/*----------------------------------------------------------------------------
* Assign a floating point value for a given key to a field.
*
* If the key id is not valid, CS_FIELD_INVALID_KEY_ID is returned.
* If the field category is not compatible with the key (as defined
* by its type flag), CS_FIELD_INVALID_CATEGORY is returned.
* If the data type does not match, CS_FIELD_INVALID_TYPE is returned.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
* value <-- value associated with key
*
* returns:
* 0 in case of success, > 1 in case of error
*----------------------------------------------------------------------------*/
int
cs_field_set_key_double(cs_field_t *f,
int key_id,
double value);
/*----------------------------------------------------------------------------
* Return a floating point value for a given key associated with a field.
*
* If the key id is not valid, or the value type or field category is not
* compatible, a fatal error is provoked.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
*
* returns:
* floating point value associated with the key id for this field
*----------------------------------------------------------------------------*/
double
cs_field_get_key_double(const cs_field_t *f,
int key_id);
/*----------------------------------------------------------------------------
* Assign a character string value for a given key to a field.
*
* If the key id is not valid, CS_FIELD_INVALID_KEY_ID is returned.
* If the field category is not compatible with the key (as defined
* by its type flag), CS_FIELD_INVALID_CATEGORY is returned.
* If the data type does not match, CS_FIELD_INVALID_TYPE is returned.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
* str <-- string associated with key
*
* returns:
* 0 in case of success, > 1 in case of error
*----------------------------------------------------------------------------*/
int
cs_field_set_key_str(cs_field_t *f,
int key_id,
const char *str);
/*----------------------------------------------------------------------------
* Return a string for a given key associated with a field.
*
* If the key id is not valid, or the value type or field category is not
* compatible, a fatal error is provoked.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
*
* returns:
* pointer to character string associated with the key id for this field
*----------------------------------------------------------------------------*/
const char *
cs_field_get_key_str(const cs_field_t *f,
int key_id);
/*----------------------------------------------------------------------------
* Assign a simple structure for a given key to a field.
*
* If the key id is not valid, CS_FIELD_INVALID_KEY_ID is returned.
* If the field category is not compatible with the key (as defined
* by its type flag), CS_FIELD_INVALID_CATEGORY is returned.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
* s <-- structure associated with key
*
* returns:
* 0 in case of success, > 1 in case of error
*----------------------------------------------------------------------------*/
int
cs_field_set_key_struct(cs_field_t *f,
int key_id,
void *s);
/*----------------------------------------------------------------------------
* Return a structure for a given key associated with a field.
*
* If the key id is not valid, or the value type or field category is not
* compatible, a fatal error is provoked.
*
* parameters:
* f <-- pointer to field structure
* key_id <-- id of associated key
* s <-- structure associated with key
*
* returns:
* pointer to structure associated with the key id for this field
* (same as s)
*----------------------------------------------------------------------------*/
const void *
cs_field_get_key_struct(const cs_field_t *f,
int key_id,
void *s);
/*----------------------------------------------------------------------------
* Print info relative to all field definitions to log file.
*----------------------------------------------------------------------------*/
void
cs_field_log_defs(void);
/*----------------------------------------------------------------------------
* Print info relative to a given field to log file.
*
* parameters:
* f <-- pointer to field structure
* log_keywords <-- log level for keywords (0: do not log,
* 1: log non-default values, 2: log all)
*----------------------------------------------------------------------------*/
void
cs_field_log_info(const cs_field_t *f,
int log_keywords);
/*----------------------------------------------------------------------------
* Print info relative to all defined fields to log file.
*
* parameters:
* log_keywords <-- log level for keywords (0: do not log,
* 1: log non-default values, 2: log all)
*----------------------------------------------------------------------------*/
void
cs_field_log_fields(int log_keywords);
/*----------------------------------------------------------------------------
* Print info relative to all key definitions to log file.
*----------------------------------------------------------------------------*/
void
cs_field_log_key_defs(void);
/*----------------------------------------------------------------------------
* Print info relative to a given field key to log file.
*
* parameters:
* int key_id <-- id of associated key
* log_defaults <-- if true, log default field values in addition to
* defined field values
*----------------------------------------------------------------------------*/
void
cs_field_log_key_vals(int key_id,
bool log_defaults);
/*----------------------------------------------------------------------------
* Print info relative to all given field keys to log file.
*
* parameters:
* log_defaults <-- if true, log default field values in addition to
* defined field values
*----------------------------------------------------------------------------*/
void
cs_field_log_all_key_vals(bool log_defaults);
/*----------------------------------------------------------------------------
* Define base keys.
*
* Keys defined by this function are:
* "label" (string)
* "log" (integer)
* "post_vis" (integer)
* "post_probes" (integer)
* "coupled" (integer, restricted to CS_FIELD_VARIABLE)
* "moment_dt" (integer, restricted to CS_FIELD_PROPERTY);
*
* A recommened practice for different submodules would be to use
* "cs_<module>_key_init() functions to define keys specific to those modules.
*----------------------------------------------------------------------------*/
void
cs_field_define_keys_base(void);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __CS_FIELD_H__ */
|