src/lagr/cs_lagr_perio.h Source File

| programmer's documentation

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cs_lagr_perio.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_PERIO_H__
2 #define __CS_LAGR_PERIO_H__
3
4 /*============================================================================
5 * Management of the periodicity for particles
6 *============================================================================*/
7
8 /*
9 This file is part of Code_Saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2013 EDF S.A.
12
13 This program is free software; you can redistribute it and/or modify it under
14 the terms of the GNU General Public License as published by the Free Software
15 Foundation; either version 2 of the License, or (at your option) any later
16 version.
17
18 This program is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 details.
22
23 You should have received a copy of the GNU General Public License along with
24 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25 Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27
28 /*----------------------------------------------------------------------------*/
29
30 /*----------------------------------------------------------------------------
31 * Local headers
32 *----------------------------------------------------------------------------*/
33
34 #include "cs_base.h"
35
36 /*----------------------------------------------------------------------------*/
37
38 BEGIN_C_DECLS
39
40 /*============================================================================
41 * Public functions definition for API Fortran
42 *============================================================================*/
43
44 /*----------------------------------------------------------------------------
45 * Build buffers to keep the link between a given halo cell and :
46 * - the related real cell
47 * - the transformation id
48 *
49 * Fortran Interface :
50 *
51 * SUBROUTINE PERLOC
52 * *****************
53 *
54 * INTEGER ICELCR(NCELET-NCEL) : <- : related real cell buffer
55 * INTEGER IPERCR(NCELET-NCEL) : <- : transformation id buffer
56 *
57 * Returns:
58 *----------------------------------------------------------------------------*/
59
60 void
61 CS_PROCF (perloc, PERLOC)(cs_int_t *icelcr,
62 cs_int_t *ipercr);
63
64 /*----------------------------------------------------------------------------
65 * Apply rotation to the location of a particle.
66 *
67 * Fortran Interface :
68 *
69 * SUBROUTINE LAGPER
70 * *****************
71 *
72 * INTEGER ITRANS : -> : transformation id buffer
73 * DOUBLE PRECISION VTX_A : -> : location of vertex before transform.
74 * DOUBLE PRECISION VTX_B : <- : location of the vertex after transform.
75 *
76 * Returns:
77 *----------------------------------------------------------------------------*/
78
79 void
80 CS_PROCF (lagper, LAGPER)(const cs_int_t *itrans,
81 const cs_real_t vtx_a[],
82 cs_real_t vtx_b[]);
83
84 /*----------------------------------------------------------------------------
85 * Apply rotation on the velocity vector of a particle.
86 *
87 * Fortran Interface :
88 *
89 * SUBROUTINE LAGVEC
90 * *****************
91 *
92 * INTEGER ITRANS : -> : transformation id
93 * DOUBLE PRECISION VECTI : -> : vector before transformation
94 * DOUBLE PRECISION VECTF : <- : vector after transformation
95 *
96 * Returns:
97 *----------------------------------------------------------------------------*/
98
99 void
100 CS_PROCF (lagvec, LAGVEC)(const cs_int_t *itrans,
101 const cs_real_t vecti[],
102 cs_real_t vectf[]);
103
104 /*----------------------------------------------------------------------------*/
105
106 END_C_DECLS
107
108 #endif /* __CS_LAGR_PERIO_H__ */