cooling.h 7.26 KB
Newer Older
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
/*******************************************************************************
 * This file is part of SWIFT.
 * Copyright (c) 2016 Matthieu Schaller (matthieu.schaller@durham.ac.uk)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 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 Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/
#ifndef SWIFT_COOLING_GRACKLE_H
#define SWIFT_COOLING_GRACKLE_H

/**
 * @file src/cooling/none/cooling.h
 * @brief Empty infrastructure for the cases without cooling function
 */

/* Some standard headers. */
#include <float.h>
#include <math.h>

/* Local includes. */
#include "error.h"
#include "hydro.h"
#include "parser.h"
#include "part.h"
#include "physical_constants.h"
#include "units.h"

/* include the grackle wrapper */
#include "grackle_wrapper.h"





/*! This function computes the new entropy due to the cooling,
 *  between step t0 and t1.
 */

lhausamm's avatar
lhausamm committed
50
static INLINE double do_cooling_grackle(double energy, double density, double dtime, double *ne, double Z, double a_now)
51
52
53
54
55
56
57
58
59
{

  

  /*********************************************************************
   call to the main chemistry solver
   *********************************************************************/
  
  if (wrap_do_cooling(density, &energy, dtime,Z, a_now) == 0) {
lhausamm's avatar
lhausamm committed
60
    error("Error in do_cooling.\n");
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
    return 0;
  }
  
    
  return energy;


}


/**
 * @brief Apply the cooling function to a particle.
 *
 * We do nothing.
 *
 * @param phys_const The physical constants in internal units.
 * @param us The internal system of units.
 * @param cooling The #cooling_function_data used in the run.
 * @param p Pointer to the particle data.
 * @param dt The time-step of this particle.
 */
__attribute__((always_inline)) INLINE static void cooling_cool_part(
    const struct phys_const* restrict phys_const,
lhausamm's avatar
lhausamm committed
84
    const struct unit_system* restrict us,
85
86
87
88
89
90
91
    const struct cooling_function_data* restrict cooling,
    struct part* restrict p, struct xpart* restrict xp, float dt) {
    



  /* Get current internal energy (dt=0) */
lhausamm's avatar
lhausamm committed
92
  const float u_old = hydro_get_internal_energy(p);
93
94
95
96
97
98
99
100
101
102
103
104
105
106
  /* Get current density */
  const float rho = hydro_get_density(p);
  /* Actual scaling fractor */
  const float a_now =  1. / (1. + cooling->GrackleRedshift); ;			/*  must be chaged !!! */

  double ne,Z;

  Z =  0.02041;					/* 0.02041 (= 1 Zsun in Grackle v2.0, but = 1.5761 Zsun in Grackle v2.1) */
  ne=  0.0;					/* mass fraction of eletron */          	/* useless for GRACKLE_CHEMISTRY = 0 */
 
 
  float u_new;
  float delta_u;
  
lhausamm's avatar
lhausamm committed
107
  u_new = do_cooling_grackle(u_old, rho, dt, &ne, Z, a_now);
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
  //u_new = u_old * 0.99;





  
  //if (u_new < 0)
  //if (p->id==50356)
  //  printf("WARNING !!! ID=%llu  u_old=%g  u_new=%g rho=%g dt=%g ne=%g Z=%g a_now=%g\n",p->id,u_old,u_new,rho,dt,ne,Z,a_now);

  
  delta_u = u_new - u_old;

  /* record energy lost */
  xp->cooling_data.radiated_energy += -delta_u * hydro_get_mass(p);  
  
 
  
  /* Update the internal energy */
lhausamm's avatar
lhausamm committed
128
  hydro_set_internal_energy_dt(p, delta_u / dt);  
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
    
}

/**
 * @brief Computes the cooling time-step.
 *
 * We return FLT_MAX so as to impose no limit on the time-step.
 *
 * @param cooling The #cooling_function_data used in the run.
 * @param phys_const The physical constants in internal units.
 * @param us The internal system of units.
 * @param p Pointer to the particle data.
 */
__attribute__((always_inline)) INLINE static float cooling_timestep(
    const struct cooling_function_data* restrict cooling,
    const struct phys_const* restrict phys_const,
lhausamm's avatar
lhausamm committed
145
    const struct unit_system* restrict us, const struct part* restrict p) {
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

  return FLT_MAX;
}

/**
 * @brief Sets the cooling properties of the (x-)particles to a valid start
 * state.
 *
 * @param p Pointer to the particle data.
 * @param xp Pointer to the extended particle data.
 */
__attribute__((always_inline)) INLINE static void cooling_init_part(
    const struct part* restrict p, struct xpart* restrict xp) {

  xp->cooling_data.radiated_energy = 0.f;    
}

/**
 * @brief Returns the total radiated energy by this particle.
 *
 * @param xp The extended particle data
 */
__attribute__((always_inline)) INLINE static float cooling_get_radiated_energy(
    const struct xpart* restrict xp) {

  return xp->cooling_data.radiated_energy;
}

/**
 * @brief Initialises the cooling properties.
 *
 * @param parameter_file The parsed parameter file.
 * @param us The current internal system of units.
 * @param phys_const The physical constants in internal units.
 * @param cooling The cooling properties to initialize
 */
static INLINE void cooling_init_backend(
lhausamm's avatar
lhausamm committed
183
184
    const struct swift_params* parameter_file,
    const struct unit_system* us,
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
    const struct phys_const* phys_const,
    struct cooling_function_data* cooling) {
    


  char cloudytable[200];
  double units_density, units_length, units_time;
  int grackle_chemistry;
  int UVbackground;


  parser_get_param_string(parameter_file,"GrackleCooling:GrackleCloudyTable",cooling->GrackleCloudyTable);
  cooling->UVbackground = parser_get_param_int(parameter_file, "GrackleCooling:UVbackground");
  cooling->GrackleRedshift = parser_get_param_double(parameter_file, "GrackleCooling:GrackleRedshift");
  cooling->GrackleHSShieldingDensityThreshold = parser_get_param_double(parameter_file, "GrackleCooling:GrackleHSShieldingDensityThreshold");

  // FIXME : Why a strcpy ?
  strcpy(cloudytable,cooling->GrackleCloudyTable);
  
  
  UVbackground  =  cooling->UVbackground;
  grackle_chemistry = 0;			/* forced to be zero : read table */ 
  
  units_density = us->UnitMass_in_cgs/pow(us->UnitLength_in_cgs,3);
  units_length  = us->UnitLength_in_cgs;
  units_time    = us->UnitTime_in_cgs;
    
    

  printf("          ***************************************\n");
  printf("          initializing grackle cooling function\n");
  printf("          \n");
  
  printf("          CloudyTable                        = %s\n",cloudytable);
  printf("          UVbackground                       = %d\n",UVbackground);
  printf("          GrackleRedshift                    = %g\n",cooling->GrackleRedshift);
  printf("          GrackleHSShieldingDensityThreshold = %g\n",cooling->GrackleHSShieldingDensityThreshold);
  

  if(wrap_init_cooling(cloudytable,UVbackground,units_density, units_length, units_time, grackle_chemistry) != 1)
    {
      fprintf(stderr,"Error in initialize_chemistry_data.");
      exit(-1);
    }
  
  printf("          \n");
  printf("          ***************************************\n");



    
}

/**
 * @brief Prints the properties of the cooling model to stdout.
 *
 * @param cooling The properties of the cooling function.
 */
static INLINE void cooling_print_backend(
    const struct cooling_function_data* cooling) {

  message("Cooling function is 'Grackle'.");
}

#endif /* SWIFT_COOLING_GRACKLE_H */