/usr/include/code_saturne/cs_gui.h is in code-saturne-include 3.3.2-4.
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 | #ifndef __CS_GUI_H__
#define __CS_GUI_H__
/*============================================================================
* Management of the GUI parameters file: main parameters
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2014 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_base.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*============================================================================
* Type definitions
*============================================================================*/
/*============================================================================
* Public function prototypes for Fortran API
*============================================================================*/
/*----------------------------------------------------------------------------
* Initialise the global 'vars' structure.
*
* Fortran Interface:
*
* subroutine uiinit
* *****************
*----------------------------------------------------------------------------*/
void CS_PROCF (uiinit, UIINIT) (void);
/*----------------------------------------------------------------------------
* Thermal model.
*
* Fortran Interface:
*
* SUBROUTINE CSTHER (ITHERM)
* *****************
*
* INTEGER ITHERM --> thermal model
* integer itpscl --> temperature scale if itherm = 1
*----------------------------------------------------------------------------*/
void CS_PROCF (csther, CSTHER) (int *itherm,
int *itpscl);
/*----------------------------------------------------------------------------
* Turbulence model.
*
* Fortran Interface:
*
* SUBROUTINE CSTURB
* *****************
*
* INTEGER ITURB --> turbulence model
* INTEGER IDEUCH --> wall law treatment
* INTEGER IGRAKE --> k-eps gravity effects
* INTEGER IGRAKI --> Rij-eps gravity effects
* DOUBLE PRECISION XLOMLG --> mixing_length_scale
*----------------------------------------------------------------------------*/
void CS_PROCF (csturb, CSTURB) (int *const iturb,
int *const ideuch,
int *const igrake,
int *const igrari,
double *const xlomlg);
/*----------------------------------------------------------------------------
* Specific heat variable or constant indicator.
*
* Fortran Interface:
*
* SUBROUTINE CSCPVA
* *****************
*
* INTEGER ICP --> Specific heat variable or constant indicator
*----------------------------------------------------------------------------*/
void CS_PROCF (cscpva, CSCPVA) (int *const icp);
/*----------------------------------------------------------------------------
* Volumic viscosity variable or constant indicator.
*
* Fortran Interface:
*
* SUBROUTINE CSCVVVA (ICP)
* *****************
*
* INTEGER IVISCV --> specific heat variable or constant indicator
*----------------------------------------------------------------------------*/
void CS_PROCF (csvvva, CSVVVA) (int *const iviscv);
/*----------------------------------------------------------------------------
* User scalars number.
*
* Fortran Interface:
*
* SUBROUTINE CSNSCA
* *****************
*
* INTEGER NSCAUS --> user scalars number
*----------------------------------------------------------------------------*/
void CS_PROCF (csnsca, CSNSCA) (int *const nscaus);
/*----------------------------------------------------------------------------
* User scalars labels
*
* Fortran Interface:
*
* SUBROUTINE UISCAU
* *****************
*----------------------------------------------------------------------------*/
void CS_PROCF (uiscau, UISCAU) (void);
/*----------------------------------------------------------------------------
* User thermal scalar.
*
* Fortran Interface:
*
* SUBROUTINE UITHSC
* *****************
*
* INTEGER ISCALT --> thermal scalars number
*----------------------------------------------------------------------------*/
void CS_PROCF (uithsc, UITHSC) (int *const iscalt);
/*----------------------------------------------------------------------------
* User scalars which are variance.
*
* Fortran Interface:
*
* SUBROUTINE CSISCA (ISCAVR)
* *****************
*
* INTEGER ISCAVR --> user scalars variance array
* integer itherm <-- type of thermal model
*----------------------------------------------------------------------------*/
void CS_PROCF (csisca, CSISCA) (int *iscavr,
const int *itherm);
/*----------------------------------------------------------------------------
* Constant or variable indicator for the user scalar laminar viscosity.
*
* Fortran Interface:
*
* SUBROUTINE CSIVIS
* *****************
*
* INTEGER ISCAVR <-> number of the related variance if any
* INTEGER IVISLS --> indicator for the user scalar viscosity
* INTEGER ISCALT <-> number of the user thermal scalar if any
* INTEGER ISCSTH <-> type of the user thermal scalar
* INTEGER ITEMPK --> rtp index for temperature (in K)
*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
* Constant or variable indicator for the user scalar laminar viscosity.
*
* Fortran Interface:
*
* subroutine csivis (iscavr, ivisls, iscalt, itherm, itempk)
* *****************
*
* integer iscavr <--> number of the related variance if any
* integer ivisls <-- indicator for the user scalar viscosity
* integer iscalt <--> number of the user thermal scalar if any
* integer itherm <--> type of thermal model
* integer itempk --> rtp index for temperature (in K)
*----------------------------------------------------------------------------*/
void CS_PROCF (csivis, CSIVIS) (int *const iscavr,
int *const ivisls,
int *const iscalt,
int *const itherm,
int *const itempk);
/*----------------------------------------------------------------------------
* Time passing parameter.
*
* Fortran Interface:
*
* SUBROUTINE CSIDTV (IDTVAR)
* *****************
*
* INTEGER IDTVAR --> fixed or variable time step
*----------------------------------------------------------------------------*/
void CS_PROCF(csidtv, CSIDTV) (int *const idtvar);
/*----------------------------------------------------------------------------
* Hydrostatic pressure parameter.
*
* Fortran Interface:
*
* SUBROUTINE CSIPHY (IPHYDR)
* *****************
*
* INTEGER IPHYDR --> hydrostatic pressure
*----------------------------------------------------------------------------*/
void CS_PROCF (csiphy, CSIPHY) (int *const iphydr);
/*----------------------------------------------------------------------------
* Hydrostatic equilibrium parameter.
*
* Fortran Interface:
*
* SUBROUTINE CSCFGP (ICFGRP)
* *****************
*
* INTEGER ICFGRP --> hydrostatic equilibrium
*----------------------------------------------------------------------------*/
void CS_PROCF (cscfgp, CSCFGP) (int *const icfgrp);
/*----------------------------------------------------------------------------
* Restart parameters.
*
* Fortran Interface:
*
* SUBROUTINE CSISUI
* *****************
*
* INTEGER NTSUIT --> checkpoint frequency
* INTEGER ILEAUX --> restart with auxiliary
* INTEGER ICCFVG --> restart with frozen field
*----------------------------------------------------------------------------*/
void CS_PROCF (csisui, CSISUI) (int *const ntsuit,
int *const ileaux,
int *const iccvfg);
/*----------------------------------------------------------------------------
* Time passing parameters.
*
* Fortran Interface:
*
* SUBROUTINE CSTIME
* *****************
*
* INTEGER INPDT0 --> zero tim step
* INTEGER IPTLTO --> thermal time step control
* INTEGER NTMABS --> iterations numbers
* INTEGER IDTVAR --> time step's options
* DOUBLE PRECISION DTREF --> time step
* DOUBLE PRECISION DTMIN --> minimal time step
* DOUBLE PRECISION DTMAX --> maximal time step
* DOUBLE PRECISION COUMAX --> maximal courant number
* DOUBLE PRECISION FOUMAX --> maximal fournier number
* DOUBLE PRECISION VARRDT --> max time step variation between 2 iterations
* DOUBLE PRECISION RELXST --> relaxation coefficient if idtvar = -1
*----------------------------------------------------------------------------*/
void CS_PROCF (cstime, CSTIME) (int *const inpdt0,
int *const iptlro,
int *const ntmabs,
int *const idtvar,
double *const dtref,
double *const dtmin,
double *const dtmax,
double *const coumax,
double *const foumax,
double *const varrdt,
double *const relxst);
/*----------------------------------------------------------------------------
*
* Fortran Interface:
*
* SUBROUTINE UINUM1
* *****************
*
*----------------------------------------------------------------------------*/
void CS_PROCF (uinum1, UINUM1) (double *const blencv,
int *const ischcv,
int *const isstpc,
int *const ircflu,
double *const cdtvar,
int *const nitmax,
double *const epsilo,
int *const iresol,
int *const imgrpr,
int *const nswrsm);
/*----------------------------------------------------------------------------
* Global numerical parameters.
*
* Fortran Interface:
*
* SUBROUTINE CSNUM2
* *****************
*
* INTEGER IVISSE --> gradient transpose
* INTEGER RELAXP --> pressure relaxation
* INTEGER IPUCOU --> velocity pressure coupling
* INTEGER EXTRAG --> wall pressure extrapolation
* INTEGER IMRGRA --> gradient reconstruction
* INTEGER NTERUP --> piso sweep number
*----------------------------------------------------------------------------*/
void CS_PROCF (csnum2, CSNUM2) ( int *const ivisse,
double *const relaxp,
int *const ipucou,
double *const extrag,
int *const imrgra,
int *const nterup);
void CS_PROCF (csphys, CSPHYS) (const int *const nmodpp,
int *const irovar,
int *const ivivar,
int *const icorio,
double *const gx,
double *const gy,
double *const gz,
double *const omegax,
double *const omegay,
double *const omegaz,
double *const ro0,
double *const viscl0,
double *const viscv0,
double *const visls0,
double *const cp0,
double *const t0,
double *const p0,
double *const xmasmr,
int *const itempk,
int *const itherm,
int *const itpscl);
/*----------------------------------------------------------------------------
* User scalar min and max values for clipping.
*
* Fortran Interface:
*
* subroutine cssca2
* *****************
*
* integer iscavr <-- number of the related variance if any
*----------------------------------------------------------------------------*/
void CS_PROCF (cssca2, CSSCA2) (const int *const iscavr);
void CS_PROCF (cssca3, CSSCA3) (const int *const itherm,
const int *const iscalt,
const int *const iscavr,
double *const visls0,
double *const t0,
double *const p0,
double *const cp0);
/*----------------------------------------------------------------------------
* Array of properties used in the calculation
*----------------------------------------------------------------------------*/
void CS_PROCF (uiprop, UIPROP) (const int *const ivisls,
const int *const ismago,
const int *const iale,
const int *const icp,
const int *const iscavr);
/*----------------------------------------------------------------------------
* Temporal averaging treatment
*----------------------------------------------------------------------------*/
void CS_PROCF (uimoyt, UIMOYT) (const int *const ndgmox,
int *const ntdmom,
int *const imoold,
int *const idfmom);
/*----------------------------------------------------------------------------
* Turbulence initialization parameters.
*
* Fortran Interface:
*
* SUBROUTINE CSTINI
* *****************
*
* INTEGER UREF --> reference velocity
* INTEGER ALMAX --> reference length
*----------------------------------------------------------------------------*/
void CS_PROCF (cstini, CSTINI) (double *const uref,
double *const almax);
/*----------------------------------------------------------------------------
* Solver taking a scalar porosity into account
*
* Fortran Interface:
*
* SUBROUTINE UIIPSU
* *****************
*
* INTEGER IPOROS --> porosity
*----------------------------------------------------------------------------*/
void CS_PROCF (uiipsu, UIIPSU) (int *iporos);
/*----------------------------------------------------------------------------
* Define porosity.
*
* Fortran Interface:
*
* SUBROUTINE UIPORO
* *****************
*
* INTEGER IPOROS <-- porosity
*----------------------------------------------------------------------------*/
void CS_PROCF (uiporo, UIPORO) (const int *ncelet,
const int *iporos);
/*----------------------------------------------------------------------------
* User momentum source terms.
*
* Fortran Interface:
*
* subroutine uitsnv (ncelet, vel, tsexp, tsimp)
* *****************
*
* integer ncelet <-- number of cells with halo
* double precision vel <-- fluid velocity
* double precision tsexp --> explicit source terms
* double precision tsimp --> implicit source terms
*----------------------------------------------------------------------------*/
void CS_PROCF(uitsnv, UITSNV)(const cs_real_3_t *restrict vel,
cs_real_3_t *restrict tsexp,
cs_real_33_t *restrict tsimp);
/*----------------------------------------------------------------------------
* User scalar source terms.
*
* Fortran Interface:
*
* subroutine uitssc (f_id, pvar, tsexp, tsimp)
* *****************
*
* integer f_id <-- field id
* double precision pvar <-- scalar
* double precision tsexp --> explicit source terms
* double precision tsimp --> implicit source terms
*----------------------------------------------------------------------------*/
void CS_PROCF(uitssc, UITSSC)(const int *f_id,
const cs_real_t *restrict pvar,
cs_real_t *restrict tsexp,
cs_real_t *restrict tsimp);
/*----------------------------------------------------------------------------
* Thermal scalar source terms.
*
* Fortran Interface:
*
* subroutine uitsth (f_id, pvar, tsexp, tsimp)
* *****************
*
* integer f_id <-- field id
* double precision pvar <-- scalar
* double precision tsexp --> explicit source terms
* double precision tsimp --> implicit source terms
*----------------------------------------------------------------------------*/
void CS_PROCF(uitsth, UITSTH)(const int *f_id,
const cs_real_t *restrict pvar,
cs_real_t *restrict tsexp,
cs_real_t *restrict tsimp);
/*----------------------------------------------------------------------------
* Variables and user scalars initialization.
*
* Fortran Interface:
*
* subroutine uiiniv
* *****************
*
* integer ncelet <-- number of cells with halo
* integer isuite <-- restart indicator
* integer iccfth <-- type of initialisation(compressible model)
* double precision ro0 <-- value of density if IROVAR=0
* double precision cp0 <-- value of specific heat if ICP=0
* double precision viscl0 <-- value of viscosity if IVIVAR=0
* double precision uref <-- value of reference velocity
* double precision almax <-- value of reference length
* double precision xyzcen <-- cell's gravity center
*----------------------------------------------------------------------------*/
void CS_PROCF(uiiniv, UIINIV)(const int *ncelet,
const int *isuite,
int *iccfth,
const cs_real_t *ro0,
const cs_real_t *cp0,
const cs_real_t *viscl0,
const cs_real_t *uref,
const cs_real_t *almax,
const double *const xyzcen);
/*----------------------------------------------------------------------------
* User law for material Properties
*
* Fortran Interface:
*
* SUBROUTINE UIPHYV (NCELET, ISCA, RTP)
* *****************
*
* INTEGER NCEL <-- number of cells whithout halo
* INTEGER NCELET <-- number of cells whith halo
* INTEGER ICP <-- pointer for predifined heat Cp
* INTEGER IVISLS <-- pointer for Lambda/Cp
* INTEGER IROVAR <-- =1 if rho variable, =0 if rho constant
* INTEGER IVIVAR <-- =1 if mu variable, =0 if mu constant
* INTEGER ISCALT <-- pointer for the thermal scalar in ISCA
* INTEGER ISCAVR <-- scalars that are variance
* INTEGER IVISCV <-- pointer for volumic viscosity viscv
* INTEGER ITEMPK <-- pointer for temperature (in K)
* DOUBLE PRECISION P0 <-- pressure reference value
* DOUBLE PRECISION T0 <-- temperature reference value
* DOUBLE PRECISION RO0 <-- density reference value
* DOUBLE PRECISION CP0 <-- specific heat reference value
* DOUBLE PRECISION VISCL0 <-- dynamic viscosity reference value
* DOUBLE PRECISION VISLS0 <-- diffusion coefficient of the scalars
* DOUBLE PRECISION VISCV0 <-- volumic viscosity
*----------------------------------------------------------------------------*/
void CS_PROCF(uiphyv, UIPHYV)(const cs_int_t *ncel,
const cs_int_t *ncelet,
const cs_int_t *itherm,
const cs_int_t *icp,
const cs_int_t ivisls[],
const cs_int_t *irovar,
const cs_int_t *ivivar,
const cs_int_t *iscalt,
const cs_int_t iscavr[],
const cs_int_t *iviscv,
const cs_int_t *itempk,
const cs_real_t *p0,
const cs_real_t *t0,
const cs_real_t *ro0,
const cs_real_t *cp0,
const cs_real_t *viscl0,
const cs_real_t *visls0,
const cs_real_t *viscv0);
/*----------------------------------------------------------------------------
* Head losses definition
*
* Fortran Interface:
*
* subroutine uikpdc
* *****************
*
* integer iappel <-- number of calls during a time step
* integer ncelet <-- number of cells with halo
* integer ncepdp --> number of cells with head losses
* integer icepdc --> ncepdp cells number with head losses
* double precision ckupdc --> head losses matrix
*----------------------------------------------------------------------------*/
void CS_PROCF(uikpdc, UIKPDC)(const int* iappel,
const int* ncelet,
int* ncepdp,
int icepdc[],
double ckupdc[]);
/*----------------------------------------------------------------------------
* 1D profile postprocessing
*
* Fortran Interface:
*
* SUBROUTINE UIPROF
* *****************
*
* INTEGER NCELET <-- number of cells with halo
* INTEGER NCEL <-- number of cells without halo
* INTEGER NTMABS <-- max iterations numbers
* INTEGER NTCABS <-- current iteration number
* DOUBLE PRECISION TTCABS <-- current physical time
* DOUBLE PRECISION TTMABS <-- max physical time
* DOUBLE PRECISION TTPABS <-- physical time at calculation beginning
* DOUBLE PRECISION XYZCEN <-- cell's gravity center
*----------------------------------------------------------------------------*/
void CS_PROCF (uiprof, UIPROF)(const int *const ncelet,
const int *const ncel,
const int *const ntmabs,
const int *const ntcabs,
const double *const ttcabs,
const double *const ttmabs,
const double *const ttpabs,
const double *const xyzcen);
/*----------------------------------------------------------------------------
* Free memory: clean global private variables and libxml2 variables.
*
* Fortran Interface:
*
* SUBROUTINE MEMUI1
* *****************
*
* INTEGER NCHARB <-- number of coal
*----------------------------------------------------------------------------*/
void CS_PROCF (memui1, MEMUI1) (const int *const ncharb);
/*=============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Get thermal scalar model.
*
* return:
* value of itherm
*----------------------------------------------------------------------------*/
int
gui_thermal_model(void);
/*-----------------------------------------------------------------------------
* Get initial value from property markup.
*
* parameters:
* property_name <-- name of the property
* value --> new initial value of the property
*----------------------------------------------------------------------------*/
void
cs_gui_properties_value(const char *property_name,
double *value);
/*-----------------------------------------------------------------------------
* Initialization choice of the reference variables parameters.
*
* parameters:
* name <-- parameter name
* value --> parameter value
*----------------------------------------------------------------------------*/
void
cs_gui_reference_initialization(const char *param,
double *value);
/*-----------------------------------------------------------------------------
* Set partitioning options.
*----------------------------------------------------------------------------*/
void
cs_gui_partition(void);
/*-----------------------------------------------------------------------------
* Define parallel IO settings.
*----------------------------------------------------------------------------*/
void
cs_gui_parallel_io(void);
/*-----------------------------------------------------------------------------
* Free memory: clean global private variables and libxml2 variables
*----------------------------------------------------------------------------*/
void
cs_gui_clean_memory(void);
/*----------------------------------------------------------------------------
* Logging output for MEI usage.
*----------------------------------------------------------------------------*/
void
cs_gui_usage_log(void);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __CS_GUI_H__ */
|