GlobalPressureTemperature2.java

/* Copyright 2002-2024 Thales Alenia Space
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You 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.
 */
package org.orekit.models.earth.weather;

import java.io.IOException;

import org.orekit.data.DataProvidersManager;
import org.orekit.data.DataSource;
import org.orekit.time.TimeScale;

/** The Global Pressure and Temperature 2 (GPT2) model.
 * @author Luc Maisonobe
 * @since 12.1
 */
public class GlobalPressureTemperature2 extends AbstractGlobalPressureTemperature {

    /**
     * Constructor with source of GPT2 auxiliary data given by user.
     *
     * @param source grid data source (files with extra columns like GPT2w or GPT3 can be used here)
     * @param utc UTC time scale.
     * @exception IOException if grid data cannot be read
     */
    public GlobalPressureTemperature2(final DataSource source, final TimeScale utc)
        throws IOException {
        super(source, utc,
              SeasonalModelType.PRESSURE,
              SeasonalModelType.TEMPERATURE,
              SeasonalModelType.QV,
              SeasonalModelType.DT,
              SeasonalModelType.AH,
              SeasonalModelType.AW);
    }

    /**
     * Constructor with supported names and source of GPT2 auxiliary data given by user.
     *
     * @param supportedNames supported names (files with extra columns like GPT2w or GPT3 can be used here)
     * @param dataProvidersManager provides access to auxiliary data.
     * @param utc UTC time scale.
     * @deprecated as of 12.1 used only by {@link GlobalPressureTemperature2Model}
     */
    @Deprecated
    protected GlobalPressureTemperature2(final String supportedNames,
                                         final DataProvidersManager dataProvidersManager,
                                         final TimeScale utc) {
        super(buildGrid(supportedNames, dataProvidersManager), utc);
    }

    /** Builder for grid provided as supported names and source of GPT2 auxiliary data given by user.
     *
     * @param supportedNames supported names (files with extra columns like GPT2w or GPT3 can be used here)
     * @param dataProvidersManager provides access to auxiliary data.
     * @return built grid
     * @deprecated as of 12.1 used only by {@link GlobalPressureTemperature2Model}
     */
    @Deprecated
    private static Grid buildGrid(final String supportedNames,
                                  final DataProvidersManager dataProvidersManager) {
        final GptNParser parser = new GptNParser(SeasonalModelType.PRESSURE,
                                                 SeasonalModelType.TEMPERATURE,
                                                 SeasonalModelType.QV,
                                                 SeasonalModelType.DT,
                                                 SeasonalModelType.AH,
                                                 SeasonalModelType.AW);
        dataProvidersManager.feed(supportedNames, parser);
        return parser.getGrid();
    }

}