MPI-AMRVAC 3.2
The MPI - Adaptive Mesh Refinement - Versatile Advection Code (development version)
Loading...
Searching...
No Matches
mod_hd_phys.t
Go to the documentation of this file.
1!> Hydrodynamics physics module
7 use mod_comm_lib, only: mpistop
8 implicit none
9 private
10
11 !> Whether an energy equation is used
12 logical, public, protected :: hd_energy = .true.
13
14 !> Whether thermal conduction is added
15 logical, public, protected :: hd_thermal_conduction = .false.
16 type(tc_fluid), allocatable, public :: tc_fl
17 type(te_fluid), allocatable, public :: te_fl_hd
18
19 !> Whether radiative cooling is added
20 logical, public, protected :: hd_radiative_cooling = .false.
21 type(rc_fluid), allocatable, public :: rc_fl
22
23 !> Whether dust is added
24 logical, public, protected :: hd_dust = .false.
25
26 !> Whether viscosity is added
27 logical, public, protected :: hd_viscosity = .false.
28
29 !> Whether gravity is added
30 logical, public, protected :: hd_gravity = .false.
31
32 !> Whether particles module is added
33 logical, public, protected :: hd_particles = .false.
34
35 !> Whether rotating frame is activated
36 logical, public, protected :: hd_rotating_frame = .false.
37
38 !> Whether CAK radiation line force is activated
39 logical, public, protected :: hd_cak_force = .false.
40
41 !> Number of tracer species
42 integer, public, protected :: hd_n_tracer = 0
43
44 !> Whether plasma is partially ionized
45 logical, public, protected :: hd_partial_ionization = .false.
46
47 !> Index of the density (in the w array)
48 integer, public, protected :: rho_
49
50 !> Indices of the momentum density
51 integer, allocatable, public, protected :: mom(:)
52
53 !> Indices of the momentum density for the form of better vectorization
54 integer, public, protected :: ^c&m^C_
55
56 !> Indices of the tracers
57 integer, allocatable, public, protected :: tracer(:)
58
59 !> Index of the energy density (-1 if not present)
60 integer, public, protected :: e_
61
62 !> Index of the gas pressure (-1 if not present) should equal e_
63 integer, public, protected :: p_
64
65 !> Indices of temperature
66 integer, public, protected :: te_
67
68 !> Index of the cutoff temperature for the TRAC method
69 integer, public, protected :: tcoff_
70
71 !> The adiabatic index
72 double precision, public :: hd_gamma = 5.d0/3.0d0
73
74 !> gamma minus one and its inverse
75 double precision :: gamma_1, inv_gamma_1
76
77 !> The adiabatic constant
78 double precision, public :: hd_adiab = 1.0d0
79
80 !> The small_est allowed energy
81 double precision, protected :: small_e
82
83 !> Whether TRAC method is used
84 logical, public, protected :: hd_trac = .false.
85 integer, public, protected :: hd_trac_type = 1
86
87 !> Helium abundance over Hydrogen
88 double precision, public, protected :: he_abundance=0.1d0
89 !> Ionization fraction of H
90 !> H_ion_fr = H+/(H+ + H)
91 double precision, public, protected :: h_ion_fr=1d0
92 !> Ionization fraction of He
93 !> He_ion_fr = (He2+ + He+)/(He2+ + He+ + He)
94 double precision, public, protected :: he_ion_fr=1d0
95 !> Ratio of number He2+ / number He+ + He2+
96 !> He_ion_fr2 = He2+/(He2+ + He+)
97 double precision, public, protected :: he_ion_fr2=1d0
98 ! used for eq of state when it is not defined by units,
99 ! the units do not contain terms related to ionization fraction
100 ! and it is p = RR * rho * T
101 double precision, public, protected :: rr=1d0
102 ! remove the below flag and assume default value = .false.
103 ! when eq state properly implemented everywhere
104 ! and not anymore through units
105 logical, public, protected :: eq_state_units = .true.
106
107 procedure(sub_get_pthermal), pointer :: hd_get_rfactor => null()
108 ! Public methods
109 public :: hd_phys_init
110 public :: hd_kin_en
111 public :: hd_get_pthermal
112 public :: hd_get_csound2
113 public :: hd_to_conserved
114 public :: hd_to_primitive
115 public :: hd_check_params
116 public :: hd_check_w
117 public :: hd_e_to_ei
118 public :: hd_ei_to_e
119
120contains
121
122 !> Read this module's parameters from a file
123 subroutine hd_read_params(files)
125 character(len=*), intent(in) :: files(:)
126 integer :: n
127
128 namelist /hd_list/ hd_energy, hd_n_tracer, hd_gamma, hd_adiab, &
133
134 do n = 1, size(files)
135 open(unitpar, file=trim(files(n)), status="old")
136 read(unitpar, hd_list, end=111)
137111 close(unitpar)
138 end do
139
140 end subroutine hd_read_params
141
142 !> Write this module's parameters to a snapsoht
143 subroutine hd_write_info(fh)
145 integer, intent(in) :: fh
146 integer, parameter :: n_par = 1
147 double precision :: values(n_par)
148 character(len=name_len) :: names(n_par)
149 integer, dimension(MPI_STATUS_SIZE) :: st
150 integer :: er
151
152 call mpi_file_write(fh, n_par, 1, mpi_integer, st, er)
153
154 names(1) = "gamma"
155 values(1) = hd_gamma
156 call mpi_file_write(fh, values, n_par, mpi_double_precision, st, er)
157 call mpi_file_write(fh, names, n_par * name_len, mpi_character, st, er)
158 end subroutine hd_write_info
159
160 !> Initialize the module
161 subroutine hd_phys_init()
165 use mod_dust, only: dust_init
167 use mod_gravity, only: gravity_init
170 use mod_cak_force, only: cak_init
175
176 integer :: itr, idir
177
178 call hd_read_params(par_files)
179
180 physics_type = "hd"
181 phys_energy = hd_energy
182 phys_total_energy = hd_energy
183 phys_internal_e = .false.
184 phys_gamma = hd_gamma
185 phys_partial_ionization=hd_partial_ionization
186
188 if(phys_trac) then
189 if(ndim .eq. 1) then
190 if(hd_trac_type .gt. 2) then
192 if(mype==0) write(*,*) 'WARNING: set hd_trac_type=1'
193 end if
195 else
196 phys_trac=.false.
197 if(mype==0) write(*,*) 'WARNING: set hd_trac=F when ndim>=2'
198 end if
199 end if
200
201 ! set default gamma for polytropic/isothermal process
202 if(.not.hd_energy) then
203 if(hd_thermal_conduction) then
205 if(mype==0) write(*,*) 'WARNING: set hd_thermal_conduction=F when hd_energy=F'
206 end if
207 if(hd_radiative_cooling) then
209 if(mype==0) write(*,*) 'WARNING: set hd_radiative_cooling=F when hd_energy=F'
210 end if
211 end if
212 if(.not.eq_state_units) then
213 if(hd_partial_ionization) then
215 if(mype==0) write(*,*) 'WARNING: set hd_partial_ionization=F when eq_state_units=F'
216 end if
217 end if
219
220 allocate(start_indices(number_species),stop_indices(number_species))
221
222 ! set the index of the first flux variable for species 1
223 start_indices(1)=1
224 ! Determine flux variables
225 rho_ = var_set_rho()
226
227 allocate(mom(ndir))
228 mom(:) = var_set_momentum(ndir)
229 m^c_=mom(^c);
230
231 ! Set index of energy variable
232 if (hd_energy) then
233 e_ = var_set_energy()
234 p_ = e_
235 else
236 e_ = -1
237 p_ = -1
238 end if
239
240 phys_get_dt => hd_get_dt
241 phys_get_cmax => hd_get_cmax
242 phys_get_a2max => hd_get_a2max
243 phys_get_tcutoff => hd_get_tcutoff
244 phys_get_cbounds => hd_get_cbounds
245 phys_get_flux => hd_get_flux
246 phys_add_source_geom => hd_add_source_geom
247 phys_add_source => hd_add_source
248 phys_to_conserved => hd_to_conserved
249 phys_to_primitive => hd_to_primitive
250 phys_check_params => hd_check_params
251 phys_check_w => hd_check_w
252 phys_get_pthermal => hd_get_pthermal
253 phys_get_v => hd_get_v
254 phys_get_rho => hd_get_rho
255 phys_write_info => hd_write_info
256 phys_handle_small_values => hd_handle_small_values
257
258 ! derive units from basic units
259 call hd_physical_units()
260
261 if (hd_dust) then
262 call dust_init(rho_, mom(:), e_)
263 endif
264
265 allocate(tracer(hd_n_tracer))
266
267 ! Set starting index of tracers
268 do itr = 1, hd_n_tracer
269 tracer(itr) = var_set_fluxvar("trc", "trp", itr, need_bc=.false.)
270 end do
271
272 ! set number of variables which need update ghostcells
273 nwgc=nwflux+nwaux
274
275 ! set the index of the last flux variable for species 1
276 stop_indices(1)=nwflux
277
278 ! set temperature as an auxiliary variable to get ionization degree
279 if(hd_partial_ionization) then
280 te_ = var_set_auxvar('Te','Te')
281 else
282 te_ = -1
283 end if
284
285 if(hd_trac) then
286 tcoff_ = var_set_wextra()
287 iw_tcoff=tcoff_
288 else
289 tcoff_ = -1
290 end if
291
292 ! choose Rfactor in ideal gas law
293 if(hd_partial_ionization) then
294 hd_get_rfactor=>rfactor_from_temperature_ionization
295 phys_update_temperature => hd_update_temperature
296 else if(associated(usr_rfactor)) then
297 hd_get_rfactor=>usr_rfactor
298 else
299 hd_get_rfactor=>rfactor_from_constant_ionization
300 end if
301
302 ! initialize thermal conduction module
303 if (hd_thermal_conduction) then
304 if (.not. hd_energy) &
305 call mpistop("thermal conduction needs hd_energy=T")
306
307 call sts_init()
309
310 allocate(tc_fl)
311 call tc_get_hd_params(tc_fl,tc_params_read_hd)
312 call add_sts_method(hd_get_tc_dt_hd,hd_sts_set_source_tc_hd,e_,1,e_,1,.false.)
314 call set_error_handling_to_head(hd_tc_handle_small_e)
315 tc_fl%get_temperature_from_conserved => hd_get_temperature_from_etot
316 tc_fl%get_temperature_from_eint => hd_get_temperature_from_eint
317 tc_fl%get_rho => hd_get_rho
318 tc_fl%e_ = e_
319 end if
320
321 ! Initialize radiative cooling module
322 if (hd_radiative_cooling) then
323 if (.not. hd_energy) &
324 call mpistop("radiative cooling needs hd_energy=T")
326 allocate(rc_fl)
327 call radiative_cooling_init(rc_fl,rc_params_read)
328 rc_fl%get_rho => hd_get_rho
329 rc_fl%get_pthermal => hd_get_pthermal
330 rc_fl%get_var_Rfactor => hd_get_rfactor
331 rc_fl%e_ = e_
332 rc_fl%Tcoff_ = tcoff_
333 end if
334 allocate(te_fl_hd)
335 te_fl_hd%get_rho=> hd_get_rho
336 te_fl_hd%get_pthermal=> hd_get_pthermal
337 te_fl_hd%get_var_Rfactor => hd_get_rfactor
338{^ifthreed
339 phys_te_images => hd_te_images
340}
341 ! Initialize viscosity module
342 if (hd_viscosity) call viscosity_init(phys_wider_stencil)
343
344 ! Initialize gravity module
345 if (hd_gravity) call gravity_init()
346
347 ! Initialize rotating_frame module
349
350 ! Initialize CAK radiation force module
352
353 ! Initialize particles module
354 if (hd_particles) then
355 call particles_init()
356 end if
357
358 ! Check whether custom flux types have been defined
359 if (.not. allocated(flux_type)) then
360 allocate(flux_type(ndir, nw))
361 flux_type = flux_default
362 else if (any(shape(flux_type) /= [ndir, nw])) then
363 call mpistop("phys_check error: flux_type has wrong shape")
364 end if
365
366 nvector = 1 ! No. vector vars
367 allocate(iw_vector(nvector))
368 iw_vector(1) = mom(1) - 1
369 ! initialize ionization degree table
371
372 end subroutine hd_phys_init
373
374{^ifthreed
375 subroutine hd_te_images
378 select case(convert_type)
379 case('EIvtiCCmpi','EIvtuCCmpi')
381 case('ESvtiCCmpi','ESvtuCCmpi')
383 case('SIvtiCCmpi','SIvtuCCmpi')
385 case('WIvtiCCmpi','WIvtuCCmpi')
387 case default
388 call mpistop("Error in synthesize emission: Unknown convert_type")
389 end select
390 end subroutine hd_te_images
391}
392!!start th cond
393 ! wrappers for STS functions in thermal_conductivity module
394 ! which take as argument the tc_fluid (defined in the physics module)
395 subroutine hd_sts_set_source_tc_hd(ixI^L,ixO^L,w,x,wres,fix_conserve_at_step,my_dt,igrid,nflux)
399 integer, intent(in) :: ixi^l, ixo^l, igrid, nflux
400 double precision, intent(in) :: x(ixi^s,1:ndim)
401 double precision, intent(inout) :: wres(ixi^s,1:nw), w(ixi^s,1:nw)
402 double precision, intent(in) :: my_dt
403 logical, intent(in) :: fix_conserve_at_step
404 call sts_set_source_tc_hd(ixi^l,ixo^l,w,x,wres,fix_conserve_at_step,my_dt,igrid,nflux,tc_fl)
405 end subroutine hd_sts_set_source_tc_hd
406
407 function hd_get_tc_dt_hd(w,ixI^L,ixO^L,dx^D,x) result(dtnew)
408 !Check diffusion time limit dt < dx_i**2/((gamma-1)*tc_k_para/rho)
409 !and tc_k_para can depend on T=p/rho
412
413 integer, intent(in) :: ixi^l, ixo^l
414 double precision, intent(in) :: dx^d, x(ixi^s,1:ndim)
415 double precision, intent(in) :: w(ixi^s,1:nw)
416 double precision :: dtnew
417
418 dtnew=get_tc_dt_hd(w,ixi^l,ixo^l,dx^d,x,tc_fl)
419 end function hd_get_tc_dt_hd
420
421 subroutine hd_tc_handle_small_e(w, x, ixI^L, ixO^L, step)
422 ! move this in a different routine as in mhd if needed in more places
425
426 integer, intent(in) :: ixi^l,ixo^l
427 double precision, intent(inout) :: w(ixi^s,1:nw)
428 double precision, intent(in) :: x(ixi^s,1:ndim)
429 integer, intent(in) :: step
430
431 integer :: idir
432 logical :: flag(ixi^s,1:nw)
433 character(len=140) :: error_msg
434
435 flag=.false.
436 where(w(ixo^s,e_)<small_e) flag(ixo^s,e_)=.true.
437 if(any(flag(ixo^s,e_))) then
438 select case (small_values_method)
439 case ("replace")
440 where(flag(ixo^s,e_)) w(ixo^s,e_)=small_e
441 case ("average")
442 call small_values_average(ixi^l, ixo^l, w, x, flag, e_)
443 case default
444 ! small values error shows primitive variables
445 w(ixo^s,e_)=w(ixo^s,e_)*(hd_gamma - 1.0d0)
446 do idir = 1, ndir
447 w(ixo^s, iw_mom(idir)) = w(ixo^s, iw_mom(idir))/w(ixo^s,rho_)
448 end do
449 write(error_msg,"(a,i3)") "Thermal conduction step ", step
450 call small_values_error(w, x, ixi^l, ixo^l, flag, error_msg)
451 end select
452 end if
453 end subroutine hd_tc_handle_small_e
454
455 ! fill in tc_fluid fields from namelist
456 subroutine tc_params_read_hd(fl)
458 type(tc_fluid), intent(inout) :: fl
459 integer :: n
460 logical :: tc_saturate=.false.
461 double precision :: tc_k_para=0d0
462
463 namelist /tc_list/ tc_saturate, tc_k_para
464
465 do n = 1, size(par_files)
466 open(unitpar, file=trim(par_files(n)), status="old")
467 read(unitpar, tc_list, end=111)
468111 close(unitpar)
469 end do
470 fl%tc_saturate = tc_saturate
471 fl%tc_k_para = tc_k_para
472
473 end subroutine tc_params_read_hd
474
475 subroutine hd_get_rho(w,x,ixI^L,ixO^L,rho)
477 integer, intent(in) :: ixi^l, ixo^l
478 double precision, intent(in) :: w(ixi^s,1:nw),x(ixi^s,1:ndim)
479 double precision, intent(out) :: rho(ixi^s)
480
481 rho(ixo^s) = w(ixo^s,rho_)
482
483 end subroutine hd_get_rho
484
485!!end th cond
486!!rad cool
487 subroutine rc_params_read(fl)
489 use mod_constants, only: bigdouble
490 use mod_basic_types, only: std_len
491 type(rc_fluid), intent(inout) :: fl
492 integer :: n
493 ! list parameters
494 integer :: ncool = 4000
495
496 !> Name of cooling curve
497 character(len=std_len) :: coolcurve='JCcorona'
498
499 !> Fixed temperature not lower than tlow
500 logical :: tfix=.false.
501
502 !> Lower limit of temperature
503 double precision :: tlow=bigdouble
504
505 !> Add cooling source in a split way (.true.) or un-split way (.false.)
506 logical :: rc_split=.false.
507
508
509 namelist /rc_list/ coolcurve, ncool, tlow, tfix, rc_split
510
511 do n = 1, size(par_files)
512 open(unitpar, file=trim(par_files(n)), status="old")
513 read(unitpar, rc_list, end=111)
514111 close(unitpar)
515 end do
516
517 fl%ncool=ncool
518 fl%coolcurve=coolcurve
519 fl%tlow=tlow
520 fl%Tfix=tfix
521 fl%rc_split=rc_split
522 end subroutine rc_params_read
523!! end rad cool
524
528
529 if (.not. hd_energy) then
530 if (hd_gamma <= 0.0d0) call mpistop ("Error: hd_gamma <= 0")
531 if (hd_adiab < 0.0d0) call mpistop ("Error: hd_adiab < 0")
533 else
534 if (hd_gamma <= 0.0d0 .or. hd_gamma == 1.0d0) &
535 call mpistop ("Error: hd_gamma <= 0 or hd_gamma == 1.0")
536 small_e = small_pressure/(hd_gamma - 1.0d0)
537 inv_gamma_1=1.d0/(hd_gamma-1.d0)
538 end if
539
540 if (hd_dust) call dust_check_params()
541 if(use_imex_scheme) then
542 ! implicit dust update
543 phys_implicit_update => dust_implicit_update
544 phys_evaluate_implicit => dust_evaluate_implicit
545 endif
546
547 end subroutine hd_check_params
548
549 subroutine hd_physical_units
551 double precision :: mp,kb
552 double precision :: a,b
553 ! Derive scaling units
554 if(si_unit) then
555 mp=mp_si
556 kb=kb_si
557 else
558 mp=mp_cgs
559 kb=kb_cgs
560 end if
561 if(eq_state_units) then
562 a=1d0+4d0*he_abundance
563 if(hd_partial_ionization) then
564 b=1d0+h_ion_fr+he_abundance*(he_ion_fr*(he_ion_fr2+1d0)+1d0)
565 else
566 b=2d0+3d0*he_abundance
567 end if
568 rr=1d0
569 else
570 a=1d0
571 b=1d0
572 rr=(1d0+h_ion_fr+he_abundance*(he_ion_fr*(he_ion_fr2+1d0)+1d0))/(1d0+4d0*he_abundance)
573 end if
574 if(unit_density/=1.d0 .or. unit_numberdensity/=1.d0) then
575 if(unit_density/=1.d0) then
577 else if(unit_numberdensity/=1.d0) then
579 end if
580 if(unit_temperature/=1.d0) then
583 if(unit_length/=1.d0) then
585 else if(unit_time/=1.d0) then
587 end if
588 else if(unit_pressure/=1.d0) then
591 if(unit_length/=1.d0) then
593 else if(unit_time/=1.d0) then
595 end if
596 else if(unit_velocity/=1.d0) then
599 if(unit_length/=1.d0) then
601 else if(unit_time/=1.d0) then
603 end if
604 else if(unit_time/=1.d0) then
608 end if
609 else if(unit_temperature/=1.d0) then
610 ! units of temperature and velocity are dependent
611 if(unit_pressure/=1.d0) then
615 if(unit_length/=1.d0) then
617 else if(unit_time/=1.d0) then
619 end if
620 end if
621 else if(unit_pressure/=1.d0) then
622 if(unit_velocity/=1.d0) then
626 if(unit_length/=1.d0) then
628 else if(unit_time/=1.d0) then
630 end if
631 else if(unit_time/=0.d0) then
636 end if
637 end if
639
640 end subroutine hd_physical_units
641
642 !> Returns logical argument flag where values are ok
643 subroutine hd_check_w(primitive, ixI^L, ixO^L, w, flag)
645 use mod_dust, only: dust_check_w
646
647 logical, intent(in) :: primitive
648 integer, intent(in) :: ixi^l, ixo^l
649 double precision, intent(in) :: w(ixi^s, nw)
650 logical, intent(inout) :: flag(ixi^s,1:nw)
651 double precision :: tmp(ixi^s)
652
653 flag=.false.
654
655 if (hd_energy) then
656 if (primitive) then
657 where(w(ixo^s, e_) < small_pressure) flag(ixo^s,e_) = .true.
658 else
659 tmp(ixo^s)=(hd_gamma-1.0d0)*(w(ixo^s,e_)-&
660 half*(^c&w(ixo^s,m^c_)**2+)/w(ixo^s,rho_))
661 where(tmp(ixo^s) < small_pressure) flag(ixo^s,e_) = .true.
662 endif
663 end if
664
665 where(w(ixo^s, rho_) < small_density) flag(ixo^s,rho_) = .true.
666
667 if(hd_dust) call dust_check_w(ixi^l,ixo^l,w,flag)
668
669 end subroutine hd_check_w
670
671 !> Transform primitive variables into conservative ones
672 subroutine hd_to_conserved(ixI^L, ixO^L, w, x)
674 use mod_dust, only: dust_to_conserved
675 integer, intent(in) :: ixi^l, ixo^l
676 double precision, intent(inout) :: w(ixi^s, nw)
677 double precision, intent(in) :: x(ixi^s, 1:ndim)
678
679 integer :: ix^d
680
681 {do ix^db=ixomin^db,ixomax^db\}
682 if (hd_energy) then
683 ! Calculate total energy from pressure and kinetic energy
684 w(ix^d,e_)=w(ix^d, e_)*inv_gamma_1+&
685 half*(^c&w(ix^d,m^c_)**2+)*w(ix^d,rho_)
686 end if
687 ! Convert velocity to momentum
688 ^c&w(ix^d,m^c_)=w(ix^d,rho_)*w(ix^d,m^c_)\
689 {end do\}
690
691 if (hd_dust) then
692 call dust_to_conserved(ixi^l, ixo^l, w, x)
693 end if
694
695 end subroutine hd_to_conserved
696
697 !> Transform conservative variables into primitive ones
698 subroutine hd_to_primitive(ixI^L, ixO^L, w, x)
700 use mod_dust, only: dust_to_primitive
701 integer, intent(in) :: ixi^l, ixo^l
702 double precision, intent(inout) :: w(ixi^s, nw)
703 double precision, intent(in) :: x(ixi^s, 1:ndim)
704
705 double precision :: inv_rho
706 integer :: ix^d
707
708 if (fix_small_values) then
709 call hd_handle_small_values(.false., w, x, ixi^l, ixo^l, 'hd_to_primitive')
710 end if
711
712 {do ix^db=ixomin^db,ixomax^db\}
713 inv_rho = 1.d0/w(ix^d,rho_)
714 ! Convert momentum to velocity
715 ^c&w(ix^d,m^c_)=w(ix^d,m^c_)*inv_rho\
716 ! Calculate pressure = (gamma-1) * (e-ek)
717 if(hd_energy) then
718 ! Compute pressure
719 w(ix^d,p_)=(hd_gamma-1.d0)*(w(ix^d,e_)&
720 -half*w(ix^d,rho_)*(^c&w(ix^d,m^c_)**2+))
721 end if
722 {end do\}
723
724 ! Convert dust momentum to dust velocity
725 if (hd_dust) then
726 call dust_to_primitive(ixi^l, ixo^l, w, x)
727 end if
728
729 end subroutine hd_to_primitive
730
731 !> Transform internal energy to total energy
732 subroutine hd_ei_to_e(ixI^L,ixO^L,w,x)
734 integer, intent(in) :: ixi^l, ixo^l
735 double precision, intent(inout) :: w(ixi^s, nw)
736 double precision, intent(in) :: x(ixi^s, 1:ndim)
737
738 ! Calculate total energy from internal and kinetic energy
739 w(ixo^s,e_)=w(ixo^s,e_)+half*(^c&w(ixo^s,m^c_)**2+)/w(ixo^s,rho_)
740
741 end subroutine hd_ei_to_e
742
743 !> Transform total energy to internal energy
744 subroutine hd_e_to_ei(ixI^L,ixO^L,w,x)
746 integer, intent(in) :: ixi^l, ixo^l
747 double precision, intent(inout) :: w(ixi^s, nw)
748 double precision, intent(in) :: x(ixi^s, 1:ndim)
749
750 ! Calculate ei = e - ek
751 w(ixo^s,e_)=w(ixo^s,e_)-half*(^c&w(ixo^s,m^c_)**2+)/w(ixo^s,rho_)
752
753 end subroutine hd_e_to_ei
754
755 !> Calculate v_i = m_i / rho within ixO^L
756 subroutine hd_get_v_idim(w, x, ixI^L, ixO^L, idim, v)
758 integer, intent(in) :: ixi^l, ixo^l, idim
759 double precision, intent(in) :: w(ixi^s, nw), x(ixi^s, 1:ndim)
760 double precision, intent(out) :: v(ixi^s)
761
762 v(ixo^s) = w(ixo^s, mom(idim)) / w(ixo^s, rho_)
763 end subroutine hd_get_v_idim
764
765 !> Calculate velocity vector v_i = m_i / rho within ixO^L
766 subroutine hd_get_v(w,x,ixI^L,ixO^L,v)
768
769 integer, intent(in) :: ixi^l, ixo^l
770 double precision, intent(in) :: w(ixi^s,nw), x(ixi^s,1:^nd)
771 double precision, intent(out) :: v(ixi^s,1:ndir)
772
773 integer :: idir
774
775 do idir=1,ndir
776 v(ixo^s,idir) = w(ixo^s, mom(idir)) / w(ixo^s, rho_)
777 end do
778
779 end subroutine hd_get_v
780
781 !> Calculate cmax_idim = csound + abs(v_idim) within ixO^L
782 subroutine hd_get_cmax(w, x, ixI^L, ixO^L, idim, cmax)
786
787 integer, intent(in) :: ixi^l, ixo^l, idim
788 ! w in primitive form
789 double precision, intent(in) :: w(ixi^s, nw), x(ixi^s, 1:ndim)
790 double precision, intent(inout) :: cmax(ixi^s)
791
792 if(hd_energy) then
793 cmax(ixo^s)=dabs(w(ixo^s,mom(idim)))+dsqrt(hd_gamma*w(ixo^s,p_)/w(ixo^s,rho_))
794 else
795 if (.not. associated(usr_set_pthermal)) then
796 cmax(ixo^s) = hd_adiab * w(ixo^s, rho_)**hd_gamma
797 else
798 call usr_set_pthermal(w,x,ixi^l,ixo^l,cmax)
799 end if
800 cmax(ixo^s)=dabs(w(ixo^s,mom(idim)))+dsqrt(hd_gamma*cmax(ixo^s)/w(ixo^s,rho_))
801 end if
802
803 if (hd_dust) then
804 call dust_get_cmax_prim(w, x, ixi^l, ixo^l, idim, cmax)
805 end if
806 end subroutine hd_get_cmax
807
808 subroutine hd_get_a2max(w,x,ixI^L,ixO^L,a2max)
810
811 integer, intent(in) :: ixi^l, ixo^l
812 double precision, intent(in) :: w(ixi^s, nw), x(ixi^s,1:ndim)
813 double precision, intent(inout) :: a2max(ndim)
814 double precision :: a2(ixi^s,ndim,nw)
815 integer :: gxo^l,hxo^l,jxo^l,kxo^l,i,j
816
817 a2=zero
818 do i = 1,ndim
819 !> 4th order
820 hxo^l=ixo^l-kr(i,^d);
821 gxo^l=hxo^l-kr(i,^d);
822 jxo^l=ixo^l+kr(i,^d);
823 kxo^l=jxo^l+kr(i,^d);
824 a2(ixo^s,i,1:nw)=dabs(-w(kxo^s,1:nw)+16.d0*w(jxo^s,1:nw)&
825 -30.d0*w(ixo^s,1:nw)+16.d0*w(hxo^s,1:nw)-w(gxo^s,1:nw))
826 a2max(i)=maxval(a2(ixo^s,i,1:nw))/12.d0/dxlevel(i)**2
827 end do
828 end subroutine hd_get_a2max
829
830 !> get adaptive cutoff temperature for TRAC (Johnston 2019 ApJL, 873, L22)
831 subroutine hd_get_tcutoff(ixI^L,ixO^L,w,x,tco_local,Tmax_local)
833 integer, intent(in) :: ixi^l,ixo^l
834 double precision, intent(in) :: x(ixi^s,1:ndim)
835 ! in primitive form
836 double precision, intent(inout) :: w(ixi^s,1:nw)
837 double precision, intent(out) :: tco_local, tmax_local
838
839 double precision, parameter :: trac_delta=0.25d0
840 double precision :: tmp1(ixi^s),te(ixi^s),lts(ixi^s)
841 double precision :: ltr(ixi^s),ltrc,ltrp,tcoff(ixi^s)
842 integer :: jxo^l,hxo^l
843 integer :: jxp^l,hxp^l,ixp^l
844 logical :: lrlt(ixi^s)
845
846 {^ifoned
847 call hd_get_rfactor(w,x,ixi^l,ixi^l,te)
848 te(ixi^s)=w(ixi^s,p_)/(te(ixi^s)*w(ixi^s,rho_))
849
850 tco_local=zero
851 tmax_local=maxval(te(ixo^s))
852 select case(hd_trac_type)
853 case(0)
854 w(ixi^s,tcoff_)=3.d5/unit_temperature
855 case(1)
856 hxo^l=ixo^l-1;
857 jxo^l=ixo^l+1;
858 lts(ixo^s)=0.5d0*dabs(te(jxo^s)-te(hxo^s))/te(ixo^s)
859 lrlt=.false.
860 where(lts(ixo^s) > trac_delta)
861 lrlt(ixo^s)=.true.
862 end where
863 if(any(lrlt(ixo^s))) then
864 tco_local=maxval(te(ixo^s), mask=lrlt(ixo^s))
865 end if
866 case(2)
867 !> iijima et al. 2021, LTRAC method
868 ltrc=1.5d0
869 ltrp=2.5d0
870 ixp^l=ixo^l^ladd1;
871 hxo^l=ixo^l-1;
872 jxo^l=ixo^l+1;
873 hxp^l=ixp^l-1;
874 jxp^l=ixp^l+1;
875 lts(ixp^s)=0.5d0*abs(te(jxp^s)-te(hxp^s))/te(ixp^s)
876 ltr(ixp^s)=max(one, (exp(lts(ixp^s))/ltrc)**ltrp)
877 w(ixo^s,tcoff_)=te(ixo^s)*&
878 (0.25*(ltr(jxo^s)+two*ltr(ixo^s)+ltr(hxo^s)))**0.4d0
879 case default
880 call mpistop("hd_trac_type not allowed for 1D simulation")
881 end select
882 }
883 end subroutine hd_get_tcutoff
884
885 !> Calculate cmax_idim = csound + abs(v_idim) within ixO^L
886 subroutine hd_get_cbounds(wLC, wRC, wLp, wRp, x, ixI^L, ixO^L, idim,Hspeed,cmax, cmin)
888 use mod_dust, only: dust_get_cmax
889 use mod_variables
890
891 integer, intent(in) :: ixi^l, ixo^l, idim
892 ! conservative left and right status
893 double precision, intent(in) :: wlc(ixi^s, nw), wrc(ixi^s, nw)
894 ! primitive left and right status
895 double precision, intent(in) :: wlp(ixi^s, nw), wrp(ixi^s, nw)
896 double precision, intent(in) :: x(ixi^s, 1:ndim)
897 double precision, intent(inout) :: cmax(ixi^s,1:number_species)
898 double precision, intent(inout), optional :: cmin(ixi^s,1:number_species)
899 double precision, intent(in) :: hspeed(ixi^s,1:number_species)
900
901 double precision :: wmean(ixi^s,nw)
902 double precision, dimension(ixI^S) :: umean, dmean, csoundl, csoundr, tmp1,tmp2,tmp3
903 integer :: ix^d
904
905 select case(boundspeed)
906 case (1)
907 ! This implements formula (10.52) from "Riemann Solvers and Numerical
908 ! Methods for Fluid Dynamics" by Toro.
909
910 tmp1(ixo^s)=dsqrt(wlp(ixo^s,rho_))
911 tmp2(ixo^s)=dsqrt(wrp(ixo^s,rho_))
912 tmp3(ixo^s)=1.d0/(tmp1(ixo^s)+tmp2(ixo^s))
913 umean(ixo^s)=(wlp(ixo^s,mom(idim))*tmp1(ixo^s)+wrp(ixo^s,mom(idim))*tmp2(ixo^s))*tmp3(ixo^s)
914
915 if(hd_energy) then
916 csoundl(ixo^s)=hd_gamma*wlp(ixo^s,p_)/wlp(ixo^s,rho_)
917 csoundr(ixo^s)=hd_gamma*wrp(ixo^s,p_)/wrp(ixo^s,rho_)
918 else
919 call hd_get_csound2(wlc,x,ixi^l,ixo^l,csoundl)
920 call hd_get_csound2(wrc,x,ixi^l,ixo^l,csoundr)
921 end if
922
923 dmean(ixo^s) = (tmp1(ixo^s)*csoundl(ixo^s)+tmp2(ixo^s)*csoundr(ixo^s)) * &
924 tmp3(ixo^s) + 0.5d0*tmp1(ixo^s)*tmp2(ixo^s)*tmp3(ixo^s)**2 * &
925 (wrp(ixo^s,mom(idim))-wlp(ixo^s,mom(idim)))**2
926
927 dmean(ixo^s)=dsqrt(dmean(ixo^s))
928 if(present(cmin)) then
929 cmin(ixo^s,1)=umean(ixo^s)-dmean(ixo^s)
930 cmax(ixo^s,1)=umean(ixo^s)+dmean(ixo^s)
931 if(h_correction) then
932 {do ix^db=ixomin^db,ixomax^db\}
933 cmin(ix^d,1)=sign(one,cmin(ix^d,1))*max(abs(cmin(ix^d,1)),hspeed(ix^d,1))
934 cmax(ix^d,1)=sign(one,cmax(ix^d,1))*max(abs(cmax(ix^d,1)),hspeed(ix^d,1))
935 {end do\}
936 end if
937 else
938 cmax(ixo^s,1)=dabs(umean(ixo^s))+dmean(ixo^s)
939 end if
940
941 if (hd_dust) then
942 wmean(ixo^s,1:nwflux)=0.5d0*(wlc(ixo^s,1:nwflux)+wrc(ixo^s,1:nwflux))
943 call dust_get_cmax(wmean, x, ixi^l, ixo^l, idim, cmax, cmin)
944 end if
945
946 case (2)
947 wmean(ixo^s,1:nwflux)=0.5d0*(wlc(ixo^s,1:nwflux)+wrc(ixo^s,1:nwflux))
948 tmp1(ixo^s)=wmean(ixo^s,mom(idim))/wmean(ixo^s,rho_)
949 call hd_get_csound2(wmean,x,ixi^l,ixo^l,csoundr)
950 csoundr(ixo^s) = dsqrt(csoundr(ixo^s))
951
952 if(present(cmin)) then
953 cmax(ixo^s,1)=max(tmp1(ixo^s)+csoundr(ixo^s),zero)
954 cmin(ixo^s,1)=min(tmp1(ixo^s)-csoundr(ixo^s),zero)
955 if(h_correction) then
956 {do ix^db=ixomin^db,ixomax^db\}
957 cmin(ix^d,1)=sign(one,cmin(ix^d,1))*max(abs(cmin(ix^d,1)),hspeed(ix^d,1))
958 cmax(ix^d,1)=sign(one,cmax(ix^d,1))*max(abs(cmax(ix^d,1)),hspeed(ix^d,1))
959 {end do\}
960 end if
961 else
962 cmax(ixo^s,1)=dabs(tmp1(ixo^s))+csoundr(ixo^s)
963 end if
964
965 if (hd_dust) then
966 call dust_get_cmax(wmean, x, ixi^l, ixo^l, idim, cmax, cmin)
967 end if
968 case (3)
969 ! Miyoshi 2005 JCP 208, 315 equation (67)
970 if(hd_energy) then
971 csoundl(ixo^s)=hd_gamma*wlp(ixo^s,p_)/wlp(ixo^s,rho_)
972 csoundr(ixo^s)=hd_gamma*wrp(ixo^s,p_)/wrp(ixo^s,rho_)
973 else
974 call hd_get_csound2(wlc,x,ixi^l,ixo^l,csoundl)
975 call hd_get_csound2(wrc,x,ixi^l,ixo^l,csoundr)
976 end if
977 csoundl(ixo^s)=max(dsqrt(csoundl(ixo^s)),dsqrt(csoundr(ixo^s)))
978 if(present(cmin)) then
979 cmin(ixo^s,1)=min(wlp(ixo^s,mom(idim)),wrp(ixo^s,mom(idim)))-csoundl(ixo^s)
980 cmax(ixo^s,1)=max(wlp(ixo^s,mom(idim)),wrp(ixo^s,mom(idim)))+csoundl(ixo^s)
981 if(h_correction) then
982 {do ix^db=ixomin^db,ixomax^db\}
983 cmin(ix^d,1)=sign(one,cmin(ix^d,1))*max(abs(cmin(ix^d,1)),hspeed(ix^d,1))
984 cmax(ix^d,1)=sign(one,cmax(ix^d,1))*max(abs(cmax(ix^d,1)),hspeed(ix^d,1))
985 {end do\}
986 end if
987 else
988 cmax(ixo^s,1)=max(wlp(ixo^s,mom(idim)),wrp(ixo^s,mom(idim)))+csoundl(ixo^s)
989 end if
990 if (hd_dust) then
991 wmean(ixo^s,1:nwflux)=0.5d0*(wlc(ixo^s,1:nwflux)+wrc(ixo^s,1:nwflux))
992 call dust_get_cmax(wmean, x, ixi^l, ixo^l, idim, cmax, cmin)
993 end if
994 end select
995
996 end subroutine hd_get_cbounds
997
998 !> Calculate the square of the thermal sound speed csound2 within ixO^L.
999 !> csound2=gamma*p/rho
1000 subroutine hd_get_csound2(w,x,ixI^L,ixO^L,csound2)
1002 integer, intent(in) :: ixi^l, ixo^l
1003 double precision, intent(in) :: w(ixi^s,nw)
1004 double precision, intent(in) :: x(ixi^s,1:ndim)
1005 double precision, intent(out) :: csound2(ixi^s)
1006
1007 call hd_get_pthermal(w,x,ixi^l,ixo^l,csound2)
1008 csound2(ixo^s)=hd_gamma*csound2(ixo^s)/w(ixo^s,rho_)
1009
1010 end subroutine hd_get_csound2
1011
1012 !> Calculate thermal pressure=(gamma-1)*(e-0.5*m**2/rho) within ixO^L
1013 subroutine hd_get_pthermal(w, x, ixI^L, ixO^L, pth)
1017
1018 integer, intent(in) :: ixi^l, ixo^l
1019 double precision, intent(in) :: w(ixi^s, 1:nw)
1020 double precision, intent(in) :: x(ixi^s, 1:ndim)
1021 double precision, intent(out):: pth(ixi^s)
1022 integer :: iw, ix^d
1023
1024 if (hd_energy) then
1025 pth(ixo^s) = (hd_gamma - 1.0d0) * (w(ixo^s, e_) - &
1026 hd_kin_en(w, ixi^l, ixo^l))
1027 else
1028 if (.not. associated(usr_set_pthermal)) then
1029 pth(ixo^s) = hd_adiab * w(ixo^s, rho_)**hd_gamma
1030 else
1031 call usr_set_pthermal(w,x,ixi^l,ixo^l,pth)
1032 end if
1033 end if
1034
1035 if (fix_small_values) then
1036 {do ix^db= ixo^lim^db\}
1037 if(pth(ix^d)<small_pressure) then
1038 pth(ix^d)=small_pressure
1039 endif
1040 {enddo^d&\}
1041 else if (check_small_values) then
1042 {do ix^db= ixo^lim^db\}
1043 if(pth(ix^d)<small_pressure) then
1044 write(*,*) "Error: small value of gas pressure",pth(ix^d),&
1045 " encountered when call hd_get_pthermal"
1046 write(*,*) "Iteration: ", it, " Time: ", global_time
1047 write(*,*) "Location: ", x(ix^d,:)
1048 write(*,*) "Cell number: ", ix^d
1049 do iw=1,nw
1050 write(*,*) trim(cons_wnames(iw)),": ",w(ix^d,iw)
1051 end do
1052 ! use erroneous arithmetic operation to crash the run
1053 if(trace_small_values) write(*,*) dsqrt(pth(ix^d)-bigdouble)
1054 write(*,*) "Saving status at the previous time step"
1055 crash=.true.
1056 end if
1057 {enddo^d&\}
1058 end if
1059
1060 end subroutine hd_get_pthermal
1061
1062 !> Calculate temperature=p/rho when in e_ the total energy is stored
1063 subroutine hd_get_temperature_from_etot(w, x, ixI^L, ixO^L, res)
1065 integer, intent(in) :: ixi^l, ixo^l
1066 double precision, intent(in) :: w(ixi^s, 1:nw)
1067 double precision, intent(in) :: x(ixi^s, 1:ndim)
1068 double precision, intent(out):: res(ixi^s)
1069
1070 double precision :: r(ixi^s)
1071
1072 call hd_get_rfactor(w,x,ixi^l,ixo^l,r)
1073 call hd_get_pthermal(w, x, ixi^l, ixo^l, res)
1074 res(ixo^s)=res(ixo^s)/(r(ixo^s)*w(ixo^s,rho_))
1075 end subroutine hd_get_temperature_from_etot
1076
1077 !> Calculate temperature=p/rho when in e_ the internal energy is stored
1078 subroutine hd_get_temperature_from_eint(w, x, ixI^L, ixO^L, res)
1080 integer, intent(in) :: ixi^l, ixo^l
1081 double precision, intent(in) :: w(ixi^s, 1:nw)
1082 double precision, intent(in) :: x(ixi^s, 1:ndim)
1083 double precision, intent(out):: res(ixi^s)
1084
1085 double precision :: r(ixi^s)
1086
1087 call hd_get_rfactor(w,x,ixi^l,ixo^l,r)
1088 res(ixo^s) = (hd_gamma - 1.0d0) * w(ixo^s, e_)/(w(ixo^s,rho_)*r(ixo^s))
1089 end subroutine hd_get_temperature_from_eint
1090
1091 ! Calculate flux f_idim[iw]
1092 subroutine hd_get_flux(wC, w, x, ixI^L, ixO^L, idim, f)
1094 use mod_dust, only: dust_get_flux_prim
1095
1096 integer, intent(in) :: ixi^l, ixo^l, idim
1097 ! conservative w
1098 double precision, intent(in) :: wc(ixi^s, 1:nw)
1099 ! primitive w
1100 double precision, intent(in) :: w(ixi^s, 1:nw)
1101 double precision, intent(in) :: x(ixi^s, 1:ndim)
1102 double precision, intent(out) :: f(ixi^s, nwflux)
1103
1104 double precision :: pth(ixi^s)
1105 integer :: ix^db
1106
1107 if (hd_energy) then
1108 {do ix^db=ixomin^db,ixomax^db\}
1109 f(ix^d,rho_)=w(ix^d,mom(idim))*w(ix^d,rho_)
1110 ! Momentum flux is v_i*m_i, +p in direction idim
1111 ^c&f(ix^d,m^c_)=w(ix^d,mom(idim))*wc(ix^d,m^c_)\
1112 f(ix^d,mom(idim))=f(ix^d,mom(idim))+w(ix^d,p_)
1113 ! Energy flux is v_i*(e + p)
1114 f(ix^d,e_)=w(ix^d,mom(idim))*(wc(ix^d,e_)+w(ix^d,p_))
1115 {end do\}
1116 else
1117 call hd_get_pthermal(wc, x, ixi^l, ixo^l, pth)
1118 {do ix^db=ixomin^db,ixomax^db\}
1119 f(ix^d,rho_)=w(ix^d,mom(idim))*w(ix^d,rho_)
1120 ! Momentum flux is v_i*m_i, +p in direction idim
1121 ^c&f(ix^d,m^c_)=w(ix^d,mom(idim))*wc(ix^d,m^c_)\
1122 f(ix^d,mom(idim))=f(ix^d,mom(idim))+pth(ix^d)
1123 {end do\}
1124 end if
1125
1126 do ix1 = 1, hd_n_tracer
1127 f(ixo^s, tracer(ix1)) = w(ixo^s,mom(idim)) * w(ixo^s, tracer(ix1))
1128 end do
1129
1130 ! Dust fluxes
1131 if (hd_dust) then
1132 call dust_get_flux_prim(w, x, ixi^l, ixo^l, idim, f)
1133 end if
1134
1135 end subroutine hd_get_flux
1136
1137 !> Add geometrical source terms to w
1138 !>
1139 !> Notice that the expressions of the geometrical terms depend only on ndir,
1140 !> not ndim. Eg, they are the same in 2.5D and in 3D, for any geometry.
1141 !>
1142 !> Ileyk : to do :
1143 !> - address the source term for the dust in case (coordinate == spherical)
1144 subroutine hd_add_source_geom(qdt, dtfactor, ixI^L, ixO^L, wCT, wprim, w, x)
1149 use mod_geometry
1150 integer, intent(in) :: ixi^l, ixo^l
1151 double precision, intent(in) :: qdt, dtfactor, x(ixi^s, 1:ndim)
1152 double precision, intent(inout) :: wct(ixi^s, 1:nw), wprim(ixi^s,1:nw),w(ixi^s, 1:nw)
1153 ! to change and to set as a parameter in the parfile once the possibility to
1154 ! solve the equations in an angular momentum conserving form has been
1155 ! implemented (change tvdlf.t eg)
1156 double precision :: pth(ixi^s), source(ixi^s), minrho
1157 integer :: iw,idir, h1x^l{^nooned, h2x^l}
1158 integer :: mr_,mphi_ ! Polar var. names
1159 integer :: irho, ifluid, n_fluids
1160 double precision :: exp_factor(ixi^s), del_exp_factor(ixi^s), exp_factor_primitive(ixi^s)
1161
1162 if (hd_dust) then
1163 n_fluids = 1 + dust_n_species
1164 else
1165 n_fluids = 1
1166 end if
1167
1168 select case (coordinate)
1169
1171 !the user provides the functions of exp_factor and del_exp_factor
1172 if(associated(usr_set_surface)) call usr_set_surface(ixi^l,x,block%dx,exp_factor,del_exp_factor,exp_factor_primitive)
1173 if(hd_energy) then
1174 source(ixo^s)=wprim(ixo^s, p_)
1175 else
1176 if(.not. associated(usr_set_pthermal)) then
1177 source(ixo^s)=hd_adiab * wprim(ixo^s, rho_)**hd_gamma
1178 else
1179 call usr_set_pthermal(wct,x,ixi^l,ixo^l,source)
1180 end if
1181 end if
1182 source(ixo^s) = source(ixo^s)*del_exp_factor(ixo^s)/exp_factor(ixo^s)
1183 w(ixo^s,mom(1)) = w(ixo^s,mom(1)) + qdt*source(ixo^s)
1184
1185 case (cylindrical)
1186 do ifluid = 0, n_fluids-1
1187 ! s[mr]=(pthermal+mphi**2/rho)/radius
1188 if (ifluid == 0) then
1189 ! gas
1190 irho = rho_
1191 mr_ = mom(r_)
1192 if(phi_>0) mphi_ = mom(phi_)
1193 if(hd_energy) then
1194 source(ixo^s)=wprim(ixo^s, p_)
1195 else
1196 if(.not. associated(usr_set_pthermal)) then
1197 source(ixo^s)=hd_adiab * wprim(ixo^s, rho_)**hd_gamma
1198 else
1199 call usr_set_pthermal(wct,x,ixi^l,ixo^l,source)
1200 end if
1201 end if
1202 minrho = 0.0d0
1203 else
1204 ! dust : no pressure
1205 irho = dust_rho(ifluid)
1206 mr_ = dust_mom(r_, ifluid)
1207 if(phi_>0) mphi_ = dust_mom(phi_, ifluid)
1208 source(ixi^s) = zero
1209 minrho = 0.0d0
1210 end if
1211 if(phi_ > 0) then
1212 where (wct(ixo^s, irho) > minrho)
1213 source(ixo^s) = source(ixo^s) + wct(ixo^s,mphi_)*wprim(ixo^s,mphi_)
1214 w(ixo^s, mr_) = w(ixo^s, mr_) + qdt*source(ixo^s)/x(ixo^s,r_)
1215 end where
1216 ! s[mphi]=(-mphi*vr)/radius
1217 where (wct(ixo^s, irho) > minrho)
1218 source(ixo^s) = -wct(ixo^s, mphi_) * wprim(ixo^s, mr_)
1219 w(ixo^s, mphi_) = w(ixo^s, mphi_) + qdt * source(ixo^s) / x(ixo^s, r_)
1220 end where
1221 else
1222 ! s[mr]=2pthermal/radius
1223 w(ixo^s, mr_) = w(ixo^s, mr_) + qdt * source(ixo^s) / x(ixo^s, r_)
1224 end if
1225 end do
1226 case (spherical)
1227 if (hd_dust) then
1228 call mpistop("Dust geom source terms not implemented yet with spherical geometries")
1229 end if
1230 mr_ = mom(r_)
1231 if(phi_>0) mphi_ = mom(phi_)
1232 h1x^l=ixo^l-kr(1,^d); {^nooned h2x^l=ixo^l-kr(2,^d);}
1233 if(hd_energy) then
1234 pth(ixo^s)=wprim(ixo^s, p_)
1235 else
1236 if(.not. associated(usr_set_pthermal)) then
1237 pth(ixo^s)=hd_adiab * wprim(ixo^s, rho_)**hd_gamma
1238 else
1239 call usr_set_pthermal(wct,x,ixi^l,ixo^l,pth)
1240 end if
1241 end if
1242 ! s[mr]=((vtheta**2+vphi**2)*rho+2*p)/r
1243 source(ixo^s) = pth(ixo^s) * x(ixo^s, 1) &
1244 *(block%surfaceC(ixo^s, 1) - block%surfaceC(h1x^s, 1)) &
1245 /block%dvolume(ixo^s)
1246 do idir = 2, ndir
1247 source(ixo^s) = source(ixo^s) + wprim(ixo^s, mom(idir))**2 * wprim(ixo^s, rho_)
1248 end do
1249 w(ixo^s, mr_) = w(ixo^s, mr_) + qdt * source(ixo^s) / x(ixo^s, 1)
1250
1251 {^nooned
1252 ! s[mtheta]=-(vr*vtheta*rho)/r+cot(theta)*(vphi**2*rho+p)/r
1253 source(ixo^s) = pth(ixo^s) * x(ixo^s, 1) &
1254 * (block%surfaceC(ixo^s, 2) - block%surfaceC(h2x^s, 2)) &
1255 / block%dvolume(ixo^s)
1256 if (ndir == 3) then
1257 source(ixo^s) = source(ixo^s) + (wprim(ixo^s, mom(3))**2 * wprim(ixo^s, rho_)) / tan(x(ixo^s, 2))
1258 end if
1259 source(ixo^s) = source(ixo^s) - (wprim(ixo^s, mom(2)) * wprim(ixo^s, mr_)) * wprim(ixo^s, rho_)
1260 w(ixo^s, mom(2)) = w(ixo^s, mom(2)) + qdt * source(ixo^s) / x(ixo^s, 1)
1261
1262 if (ndir == 3) then
1263 ! s[mphi]=-(vphi*vr/rho)/r-cot(theta)*(vtheta*vphi/rho)/r
1264 source(ixo^s) = -(wprim(ixo^s, mom(3)) * wprim(ixo^s, mr_)) * wprim(ixo^s, rho_)&
1265 - (wprim(ixo^s, mom(2)) * wprim(ixo^s, mom(3))) * wprim(ixo^s, rho_) / tan(x(ixo^s, 2))
1266 w(ixo^s, mom(3)) = w(ixo^s, mom(3)) + qdt * source(ixo^s) / x(ixo^s, 1)
1267 end if
1268 }
1269 end select
1270
1271 if (hd_rotating_frame) then
1272 if (hd_dust) then
1273 call mpistop("Rotating frame not implemented yet with dust")
1274 else
1275 call rotating_frame_add_source(qdt,dtfactor,ixi^l,ixo^l,wprim,w,x)
1276 end if
1277 end if
1278
1279 end subroutine hd_add_source_geom
1280
1281 ! w[iw]= w[iw]+qdt*S[wCT, qtC, x] where S is the source based on wCT within ixO
1282 subroutine hd_add_source(qdt,dtfactor, ixI^L,ixO^L,wCT,wCTprim,w,x,qsourcesplit,active)
1287 use mod_usr_methods, only: usr_gravity
1289 use mod_cak_force, only: cak_add_source
1290
1291 integer, intent(in) :: ixi^l, ixo^l
1292 double precision, intent(in) :: qdt, dtfactor
1293 double precision, intent(in) :: wct(ixi^s, 1:nw),wctprim(ixi^s,1:nw), x(ixi^s, 1:ndim)
1294 double precision, intent(inout) :: w(ixi^s, 1:nw)
1295 logical, intent(in) :: qsourcesplit
1296 logical, intent(inout) :: active
1297
1298 double precision :: gravity_field(ixi^s, 1:ndim)
1299 integer :: idust, idim
1300
1301 if(hd_dust .and. .not. use_imex_scheme) then
1302 call dust_add_source(qdt,ixi^l,ixo^l,wct,w,x,qsourcesplit,active)
1303 end if
1304
1305 if(hd_radiative_cooling) then
1306 call radiative_cooling_add_source(qdt,ixi^l,ixo^l,wct,wctprim,w,x,&
1307 qsourcesplit,active, rc_fl)
1308 end if
1309
1310 if(hd_viscosity) then
1311 call viscosity_add_source(qdt,ixi^l,ixo^l,wct,wctprim,w,x,&
1312 hd_energy,qsourcesplit,active)
1313 end if
1314
1315 if (hd_gravity) then
1316 call gravity_add_source(qdt,ixi^l,ixo^l,wct,wctprim,w,x,&
1317 hd_energy,qsourcesplit,active)
1318
1319 if (hd_dust .and. qsourcesplit .eqv. grav_split) then
1320 active = .true.
1321
1322 call usr_gravity(ixi^l, ixo^l, wct, x, gravity_field)
1323 do idust = 1, dust_n_species
1324 do idim = 1, ndim
1325 w(ixo^s, dust_mom(idim, idust)) = w(ixo^s, dust_mom(idim, idust)) &
1326 + qdt * gravity_field(ixo^s, idim) * wct(ixo^s, dust_rho(idust))
1327 end do
1328 end do
1329 end if
1330 end if
1331
1332 if (hd_cak_force) then
1333 call cak_add_source(qdt,ixi^l,ixo^l,wct,w,x,hd_energy,qsourcesplit,active)
1334 end if
1335
1336 if(hd_partial_ionization) then
1337 if(.not.qsourcesplit) then
1338 active = .true.
1339 call hd_update_temperature(ixi^l,ixo^l,wct,w,x)
1340 end if
1341 end if
1342
1343 end subroutine hd_add_source
1344
1345 subroutine hd_get_dt(w, ixI^L, ixO^L, dtnew, dx^D, x)
1347 use mod_dust, only: dust_get_dt
1349 use mod_gravity, only: gravity_get_dt
1350 use mod_cak_force, only: cak_get_dt
1351
1352 integer, intent(in) :: ixi^l, ixo^l
1353 double precision, intent(in) :: dx^d, x(ixi^s, 1:^nd)
1354 double precision, intent(in) :: w(ixi^s, 1:nw)
1355 double precision, intent(inout) :: dtnew
1356
1357 dtnew = bigdouble
1358
1359 if(hd_dust) then
1360 call dust_get_dt(w, ixi^l, ixo^l, dtnew, dx^d, x)
1361 end if
1362
1363 if(hd_viscosity) then
1364 call viscosity_get_dt(w,ixi^l,ixo^l,dtnew,dx^d,x)
1365 end if
1366
1367 if(hd_gravity) then
1368 call gravity_get_dt(w,ixi^l,ixo^l,dtnew,dx^d,x)
1369 end if
1370
1371 if (hd_cak_force) then
1372 call cak_get_dt(w,ixi^l,ixo^l,dtnew,dx^d,x)
1373 end if
1374
1375 end subroutine hd_get_dt
1376
1377 function hd_kin_en(w, ixI^L, ixO^L, inv_rho) result(ke)
1378 use mod_global_parameters, only: nw, ndim
1379 integer, intent(in) :: ixi^l, ixo^l
1380 double precision, intent(in) :: w(ixi^s, nw)
1381 double precision :: ke(ixo^s)
1382 double precision, intent(in), optional :: inv_rho(ixo^s)
1383
1384 if (present(inv_rho)) then
1385 ke = 0.5d0 * sum(w(ixo^s, mom(:))**2, dim=ndim+1) * inv_rho
1386 else
1387 ke = 0.5d0 * sum(w(ixo^s, mom(:))**2, dim=ndim+1) / w(ixo^s, rho_)
1388 end if
1389 end function hd_kin_en
1390
1391 function hd_inv_rho(w, ixI^L, ixO^L) result(inv_rho)
1392 use mod_global_parameters, only: nw, ndim
1393 integer, intent(in) :: ixi^l, ixo^l
1394 double precision, intent(in) :: w(ixi^s, nw)
1395 double precision :: inv_rho(ixo^s)
1396
1397 ! Can make this more robust
1398 inv_rho = 1.0d0 / w(ixo^s, rho_)
1399 end function hd_inv_rho
1400
1401 subroutine hd_handle_small_values(primitive, w, x, ixI^L, ixO^L, subname)
1402 ! handles hydro (density,pressure,velocity) bootstrapping
1403 ! any negative dust density is flagged as well (and throws an error)
1404 ! small_values_method=replace also for dust
1408 logical, intent(in) :: primitive
1409 integer, intent(in) :: ixi^l,ixo^l
1410 double precision, intent(inout) :: w(ixi^s,1:nw)
1411 double precision, intent(in) :: x(ixi^s,1:ndim)
1412 character(len=*), intent(in) :: subname
1413
1414 integer :: n,idir
1415 logical :: flag(ixi^s,1:nw)
1416
1417 call hd_check_w(primitive, ixi^l, ixo^l, w, flag)
1418
1419 if (any(flag)) then
1420 select case (small_values_method)
1421 case ("replace")
1422 where(flag(ixo^s,rho_)) w(ixo^s,rho_) = small_density
1423 do idir = 1, ndir
1424 if(small_values_fix_iw(mom(idir))) then
1425 where(flag(ixo^s,rho_)) w(ixo^s, mom(idir)) = 0.0d0
1426 end if
1427 end do
1428 if(hd_energy)then
1429 if(small_values_fix_iw(e_)) then
1430 if(primitive) then
1431 where(flag(ixo^s,rho_)) w(ixo^s, p_) = small_pressure
1432 else
1433 where(flag(ixo^s,rho_)) w(ixo^s, e_) = small_e + hd_kin_en(w,ixi^l,ixo^l)
1434 endif
1435 end if
1436 endif
1437
1438 if(hd_energy) then
1439 if(primitive) then
1440 where(flag(ixo^s,e_)) w(ixo^s,p_) = small_pressure
1441 else
1442 where(flag(ixo^s,e_))
1443 ! Add kinetic energy
1444 w(ixo^s,e_) = small_e + hd_kin_en(w,ixi^l,ixo^l)
1445 end where
1446 end if
1447 end if
1448
1449 if(hd_dust)then
1450 do n=1,dust_n_species
1451 where(flag(ixo^s,dust_rho(n))) w(ixo^s,dust_rho(n)) = 0.0d0
1452 do idir = 1, ndir
1453 where(flag(ixo^s,dust_rho(n))) w(ixo^s,dust_mom(idir,n)) = 0.0d0
1454 enddo
1455 enddo
1456 endif
1457 case ("average")
1458 if(primitive)then
1459 ! averaging for all primitive fields, including dust
1460 call small_values_average(ixi^l, ixo^l, w, x, flag)
1461 else
1462 ! do averaging of density
1463 call small_values_average(ixi^l, ixo^l, w, x, flag, rho_)
1464 if(hd_energy) then
1465 ! do averaging of pressure
1466 w(ixi^s,p_)=(hd_gamma-1.d0)*(w(ixi^s,e_) &
1467 -0.5d0*sum(w(ixi^s, mom(:))**2, dim=ndim+1)/w(ixi^s,rho_))
1468 call small_values_average(ixi^l, ixo^l, w, x, flag, p_)
1469 w(ixi^s,e_)=w(ixi^s,p_)/(hd_gamma-1.d0) &
1470 +0.5d0*sum(w(ixi^s, mom(:))**2, dim=ndim+1)/w(ixi^s,rho_)
1471 end if
1472 if(hd_dust)then
1473 do n=1,dust_n_species
1474 where(flag(ixo^s,dust_rho(n))) w(ixo^s,dust_rho(n)) = 0.0d0
1475 do idir = 1, ndir
1476 where(flag(ixo^s,dust_rho(n))) w(ixo^s,dust_mom(idir,n)) = 0.0d0
1477 enddo
1478 enddo
1479 endif
1480 endif
1481 case default
1482 if(.not.primitive) then
1483 !convert w to primitive
1484 ! Calculate pressure = (gamma-1) * (e-ek)
1485 if(hd_energy) then
1486 w(ixo^s,p_)=(hd_gamma-1.d0)*(w(ixo^s,e_)-hd_kin_en(w,ixi^l,ixo^l))
1487 end if
1488 ! Convert gas momentum to velocity
1489 do idir = 1, ndir
1490 w(ixo^s, mom(idir)) = w(ixo^s, mom(idir))/w(ixo^s,rho_)
1491 end do
1492 end if
1493 ! NOTE: dust entries may still have conserved values here
1494 call small_values_error(w, x, ixi^l, ixo^l, flag, subname)
1495 end select
1496 end if
1497 end subroutine hd_handle_small_values
1498
1499 subroutine rfactor_from_temperature_ionization(w,x,ixI^L,ixO^L,Rfactor)
1502 integer, intent(in) :: ixi^l, ixo^l
1503 double precision, intent(in) :: w(ixi^s,1:nw)
1504 double precision, intent(in) :: x(ixi^s,1:ndim)
1505 double precision, intent(out):: rfactor(ixi^s)
1506
1507 double precision :: iz_h(ixo^s),iz_he(ixo^s)
1508
1509 call ionization_degree_from_temperature(ixi^l,ixo^l,w(ixi^s,te_),iz_h,iz_he)
1510 ! assume the first and second ionization of Helium have the same degree
1511 rfactor(ixo^s)=(1.d0+iz_h(ixo^s)+0.1d0*(1.d0+iz_he(ixo^s)*(1.d0+iz_he(ixo^s))))/2.3d0
1512
1513 end subroutine rfactor_from_temperature_ionization
1514
1515 subroutine rfactor_from_constant_ionization(w,x,ixI^L,ixO^L,Rfactor)
1517 integer, intent(in) :: ixi^l, ixo^l
1518 double precision, intent(in) :: w(ixi^s,1:nw)
1519 double precision, intent(in) :: x(ixi^s,1:ndim)
1520 double precision, intent(out):: rfactor(ixi^s)
1521
1522 rfactor(ixo^s)=rr
1523
1524 end subroutine rfactor_from_constant_ionization
1525
1526 subroutine hd_update_temperature(ixI^L,ixO^L,wCT,w,x)
1529
1530 integer, intent(in) :: ixi^l, ixo^l
1531 double precision, intent(in) :: wct(ixi^s,1:nw), x(ixi^s,1:ndim)
1532 double precision, intent(inout) :: w(ixi^s,1:nw)
1533
1534 double precision :: iz_h(ixo^s),iz_he(ixo^s), pth(ixi^s)
1535
1536 call ionization_degree_from_temperature(ixi^l,ixo^l,wct(ixi^s,te_),iz_h,iz_he)
1537
1538 call hd_get_pthermal(w,x,ixi^l,ixo^l,pth)
1539
1540 w(ixo^s,te_)=(2.d0+3.d0*he_abundance)*pth(ixo^s)/(w(ixo^s,rho_)*(1.d0+iz_h(ixo^s)+&
1541 he_abundance*(iz_he(ixo^s)*(iz_he(ixo^s)+1.d0)+1.d0)))
1542
1543 end subroutine hd_update_temperature
1544
1545end module mod_hd_phys
Calculate w(iw)=w(iw)+qdt*SOURCE[wCT,qtC,x] within ixO for all indices iw=iwmin......
Module with basic data types used in amrvac.
integer, parameter std_len
Default length for strings.
Module to include CAK radiation line force in (magneto)hydrodynamic models Computes both the force fr...
subroutine cak_get_dt(w, ixil, ixol, dtnew, dxd, x)
Check time step for total radiation contribution.
subroutine cak_init(phys_gamma)
Initialize the module.
subroutine cak_add_source(qdt, ixil, ixol, wct, w, x, energy, qsourcesplit, active)
w[iw]=w[iw]+qdt*S[wCT,qtC,x] where S is the source based on wCT within ixO
subroutine, public mpistop(message)
Exit MPI-AMRVAC with an error message.
Module for physical and numeric constants.
double precision, parameter bigdouble
A very large real number.
Module for including dust species, which interact with the gas through a drag force.
Definition mod_dust.t:3
subroutine, public dust_add_source(qdt, ixil, ixol, wct, w, x, qsourcesplit, active)
w[iw]= w[iw]+qdt*S[wCT, x] where S is the source based on wCT within ixO
Definition mod_dust.t:530
subroutine, public dust_evaluate_implicit(qtc, psa)
inplace update of psa==>F_im(psa)
Definition mod_dust.t:583
subroutine, public dust_to_primitive(ixil, ixol, w, x)
Definition mod_dust.t:228
subroutine, public dust_get_dt(w, ixil, ixol, dtnew, dxd, x)
Get dt related to dust and gas stopping time (Laibe 2011)
Definition mod_dust.t:898
integer, dimension(:, :), allocatable, public, protected dust_mom
Indices of the dust momentum densities.
Definition mod_dust.t:47
subroutine, public dust_to_conserved(ixil, ixol, w, x)
Definition mod_dust.t:208
integer, public, protected dust_n_species
The number of dust species.
Definition mod_dust.t:37
subroutine, public dust_get_flux_prim(w, x, ixil, ixol, idim, f)
Definition mod_dust.t:275
subroutine, public dust_check_w(ixil, ixol, w, flag)
Definition mod_dust.t:194
integer, dimension(:), allocatable, public, protected dust_rho
Indices of the dust densities.
Definition mod_dust.t:44
subroutine, public dust_get_cmax(w, x, ixil, ixol, idim, cmax, cmin)
Definition mod_dust.t:1011
subroutine, public dust_check_params()
Definition mod_dust.t:154
subroutine, public dust_get_cmax_prim(w, x, ixil, ixol, idim, cmax, cmin)
Definition mod_dust.t:1035
subroutine, public dust_init(g_rho, g_mom, g_energy)
Definition mod_dust.t:95
subroutine, public dust_implicit_update(dtfactor, qdt, qtc, psb, psa)
Implicit solve of psb=psa+dtfactor*dt*F_im(psb)
Definition mod_dust.t:652
Module for flux conservation near refinement boundaries.
Module with geometry-related routines (e.g., divergence, curl)
Definition mod_geometry.t:2
integer coordinate
Definition mod_geometry.t:7
integer, parameter spherical
integer, parameter cylindrical
integer, parameter cartesian_expansion
This module contains definitions of global parameters and variables and some generic functions/subrou...
type(state), pointer block
Block pointer for using one block and its previous state.
logical h_correction
If true, do H-correction to fix the carbuncle problem at grid-aligned shocks.
double precision unit_time
Physical scaling factor for time.
double precision unit_density
Physical scaling factor for density.
integer, parameter unitpar
file handle for IO
double precision global_time
The global simulation time.
double precision unit_mass
Physical scaling factor for mass.
logical use_imex_scheme
whether IMEX in use or not
integer, dimension(3, 3) kr
Kronecker delta tensor.
integer it
Number of time steps taken.
double precision unit_numberdensity
Physical scaling factor for number density.
character(len=std_len) convert_type
Which format to use when converting.
double precision unit_pressure
Physical scaling factor for pressure.
integer, parameter ndim
Number of spatial dimensions for grid variables.
double precision unit_length
Physical scaling factor for length.
logical use_particles
Use particles module or not.
character(len=std_len), dimension(:), allocatable par_files
Which par files are used as input.
integer mype
The rank of the current MPI task.
double precision, dimension(:), allocatable, parameter d
integer ndir
Number of spatial dimensions (components) for vector variables.
double precision unit_velocity
Physical scaling factor for velocity.
double precision unit_temperature
Physical scaling factor for temperature.
logical si_unit
Use SI units (.true.) or use cgs units (.false.)
double precision, dimension(:,:), allocatable dx
spatial steps for all dimensions at all levels
logical phys_trac
Use TRAC for MHD or 1D HD.
logical fix_small_values
fix small values with average or replace methods
logical crash
Save a snapshot before crash a run met unphysical values.
double precision, dimension(^nd) dxlevel
store unstretched cell size of current level
integer r_
Indices for cylindrical coordinates FOR TESTS, negative value when not used:
integer boundspeed
bound (left/min and right.max) speed of Riemann fan
integer, parameter unitconvert
logical check_small_values
check and optionally fix unphysical small values (density, gas pressure)
Module for including gravity in (magneto)hydrodynamics simulations.
Definition mod_gravity.t:2
logical grav_split
source split or not
Definition mod_gravity.t:6
subroutine gravity_get_dt(w, ixil, ixol, dtnew, dxd, x)
Definition mod_gravity.t:81
subroutine gravity_init()
Initialize the module.
Definition mod_gravity.t:26
subroutine gravity_add_source(qdt, ixil, ixol, wct, wctprim, w, x, energy, qsourcesplit, active)
w[iw]=w[iw]+qdt*S[wCT,qtC,x] where S is the source based on wCT within ixO
Definition mod_gravity.t:43
Hydrodynamics physics module.
Definition mod_hd_phys.t:2
integer, public, protected m
Definition mod_hd_phys.t:54
subroutine, public hd_check_params
logical, public, protected hd_energy
Whether an energy equation is used.
Definition mod_hd_phys.t:12
logical, public, protected hd_dust
Whether dust is added.
Definition mod_hd_phys.t:24
subroutine, public hd_ei_to_e(ixil, ixol, w, x)
Transform internal energy to total energy.
integer, public, protected e_
Index of the energy density (-1 if not present)
Definition mod_hd_phys.t:60
logical, public, protected hd_radiative_cooling
Whether radiative cooling is added.
Definition mod_hd_phys.t:20
double precision, public, protected rr
double precision, public hd_gamma
The adiabatic index.
Definition mod_hd_phys.t:72
integer, public, protected hd_trac_type
Definition mod_hd_phys.t:85
logical, public, protected hd_particles
Whether particles module is added.
Definition mod_hd_phys.t:33
type(tc_fluid), allocatable, public tc_fl
Definition mod_hd_phys.t:16
subroutine, public hd_check_w(primitive, ixil, ixol, w, flag)
Returns logical argument flag where values are ok.
logical, public, protected hd_viscosity
Whether viscosity is added.
Definition mod_hd_phys.t:27
integer, public, protected c
Indices of the momentum density for the form of better vectorization.
Definition mod_hd_phys.t:54
subroutine, public hd_get_csound2(w, x, ixil, ixol, csound2)
Calculate the square of the thermal sound speed csound2 within ixO^L. csound2=gamma*p/rho.
integer, public, protected tcoff_
Index of the cutoff temperature for the TRAC method.
Definition mod_hd_phys.t:69
double precision, public, protected he_ion_fr2
Ratio of number He2+ / number He+ + He2+ He_ion_fr2 = He2+/(He2+ + He+)
Definition mod_hd_phys.t:97
integer, public, protected te_
Indices of temperature.
Definition mod_hd_phys.t:66
integer, dimension(:), allocatable, public, protected mom
Indices of the momentum density.
Definition mod_hd_phys.t:51
double precision, public, protected h_ion_fr
Ionization fraction of H H_ion_fr = H+/(H+ + H)
Definition mod_hd_phys.t:91
double precision function, dimension(ixo^s), public hd_kin_en(w, ixil, ixol, inv_rho)
subroutine, public hd_to_conserved(ixil, ixol, w, x)
Transform primitive variables into conservative ones.
logical, public, protected hd_cak_force
Whether CAK radiation line force is activated.
Definition mod_hd_phys.t:39
subroutine, public hd_phys_init()
Initialize the module.
integer, dimension(:), allocatable, public, protected tracer
Indices of the tracers.
Definition mod_hd_phys.t:57
logical, public, protected hd_thermal_conduction
Whether thermal conduction is added.
Definition mod_hd_phys.t:15
logical, public, protected eq_state_units
double precision, public hd_adiab
The adiabatic constant.
Definition mod_hd_phys.t:78
subroutine, public hd_to_primitive(ixil, ixol, w, x)
Transform conservative variables into primitive ones.
integer, public, protected rho_
Index of the density (in the w array)
Definition mod_hd_phys.t:48
logical, public, protected hd_partial_ionization
Whether plasma is partially ionized.
Definition mod_hd_phys.t:45
double precision, public, protected he_ion_fr
Ionization fraction of He He_ion_fr = (He2+ + He+)/(He2+ + He+ + He)
Definition mod_hd_phys.t:94
double precision, public, protected he_abundance
Helium abundance over Hydrogen.
Definition mod_hd_phys.t:88
logical, public, protected hd_gravity
Whether gravity is added.
Definition mod_hd_phys.t:30
integer, public, protected c_
Definition mod_hd_phys.t:54
type(rc_fluid), allocatable, public rc_fl
Definition mod_hd_phys.t:21
logical, public, protected hd_trac
Whether TRAC method is used.
Definition mod_hd_phys.t:84
integer, public, protected hd_n_tracer
Number of tracer species.
Definition mod_hd_phys.t:42
type(te_fluid), allocatable, public te_fl_hd
Definition mod_hd_phys.t:17
logical, public, protected hd_rotating_frame
Whether rotating frame is activated.
Definition mod_hd_phys.t:36
subroutine, public hd_get_pthermal(w, x, ixil, ixol, pth)
Calculate thermal pressure=(gamma-1)*(e-0.5*m**2/rho) within ixO^L.
integer, public, protected p_
Index of the gas pressure (-1 if not present) should equal e_.
Definition mod_hd_phys.t:63
subroutine, public hd_e_to_ei(ixil, ixol, w, x)
Transform total energy to internal energy.
module ionization degree - get ionization degree for given temperature
subroutine ionization_degree_from_temperature(ixil, ixol, te, iz_h, iz_he)
Module containing all the particle routines.
subroutine particles_init()
Initialize particle data and parameters.
This module defines the procedures of a physics module. It contains function pointers for the various...
Definition mod_physics.t:4
module radiative cooling – add optically thin radiative cooling
subroutine radiative_cooling_init_params(phys_gamma, he_abund)
Radiative cooling initialization.
subroutine radiative_cooling_init(fl, read_params)
subroutine radiative_cooling_add_source(qdt, ixil, ixol, wct, wctprim, w, x, qsourcesplit, active, fl)
Module for including rotating frame in (magneto)hydrodynamics simulations The rotation vector is assu...
subroutine rotating_frame_add_source(qdt, dtfactor, ixil, ixol, wct, w, x)
w[iw]=w[iw]+qdt*S[wCT,qtC,x] where S is the source based on wCT within ixO
subroutine rotating_frame_init()
Initialize the module.
Module for handling problematic values in simulations, such as negative pressures.
subroutine, public small_values_average(ixil, ixol, w, x, w_flag, windex)
logical, public trace_small_values
trace small values in the source file using traceback flag of compiler
subroutine, public small_values_error(wprim, x, ixil, ixol, w_flag, subname)
logical, dimension(:), allocatable, public small_values_fix_iw
Whether to apply small value fixes to certain variables.
character(len=20), public small_values_method
How to handle small values.
Generic supertimestepping method which can be used for multiple source terms in the governing equatio...
subroutine, public add_sts_method(sts_getdt, sts_set_sources, startvar, nflux, startwbc, nwbc, evolve_b)
subroutine which added programatically a term to be calculated using STS Params: sts_getdt function c...
subroutine, public set_conversion_methods_to_head(sts_before_first_cycle, sts_after_last_cycle)
Set the hooks called before the first cycle and after the last cycle in the STS update This method sh...
subroutine, public set_error_handling_to_head(sts_error_handling)
Set the hook of error handling in the STS update. This method is called before updating the BC....
subroutine, public sts_init()
Initialize sts module.
Thermal conduction for HD and MHD or RHD and RMHD or twofl (plasma-neutral) module Adaptation of mod_...
subroutine, public tc_get_hd_params(fl, read_hd_params)
Init TC coefficients: HD case.
double precision function, public get_tc_dt_hd(w, ixil, ixol, dxd, x, fl)
Get the explicit timestep for the TC (hd implementation) Note: also used in 1D MHD (or for neutrals i...
subroutine tc_init_params(phys_gamma)
subroutine, public sts_set_source_tc_hd(ixil, ixol, w, x, wres, fix_conserve_at_step, my_dt, igrid, nflux, fl)
subroutine get_euv_image(qunit, fl)
subroutine get_sxr_image(qunit, fl)
subroutine get_euv_spectrum(qunit, fl)
subroutine get_whitelight_image(qunit, fl)
Module with all the methods that users can customize in AMRVAC.
procedure(rfactor), pointer usr_rfactor
procedure(set_surface), pointer usr_set_surface
procedure(phys_gravity), pointer usr_gravity
procedure(hd_pthermal), pointer usr_set_pthermal
integer nw
Total number of variables.
integer number_species
number of species: each species has different characterictic speeds and should be used accordingly in...
The module add viscous source terms and check time step.
subroutine viscosity_init(phys_wider_stencil)
Initialize the module.
subroutine viscosity_get_dt(w, ixil, ixol, dtnew, dxd, x)
procedure(sub_add_source), pointer, public viscosity_add_source