GlobalPressureTemperature2ModelTest

/* Copyright 2002-2024 CS GROUP
 * 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 org.hipparchus.util.FastMath;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.orekit.Utils;
import org.orekit.errors.OrekitException;
import org.orekit.errors.OrekitMessages;
import org.orekit.forces.gravity.potential.GRGSFormatReader;
import org.orekit.forces.gravity.potential.GravityFieldFactory;
import org.orekit.frames.FramesFactory;
import org.orekit.models.earth.Geoid;
import org.orekit.models.earth.ReferenceEllipsoid;
import org.orekit.time.AbsoluteDate;
import org.orekit.time.TimeScalesFactory;
import org.orekit.utils.IERSConventions;

@Deprecated
public class GlobalPressureTemperature2ModelTest {

    private static double epsilon = 1.0e-12;

    @Test
    public void testProvidedParameters() {

        Utils.setDataRoot("regular-data:potential:gpt-grid");
        GravityFieldFactory.addPotentialCoefficientsReader(new GRGSFormatReader("grim4s4_gr", true));

        // Site Vienna: latitude:  48.20°N
        //              longitude: 16.37°E
        //              height:    156 m
        //
        // Date: 2 August 2012
        //
        // Expected outputs are given by the Department of Geodesy and Geoinformation of the Vienna University.
        // Expected parameters : temperature -> 22.12 °C
        //                       pressure    -> 1002.56 hPa
        //                       e           -> 15.63 hPa
        //                       ah          -> 0.0012647
        //                       aw          -> 0.0005726
        //
        // We test the fiability of our implementation by comparing our output values with
        // the ones obtained by the Vienna University.

        final double latitude  = FastMath.toRadians(48.20);
        final double longitude = FastMath.toRadians(16.37);
        final double height    = 156.0;
        final AbsoluteDate date = AbsoluteDate.createMJDDate(56141, 0.0, TimeScalesFactory.getUTC());
        final Geoid geoid = new Geoid(GravityFieldFactory.getNormalizedProvider(12, 12),
                                      ReferenceEllipsoid.getWgs84(FramesFactory.getITRF(IERSConventions.IERS_2010, true)));
        final GlobalPressureTemperature2Model model =
                        new GlobalPressureTemperature2Model("gpt2_5_extract.grd", latitude, longitude, geoid);

        model.weatherParameters(height, date);

        final double a[]         = model.getA();
        final double temperature = model.getTemperature() - 273.15;
        final double pressure    = model.getPressure();
        final double e           = model.getWaterVaporPressure();

        Assertions.assertEquals(22.12,     temperature, 2.3e-1);
        Assertions.assertEquals(1002.56,   pressure,    7.4e-1);
        Assertions.assertEquals(0.0012647, a[0],        1.1e-7);
        Assertions.assertEquals(0.0005726, a[1],        8.6e-8);
        Assertions.assertEquals(15.63,     e,           5.0e-2);

    }

    @Test
    public void testEquality() {

        Utils.setDataRoot("regular-data:potential:gpt-grid");
        GravityFieldFactory.addPotentialCoefficientsReader(new GRGSFormatReader("grim4s4_gr", true));

        // Commons parameters
        final Geoid geoid = new Geoid(GravityFieldFactory.getNormalizedProvider(12, 12),
                                      ReferenceEllipsoid.getWgs84(FramesFactory.getITRF(IERSConventions.IERS_2010, true)));

        final AbsoluteDate date = AbsoluteDate.createMJDDate(56141, 0.0, TimeScalesFactory.getUTC());
        final double latitude   = FastMath.toRadians(45.0);
        final double height     = 0.0;

        double longitude1;
        GlobalPressureTemperature2Model model1;

        double longitude2;
        GlobalPressureTemperature2Model model2;

        // Test longitude = 181° and longitude = -179°
        longitude1 = FastMath.toRadians(181.0);
        longitude2 = FastMath.toRadians(-179.0);

        model1 = new GlobalPressureTemperature2Model(latitude, longitude1, geoid);
        model2 = new GlobalPressureTemperature2Model(latitude, longitude2, geoid);

        model1.weatherParameters(height, date);
        model2.weatherParameters(height, date);

        Assertions.assertEquals(model1.getTemperature(),        model2.getTemperature(),        epsilon);
        Assertions.assertEquals(model1.getPressure(),           model2.getPressure(),           epsilon);
        Assertions.assertEquals(model1.getWaterVaporPressure(), model2.getWaterVaporPressure(), epsilon);
        Assertions.assertEquals(model1.getA()[0],               model2.getA()[0],               epsilon);
        Assertions.assertEquals(model1.getA()[1],               model2.getA()[1],               epsilon);

        // Test longitude = 180° and longitude = -180°
        longitude1 = FastMath.toRadians(180.0);
        longitude2 = FastMath.toRadians(-180.0);

        model1 = new GlobalPressureTemperature2Model(latitude, longitude1, geoid);
        model2 = new GlobalPressureTemperature2Model(latitude, longitude2, geoid);

        model1.weatherParameters(height, date);
        model2.weatherParameters(height, date);

        Assertions.assertEquals(model1.getTemperature(),        model2.getTemperature(),        epsilon);
        Assertions.assertEquals(model1.getPressure(),           model2.getPressure(),           epsilon);
        Assertions.assertEquals(model1.getWaterVaporPressure(), model2.getWaterVaporPressure(), epsilon);
        Assertions.assertEquals(model1.getA()[0],               model2.getA()[0],               epsilon);
        Assertions.assertEquals(model1.getA()[1],               model2.getA()[1],               epsilon);

        // Test longitude = 0° and longitude = 360°
        longitude1 = FastMath.toRadians(0.0);
        longitude2 = FastMath.toRadians(360.0);

        model1 = new GlobalPressureTemperature2Model(latitude, longitude1, geoid);
        model2 = new GlobalPressureTemperature2Model(latitude, longitude2, geoid);

        model1.weatherParameters(height, date);
        model2.weatherParameters(height, date);

        Assertions.assertEquals(model1.getTemperature(),        model2.getTemperature(),        epsilon);
        Assertions.assertEquals(model1.getPressure(),           model2.getPressure(),           epsilon);
        Assertions.assertEquals(model1.getWaterVaporPressure(), model2.getWaterVaporPressure(), epsilon);
        Assertions.assertEquals(model1.getA()[0],               model2.getA()[0],               epsilon);
        Assertions.assertEquals(model1.getA()[1],               model2.getA()[1],               epsilon);

    }

    @Test
    public void testCorruptedFileBadData() {

        Utils.setDataRoot("regular-data:potential:gpt-grid");
        GravityFieldFactory.addPotentialCoefficientsReader(new GRGSFormatReader("grim4s4_gr", true));

        final double latitude  = FastMath.toRadians(14.0);
        final double longitude = FastMath.toRadians(67.5);

        // Date is not used here
        final Geoid geoid = new Geoid(GravityFieldFactory.getNormalizedProvider(12, 12),
                                      ReferenceEllipsoid.getWgs84(FramesFactory.getITRF(IERSConventions.IERS_2010, true)));

        final String fileName = "corrupted-bad-data-gpt3_15.grd";
        try {
        new GlobalPressureTemperature2Model(fileName, latitude, longitude, geoid);
            Assertions.fail("An exception should have been thrown");
        } catch (OrekitException oe) {
            Assertions.assertEquals(OrekitMessages.UNABLE_TO_PARSE_LINE_IN_FILE, oe.getSpecifier());
            Assertions.assertEquals(6, ((Integer) oe.getParts()[0]).intValue());
            Assertions.assertTrue(((String) oe.getParts()[1]).endsWith(fileName));
        }

    }

    @Test
    public void testCorruptedIrregularGrid() {

        Utils.setDataRoot("regular-data:potential:gpt-grid");
        GravityFieldFactory.addPotentialCoefficientsReader(new GRGSFormatReader("grim4s4_gr", true));

        final double latitude  = FastMath.toRadians(14.0);
        final double longitude = FastMath.toRadians(68.5);

        // Date is not used here
        final Geoid geoid = new Geoid(GravityFieldFactory.getNormalizedProvider(12, 12),
                                      ReferenceEllipsoid.getWgs84(FramesFactory.getITRF(IERSConventions.IERS_2010, true)));

        final String fileName = "corrupted-irregular-grid-gpt3_15.grd";
        try {
        new GlobalPressureTemperature2Model(fileName, latitude, longitude, geoid);
            Assertions.fail("An exception should have been thrown");
        } catch (OrekitException oe) {
            Assertions.assertEquals(OrekitMessages.IRREGULAR_OR_INCOMPLETE_GRID, oe.getSpecifier());
            Assertions.assertTrue(((String) oe.getParts()[0]).endsWith(fileName));
        }

    }

}