/usr/share/code_saturne/user_examples/cs_user_mass_source_terms.f90 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 | !-------------------------------------------------------------------------------
! Code_Saturne version 4.0-alpha
! --------------------------
! 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.
!-------------------------------------------------------------------------------
!===============================================================================
! Purpose:
! -------
!> \file cs_user_mass_source_terms.f90
!>
!> \brief Mass source term example.
!>
!> See \subpage cs_user_mass_source_terms for examples.
!>
!-------------------------------------------------------------------------------
!> Arguments
!______________________________________________________________________________.
! mode name role
!______________________________________________________________________________!
!> \param[in] nvar total number of variables
!> \param[in] nscal total number of scalars
!> \param[in] ncepdp number of cells with head loss terms
!> \param[in] ncesmp number of cells with mass source terms
!> \param[in] iappel indicates which at which stage the routine is
!> is called
!> \param[in] icepdc index number of cells with head loss terms
!> (usable only for iappel > 1)
!> \param[in,out] icetsm index number of cells with mass source terms
!> \param[in,out] itypsm type of mass source term for each variable
!> (see uttsma.f90)
!> \param[in] izctsm cells zone for mass source terms definition
!> \param[in] dt time step (per cell)
!> \param[in] ckupdc head loss coefficient
!> \param[in,out] smacel value associated to each variable in the mass
!> source terms or mass rate
!______________________________________________________________________________!
subroutine cs_user_mass_source_terms &
( nvar , nscal , ncepdp , &
ncesmp , iappel , &
icepdc , icetsm , itypsm , izctsm , &
dt , &
ckupdc , smacel )
!===============================================================================
! Module files
!===============================================================================
use paramx
use numvar
use entsor
use optcal
use cstphy
use cstnum
use parall
use period
use mesh
!===============================================================================
implicit none
! Arguments
integer nvar , nscal
integer ncepdp , ncesmp
integer iappel
integer icepdc(*)
integer icetsm(ncesmp), itypsm(ncesmp,nvar)
integer izctsm(ncel)
double precision dt(ncelet)
double precision ckupdc(ncepdp,6)
double precision smacel(ncesmp,nvar)
!< [loc_var]
! Local variables
integer ieltsm
integer ifac, ii
integer ilelt, nlelt
integer izone
double precision wind, wind2
double precision dh, ustar2
double precision xkent, xeent
double precision flucel
double precision vtot , gamma
integer, allocatable, dimension(:) :: lstelt
!< [loc_var]
!===============================================================================
!< [allocate]
! Allocate a temporary array for cells selection
allocate(lstelt(ncel))
!< [allocate]
!< [one_or_two]
if (iappel.eq.1.or.iappel.eq.2) then
!< [one_or_two]
!===============================================================================
! 1. One or two calls
! First call:
!
! iappel = 1: ncesmp: calculation of the number of cells with
! mass source term
! Second call (if ncesmp>0):
! iappel = 2: icetsm: index number of cells with mass source terms
! WARNINGS
! ========
! Do not use smacel in this section (it is set on the third call, iappel=3)
! Do not use icetsm in this section on the first call (iappel=1)
! This section (iappel=1 or 2) is only accessed at the beginning of a
! calculation. Should the localization of the mass source terms evolve
! in time, the user must identify at the beginning all cells that can
! potentially become a mass source term.
!===============================================================================
! 1.1 To be completed by the user: cell selection
! -----------------------------------------------
! Example 1: No mass source term (default)
!< [example_1_1]
ieltsm = 0
!< [example_1_1]
! Example 2 : Mass source term one in the cells that
! have a boundary face of color 3 and the cells
! with a coordinate X between 2.5 and 5.
!
! In this test in two parts, one mut pay attention not to count
! the cells twice (a cell with a boundary face of color 3 can
! also have a coordinate X between 2.5 and 5).
! One should also pay attention that, on the first call, the
! array icetsm doesn't exist yet. It mustn't be used outside
! of tests (iappel.eq.2).
!< [example_1_2]
izone = 0
ieltsm = 0
! Cells with coordinate X between 2.5 and 5.
call getcel('X > 2.5 and X < 5.0',nlelt,lstelt)
izone = izone + 1
do ilelt = 1, nlelt
ii = lstelt(ilelt)
izctsm(ii) = izone
ieltsm = ieltsm + 1
if (iappel.eq.2) icetsm(ieltsm) = ii
enddo
! Cells with a boundary face of color 3
call getfbr('3',nlelt,lstelt)
izone = izone + 1
do ilelt = 1, nlelt
ifac = lstelt(ilelt)
ii = ifabor(ifac)
! The cells that have already been counted above are not
! counted again.
if (.not.(xyzcen(1,ii).lt.500.d0.and. &
xyzcen(1,ii).gt.250.d0) )then
ieltsm = ieltsm + 1
izctsm(ii) = izone
if (iappel.eq.2) icetsm(ieltsm) = ii
endif
enddo
!< [example_1_2]
! 1.2 Generic subsection: do not modify
! -------------------------------------
! --- For iappel = 1,
! Specification of ncesmp. This block is valid for both examples.
!< [generic_sub]
if (iappel.eq.1) then
ncesmp = ieltsm
endif
!< [generic_sub]
!-------------------------------------------------------------------------------
!< [call_3]
elseif (iappel.eq.3) then
!< [call_3]
!===============================================================================
! 2. For ncesmp > 0 , third call
! iappel = 3 : itypsm : type of mass source term
! smacel : mass source term
! Remark
! ======
! If itypsm(ieltsm,ivar) is set to 1, smacel(ieltsm,ivar) must be set.
!===============================================================================
! 2.1 To be completed by the user: itypsm and smacel
! --------------------------------------------------
! Example 1: simulation of an inlet condition by mass source terms
! and printing of the total mass rate.
!< [example_2_1]
wind = 0.1d0
wind2 = wind**2
dh = 0.5d0
!< [example_2_1]
! Calculation of the inlet conditions for k and epsilon with standard
! laws in a circular pipe.
!< [inlet_cal]
ustar2 = 0.d0
xkent = epzero
xeent = epzero
call keendb &
!==========
( wind2, dh, ro0, viscl0, cmu, xkappa, &
ustar2, xkent, xeent )
flucel = 0.d0
do ieltsm = 1, ncesmp
smacel(ieltsm,ipr) = 30000.d0
itypsm(ieltsm,iv) = 1
smacel(ieltsm,iv) = wind
if (itytur.eq.2) then
itypsm(ieltsm,ik) = 1
smacel(ieltsm,ik) = xkent
itypsm(ieltsm,iep) = 1
smacel(ieltsm,iep) = xeent
else if (itytur.eq.3) then
itypsm(ieltsm,ir11) = 1
itypsm(ieltsm,ir12) = 1
itypsm(ieltsm,ir13) = 1
itypsm(ieltsm,ir22) = 1
itypsm(ieltsm,ir23) = 1
itypsm(ieltsm,ir33) = 1
smacel(ieltsm,ir11) = 2.d0/3.d0*xkent
smacel(ieltsm,ir12) = 0.d0
smacel(ieltsm,ir13) = 0.d0
smacel(ieltsm,ir22) = 2.d0/3.d0*xkent
smacel(ieltsm,ir23) = 0.d0
smacel(ieltsm,ir33) = 2.d0/3.d0*xkent
itypsm(ieltsm,iep) = 1
smacel(ieltsm,iep) = xeent
else if (iturb.eq.50) then
itypsm(ieltsm,ik) = 1
smacel(ieltsm,ik) = xkent
itypsm(ieltsm,iep) = 1
smacel(ieltsm,iep) = xeent
itypsm(ieltsm,iphi) = 1
smacel(ieltsm,iphi) = 2.d0/3.d0
! There is no mass source term in the equation for f_bar
else if (iturb.eq.60) then
itypsm(ieltsm,ik) = 1
smacel(ieltsm,ik) = xkent
itypsm(ieltsm,iomg)= 1
smacel(ieltsm,iomg)= xeent/cmu/xkent
endif
if (nscal.gt.0) then
do ii = 1, nscal
itypsm(ieltsm,isca(ii)) = 1
smacel(ieltsm,isca(ii)) = 1.d0
enddo
endif
flucel = flucel+ &
volume(icetsm(ieltsm))*smacel(ieltsm,ipr)
enddo
if (irangp.ge.0) then
call parsom (flucel)
endif
if (iwarni(ipr).ge.1) then
write(nfecra,1000) flucel
endif
!< [inlet_cal]
!-------------------------------------------------------------------------------
! Example 2 : simulation of a suction (by a pump for instance) with a
! total rate of 80 000 kg/s.
! The suction rate is supposed to be uniformly distributed
! on all the cells selected above.
! Calculation of the total volume of the area where the mass source
! term is imposed (the case of parallel computing is taken into
! account with the call to parsom).
!< [calcul_total]
vtot = 0.d0
do ieltsm = 1, ncesmp
vtot = vtot + volume(icetsm(ieltsm))
enddo
if (irangp.ge.0) then
call parsom (vtot)
endif
!< [calcul_total]
! The mass suction rate is gamma = -80000/vtot (in kg/m3/s)
! It is set below, with a test for cases where vtot=0. The total
! mass rate is calculated for verification.
!< [mass_suction]
if (vtot.gt.0.d0) then
gamma = -80000.d0/vtot
else
write(nfecra,9000) vtot
call csexit (1)
endif
flucel = 0.d0
do ieltsm = 1, ncesmp
smacel(ieltsm,ipr) = gamma
flucel = flucel+ &
volume(icetsm(ieltsm))*smacel(ieltsm,ipr)
enddo
if (irangp.ge.0) then
call parsom (flucel)
endif
if (iwarni(ipr).ge.1) then
write(nfecra,2000) flucel, vtot
endif
!< [mass_suction]
!-------------------------------------------------------------------------------
!< [end_call_3]
endif
!< [end_call_3]
!--------
! Formats
!--------
!< [format]
1000 format(/,'Mass rate generated in the domain: ',E14.5,/)
2000 format(/,'Mass flux rate generated in the domain: ',E14.5,/, &
' distributed on the volume: ',E14.5)
9000 format(/,'Error in cs_user_mass_source_terms',/, &
' the volume of the mass suction area is = ',E14.5,/)
!< [format]
!----
! End
!----
!< [deallocate]
! Deallocate the temporary array
deallocate(lstelt)
return
end subroutine cs_user_mass_source_terms
!< [deallocate]
|