~ubuntu-branches/ubuntu/precise/code-saturne/precise

« back to all changes in this revision

Viewing changes to include/base/cs_selector.h

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2011-11-24 00:00:08 UTC
  • mfrom: (6.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20111124000008-2vo99e38267942q5
Tags: 2.1.0-3
Install a missing file

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/*============================================================================
2
 
 *
3
 
 *     This file is part of the Code_Saturne Kernel, element of the
4
 
 *     Code_Saturne CFD tool.
5
 
 *
6
 
 *     Copyright (C) 1998-2009 EDF S.A., France
7
 
 *
8
 
 *     contact: saturne-support@edf.fr
9
 
 *
10
 
 *     The Code_Saturne Kernel is free software; you can redistribute it
11
 
 *     and/or modify it under the terms of the GNU General Public License
12
 
 *     as published by the Free Software Foundation; either version 2 of
13
 
 *     the License, or (at your option) any later version.
14
 
 *
15
 
 *     The Code_Saturne Kernel is distributed in the hope that it will be
16
 
 *     useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17
 
 *     of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 
 *     GNU General Public License for more details.
19
 
 *
20
 
 *     You should have received a copy of the GNU General Public License
21
 
 *     along with the Code_Saturne Kernel; if not, write to the
22
 
 *     Free Software Foundation, Inc.,
23
 
 *     51 Franklin St, Fifth Floor,
24
 
 *     Boston, MA  02110-1301  USA
25
 
 *
26
 
 *============================================================================*/
27
 
 
28
 
#ifndef __CS_SELECTOR_H__
29
 
#define __CS_SELECTOR_H__
30
 
 
31
 
/*============================================================================
32
 
 * Build selection lists for faces or cells
33
 
 *============================================================================*/
34
 
 
35
 
#include "cs_base.h"
36
 
 
37
 
/*----------------------------------------------------------------------------*/
38
 
 
39
 
BEGIN_C_DECLS
40
 
 
41
 
/*============================================================================
42
 
 * Public functions definition for Fortran API
43
 
 *============================================================================*/
44
 
 
45
 
/*----------------------------------------------------------------------------
46
 
 * Build a list of boundary faces verifying a given selection criteria.
47
 
 *----------------------------------------------------------------------------*/
48
 
 
49
 
void CS_PROCF(csgfbr, CSGFBR)
50
 
(
51
 
 const char   *const fstr,      /* <-- Fortran string */
52
 
 cs_int_t     *const len,       /* <-- String Length  */
53
 
 cs_int_t     *const n_faces,   /* --> number of faces */
54
 
 cs_int_t     *const face_list  /* --> face list  */
55
 
 CS_ARGF_SUPP_CHAINE
56
 
);
57
 
 
58
 
/*----------------------------------------------------------------------------
59
 
 * Build a list of interior faces verifying a given selection criteria.
60
 
 *----------------------------------------------------------------------------*/
61
 
 
62
 
void CS_PROCF(csgfac, CSGFAC)
63
 
(
64
 
 const char   *const fstr,      /* <-- Fortran string */
65
 
 cs_int_t     *const len,       /* <-- String Length  */
66
 
 cs_int_t     *const n_faces,   /* --> number of faces */
67
 
 cs_int_t     *const face_list  /* --> face list  */
68
 
 CS_ARGF_SUPP_CHAINE
69
 
);
70
 
 
71
 
/*----------------------------------------------------------------------------
72
 
 * Build a list of cells verifying a given selection criteria.
73
 
 *----------------------------------------------------------------------------*/
74
 
 
75
 
void CS_PROCF(csgcel, CSGCEL)
76
 
(
77
 
 const char   *const fstr,      /* <-- Fortran string */
78
 
 cs_int_t     *const len,       /* <-- String Length  */
79
 
 cs_int_t     *const n_cells,   /* --> number of cells */
80
 
 cs_int_t     *const cell_list  /* --> cell list  */
81
 
 CS_ARGF_SUPP_CHAINE
82
 
);
83
 
 
84
 
/*=============================================================================
85
 
 * Public function prototypes
86
 
 *============================================================================*/
87
 
 
88
 
/*----------------------------------------------------------------------------
89
 
 * Fill a list of boundary faces verifying a given selection criteria.
90
 
 *
91
 
 * parameters:
92
 
 *   criteria    <-- selection criteria string
93
 
 *   n_b_faces   --> number of selected interior faces
94
 
 *   b_face_list --> list of selected boundary faces
95
 
 *                   (1 to n, preallocated to cs_glob_mesh->n_b_faces)
96
 
 *----------------------------------------------------------------------------*/
97
 
 
98
 
void
99
 
cs_selector_get_b_face_list(const char  *criteria,
100
 
                            fvm_lnum_t  *n_b_faces,
101
 
                            fvm_lnum_t   b_face_list[]);
102
 
 
103
 
/*----------------------------------------------------------------------------
104
 
 * Fill a list of interior faces verifying a given selection criteria.
105
 
 *
106
 
 * parameters:
107
 
 *   criteria    <-- selection criteria string
108
 
 *   n_i_faces   --> number of selected interior faces
109
 
 *   i_face_list --> list of selected interior faces
110
 
 *                   (1 to n, preallocated to cs_glob_mesh->n_i_faces)
111
 
 *----------------------------------------------------------------------------*/
112
 
 
113
 
void
114
 
cs_selector_get_i_face_list(const char  *criteria,
115
 
                            fvm_lnum_t  *n_i_faces,
116
 
                            fvm_lnum_t   i_face_list[]);
117
 
 
118
 
/*----------------------------------------------------------------------------
119
 
 * Fill a list of cells verifying a given selection criteria.
120
 
 *
121
 
 * parameters:
122
 
 *   criteria  <-- selection criteria string
123
 
 *   n_cells   --> number of selected cells
124
 
 *   cell_list --> list of selected cells
125
 
 *                 (1 to n, preallocated to cs_glob_mesh->n_cells)
126
 
 *----------------------------------------------------------------------------*/
127
 
 
128
 
void
129
 
cs_selector_get_cell_list(const char  *criteria,
130
 
                          fvm_lnum_t  *n_cells,
131
 
                          fvm_lnum_t   cell_list[]);
132
 
 
133
 
/*----------------------------------------------------------------------------*/
134
 
 
135
 
END_C_DECLS
136
 
 
137
 
#endif /* __CS_SELECTOR_H__ */