|
| 1 | +# Copyright 2024 DeepMind Technologies Limited |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +"""Unit tests for torax.transport_model.tglf_based_transport_model.""" |
| 16 | +from absl.testing import absltest |
| 17 | +from absl.testing import parameterized |
| 18 | +import chex |
| 19 | +import jax.numpy as jnp |
| 20 | +from torax import core_profile_setters |
| 21 | +from torax import state |
| 22 | +from torax.config import runtime_params as general_runtime_params |
| 23 | +from torax.config import runtime_params_slice |
| 24 | +from torax.geometry import geometry |
| 25 | +from torax.pedestal_model import pedestal_model as pedestal_model_lib |
| 26 | +from torax.pedestal_model import set_tped_nped |
| 27 | +from torax.sources import source_models as source_models_lib |
| 28 | +from torax.transport_model import tglf_based_transport_model |
| 29 | +from torax.transport_model import quasilinear_transport_model |
| 30 | +from torax.transport_model import runtime_params as runtime_params_lib |
| 31 | + |
| 32 | + |
| 33 | +def _get_model_inputs(transport: tglf_based_transport_model.RuntimeParams): |
| 34 | + """Returns the model inputs for testing.""" |
| 35 | + runtime_params = general_runtime_params.GeneralRuntimeParams() |
| 36 | + geo = geometry.build_circular_geometry() |
| 37 | + source_models_builder = source_models_lib.SourceModelsBuilder() |
| 38 | + source_models = source_models_builder() |
| 39 | + pedestal_model_builder = ( |
| 40 | + set_tped_nped.SetTemperatureDensityPedestalModelBuilder() |
| 41 | + ) |
| 42 | + dynamic_runtime_params_slice = ( |
| 43 | + runtime_params_slice.DynamicRuntimeParamsSliceProvider( |
| 44 | + runtime_params=runtime_params, |
| 45 | + transport=transport, |
| 46 | + sources=source_models_builder.runtime_params, |
| 47 | + pedestal=pedestal_model_builder.runtime_params, |
| 48 | + torax_mesh=geo.torax_mesh, |
| 49 | + )( |
| 50 | + t=runtime_params.numerics.t_initial, |
| 51 | + ) |
| 52 | + ) |
| 53 | + static_slice = runtime_params_slice.build_static_runtime_params_slice( |
| 54 | + runtime_params=runtime_params, |
| 55 | + source_runtime_params=source_models_builder.runtime_params, |
| 56 | + torax_mesh=geo.torax_mesh, |
| 57 | + ) |
| 58 | + core_profiles = core_profile_setters.initial_core_profiles( |
| 59 | + dynamic_runtime_params_slice=dynamic_runtime_params_slice, |
| 60 | + static_runtime_params_slice=static_slice, |
| 61 | + geo=geo, |
| 62 | + source_models=source_models, |
| 63 | + ) |
| 64 | + return dynamic_runtime_params_slice, geo, core_profiles |
| 65 | + |
| 66 | + |
| 67 | +class TGLFBasedTransportModelTest(parameterized.TestCase): |
| 68 | + """Unit tests for the `torax.transport_model.tglf_based_transport_model` module.""" |
| 69 | + |
| 70 | + def test_tglf_based_transport_model_output_shapes(self): |
| 71 | + """Tests that the core transport output has the right shapes.""" |
| 72 | + transport = tglf_based_transport_model.RuntimeParams( |
| 73 | + **runtime_params_lib.RuntimeParams() |
| 74 | + ) |
| 75 | + transport_model = FakeTGLFBasedTransportModel() |
| 76 | + dynamic_runtime_params_slice, geo, core_profiles = _get_model_inputs( |
| 77 | + transport |
| 78 | + ) |
| 79 | + pedestal_model = set_tped_nped.SetTemperatureDensityPedestalModel() |
| 80 | + pedestal_model_outputs = pedestal_model( |
| 81 | + dynamic_runtime_params_slice, geo, core_profiles |
| 82 | + ) |
| 83 | + |
| 84 | + core_transport = transport_model( |
| 85 | + dynamic_runtime_params_slice, geo, core_profiles, pedestal_model_outputs |
| 86 | + ) |
| 87 | + expected_shape = geo.rho_face_norm.shape |
| 88 | + self.assertEqual(core_transport.chi_face_ion.shape, expected_shape) |
| 89 | + self.assertEqual(core_transport.chi_face_el.shape, expected_shape) |
| 90 | + self.assertEqual(core_transport.d_face_el.shape, expected_shape) |
| 91 | + self.assertEqual(core_transport.v_face_el.shape, expected_shape) |
| 92 | + |
| 93 | + def test_tglf_based_transport_model_prepare_tglf_inputs_shapes(self): |
| 94 | + """Tests that the tglf inputs have the expected shapes.""" |
| 95 | + transport = tglf_based_transport_model.RuntimeParams( |
| 96 | + **runtime_params_lib.RuntimeParams() |
| 97 | + ) |
| 98 | + dynamic_runtime_params_slice, geo, core_profiles = _get_model_inputs( |
| 99 | + transport |
| 100 | + ) |
| 101 | + transport_model = FakeTGLFBasedTransportModel() |
| 102 | + tglf_inputs = transport_model._prepare_tglf_inputs( |
| 103 | + Zeff_face=dynamic_runtime_params_slice.plasma_composition.Zeff_face, |
| 104 | + q_correction_factor=dynamic_runtime_params_slice.numerics.q_correction_factor, |
| 105 | + geo=geo, |
| 106 | + core_profiles=core_profiles, |
| 107 | + ) |
| 108 | + |
| 109 | + # Inputs that are 1D |
| 110 | + vector_keys = [ |
| 111 | + 'chiGB', |
| 112 | + 'lref_over_lti', |
| 113 | + 'lref_over_lte', |
| 114 | + 'lref_over_lne', |
| 115 | + 'lref_over_lni0', |
| 116 | + 'lref_over_lni1', |
| 117 | + 'Ti_over_Te', |
| 118 | + 'drmaj', |
| 119 | + 'q', |
| 120 | + 's_hat', |
| 121 | + 'nu_ee', |
| 122 | + 'kappa', |
| 123 | + 'kappa_shear', |
| 124 | + 'delta', |
| 125 | + 'delta_shear', |
| 126 | + 'beta_e', |
| 127 | + 'Zeff', |
| 128 | + ] |
| 129 | + # Inputs that are 0D |
| 130 | + scalar_keys = ['Rmaj', 'Rmin'] |
| 131 | + |
| 132 | + expected_vector_length = geo.rho_face_norm.shape[0] |
| 133 | + for key in vector_keys: |
| 134 | + try: |
| 135 | + self.assertEqual( |
| 136 | + getattr(tglf_inputs, key).shape, (expected_vector_length,) |
| 137 | + ) |
| 138 | + except Exception as e: |
| 139 | + print(key, getattr(tglf_inputs, key)) |
| 140 | + raise e |
| 141 | + for key in scalar_keys: |
| 142 | + self.assertEqual(getattr(tglf_inputs, key).shape, ()) |
| 143 | + |
| 144 | + |
| 145 | +class FakeTGLFBasedTransportModel( |
| 146 | + tglf_based_transport_model.TGLFBasedTransportModel |
| 147 | +): |
| 148 | + """Fake TGLFBasedTransportModel for testing purposes.""" |
| 149 | + |
| 150 | + def __init__(self): |
| 151 | + super().__init__() |
| 152 | + self._frozen = True |
| 153 | + |
| 154 | + # pylint: disable=invalid-name |
| 155 | + def prepare_tglf_inputs( |
| 156 | + self, |
| 157 | + Zeff_face: chex.Array, |
| 158 | + q_correction_factor: chex.Numeric, |
| 159 | + geo: geometry.Geometry, |
| 160 | + core_profiles: state.CoreProfiles, |
| 161 | + ) -> tglf_based_transport_model.TGLFInputs: |
| 162 | + """Exposing prepare_tglf_inputs for testing.""" |
| 163 | + return self._prepare_tglf_inputs( |
| 164 | + Zeff_face=Zeff_face, |
| 165 | + q_correction_factor=q_correction_factor, |
| 166 | + geo=geo, |
| 167 | + core_profiles=core_profiles, |
| 168 | + ) |
| 169 | + |
| 170 | + # pylint: enable=invalid-name |
| 171 | + |
| 172 | + def _call_implementation( |
| 173 | + self, |
| 174 | + dynamic_runtime_params_slice: runtime_params_slice.DynamicRuntimeParamsSlice, |
| 175 | + geo: geometry.Geometry, |
| 176 | + core_profiles: state.CoreProfiles, |
| 177 | + pedestal_model_output: pedestal_model_lib.PedestalModelOutput, |
| 178 | + ) -> state.CoreTransport: |
| 179 | + tglf_inputs = self._prepare_tglf_inputs( |
| 180 | + Zeff_face=dynamic_runtime_params_slice.plasma_composition.Zeff_face, |
| 181 | + q_correction_factor=dynamic_runtime_params_slice.numerics.q_correction_factor, |
| 182 | + geo=geo, |
| 183 | + core_profiles=core_profiles, |
| 184 | + ) |
| 185 | + |
| 186 | + transport = dynamic_runtime_params_slice.transport |
| 187 | + # Assert required for pytype. |
| 188 | + assert isinstance( |
| 189 | + transport, |
| 190 | + tglf_based_transport_model.DynamicRuntimeParams, |
| 191 | + ) |
| 192 | + |
| 193 | + return self._make_core_transport( |
| 194 | + qi=jnp.ones(geo.rho_face_norm.shape) * 0.4, |
| 195 | + qe=jnp.ones(geo.rho_face_norm.shape) * 0.5, |
| 196 | + pfe=jnp.ones(geo.rho_face_norm.shape) * 1.6, |
| 197 | + quasilinear_inputs=tglf_inputs, |
| 198 | + transport=transport, |
| 199 | + geo=geo, |
| 200 | + core_profiles=core_profiles, |
| 201 | + gradient_reference_length=geo.Rmaj, # TODO |
| 202 | + gyrobohm_flux_reference_length=geo.Rmin, # TODO |
| 203 | + ) |
| 204 | + |
| 205 | + |
| 206 | +if __name__ == '__main__': |
| 207 | + absltest.main() |
0 commit comments