# Copyright 2024 DeepMind Technologies Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Pydantic config for time step calculators."""
import enum
from torax.time_step_calculator import chi_time_step_calculator
from torax.time_step_calculator import fixed_time_step_calculator
from torax.time_step_calculator import time_step_calculator
from torax.torax_pydantic import torax_pydantic
[docs]
@enum.unique
class TimeStepCalculatorType(enum.Enum):
"""Types of time step calculators."""
CHI = 'chi'
FIXED = 'fixed'
[docs]
class TimeStepCalculator(torax_pydantic.BaseModelFrozen):
"""Config for a time step calculator.
Attributes:
calculator_type: The type of time step calculator to use.
tolerance: The tolerance within the final time for which the simulation
will be considered done.
"""
calculator_type: TimeStepCalculatorType = TimeStepCalculatorType.CHI
tolerance: float = 1e-7
@property
def time_step_calculator(self) -> time_step_calculator.TimeStepCalculator:
match self.calculator_type:
case TimeStepCalculatorType.CHI:
return chi_time_step_calculator.ChiTimeStepCalculator(
tolerance=self.tolerance
)
case TimeStepCalculatorType.FIXED:
return fixed_time_step_calculator.FixedTimeStepCalculator(
tolerance=self.tolerance
)