/usr/share/code_saturne/user/cs_user_coupling.c is in code-saturne-data 4.2.0+repack-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 | /*============================================================================
* Code couplings definition with SYRTHES and Code_Saturne.
*
* 1) Define conjuguate heat transfer couplings with the SYRTHES code
* 2) Define couplings with other instances of Code_Saturne
*============================================================================*/
/* Code_Saturne version 4.2.0 */
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2015 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.
*/
/*----------------------------------------------------------------------------*/
#include "cs_defs.h"
/*----------------------------------------------------------------------------
* Standard C library headers
*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
* PLE library headers
*----------------------------------------------------------------------------*/
#include <ple_coupling.h>
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "cs_base.h"
#include "cs_coupling.h"
#include "cs_sat_coupling.h"
#include "cs_syr_coupling.h"
/*----------------------------------------------------------------------------
* Header for the current file
*----------------------------------------------------------------------------*/
#include "cs_prototypes.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*============================================================================
* User function definitions
*============================================================================*/
/*----------------------------------------------------------------------------
* Define global options for couplings.
*
* These options allow defining the time step synchronization policy,
* as well as a time step multiplier.
*----------------------------------------------------------------------------*/
void
cs_user_coupling(void)
{
/*-------------------------------------------------------------------------
* Example for time step multiplier for external couplings.
*
* The apparent time step for the current instance times (as viewed by
* coupled codes) is equal to the true time step times this multiplier.
*
* When coupling with SYRTHES, it is recommended to use the same multiplier
* here as for the thermal variable time step (this is not automated,
* to allow for more advanced combinations if necessary, so the user
* should ensure this when using a time step multiplier).
*-------------------------------------------------------------------------*/
if (false)
cs_coupling_set_ts_multiplier(10.);
}
/*----------------------------------------------------------------------------
* Define couplings with SYRTHES code.
*
* This is done by calling the cs_syr_coupling_define() function for each
* coupling to add.
*
* The arguments to cs_syr_coupling_define are:
* syrthes_name <-- matching SYRTHES application name
* boundary_criteria <-- surface selection criteria
* volume _criteria <-- volume selection criteria
* projection_axis <-- ' ' : standard 3D coupling
* 'x', 'y', or 'z': projection axis for coupling
* with 2D SYRTHES.
* allow_nonmatching <-- if true, allow extending search to match
* faces beyond mapping tolerance distance (useful
* when meshes have a different level of detail)
* tolerance <-- addition to local extents of each element
* extent = base_extent * (1 + tolerance)
* verbosity <-- verbosity level
* plot <-- visualization level
*
* In the case of a single Code_Saturne and single SYRTHES instance, the
* 'syrthes_name' argument is ignored, as there is only one matching
* possibility.
*
* In case of multiple couplings, a coupling will be matched with available
* SYRTHES instances based on the 'syrthes_name' argument.
*----------------------------------------------------------------------------*/
void
cs_user_syrthes_coupling(void)
{
int verbosity = 1, plot = 1;
float tolerance = 0.1;
bool allow_nonmatching = false;
/*-------------------------------------------------------------------------
* Example 1:
*
* Boundary faces of group '3' coupled with instance named 'SYRTHES_01'.
*-------------------------------------------------------------------------*/
if (false)
cs_syr_coupling_define("SYRTHES_01",
"3", /* boundary criteria */
NULL, /* volume_criteria */
' ', /* projection_axis */
allow_nonmatching,
tolerance,
verbosity,
plot);
/*-------------------------------------------------------------------------
* Example 2:
*
* Boundary faces of group 'Wall' coupled with 2D SYRTHES instance
* named 'SYRTHES_02'.
*-------------------------------------------------------------------------*/
if (false)
cs_syr_coupling_define("SYRTHES_02",
"Wall", /* boundary criteria */
NULL, /* volume_criteria */
'z', /* projection_axis */
allow_nonmatching,
tolerance,
verbosity,
plot);
/*-------------------------------------------------------------------------
* Example 3:
*
* Cells in box with corners (0, 0, 0) and (1, 1, 1) coupled with
* SYRTHES instance named 'Solid' (volume coupling).
*-------------------------------------------------------------------------*/
if (false)
cs_syr_coupling_define("Solid",
NULL, /* boundary */
"box[0., 0., 0., 1., 1., 1.]", /* volume */
' ', /* projection */
allow_nonmatching,
tolerance,
verbosity,
plot);
/* By default, conservativity forcing flag is switched off (value 0)
If one wants to switch on the conservativity forcing flag:
cs_syr_coupling_set_conservativity(1);
*/
/* Only for a volume coupling:
By default, implicit treatment is done. You can switch to
an explicit treatment by using the following function:
cs_syr_coupling_set_explicit_treatment();
*/
}
/*----------------------------------------------------------------------------
* Define couplings with other instances of Code_Saturne.
*
* This is done by calling the cs_sat_coupling_define() function for each
* coupling to add.
*
* The arguments to cs_sat_coupling_define are:
* saturne_name <-- matching Code_Saturne application name
* boundary_cpl_criteria <-- boundary face selection criteria for coupled
* faces
* volume_cpl_criteria <-- cell selection criteria for coupled cells
* boundary_sup_criteria <-- boundary face selection criteria for support
* (not functional)
* volume_sup_criteria <-- cell selection criteria for support
* verbosity <-- verbosity level
*
* In the case of only 2 Code_Saturne instances, the 'saturne_name' argument
* is ignored, as there is only one matching possibility.
*
* In case of multiple couplings, a coupling will be matched with available
* Code_Saturne instances based on the 'saturne_name' argument.
*----------------------------------------------------------------------------*/
void
cs_user_saturne_coupling(void)
{
int verbosity = 1;
/*-------------------------------------------------------------------------
* Example 1: coupling with instance "SATURNE_01".
*
* - coupled faces of groups "3" or "4"
* - all cells available as location support
*-------------------------------------------------------------------------*/
if (false)
cs_sat_coupling_define("SATURNE_01",
"3 or 4",
NULL,
NULL,
"all[]",
verbosity);
/*-------------------------------------------------------------------------
* Example 2: coupling with instance "SATURNE_03".
*
* - coupled faces of groups "coupled_faces"
* - coupled cells (every cell overlapping the distant mesh)
* - all cells available as location support
*-------------------------------------------------------------------------*/
if (false)
cs_sat_coupling_define("SATURNE_03",
"coupled_faces",
"all[]",
NULL,
"all[]",
verbosity);
}
END_C_DECLS
|