FLASH-X
Doxygen Generated Documentation From Interface Source Code
Burn_interface.F90
Go to the documentation of this file.
1!! NOTICE
2!! Copyright 2022 UChicago Argonne, LLC and contributors
3!!
4!! Licensed under the Apache License, Version 2.0 (the "License");
5!! you may not use this file except in compliance with the License.
6!!
7!! Unless required by applicable law or agreed to in writing, software
8!! distributed under the License is distributed on an "AS IS" BASIS,
9!! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10!! See the License for the specific language governing permissions and
11!! limitations under the License.
12!!
13!! This is the header file for the Burn module
14!! that defines its public interfaces.
15
17
18#include "constants.h"
19#include "Simulation.h"
20
22 subroutine Burn_computeDt(tileDesc, solnData, dt_burn, dt_minloc)
23 use Grid_tile, ONLY : Grid_tile_t
24 implicit none
25 type(Grid_tile_t), intent(IN) :: tileDesc
26 real, pointer :: solnData(:,:,:,:)
27 real,INTENT(INOUT) :: dt_burn
28 integer,INTENT(INOUT) :: dt_minloc(5)
29 end subroutine Burn_computeDt
30 end interface
31
32 interface Burn
33 subroutine Burn(dt)
34 real,intent(IN) :: dt
35 end subroutine Burn
36 end interface
37
38 interface Burn_finalize
39 subroutine Burn_finalize()
40 end subroutine Burn_finalize
41 end interface
42
43 interface
44 subroutine Burn_computeAbarZbar(solnScalars, abarData, zbarData)
45 implicit none
46 real, dimension(:,:), intent(in) :: solnScalars
47 real, dimension(:), intent(inout) :: abarData, zbarData
48 ! A callback, typically called by Eos unit implementations to get
49 ! values for EOS_ABAR and EOS_ZBAR input elements of eosData
50 ! before the EOS computation proper.
51 end subroutine Burn_computeAbarZbar
52 end interface
53
54 interface
55 subroutine Burn_guardCellMaskHook(ccMask, needEos)
56 implicit none
57 logical,intent(INOUT) :: ccMask(*)
58 logical,intent(IN) :: needEos
59 end subroutine Burn_guardCellMaskHook
60 end interface
61
62 interface Burn_init
63 subroutine Burn_init()
64
65 end subroutine Burn_init
66 end interface
67
69 subroutine Burn_nseAtDens(qbar_nse,sumyi_nse,approxtemp,edot,Yedot, Ye, dens, emq)
70 implicit none
71 real, intent(IN) :: Ye, dens, emq
72 real, intent(OUT) :: qbar_nse,sumyi_nse,approxtemp,edot,Yedot
73 end subroutine Burn_nseAtDens
74 end interface
75
76
78 subroutine Burn_nseAtPres(qbar_nse,sumyi_nse,approxtemp,edot,Yedot, Ye, pres, hmq)
79 implicit none
80 real, intent(IN) :: Ye, pres, hmq
81 real, intent(OUT) :: qbar_nse,sumyi_nse,approxtemp,edot,Yedot
82 end subroutine Burn_nseAtPres
83 end interface
84
85
86end Module Burn_interface
87
88