Code_Saturne
CFD tool
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
cs_join.h
Go to the documentation of this file.
1 #ifndef __CS_JOIN_H__
2 #define __CS_JOIN_H__
3 
4 /*============================================================================
5  * Structure and function headers handling with joining operation
6  *===========================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2012 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  * FVM library headers
32  *---------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *---------------------------------------------------------------------------*/
37 
38 #include "cs_base.h"
39 #include "cs_join_util.h"
40 
41 /*---------------------------------------------------------------------------*/
42 
44 
45 /*=============================================================================
46  * Local Macro definitions
47  *===========================================================================*/
48 
49 /*============================================================================
50  * Type definition
51  *===========================================================================*/
52 
53 /*=============================================================================
54  * Global variables
55  *===========================================================================*/
56 
57 /*=============================================================================
58  * Public function prototypes
59  *===========================================================================*/
60 
61 /*----------------------------------------------------------------------------
62  * Add a cs_join_t structure to the list of pending joinings.
63  *
64  * parameters:
65  * sel_criteria <-- boundary face selection criteria
66  * fraction <-- value of the fraction parameter
67  * plane <-- value of the plane parameter
68  * verbosity <-- level of verbosity required
69  * visualization <-- level of visualization required
70  *
71  * returns:
72  * number (1 to n) associated with new joining
73  *---------------------------------------------------------------------------*/
74 
75 int
76 cs_join_add(const char *sel_criteria,
77  float fraction,
78  float plane,
79  int verbosity,
80  int visualization);
81 
82 /*----------------------------------------------------------------------------
83  * Set advanced parameters for the joining algorithm.
84  *
85  * parameters:
86  * join_num <-> joining operation number
87  * mtf <-- merge tolerance coefficient
88  * pmf <-- pre-merge factor
89  * tcm <-- tolerance computation mode
90  * icm <-- intersection computation mode
91  * max_break <-- max number of equivalences to break (merge step)
92  * max_sub_faces <-- max. possible number of sub-faces by splitting a face
93  * tml <-- tree max level
94  * tmb <-- tree max boxes
95  * tmr <-- tree max ratio
96  * tmr_distrib <-- tree max ratio for distribution
97  *---------------------------------------------------------------------------*/
98 
99 void
100 cs_join_set_advanced_param(int join_num,
101  double mtf,
102  double pmf,
103  int tcm,
104  int icm,
105  int max_break,
106  int max_sub_faces,
107  int tml,
108  int tmb,
109  double tmr,
110  double tmr_distrib);
111 
112 /*----------------------------------------------------------------------------
113  * Apply all the defined joining operations.
114  *---------------------------------------------------------------------------*/
115 
116 void
117 cs_join_all(void);
118 
119 /*---------------------------------------------------------------------------*/
120 
122 
123 #endif /* __CS_JOIN_H__ */
void cs_join_set_advanced_param(int join_num, double mtf, double pmf, int tcm, int icm, int max_break, int max_sub_faces, int tml, int tmb, double tmr, double tmr_distrib)
Definition: cs_join.c:1441
#define BEGIN_C_DECLS
Definition: cs_defs.h:365
BEGIN_C_DECLS int cs_join_add(const char *sel_criteria, float fraction, float plane, int verbosity, int visualization)
Definition: cs_join.c:1397
#define END_C_DECLS
Definition: cs_defs.h:366
void cs_join_all(void)
Definition: cs_join.c:1492