/usr/share/code_saturne/user_examples/cs_user_cdo-groundwater.c is in code-saturne-data 4.3.3+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 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 | /*============================================================================
* Set main parameters for the current simulation when the CDO kernel is used
*============================================================================*/
/* Code_Saturne version 4.3.3 */
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2016 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
*----------------------------------------------------------------------------*/
#include <errno.h>
#include <locale.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <math.h>
#include <float.h>
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include <bft_mem.h>
#include <bft_printf.h>
#include "cs_mesh_location.h"
#include "cs_cdo_toolbox.h"
#include "cs_property.h"
#include "cs_advection_field.h"
/*----------------------------------------------------------------------------
* Header for the current file
*----------------------------------------------------------------------------*/
#include "cs_prototypes.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*=============================================================================
* Additional doxygen documentation
*============================================================================*/
/*----------------------------------------------------------------------------*/
/*!
* \file cs_user_cdo-groundwater.c
*
* \brief Main user subroutine for setting of a calculation with CDO for the
* groundwater flow module
*/
/*----------------------------------------------------------------------------*/
/*! \cond DOXYGEN_SHOULD_SKIP_THIS */
/*! \endcond (end ignore by Doxygen) */
/*============================================================================
* Private function prototypes
*============================================================================*/
static const double one6 = 1/6.;
static const double L = 200;
/* Solution of the TRACY 1D verification testcase
F.T. Tracy, "1D, 2D, 3D analytical solutions of unsaturated flow in
groundwater", Journal of Hydrology, 170, pp. 199--214 (1995)
*/
static void
get_sol(cs_real_t time,
const cs_real_3_t xyz,
cs_get_t *get)
{
/* Physical parameters */
const double ks = 1.15741e-4;
const double theta_r = 0.15, theta_s = 0.45, dtheta = theta_s - theta_r;
const double hr = -100;
const double td = -5*L*L*dtheta/(6*hr*ks);
/* Space-dependent part */
const double xll = (xyz[0] - L)/L, beta = xll*xll;
/* Time-dependent part */
const double alpha = 6 - 5*time/td;
(*get).val = hr*(1 - beta/alpha);
}
/* Same as get_sol but optimize for time=0 */
static void
get_ic(cs_real_t time,
const cs_real_3_t xyz,
cs_get_t *get)
{
const double x = xyz[0], xll = (x - L)/L;
const double hr = -100;
(*get).val = 1-one6*xll*xll;
(*get).val *= hr;
}
/*============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------*/
/*!
* \brief Activate or not the CDO module
*/
/*----------------------------------------------------------------------------*/
bool
cs_user_cdo_activated(void)
{
return true;
}
/*----------------------------------------------------------------------------*/
/*!
* \brief Specify additional mesh locations
*/
/*----------------------------------------------------------------------------*/
void
cs_user_cdo_add_mesh_locations(void)
{
return; /* REMOVE_LINE_FOR_USE_OF_SUBROUTINE */
/* ===========================
Define mesh locations
===========================
By default several mesh locations are predefined
>> "cells"
>> "interior_faces"
>> "boundary_faces"
>> "vertices"
*/
cs_mesh_location_add("left", CS_MESH_LOCATION_BOUNDARY_FACES, "x < 1e-3");
char cmd[20];
const double tol = 1e-5;
sprintf(cmd, "x > %10.7e", L-tol);
cs_mesh_location_add("right", CS_MESH_LOCATION_BOUNDARY_FACES, cmd);
return;
}
/*----------------------------------------------------------------------------*/
/*!
* \brief Specify for the computational domain:
* -- which type of boundaries closed the computational domain
* -- the settings for the time step
* -- activate predefined equations or modules
* -- add user-defined properties and/or advection fields
* -- add user-defined equations
*
* \param[in, out] domain pointer to a cs_domain_t structure
*/
/*----------------------------------------------------------------------------*/
void
cs_user_cdo_init_domain(cs_domain_t *domain)
{
return; /* REMOVE_LINE_FOR_USE_OF_SUBROUTINE */
/* ======================
Boundary of the domain
====================== */
/* Choose a boundary by default.
keyval is one of the following keyword: "wall" or "symmetry" */
cs_domain_set_param(domain, CS_DOMAIN_DEFAULT_BOUNDARY, "symmetry");
/* Add a boundary:
>> cs_domain_add_boundary(domain,
mesh location name,
boundary keyword)
mesh location name is either a predefined mesh location or one defined
by user
boundary keyword is one of the following keyword
>> wall, inlet, outlet, symmetry
*/
cs_domain_add_boundary(domain, "left", "inlet");
cs_domain_add_boundary(domain, "right", "outlet");
/* =========================
Generic output management
========================= */
/* Set the output frequency for log either in terms of number of iteration
>> cs_domain_set_param(domain, CS_DOMAIN_OUTPUT_NT, keyval);
keyval is for instance "10"
either in terms of simulated time
>> cs_domain_set_param(domain, CS_DOMAIN_OUTPUT_DT, keyval);
keyval is for instance "0.1" */
cs_domain_set_param(domain, CS_DOMAIN_OUTPUT_NT, "10");
/* Set the level of verbosity (a fine-grained setting is also available if
one uses the function cs_user_cdo_numerics_settings())
>> cs_domain_set_param(domain, CS_DOMAIN_VERBOSITY, keyval);
keyval is for instance "-1" --> the lowest-level of information
"0" --> reduced level of information
"1" --> standard level of information
"2" --> higher level of information */
cs_domain_set_param(domain, CS_DOMAIN_VERBOSITY, "2");
/* ====================
Time step management
==================== */
/* Set the final time of the simulation
>> cs_domain_set_param(domain, CS_DOMAIN_TMAX, keyval);
keyval is for instance "1.5"
Set the max. number of time steps
>> cs_domain_set_param(domain, CS_DOMAIN_NTMAX, keyval);
keyval is for instance "100"
If there is an inconsistency between the max. number of iteration in
time and the final physical time, the first condition encountered stops
the calculation.
*/
cs_domain_set_param(domain, CS_DOMAIN_TMAX, "864000.");
cs_domain_set_param(domain, CS_DOMAIN_NTMAX, "200");
/* Define the value of the time step
>> cs_domain_def_time_step_by_value(domain, dt_val);
>> cs_domain_def_time_step_by_func(domain, dt_func);
The second way to define the time step enable complex definitions.
dt_func must have the following prototype:
double dt_func(int nt_cur, double time_cur)
*/
cs_domain_def_time_step_by_value(domain, 4320);
/* Rk: Final time is 10 days = 864000 and dt = 0.05 day i.e 20 iters
for one day */
/* ================================
Activate groundwater flow module
================================
For the groundwater flow module:
>> cs_domain_activate_groundwater(domain,
permeability_type,
Richards_time,
n_soils,
n_tracers);
* permeability_type is one of the following keywords:
"isotropic", "orthotropic" or "anisotropic"
* Richards_time is one of the following keywords:
"steady" or "unsteady"
* n_soils should be at least equal to 1.
* Consequences of the activation of the groundwater flow module are:
- add a new equation named "Richards" along with an associated field named
"hydraulic_head". Default boundary condition is set to "zero_flux".
- define a new advection field named "darcian_flux"
- define a new property called "permeability".
- define a new property called "soil_capacity" if "unsteady" is chosen
*/
cs_domain_activate_groundwater(domain,
"isotropic", // type of permeability
"unsteady", // steady or unsteady
1, // number of soils
0); // number of tracers
/* Retrieve the groundwater flow module */
cs_groundwater_t *gw = cs_domain_get_groundwater(domain);
/* Set additional parameters related to the groundwater flow module
>> cs_groundwater_set_param(gw, key, keyval);
CS_GWKEY_GRAVITATION with "x", "-x", "z", "-z"...
CS_GWKEY_OUTPUT_MOISTURE with "true" or "false" (default)
*/
cs_groundwater_set_param(gw, CS_GWKEY_OUTPUT_MOISTURE, "true");
/* =========
Add soils
=========
>> cs_groundwater_add_soil_by_value(gw,
mesh_location_name,
model_keyword,
saturated_permeability);
- mesh_location_name is the name of the mesh location where this soil is
defined. The mesh location is related to cells. By default, "cells"
corresponds to all the cells of the mesh. Otherwise, one needs to define
new mesh locations.
- model_keyword is one of the following choices:
"saturated", "tracy" or "genutchen"
- saturated_permeability depends on the type of permeability chosen.
1 value if isotropic, 3 values if orthtropic or 9 values if anisotropic.
*/
cs_groundwater_add_soil_by_value(gw,
"cells", /* mesh location name */
"tracy", /* soil model */
"1.15741e-4"); /* saturated permeability */
/* Set additional parameters defining this soil
>> cs_groundwater_set_soil_param(gw,
mesh_location_name,
key,
keyval);
If mesh_location_name is set to NULL, all soils are set.
Available keys are:
CS_SOILKEY_SAT_MOISTURE, // Set the saturated moisture content
CS_SOILKEY_RES_MOISTURE, // Set the residual moisture content
Keys specific to the Tracy model
CS_SOILKEY_TRACY_SAT_H, // Head related to the saturated moisture content
CS_SOILKEY_TRACY_RES_H, // Head related to the residual moisture content
*/
cs_groundwater_set_soil_param(gw, "cells", CS_SOILKEY_TRACY_RES_H, "-100");
cs_groundwater_set_soil_param(gw, NULL, CS_SOILKEY_SAT_MOISTURE, "0.45");
cs_groundwater_set_soil_param(gw, NULL, CS_SOILKEY_RES_MOISTURE, "0.15");
/* ====================
Add tracer equations
====================
Add a tracer equation which is unsteady and convected by the darcean flux
>> cs_domain_add_groundwater_tracer(domain,
eqname,
varname);
This implies the creation of a new equation called eqname and a new
field called varname.
*/
/* Set parameters related to each tracer equation in each soil
>> cs_domain_set_groundwater_tracer(domain,
eqname,
mesh_location_name,
water_diff,
alpha_l,
alpha_t,
rho,
kd,
lambda);
According to the setting, additional properties can be created which are
associated to the diffusion and/or reaction terms.
If mesh_location_name is set to NULL, all soils are set.
*/
}
/*----------------------------------------------------------------------------*/
/*!
* \brief - Specify the elements such as properties, advection fields,
* user-defined equations and modules which have been previously
* added.
*
* \param[in, out] domain pointer to a cs_domain_t structure
*/
/*----------------------------------------------------------------------------*/
void
cs_user_cdo_set_domain(cs_domain_t *domain)
{
/* Retrieve the equation to set
cs_equation_t *eq = cs_domain_get_equation(domain, "eq_name");
*/
cs_equation_t *eq = NULL;
/* =================
Richards equation
================= */
eq = cs_domain_get_equation(domain, "Richards");
/* Define the boundary conditions
>> cs_equation_add_bc(eq,
"mesh_location_name",
"bc_type_keyword",
"definition_type_keyword",
pointer to the definition);
-- eq is the structure related to the equation to set
-- Keyword related to the boundary condition type is a choice among:
>> "dirichlet", "neumann" or "robin"
-- Keyword related to the type of definition is a choice among:
>> "value", "analytic"
*/
cs_equation_add_bc(eq, // equation
"left", // name of the mesh location
"dirichlet", // BC type
"analytic", // type of definition
get_sol); // pointer to the analytic function
cs_equation_add_bc(eq, // equation
"right", // name of the mesh location
"dirichlet", // BC type
"value", // type of definition
"-100"); // value to set
/* Define the initial condition (By default: zero is set) */
cs_equation_set_ic(eq, // equation
NULL, // name of the related mesh location
"analytic", // type of definition
get_ic); // pointer to the analytic function
}
/*----------------------------------------------------------------------------*/
END_C_DECLS
|